stack-array 0.7.0

A maximum-sized array stored on the stack
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
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75

//^
//^ HEAD
//^

//> HEAD -> LINTS
#![allow(incomplete_features)]

//> HEAD -> FEATURES
#![feature(generic_const_exprs)]

//> HEAD -> SUPER
use stack_array::Array;

//> HEAD -> CORE
use core::hint::black_box;

//> HEAD -> CRITERION
use criterion::{
    Criterion,
    criterion_group,
    criterion_main,
    Throughput
};

//> HEAD -> ARRAYVEC
use arrayvec::ArrayVec;


//^
//^ BENCHES
//^

//> BENCHES -> SETUP
criterion_group!(stack_array, benches);
criterion_main!(stack_array);

//> BENCHES -> RUN
fn benches(criterion: &mut Criterion) -> () {
    let mut group = criterion.benchmark_group("stack-array");
    const ITERATIONS: usize = 10000;
    group.throughput(Throughput::Elements(ITERATIONS as u64));
    let mut array = Array::<u8, 10>::from([1, 2, 3]);
    group.bench_function("pushpop", |bencher| bencher.iter(|| for _ in 0..ITERATIONS {
        array.push(black_box(0));
        let x = black_box(array.pop());
        black_box(x);
    }));
    let mut vector = Vec::with_capacity(10);
    vector.push(1);
    vector.push(2);
    vector.push(3);
    group.bench_function("veccomparison", |bencher| bencher.iter(|| for _ in 0..ITERATIONS {
        vector.push(black_box(0));
        let x = black_box(vector.pop());
        black_box(x);
    }));
    let mut competitor = ArrayVec::<u8, 10>::new();
    competitor.push(1);
    competitor.push(2);
    competitor.push(3);
    group.bench_function("arrayvec", |bencher| bencher.iter(|| for _ in 0..ITERATIONS {
        competitor.push(black_box(0));
        let x = black_box(competitor.pop());
        black_box(x);
    }));
    group.bench_function("insertremove", |bencher| bencher.iter(|| for _ in 0..ITERATIONS {
        array.insert(black_box(0), black_box(0));
        let x = array.remove(black_box(0));
        black_box(x);
    }));
    group.bench_function("extendclear", |bencher| bencher.iter(|| for _ in 0..ITERATIONS {
        array.extend(black_box([1, 2, 3, 4, 5]));
        array.clear();
    }));
}