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
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
use super::Matrix;
use super::layout::Order;
use crate::error::Result;
use crate::index::Index;
use rayon::prelude::*;
impl<T, O> Matrix<T, O>
where
O: Order,
{
/// Applies a closure to each element in parallel, modifying the matrix
/// in-place.
///
/// # Examples
///
/// ```
/// use matreex::matrix;
///
/// let mut matrix = matrix![[1, 2, 3], [4, 5, 6]];
/// matrix.par_apply(|element| *element += 2);
/// assert_eq!(matrix, matrix![[3, 4, 5], [6, 7, 8]]);
/// ```
pub fn par_apply<F>(&mut self, f: F) -> &mut Self
where
T: Send,
F: Fn(&mut T) + Send + Sync,
{
self.data.par_iter_mut().for_each(f);
self
}
/// Applies a closure to each element in parallel, returning a new matrix with
/// the results.
///
/// See [`par_map_ref`] for a non-consuming version.
///
/// # Errors
///
/// - [`Error::CapacityOverflow`] if the required capacity in bytes exceeds [`isize::MAX`].
///
/// # Examples
///
/// ```
/// use matreex::matrix;
///
/// let matrix = matrix![[1, 2, 3], [4, 5, 6]];
/// let result = matrix.par_map(|element| element as f64);
/// assert_eq!(result, Ok(matrix![[1.0, 2.0, 3.0], [4.0, 5.0, 6.0]]));
/// ```
///
/// [`par_map_ref`]: Matrix::par_map_ref
/// [`Error::CapacityOverflow`]: crate::error::Error::CapacityOverflow
pub fn par_map<F, U>(self, f: F) -> Result<Matrix<U, O>>
where
T: Send,
F: Fn(T) -> U + Send + Sync,
U: Send,
{
let layout = self.layout.cast()?;
let data = self.data.into_par_iter().map(f).collect();
Ok(Matrix { layout, data })
}
/// Applies a closure to each element in parallel, returning a new matrix with
/// the results.
///
/// See [`par_map`] for a consuming version.
///
/// # Errors
///
/// - [`Error::CapacityOverflow`] if the required capacity in bytes exceeds [`isize::MAX`].
///
/// # Examples
///
/// ```
/// use matreex::matrix;
///
/// let matrix = matrix![[1, 2, 3], [4, 5, 6]];
/// let result = matrix.par_map_ref(|element| *element as f64);
/// assert_eq!(result, Ok(matrix![[1.0, 2.0, 3.0], [4.0, 5.0, 6.0]]));
/// ```
///
/// [`par_map`]: Matrix::par_map
/// [`Error::CapacityOverflow`]: crate::error::Error::CapacityOverflow
pub fn par_map_ref<'a, F, U>(&'a self, f: F) -> Result<Matrix<U, O>>
where
T: Sync,
F: Fn(&'a T) -> U + Send + Sync,
U: Send,
{
let layout = self.layout.cast()?;
let data = self.data.par_iter().map(f).collect();
Ok(Matrix { layout, data })
}
}
impl<T, O> Matrix<T, O>
where
O: Order,
{
/// Returns a parallel iterator over the elements.
///
/// # Examples
///
/// ```
/// use matreex::matrix;
/// use matreex::parallel::*;
///
/// let matrix = matrix![[1, 2, 3], [4, 5, 6]];
/// let sum = matrix.par_iter_elements().sum::<i32>();
/// assert_eq!(sum, 21);
/// ```
pub fn par_iter_elements(&self) -> impl ParallelIterator<Item = &T>
where
T: Sync,
{
self.data.par_iter()
}
/// Returns a parallel iterator that allows modifying each element.
///
/// # Examples
///
/// ```
/// use matreex::matrix;
/// use matreex::parallel::*;
///
/// let mut matrix = matrix![[1, 2, 3], [4, 5, 6]];
/// matrix
/// .par_iter_elements_mut()
/// .for_each(|element| *element += 2);
/// assert_eq!(matrix, matrix![[3, 4, 5], [6, 7, 8]]);
/// ```
pub fn par_iter_elements_mut(&mut self) -> impl ParallelIterator<Item = &mut T>
where
T: Send,
{
self.data.par_iter_mut()
}
/// Creates a parallel consuming iterator, that is, one that moves each element
/// out of the matrix.
///
/// # Examples
///
/// ```
/// use matreex::matrix;
/// use matreex::parallel::*;
///
/// let matrix = matrix![[1, 2, 3], [4, 5, 6]];
/// let sum = matrix.into_par_iter_elements().sum::<i32>();
/// assert_eq!(sum, 21);
/// ```
pub fn into_par_iter_elements(self) -> impl ParallelIterator<Item = T>
where
T: Send,
{
self.data.into_par_iter()
}
/// Returns a parallel iterator over the elements along with their indices.
///
/// # Examples
///
/// ```
/// use matreex::matrix;
/// use matreex::parallel::*;
///
/// let matrix = matrix![[1, 2, 3], [4, 5, 6]];
/// matrix
/// .par_iter_elements_with_index()
/// .for_each(|(index, element)| {
/// assert_eq!(element, &matrix[index]);
/// });
/// ```
pub fn par_iter_elements_with_index(&self) -> impl ParallelIterator<Item = (Index, &T)>
where
T: Sync,
{
let stride = self.stride();
self.data
.par_iter()
.enumerate()
.map(move |(index, element)| {
let index = Index::from_flattened::<O>(index, stride);
(index, element)
})
}
/// Returns a parallel iterator that allows modifying each element along with
/// its index.
///
/// # Examples
///
/// ```
/// use matreex::matrix;
/// use matreex::parallel::*;
///
/// let mut matrix = matrix![[1, 2, 3], [4, 5, 6]];
/// matrix
/// .par_iter_elements_mut_with_index()
/// .for_each(|(index, element)| {
/// *element += index.row as i32 + index.col as i32;
/// });
/// assert_eq!(matrix, matrix![[1, 3, 5], [5, 7, 9]]);
/// ```
pub fn par_iter_elements_mut_with_index(
&mut self,
) -> impl ParallelIterator<Item = (Index, &mut T)>
where
T: Send,
{
let stride = self.stride();
self.data
.par_iter_mut()
.enumerate()
.map(move |(index, element)| {
let index = Index::from_flattened::<O>(index, stride);
(index, element)
})
}
/// Creates a parallel consuming iterator, that is, one that moves each element
/// out of the matrix along with its index.
///
/// # Examples
///
/// ```
/// use matreex::matrix;
/// use matreex::parallel::*;
///
/// let matrix = matrix![[1, 2, 3], [4, 5, 6]];
/// matrix
/// .clone()
/// .into_par_iter_elements_with_index()
/// .for_each(|(index, element)| {
/// assert_eq!(element, matrix[index]);
/// });
/// ```
pub fn into_par_iter_elements_with_index(self) -> impl ParallelIterator<Item = (Index, T)>
where
T: Send,
{
let stride = self.stride();
self.data
.into_par_iter()
.enumerate()
.map(move |(index, element)| {
let index = Index::from_flattened::<O>(index, stride);
(index, element)
})
}
}
#[cfg(not(miri))]
#[cfg(test)]
mod tests {
use super::*;
use crate::error::Error;
use crate::{dispatch_unary, matrix};
#[test]
fn test_par_apply() {
dispatch_unary! {{
let mut matrix = matrix![[1, 2, 3], [4, 5, 6]].with_order::<O>();
matrix.par_apply(|element| *element += 2);
let expected = matrix![[3, 4, 5], [6, 7, 8]];
assert_eq!(matrix, expected);
}}
}
#[test]
fn test_par_map() {
dispatch_unary! {{
let matrix = matrix![[1, 2, 3], [4, 5, 6]].with_order::<O>();
let output = matrix.par_map(|element| element as f64).unwrap();
let expected = matrix![[1.0, 2.0, 3.0], [4.0, 5.0, 6.0]];
assert_eq!(output, expected);
let matrix = matrix![[(); usize::MAX]; 1].with_order::<O>();
let error = matrix.par_map(|_| 0).unwrap_err();
assert_eq!(error, Error::CapacityOverflow);
}}
}
#[test]
fn test_par_map_ref() {
dispatch_unary! {{
let matrix = matrix![[1, 2, 3], [4, 5, 6]].with_order::<O>();
let output = matrix.par_map_ref(|element| *element as f64).unwrap();
let expected = matrix![[1.0, 2.0, 3.0], [4.0, 5.0, 6.0]];
assert_eq!(output, expected);
// Map to matrix of references.
let matrix = matrix![[1, 2, 3], [4, 5, 6]].with_order::<O>();
let output = matrix.par_map_ref(|element| element).unwrap();
let expected = matrix![[&1, &2, &3], [&4, &5, &6]];
assert_eq!(output, expected);
let matrix = matrix![[(); usize::MAX]; 1].with_order::<O>();
let error = matrix.par_map_ref(|_| 0).unwrap_err();
assert_eq!(error, Error::CapacityOverflow);
}}
}
#[test]
fn test_par_iter_elements() {
dispatch_unary! {{
let matrix = matrix![[1, 2, 3], [4, 5, 6]].with_order::<O>();
let sum = matrix.par_iter_elements().sum::<i32>();
let expected = 21;
assert_eq!(sum, expected);
}}
}
#[test]
fn test_par_iter_elements_mut() {
dispatch_unary! {{
let mut matrix = matrix![[1, 2, 3], [4, 5, 6]].with_order::<O>();
matrix
.par_iter_elements_mut()
.for_each(|element| *element += 2);
let expected = matrix![[3, 4, 5], [6, 7, 8]];
assert_eq!(matrix, expected);
}}
}
#[test]
fn test_into_par_iter_elements() {
dispatch_unary! {{
let matrix = matrix![[1, 2, 3], [4, 5, 6]].with_order::<O>();
let sum = matrix.into_par_iter_elements().sum::<i32>();
let expected = 21;
assert_eq!(sum, expected);
}}
}
#[test]
fn test_par_iter_elements_with_index() {
dispatch_unary! {{
let matrix = matrix![[1, 2, 3], [4, 5, 6]].with_order::<O>();
matrix
.par_iter_elements_with_index()
.for_each(|(index, element)| {
assert_eq!(element, &matrix[index]);
});
// Assert no panic from unflattening indices occurs.
let matrix = matrix![[0; 0]; 2].with_order::<O>();
matrix.par_iter_elements_with_index().for_each(|_| ());
// Assert no panic from unflattening indices occurs.
let matrix = matrix![[0; 3]; 0].with_order::<O>();
matrix.par_iter_elements_with_index().for_each(|_| ());
}}
}
#[test]
fn test_par_iter_elements_mut_with_index() {
dispatch_unary! {{
let mut matrix = matrix![[1, 2, 3], [4, 5, 6]].with_order::<O>();
matrix
.par_iter_elements_mut_with_index()
.for_each(|(index, element)| {
*element += index.row + index.col;
});
let expected = matrix![[1, 3, 5], [5, 7, 9]];
assert_eq!(matrix, expected);
// Assert no panic from unflattening indices occurs.
let mut matrix = matrix![[0; 0]; 2].with_order::<O>();
matrix.par_iter_elements_mut_with_index().for_each(|_| ());
// Assert no panic from unflattening indices occurs.
let mut matrix = matrix![[0; 3]; 0].with_order::<O>();
matrix.par_iter_elements_mut_with_index().for_each(|_| ());
}}
}
#[test]
fn test_into_par_iter_elements_with_index() {
dispatch_unary! {{
let matrix = matrix![[1, 2, 3], [4, 5, 6]].with_order::<O>();
matrix
.clone()
.into_par_iter_elements_with_index()
.for_each(|(index, element)| {
assert_eq!(element, matrix[index]);
});
// Assert no panic from unflattening indices occurs.
let matrix = matrix![[0; 0]; 2].with_order::<O>();
matrix.into_par_iter_elements_with_index().for_each(|_| ());
// Assert no panic from unflattening indices occurs.
let matrix = matrix![[0; 3]; 0].with_order::<O>();
matrix.into_par_iter_elements_with_index().for_each(|_| ());
}}
}
}