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
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131

//! Assertions and error messages.

/// Assert elements are a multiple of the slice length.
macro_rules! assert_element_len {
    (
        $axis:ident,
        $el_len:ident,
        $slice_len:ident
    ) => {
        assert!(
            $el_len % $slice_len == 0,
            "operation on axis {} expected a multiple of {} elements (recieved {})",
            $axis,
            $slice_len,
            $el_len
        );
    };
}

/// Assert elements are less than or equal to the slice length.
macro_rules! assert_slice_len {
    (
        $array:ident,
        $axis:ident,
        $el_n:ident
    ) => {
        assert!(
            $el_n <= $array.shape[$axis],
            "operation on axis {} expected a slice length <= axis length {} (recieved {})",
            $axis,
            $array.shape[$axis],
            $el_n
        )
    };
}

/// Assert an index is within the array dimensionality.
macro_rules! assert_shape_index {
    (
        $axis:ident,
        $N:ident
    ) => {
        assert!(
            $axis < $N,
            "axis {} is out of bounds for dimensionality {}",
            $axis,
            $N
        );
    };
}

/// Assert an axis index is in bounds.
macro_rules! assert_slice_index {
    (
        $array:ident,
        $axis:ident,
        $index:expr
    ) => {
        assert!(
            $index < $array.shape[$axis],
            "slice index {} is out of bounds axis {} of length {}",
            $index,
            $axis,
            $array.shape[$axis]
        );
    };
}

/// Assert an axis index is in bounds.
macro_rules! assert_slice_range {
    (
        $array:ident,
        $axis:ident,
        $range:ident
    ) => {
        assert!(
            $range.len() <= $array.shape[$axis],
            "range {:?} is out of bounds for axis {} of length {}",
            $range,
            $axis,
            $array.shape[$axis]
        );
    };
}

/// Assert an N dimensional range is contiguous.
macro_rules! assert_contiguous_range {
    (
        $array:ident,
        $axis:ident,
        $range:ident
    ) => {
        assert!(
            $range.len() <= $array.shape[$axis],
            "range {:?} is out of bounds for axis {} of length {}",
            $range,
            $axis,
            $array.shape[$axis]
        );
    };
}

/// Assert translation is in bounds.
macro_rules! assert_origin_bounds {
    (
        $axis:ident,
        $origin:ident,
        $n:ident
    ) => {
        assert!(
            $origin[$axis].checked_add($n).is_some(),
            "translation {} is out of bounds for axis {}, origin {:?}",
            $origin,
            $n,
            $axis,
        );
    };
    (
        $axis:ident,
        $origin:ident,
        -$n:ident
    ) => {
        assert!(
            $origin[$axis].checked_sub($n).is_some(),
            "translation -{} is out of bounds for axis {}, origin {:?}",
            $n,
            $axis,
            $origin
        );
    };
}