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
use crate::{
core::prelude::*,
errors::prelude::*,
extensions::prelude::*,
validators::prelude::*,
};
use crate::prelude::Numeric;
/// `ArrayTrait` - Array Axis functions
pub trait ArrayAxis<T: ArrayElement> where Array<T>: Sized + Clone {
/// Applies given function along an axis
///
/// # Arguments
///
/// * `axis` - axis along which the function will be applied
/// * `f` - function to apply
///
/// # Errors
///
/// may returns `ArrayError`
fn apply_along_axis<S: ArrayElement, F>(&self, axis: usize, f: F) -> Result<Array<S>, ArrayError>
where F: FnMut(&Array<T>) -> Result<Array<S>, ArrayError>;
/// Returns an array with axes transposed
///
/// # Arguments
///
/// * `axes` - if defined, it's a list of axes to be included in transposition
///
/// # Examples
///
/// ```
/// use arr_rs::prelude::*;
///
/// let arr = Array::new(vec![1,2,3,4,5,6,7,8], vec![2, 4]).unwrap();
/// assert_eq!(array!(i32, [[1, 5], [2, 6], [3, 7], [4, 8]]), arr.transpose(None));
///
/// let arr = Array::new(vec![1,2,3,4,5,6,7,8], vec![4, 2]).unwrap();
/// assert_eq!(array!(i32, [[1, 3, 5, 7], [2, 4, 6, 8]]), arr.transpose(None));
///
/// let arr = Array::new(vec![1,2,3,4,5,6,7,8], vec![4, 2]).unwrap();
/// assert_eq!(array!(i32, [[1, 3, 5, 7], [2, 4, 6, 8]]), arr.transpose(Some(vec![1, 0])));
/// ```
///
/// # Errors
///
/// may returns `ArrayError`
fn transpose(&self, axes: Option<Vec<isize>>) -> Result<Array<T>, ArrayError>;
/// Move axes of an array to new positions
///
/// # Arguments
///
/// * `source` - original positions of the axes to move. must be unique
/// * `destination` - destination positions for each of the original axes. must be unique
///
/// # Examples
///
/// ```
/// use arr_rs::prelude::*;
///
/// let arr = Array::<i32>::zeros(vec![3, 4, 5]);
/// assert_eq!(vec![4, 5, 3], arr.moveaxis(vec![0], vec![2]).get_shape().unwrap());
/// assert_eq!(vec![5, 3, 4], arr.moveaxis(vec![2], vec![0]).get_shape().unwrap());
/// ```
///
/// # Errors
///
/// may returns `ArrayError`
fn moveaxis(&self, source: Vec<isize>, destination: Vec<isize>) -> Result<Array<T>, ArrayError>;
/// Roll the specified axis backwards, until it lies in a given position
///
/// # Arguments
///
/// * `axis` - the axis to be rolled
/// * `start` - start position. optional, defaults to 0
///
/// # Examples
///
/// ```
/// use arr_rs::prelude::*;
///
/// let arr = Array::<i32>::zeros(vec![3, 4, 5]);
/// assert_eq!(vec![4, 3, 5], arr.rollaxis(1, None).get_shape().unwrap());
/// assert_eq!(vec![3, 5, 4], arr.rollaxis(2, Some(1)).get_shape().unwrap());
/// ```
///
/// # Errors
///
/// may returns `ArrayError`
fn rollaxis(&self, axis: isize, start: Option<isize>) -> Result<Array<T>, ArrayError>;
/// Interchange two axes of an array
///
/// # Arguments
///
/// * `axis_1` - first axis
/// * `axis_1` - second axis
///
/// # Examples
///
/// ```
/// use arr_rs::prelude::*;
///
/// let arr = Array::<i32>::zeros(vec![3, 4, 5]);
/// assert_eq!(vec![5, 4, 3], arr.swapaxes(0, 2).get_shape().unwrap());
/// assert_eq!(vec![3, 5, 4], arr.swapaxes(2, 1).get_shape().unwrap());
/// ```
///
/// # Errors
///
/// may returns `ArrayError`
fn swapaxes(&self, axis: isize, start: isize) -> Result<Array<T>, ArrayError>;
/// Expand the shape of an array
///
/// # Arguments
///
/// * `axes` - position in the expanded axes where the new axis (or axes) is placed
///
/// # Examples
///
/// ```
/// use arr_rs::prelude::*;
///
/// let arr = Array::<i32>::zeros(vec![3, 4, 5]);
/// assert_eq!(vec![1, 3, 4, 5], arr.expand_dims(vec![0]).get_shape().unwrap());
/// assert_eq!(vec![3, 1, 4, 1, 5], arr.expand_dims(vec![1, 3]).get_shape().unwrap());
/// ```
///
/// # Errors
///
/// may returns `ArrayError`
fn expand_dims(&self, axes: Vec<isize>) -> Result<Array<T>, ArrayError>;
/// Remove axes of length one from array
///
/// # Arguments
///
/// * `axes` - position of the 10-sized axes to remove. if None, all such axes will be removed
///
/// # Examples
///
/// ```
/// use arr_rs::prelude::*;
///
/// let arr = Array::<i32>::zeros(vec![1, 3, 1, 4, 5]);
/// assert_eq!(vec![3, 4, 5], arr.squeeze(None).get_shape().unwrap());
/// assert_eq!(vec![3, 1, 4, 5], arr.squeeze(Some(vec![0])).get_shape().unwrap());
/// assert_eq!(vec![1, 3, 4, 5], arr.squeeze(Some(vec![2])).get_shape().unwrap());
/// ```
///
/// # Errors
///
/// may returns `ArrayError`
fn squeeze(&self, axes: Option<Vec<isize>>) -> Result<Array<T>, ArrayError>;
}
impl <T: ArrayElement> ArrayAxis<T> for Array<T> {
fn apply_along_axis<S: ArrayElement, F>(&self, axis: usize, mut f: F) -> Result<Array<S>, ArrayError>
where F: FnMut(&Self) -> Result<Array<S>, ArrayError> {
self.axis_in_bounds(axis)?;
let parts = self.get_shape()?.remove_at(axis).into_iter().product();
let array = self.moveaxis(vec![axis.to_isize()], vec![self.ndim()?.to_isize()])?;
let partial = array
.ravel()
.split(parts, None)?.into_iter()
.map(|arr| f(&arr))
.collect::<Vec<Result<Array<S>, _>>>()
.has_error()?.into_iter()
.map(Result::unwrap)
.collect::<Vec<Array<S>>>();
let partial_len = partial[0].len()?;
let partial = partial.into_iter().flatten().collect::<Array<S>>();
let new_shape = array.get_shape()?.update_at(self.ndim()? - 1, partial_len);
let partial = partial.reshape(&new_shape);
if axis == 0 { partial.rollaxis((self.ndim()? - 1).to_isize(), None) }
else { partial.moveaxis(vec![axis.to_isize()], vec![(self.ndim()? - 1).to_isize()]) }
}
fn transpose(&self, axes: Option<Vec<isize>>) -> Result<Self, ArrayError> {
fn transpose_recursive<T: ArrayElement>(
input: &[T], input_shape: &[usize],
output: &mut [T], output_shape: &[usize],
current_indices: &mut [usize], current_dim: usize,
axes: &Option<Vec<usize>>) {
if current_dim < input_shape.len() - 1 {
(0..input_shape[current_dim]).for_each(|i| {
current_indices[current_dim] = i;
transpose_recursive(input, input_shape, output, output_shape, current_indices, current_dim + 1, axes);
});
} else {
(0..input_shape[current_dim]).for_each(|i| {
current_indices[current_dim] = i;
let input_index = input_shape.iter().enumerate().fold(0, |acc, (dim, size)| { acc * size + current_indices[dim] });
let output_indices = axes.as_ref().map_or_else(
|| current_indices.iter().rev().copied().collect::<Vec<usize>>(),
|axes| axes.iter().map(|&ax| current_indices[ax]).collect::<Vec<usize>>());
let output_index = output_shape.iter().enumerate().fold(0, |acc, (dim, size)| { acc * size + output_indices[dim] });
output[output_index] = input[input_index].clone();
});
}
}
let axes = axes.map(|axes| axes.iter()
.map(|i| self.normalize_axis(*i))
.collect::<Vec<usize>>());
let mut new_elements = vec![T::zero(); self.elements.len()];
let new_shape: Vec<usize> = axes.clone().map_or_else(
|| self.shape.clone().into_iter().rev().collect(),
|axes| axes.into_iter().map(|ax| self.shape[ax]).collect());
transpose_recursive(
&self.elements, &self.shape,
&mut new_elements, &new_shape,
&mut vec![0; self.shape.len()], 0,
&axes
);
Self::new(new_elements, new_shape)
}
fn moveaxis(&self, source: Vec<isize>, destination: Vec<isize>) -> Result<Self, ArrayError> {
source.is_unique()?;
source.len().is_equal(&destination.len())?;
let source = source.iter().map(|i| self.normalize_axis(*i)).collect::<Vec<usize>>();
let destination = destination.iter().map(|i| self.normalize_axis(*i)).collect::<Vec<usize>>();
source.is_unique()?;
destination.is_unique()?;
let mut order = (0..self.ndim()?)
.filter(|f| !source.contains(f))
.collect::<Vec<usize>>();
destination.into_iter()
.zip(source)
.sorted()
.for_each(|(d, s)| order.insert(d.min(order.len()), s));
self.transpose(Some(order.iter().map(Numeric::to_isize).collect()))
}
fn rollaxis(&self, axis: isize, start: Option<isize>) -> Result<Self, ArrayError> {
let axis = self.normalize_axis(axis);
let start = start.map_or(0, |ax| self.normalize_axis(ax));
let mut new_axes = (0..self.ndim()?).collect::<Vec<usize>>();
let axis_to_move = new_axes.remove(axis);
new_axes.insert(start, axis_to_move);
self.transpose(Some(new_axes.iter().map(|&i| i.to_isize()).collect()))
}
fn swapaxes(&self, axis_1: isize, axis_2: isize) -> Result<Self, ArrayError> {
let axis_1 = self.normalize_axis(axis_1);
let axis_2 = self.normalize_axis(axis_2);
let new_axes = (0..self.ndim()?)
.collect::<Vec<usize>>()
.swap_ext(axis_1, axis_2);
self.transpose(Some(new_axes.iter().map(|&i| i.to_isize()).collect()))
}
fn expand_dims(&self, axes: Vec<isize>) -> Result<Self, ArrayError> {
let axes = axes.iter()
.map(|&i| self.normalize_axis_dim(i, axes.len()))
.sorted()
.collect::<Vec<usize>>();
let mut new_shape = self.get_shape()?;
for item in axes { new_shape.insert(item, 1) }
self.reshape(&new_shape)
}
fn squeeze(&self, axes: Option<Vec<isize>>) -> Result<Self, ArrayError> {
if let Some(axes) = axes {
let axes = axes.iter()
.map(|&i| self.normalize_axis(i))
.sorted()
.rev()
.collect::<Vec<usize>>();
let mut new_shape = self.get_shape()?;
if axes.iter().any(|a| new_shape[*a] != 1) {
Err(ArrayError::SqueezeShapeOfAxisMustBeOne)
} else {
for item in axes { new_shape.remove(item); }
self.reshape(&new_shape)
}
}
else {
self.reshape(&self.get_shape()?.into_iter().filter(|&i| i != 1).collect::<Vec<usize>>())
}
}
}
impl <T: ArrayElement> ArrayAxis<T> for Result<Array<T>, ArrayError> {
fn apply_along_axis<S: ArrayElement, F>(&self, axis: usize, f: F) -> Result<Array<S>, ArrayError>
where F: FnMut(&Array<T>) -> Result<Array<S>, ArrayError> {
self.clone()?.apply_along_axis(axis, f)
}
fn transpose(&self, axes: Option<Vec<isize>>) -> Self {
self.clone()?.transpose(axes)
}
fn moveaxis(&self, source: Vec<isize>, destination: Vec<isize>) -> Self {
self.clone()?.moveaxis(source, destination)
}
fn rollaxis(&self, axis: isize, start: Option<isize>) -> Self {
self.clone()?.rollaxis(axis, start)
}
fn swapaxes(&self, axis: isize, start: isize) -> Self {
self.clone()?.swapaxes(axis, start)
}
fn expand_dims(&self, axes: Vec<isize>) -> Self {
self.clone()?.expand_dims(axes)
}
fn squeeze(&self, axes: Option<Vec<isize>>) -> Self {
self.clone()?.squeeze(axes)
}
}