commonware-utils 2026.10.0

Leverage common functionality across multiple primitives.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48

use commonware_utils::{TestRng, sequence::FixedBytes};
use criterion::{BatchSize, Criterion, criterion_group};
use rand::RngExt as _;
use std::hint::black_box;

fn bench_cmp_bytes<const N: usize>(c: &mut Criterion) {
    for n in [100u64, 10_000, 100_000] {
        let mut rng = TestRng::new(n);
        let keys: Vec<FixedBytes<N>> = (0..n).map(|_| FixedBytes::new(rng.random())).collect();
        c.bench_function(&format!("{}/op=sort size={N} n={n}", module_path!()), |b| {
            b.iter_batched(
                || keys.clone(),
                |mut v| {
                    v.sort_unstable();
                    v
                },
                BatchSize::LargeInput,
            );
        });
        let mut sorted = keys.clone();
        sorted.sort_unstable();

        // A hit ends on an equal compare, which reads every byte. A miss usually stops early.
        let misses: Vec<FixedBytes<N>> = (0..n).map(|_| FixedBytes::new(rng.random())).collect();
        for (op, queries) in [("hit", &keys), ("miss", &misses)] {
            c.bench_function(&format!("{}/op={op} size={N} n={n}", module_path!()), |b| {
                b.iter(|| {
                    for k in queries {
                        black_box(sorted.binary_search(black_box(k)).is_ok());
                    }
                });
            });
        }
    }
}

fn benchmark_cmp_bytes(c: &mut Criterion) {
    // 16 and 65 keep the derived compare. The rest cover whole words with and without leftovers.
    bench_cmp_bytes::<16>(c);
    bench_cmp_bytes::<20>(c);
    bench_cmp_bytes::<23>(c);
    bench_cmp_bytes::<32>(c);
    bench_cmp_bytes::<33>(c);
    bench_cmp_bytes::<64>(c);
    bench_cmp_bytes::<65>(c);
}

criterion_group!(benches, benchmark_cmp_bytes);