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
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
// devela::data::layout::array::d2::methods::coords
//
//! 2-dimensional array coordinates and indexing methods
//
use crate::{Array2d, IndexOutOfBounds, Storage, is};
/// Helper macro for implementing common methods generic on storage order.
macro_rules! impl_maj {
() => {
impl_maj![true:r:"row", false:c:"column"];
impl_maj![false:c:"column", true:r:"row"];
};
// $RMAJ: true for row-major order
// $D1: the major dimension name (not used)
// $D1long: the major dimension long name
// $D2: the other dimension name
// $D2long: the other dimension long name
// $CMAJ: false for row-major order
( $RMAJ:literal:$D1:ident:$D1long:literal,
$CMAJ:literal:$D2:ident:$D2long:literal) => { $crate::paste! {
// T, S
#[doc = "# Single element indexing (" $D1long "-major order)"]
impl<T, const C: usize, const R: usize, const CR: usize, S: Storage>
Array2d<T, C, R, CR, $RMAJ, S>
{
/* get_ref */
/// Returns a reference to the element at the given 2D coordinates
#[doc = "in the current " $D1long "-major order."]
/// # Errors
/// Returns [`IndexOutOfBounds`] if the coordinates are out of bounds.
pub fn get_ref(&self, col_row: [usize; 2]) -> Result<&T, IndexOutOfBounds> {
Self::get_index(col_row).map(|idx| &self.data[idx])
}
/// Returns a reference to the element at the given 2D coordinates
#[doc = "in the current " $D1long "-major order."]
/// # Panics
/// Panics if the coordinates are out of bounds.
#[must_use]
pub fn get_ref_unchecked(&self, col_row: [usize; 2]) -> &T {
&self.data.data[Self::get_index_unchecked(col_row)]
}
/* get_mut */
/// Returns an exclusive reference to the element at the given 2D coordinates
#[doc = "in the current " $D1long "-major order."]
/// # Errors
/// Returns [`IndexOutOfBounds`] if the coordinates are out of bounds.
pub fn get_mut(&mut self, col_row: [usize; 2]) -> Result<&mut T, IndexOutOfBounds> {
Self::get_index(col_row).map(|idx| &mut self.data[idx])
}
/// Returns an exclusive reference to the element at the given 2D coordinates
#[doc = "in the current " $D1long "-major order."]
/// # Panics
/// Panics if the coordinates are out of bounds.
#[must_use]
pub fn get_mut_unchecked(&mut self, col_row: [usize; 2]) -> &mut T {
&mut self.data.data[Self::get_index_unchecked(col_row)]
}
/* set */
/// Sets the element at the given 2D coordinates
#[doc = "in the current " $D1long "-major order."]
/// # Errors
/// Returns [`IndexOutOfBounds`] if the coordinates are out of bounds.
pub fn set(&mut self, element: T, col_row: [usize; 2]) -> Result<(), IndexOutOfBounds> {
self.get_mut(col_row).map(|e| {
*e = element;
})
}
/// Sets the element at the given 2D coordinates
#[doc = "in the current " $D1long "-major order."]
/// # Panics
/// Panics if the coordinates are out of bounds.
pub fn set_unchecked(&mut self, element: T, col_row: [usize; 2]) {
let e = self.get_mut_unchecked(col_row);
*e = element;
}
}
// T: Clone, S
// # Single element clone
impl<T: Clone, const C: usize, const R: usize, const CR: usize, S: Storage>
Array2d<T, C, R, CR, $RMAJ, S>
{
/* get */
/// Returns a clone of the element at the given 2D coordinates
#[doc = "in the current " $D1long "-major order."]
/// # Errors
/// Returns [`IndexOutOfBounds`] if the coordinates are out of bounds.
pub fn get(&self, col_row: [usize; 2]) -> Result<T, IndexOutOfBounds> {
Self::get_index(col_row).map(|idx| self.data[idx].clone())
}
/// Returns a clone of the element at the given 2D coordinates
#[doc = "in the current " $D1long "-major order."]
/// # Panics
/// Panics if the coordinates are out of bounds.
#[must_use]
pub fn get_unchecked(&self, col_row: [usize; 2]) -> T {
self.data.data[Self::get_index_unchecked(col_row)].clone()
}
}
/* methods in opposite-order */
// T, S
#[doc = "# Single element indexing (using opposite " $D2long "-major order)"]
impl<T, const C: usize, const R: usize, const CR: usize, S: Storage>
Array2d<T, C, R, CR, $RMAJ, S>
{
/* get_ref (opposite order) */
/// Returns a reference to the element at the given 2D coordinates
#[doc = "in the opposite " $D2long "-major order."]
/// # Errors
/// Returns [`IndexOutOfBounds`] if the coordinates are out of bounds.
pub fn [<get_ref_ $D2 maj>](&self, col_row: [usize; 2])
-> Result<&T, IndexOutOfBounds> {
Self::[<get_index_ $D2 maj>](col_row).map(|idx| &self.data[idx])
}
/// Returns a reference to the element at the given 2D coordinates
#[doc = "in the opposite " $D2long "-major order."]
/// # Panics
/// Panics if the coordinates are out of bounds.
#[must_use]
pub fn [<get_ref_ $D2 maj_unchecked>](&self, col_row: [usize; 2]) -> &T {
&self.data.data[Self::[<get_index_ $D2 maj_unchecked>](col_row)]
}
/* get_mut (opposite order) */
/// Returns an exclusive reference to the element at the given 2D coordinates
#[doc = "in the opposite " $D2long "-major order."]
/// # Errors
/// Returns [`IndexOutOfBounds`] if the coordinates are out of bounds.
pub fn [<get_mut_ $D2 maj>](&mut self, col_row: [usize; 2])
-> Result<&mut T, IndexOutOfBounds> {
Self::[<get_index_ $D2 maj>](col_row).map(|idx| &mut self.data[idx])
}
/// Returns an exclusive reference to the element at the given 2D coordinates
#[doc = "in the opposite " $D2long "-major order."]
/// # Panics
/// Panics if the coordinates are out of bounds.
#[must_use]
pub fn [<get_mut_ $D2 maj_unchecked>](&mut self, col_row: [usize; 2]) -> &mut T {
&mut self.data.data[Self::[<get_index_ $D2 maj_unchecked>](col_row)]
}
/* set (opposite order) */
/// Sets the element at the given 2D coordinates
#[doc = "in the opposite " $D2long "-major order."]
/// # Errors
/// Returns [`IndexOutOfBounds`] if the coordinates are out of bounds.
pub fn [<set_ $D2 maj>](&mut self, element: T, col_row: [usize; 2])
-> Result<(), IndexOutOfBounds> {
self.[<get_mut_ $D2 maj>](col_row).map(|e| {
*e = element;
})
}
/// Sets the element at the given 2D coordinates
#[doc = "in the opposite " $D2long "-major order."]
/// # Panics
/// Panics if the coordinates are out of bounds.
pub fn [<set_ $D2 maj_unchecked>](&mut self, element: T, col_row: [usize; 2]) {
let e = self.[<get_mut_ $D2 maj_unchecked>](col_row);
*e = element;
}
/* indexing (opposite order) */
/// Calculates the 1D array index from the given 2D coordinates
#[doc = "in the opposite " $D2long "-major order."]
/// # Errors
/// Returns [`IndexOutOfBounds`] if the resulting index is `> CR`.
pub const fn [<get_index_ $D2 maj>](col_row: [usize; 2])
-> Result<usize, IndexOutOfBounds> {
Array2d::<T, C, R, CR, $CMAJ, S>::[<get_index>](col_row)
}
/// Calculates the 1D array index from the given 2D coordinates
#[doc = "in the opposite " $D2long "-major order."]
#[must_use]
pub const fn [<get_index_ $D2 maj_unchecked>](col_row: [usize; 2]) -> usize {
Array2d::<T, C, R, CR, $CMAJ, S>::[<get_index_unchecked>](col_row)
}
/// Calculates the 2D coordinates from the given 1D array index
#[doc = "in the opposite " $D2long "-major order."]
/// # Errors
/// Returns [`IndexOutOfBounds`] if `index` is `> CR`.
pub const fn [<get_coords_ $D2 maj>](index: usize)
-> Result<[usize; 2], IndexOutOfBounds> {
Array2d::<T, C, R, CR, $CMAJ, S>::[<get_coords>](index)
}
/// Calculates the 2D coordinates from the given 1D array index
#[doc = "in the opposite " $D2long "-major order."]
pub const fn [<get_coords_ $D2 maj_unchecked>](index: usize) -> [usize; 2] {
Array2d::<T, C, R, CR, $CMAJ, S>::[<get_coords_unchecked>](index)
}
}
// T: Clone, S
impl<T: Clone, const C: usize, const R: usize, const CR: usize, S: Storage>
Array2d<T, C, R, CR, $RMAJ, S>
{
/* get (opposite order) */
/// Returns a clone of the element at the given 2D coordinates
#[doc = "in the opposite " $D2long "-major order."]
/// # Errors
/// Returns [`IndexOutOfBounds`] if the coordinates are out of bounds.
pub fn [<get_ $D2 maj>](&self, col_row: [usize; 2]) -> Result<T, IndexOutOfBounds> {
Self::[<get_index_ $D2 maj>](col_row).map(|idx| self.data[idx].clone())
}
/// Returns a clone of the element at the given 2D coordinates
#[doc = "in the opposite " $D2long "-major order."]
/// # Panics
/// Panics if the coordinates are out of bounds.
#[must_use]
pub fn [<get_ $D2 maj_unchecked>](&self, col_row: [usize; 2]) -> T {
self.data.data[Self::[<get_index_ $D2 maj_unchecked>](col_row)].clone()
}
}
}};
}
impl_maj![];
/* storage order specific implementations */
// T, S
/// # Fundamental indexing methods in row-major order.
impl<T, const C: usize, const R: usize, const CR: usize, S: Storage> Array2d<T, C, R, CR, true, S> {
/// Calculates the 1D array index from the given 2D coordinates
/// in the current row-major order.
/// # Errors
/// Returns [`IndexOutOfBounds`] if the resulting index is `>= CR`.
pub const fn get_index(col_row: [usize; 2]) -> Result<usize, IndexOutOfBounds> {
let idx = Self::get_index_unchecked(col_row);
is![idx < CR, Ok(idx), Err(IndexOutOfBounds(Some(idx)))]
}
/// Calculates the 1D array index from the given 2D coordinates
/// in the current row-major order.
// # Performance
// This function seems to be 2x faster than
// [`get_coords_unchecked`](#method.get_coords_unchecked).
// BENCH: 0.63 ns
#[must_use]
pub const fn get_index_unchecked(col_row: [usize; 2]) -> usize {
col_row[1] * R + col_row[0]
}
/// Calculates the 2D coordinates from the given 1D array index
/// in the current row-major order.
/// # Errors
/// Returns [`IndexOutOfBounds`] if `index` is `>= CR`.
pub const fn get_coords(index: usize) -> Result<[usize; 2], IndexOutOfBounds> {
is![index < CR, Ok(Self::get_coords_unchecked(index)), Err(IndexOutOfBounds(Some(index)))]
}
/// Calculates the 2D coordinates from the given 1D array index
/// in the current row-major order.
// # Performance
// This function seems to be 2x slower than
// [`get_index_unchecked`](#method.get_index_unchecked).
// BENCH: 1.4 ns
#[must_use]
pub const fn get_coords_unchecked(index: usize) -> [usize; 2] {
[index % R, index / R]
}
}
// T, S
/// # Fundamental indexing methods in column-major order.
impl<T, const C: usize, const R: usize, const CR: usize, S: Storage>
Array2d<T, C, R, CR, false, S>
{
/// Calculates the 1D array index from the given 2D coordinates
/// in the current column-major order.
/// # Errors
/// Returns [`IndexOutOfBounds`] if the resulting index is `>= CR`.
pub const fn get_index(col_row: [usize; 2]) -> Result<usize, IndexOutOfBounds> {
let idx = Self::get_index_unchecked(col_row);
is![idx < CR, Ok(idx), Err(IndexOutOfBounds(Some(idx)))]
}
/// Calculates the 1D array index from the given 2D coordinates
/// in the current column-major order.
// # Performance
// This function seems to be 1.5x faster than
// [`get_coords_unchecked`](#method.get_coords_unchecked-1).
// BENCH: 0.62 ns
#[must_use]
pub const fn get_index_unchecked(col_row: [usize; 2]) -> usize {
col_row[0] * C + col_row[1]
}
/// Calculates the 2D coordinates from the given 1D array index
/// in the current column-major order.
/// # Errors
/// Returns [`IndexOutOfBounds`] if `index` is `>= CR`.
pub const fn get_coords(index: usize) -> Result<[usize; 2], IndexOutOfBounds> {
is![index < CR, Ok(Self::get_coords_unchecked(index)), Err(IndexOutOfBounds(Some(index)))]
}
/// Calculates the 2D coordinates from the given 1D array index
/// in the current column-major order.
// # Performance
// This function seems to be 1.5x slower than
// [`get_index_unchecked`](#method.get_index_unchecked-1).
// BENCH: 0.94 ns
#[must_use]
pub const fn get_coords_unchecked(index: usize) -> [usize; 2] {
[index / C, index % C]
}
}