n_circular_array 0.4.2

An n-dimensional circular array.
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

#![feature(test)]
extern crate test;

use test::{black_box, Bencher};

use n_circular_array::{CircularArrayBox, CircularIndex};

/// Bench iter methods for an array of `d` dimensions of `n` elements.
macro_rules! bench {
    (
        $name:ident,
        $d:literal,
        $n:literal
    ) => {
        mod $name {
            use super::*;

            bench_iter!(iter, $d, $n);
            bench_iter!(iter_raw, $d, $n);
            bench_iter!(iter_index(0, 1), $d, $n);
            bench_iter!(iter_index_contiguous(0, 1), $d, $n);
            bench_iter!(iter_index_raw(0, 1), $d, $n);
            bench_iter!(iter_range(0, 1..$d), $d, $n);
            bench_iter!(iter_range_contiguous(0, 1..$d), $d, $n);
            bench_iter!(iter_range_raw(0, 1..$d), $d, $n);
        }
    };
}

/// Bench a specified push method for an array of `d` dimensions of `n` elements.
macro_rules! bench_iter {
    (
        $method:ident $( ( $( $arg:expr ),* ) )? ,
        $d:literal,
        $n:literal
    ) => {
        #[bench]
        fn $method(bencher: &mut Bencher) {
            const SHAPE: [usize; $d] = [$n; $d];

            let m = CircularArrayBox::from_iter(SHAPE, 0..SHAPE.iter().product::<usize>());

            bencher.iter(|| {
                m.$method( $( $( $arg ),* )? ).for_each(|i| {
                    black_box(i);
                });
            });

            black_box(m);
        }
    };
}

bench!(d2_n05, 2, 5);
bench!(d2_n10, 2, 10);
bench!(d3_n05, 3, 5);
bench!(d3_n10, 3, 10);
bench!(d4_n05, 4, 5);
bench!(d4_n10, 4, 10);