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
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
use core::ops::{Index, IndexMut};
use core::ptr;
use core::mem;
use crate::iter::*;
use crate::view::*;
use crate::flattenexact::*;
/// A `(col, row)` coordinate in 2D space.
pub type Coordinate = (usize, usize);
/// An iterator over each "cell" in a 2D array
pub type Cells<'a, T> = FlattenExact<Rows<'a, T>>;
/// A mutable iterator over each "cell" in a 2D array
pub type CellsMut<'a, T> = FlattenExact<RowsMut<'a, T>>;
/// Defines operations common to both `TooDee` and `TooDeeView`. Default implementations are provided
/// where possible/practical.
pub trait TooDeeOps<T> : Index<usize, Output=[T]> + Index<Coordinate, Output=T> {
/// The number of columns in the area represented by this object.
fn num_cols(&self) -> usize;
/// The number of rows in the area represented by this object.
fn num_rows(&self) -> usize;
/// Returns the size/dimensions of the current object.
fn size(&self) -> (usize, usize) {
(self.num_cols(), self.num_rows())
}
/// Returns `true` if the array contains no elements.
fn is_empty(&self) -> bool {
self.num_cols() == 0 || self.num_rows() == 0
}
/// Returns a view (or subset) of the current area based on the coordinates provided.
///
/// # Examples
///
/// ```
/// use toodee::{TooDee,TooDeeOps};
/// let toodee : TooDee<u32> = TooDee::new(10, 5);
/// let view = toodee.view((1, 1), (9, 4));
/// assert_eq!(view.num_cols(), 8);
/// assert_eq!(view.num_rows(), 3);
/// ```
fn view(&self, start: Coordinate, end: Coordinate) -> TooDeeView<'_, T>;
/// Returns an iterator of slices, where each slice represents an entire row.
///
/// # Examples
///
/// ```
/// use toodee::{TooDee,TooDeeOps};
/// let toodee : TooDee<u32> = TooDee::init(10, 5, 42u32);
/// let mut sum = 0u32;
/// for r in toodee.rows() {
/// sum += r.iter().sum::<u32>();
/// }
/// assert_eq!(sum, 42*50);
/// ```
fn rows(&self) -> Rows<'_, T>;
/// Returns an iterator over a single column. Note that the `Col` iterator is indexable.
///
/// # Examples
///
/// ```
/// use toodee::{TooDee,TooDeeOps};
/// let toodee : TooDee<u32> = TooDee::init(10, 5, 42u32);
/// let mut sum = 0u32;
/// for c in toodee.col(1) {
/// sum += c;
/// }
/// assert_eq!(sum, 42*5);
/// ```
fn col(&self, col: usize) -> Col<'_, T>;
/// Returns an iterator that traverses all cells within the area.
///
/// # Examples
///
/// ```
/// use toodee::{TooDee,TooDeeOps};
/// let toodee : TooDee<u32> = TooDee::init(10, 5, 42u32);
/// let mut sum = toodee.cells().sum::<u32>();
/// assert_eq!(sum, 42*50);
/// ```
fn cells(&self) -> Cells<'_, T> {
FlattenExact::new(self.rows())
}
/// Returns a row without checking that the row is valid. Generally it's best to use indexing instead, e.g., toodee\[row\]
///
/// # Safety
///
/// This is generally not recommended, use with caution!
/// Calling this method with an invalid row is *[undefined behavior]* even if the resulting reference is not used.
unsafe fn get_unchecked_row(&self, row: usize) -> &[T];
/// Returns a cell without checking that the cell coordinate is valid. Generally it's best to use indexing instead, e.g., toodee\[(col, row)\]
///
/// # Safety
///
/// This is generally not recommended, use with caution!
/// Calling this method with an invalid coordinate is *[undefined behavior]* even if the resulting reference is not used.
unsafe fn get_unchecked(&self, coord: Coordinate) -> &T;
}
/// Defines operations common to both `TooDee` and `TooDeeViewMut`. Default implementations
/// are provided where possible/practical.
pub trait TooDeeOpsMut<T> : TooDeeOps<T> + IndexMut<usize,Output=[T]> + IndexMut<Coordinate, Output=T> {
/// Returns a mutable view (or subset) of the current area based on the coordinates provided.
///
/// # Examples
///
/// ```
/// use toodee::{TooDee,TooDeeOps,TooDeeOpsMut};
/// let mut toodee : TooDee<u32> = TooDee::new(10, 5);
/// let view = toodee.view_mut((1, 1), (9, 4));
/// assert_eq!(view.num_cols(), 8);
/// assert_eq!(view.num_rows(), 3);
/// ```
fn view_mut(&mut self, start: Coordinate, end: Coordinate) -> TooDeeViewMut<'_, T>;
/// Returns a mutable iterator of slices, where each slice represents an entire row.
///
/// # Examples
///
/// ```
/// use toodee::{TooDee,TooDeeOps,TooDeeOpsMut};
/// let mut toodee : TooDee<u32> = TooDee::init(10, 5, 42u32);
/// for (i, r) in toodee.rows_mut().enumerate() {
/// r.iter_mut().for_each(|c| *c -= i as u32);
/// }
/// assert_eq!(toodee.cells().sum::<u32>(), 42*50 - 10 - 20 - 30 - 40);
/// ```
fn rows_mut(&mut self) -> RowsMut<'_, T>;
/// Returns a mutable iterator over a single column. Note that the `ColMut` iterator is indexable.
///
/// # Examples
///
/// ```
/// use toodee::{TooDee,TooDeeOps,TooDeeOpsMut};
/// let mut toodee : TooDee<u32> = TooDee::init(10, 5, 42u32);
/// for c in toodee.col_mut(4) {
/// *c /= 2;
/// }
/// assert_eq!(toodee.cells().sum::<u32>(), 42*45 + 21*5);
/// ```
fn col_mut(&mut self, col: usize) -> ColMut<'_, T>;
/// Returns an iterator that traverses all cells within the area.
///
/// # Examples
///
/// ```
/// use toodee::{TooDee,TooDeeOps,TooDeeOpsMut};
/// let mut toodee : TooDee<u32> = TooDee::init(10, 5, 42u32);
/// for c in toodee.cells_mut() {
/// *c -= 1;
/// }
/// assert_eq!(toodee.cells().sum::<u32>(), 41*50);
/// ```
fn cells_mut(&mut self) -> CellsMut<'_, T> {
FlattenExact::new(self.rows_mut())
}
/// Fills the entire area with the specified value.
///
/// # Examples
///
/// ```
/// use toodee::{TooDee,TooDeeOps,TooDeeOpsMut};
/// let mut toodee : TooDee<u32> = TooDee::init(10, 5, 42u32);
/// let mut view = toodee.view_mut((1, 1), (9, 4));
/// view.fill(0);
/// assert_eq!(toodee.cells().sum::<u32>(), 42*(50 - 8*3));
/// ```
fn fill(&mut self, fill: T)
where T: Clone {
for r in self.rows_mut() {
r.fill(fill.clone());
}
}
/// Swap/exchange the data between two columns.
///
/// # Examples
///
/// ```
/// use toodee::{TooDee,TooDeeOps,TooDeeOpsMut};
/// let mut toodee : TooDee<u32> = TooDee::init(10, 5, 42u32);
/// for c in toodee.col_mut(2) {
/// *c = 1;
/// }
/// assert_eq!(toodee[(4, 0)], 42);
/// toodee.swap_cols(2, 4);
/// assert_eq!(toodee[(4, 0)], 1);
/// ```
fn swap_cols(&mut self, c1: usize, c2: usize) {
let num_cols = self.num_cols();
assert!(c1 < num_cols);
assert!(c2 < num_cols);
for r in self.rows_mut() {
// The column indices have been checked with asserts (see above), so we can
// safely access and swap the elements using `get_unchecked_mut`.
unsafe {
let pa: *mut T = r.get_unchecked_mut(c1);
let pb: *mut T = r.get_unchecked_mut(c2);
ptr::swap(pa, pb);
}
}
}
/// Swap/exchange two cells in the array.
///
/// # Panics
///
/// Panics if either cell coordinate is out of bounds.
///
/// # Examples
///
/// ```
/// use toodee::{TooDee,TooDeeOps,TooDeeOpsMut};
/// let mut toodee = TooDee::from_vec(3, 3, (0u32..9).collect());
/// toodee.swap((0,0),(2, 2));
/// assert_eq!(toodee.data(), &[8, 1, 2, 3, 4, 5, 6, 7, 0]);
/// ```
fn swap(&mut self, mut cell1: Coordinate, mut cell2: Coordinate) {
if cell1.1 > cell2.1 {
mem::swap(&mut cell1, &mut cell2);
}
let num_cols = self.num_cols();
assert!(cell1.0 < num_cols && cell2.0 < num_cols);
let mut iter = self.rows_mut();
let row1 = iter.nth(cell1.1).unwrap();
if cell1.1 == cell2.1 {
unsafe {
let pa: *mut T = row1.get_unchecked_mut(cell1.0);
let pb: *mut T = row1.get_unchecked_mut(cell2.0);
ptr::swap(pa, pb);
}
} else {
let row2 = iter.nth(cell2.1 - cell1.1 - 1).unwrap();
unsafe {
let pa: *mut T = row1.get_unchecked_mut(cell1.0);
let pb: *mut T = row2.get_unchecked_mut(cell2.0);
ptr::swap(pa, pb);
}
}
}
/// Swap/exchange the data between two rows. Note that this method is overridden in both `TooDee` and `TooDeeOpsMut`.
/// This implementation remains in place for other types that may wish to implement the trait.
///
/// # Panics
///
/// Panics if either row index is out of bounds.
///
/// # Examples
///
/// ```
/// use toodee::{TooDee,TooDeeOps,TooDeeOpsMut};
/// let mut toodee : TooDee<u32> = TooDee::init(10, 5, 42u32);
/// toodee[0].iter_mut().for_each(|v| *v = 1);
/// assert_eq!(toodee[(0, 2)], 42);
/// toodee.view_mut((0, 0), (10, 5)).swap_rows(0, 2);
/// assert_eq!(toodee[(0, 2)], 1);
/// ```
fn swap_rows(&mut self, mut r1: usize, mut r2: usize) {
if r1 == r2 {
return;
}
if r2 < r1 {
mem::swap(&mut r1, &mut r2);
}
let mut iter = self.rows_mut();
let tmp = iter.nth(r1).unwrap();
tmp.swap_with_slice(iter.nth(r2-r1-1).unwrap());
}
/// Return the specified rows as mutable slices.
///
/// # Panics
///
/// Will panic if `r1` and `r2` are equal, or if either row index is out of bounds.
///
/// # Examples
///
/// ```
/// use toodee::{TooDee,TooDeeOps,TooDeeOpsMut};
/// let mut toodee : TooDee<u32> = TooDee::init(10, 5, 42u32);
/// let (r1, r2) = toodee.row_pair_mut(0, 4);
/// // do something with the row pair
/// r1.swap_with_slice(r2);
/// ```
fn row_pair_mut(&mut self, r1: usize, r2: usize) -> (&mut [T], &mut [T]) {
let num_rows = self.num_rows();
assert!(r1 < num_rows);
assert!(r2 < num_rows);
assert_ne!(r1, r2);
if r1 < r2 {
let mut iter = self.rows_mut();
let tmp = iter.nth(r1).unwrap();
(tmp, iter.nth(r2-r1-1).unwrap())
} else {
let mut iter = self.rows_mut();
let tmp = iter.nth(r2).unwrap();
(iter.nth(r1-r2-1).unwrap(), tmp)
}
}
/// Returns a mutable row without checking that the row is valid. Generally it's best to use indexing instead, e.g., toodee\[row\]
///
/// # Safety
///
/// This is generally not recommended, use with caution!
/// Calling this method with an invalid row is *[undefined behavior]* even if the resulting reference is not used.
unsafe fn get_unchecked_row_mut(&mut self, row: usize) -> &mut [T];
/// Returns a mutable cell without checking that the cell coordinate is valid. Generally it's best to use indexing instead, e.g., toodee\[(col, row)\]
///
/// # Safety
///
/// This is generally not recommended, use with caution!
/// Calling this method with an invalid coordinate is *[undefined behavior]* even if the resulting reference is not used.
unsafe fn get_unchecked_mut(&mut self, coord: Coordinate) -> &mut T;
}