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
use super::Matrix;
use super::layout::Layout;
use super::order::Order;
use crate::error::Result;
use crate::index::Index;
use crate::shape::AsShape;
use alloc::vec;
use alloc::vec::Vec;
impl<T, O> Matrix<T, O>
where
O: Order,
{
/// Creates a new, empty [`Matrix<T, O>`].
///
/// # Examples
///
/// ```
/// use matreex::Matrix;
///
/// let matrix = Matrix::<i32>::new();
/// assert_eq!(matrix.nrows(), 0);
/// assert_eq!(matrix.ncols(), 0);
/// assert!(matrix.is_empty());
/// ```
pub fn new() -> Self {
let layout = Layout::default();
let data = Vec::new();
Self { layout, data }
}
/// Creates a new, empty [`Matrix<T, O>`] with at least the specified capacity.
///
/// # Errors
///
/// - [`Error::CapacityOverflow`] if the required capacity in bytes exceeds [`isize::MAX`].
///
/// # Examples
///
/// ```
/// use matreex::Matrix;
///
/// let matrix = Matrix::<i32>::with_capacity(10)?;
/// assert_eq!(matrix.nrows(), 0);
/// assert_eq!(matrix.ncols(), 0);
/// assert!(matrix.is_empty());
/// assert!(matrix.capacity() >= 10);
/// #
/// # Ok::<(), matreex::Error>(())
/// ```
///
/// [`Error::CapacityOverflow`]: crate::error::Error::CapacityOverflow
pub fn with_capacity(capacity: usize) -> Result<Self> {
Layout::<T, O>::check_size(capacity)?;
let layout = Layout::default();
let data = Vec::with_capacity(capacity);
Ok(Self { layout, data })
}
/// Creates a new [`Matrix<T, O>`] with the specified shape, filled with the
/// default value.
///
/// # Errors
///
/// - [`Error::SizeOverflow`] if the size of the shape exceeds [`usize::MAX`].
/// - [`Error::CapacityOverflow`] if the required capacity in bytes exceeds [`isize::MAX`].
///
/// # Examples
///
/// ```
/// use matreex::{Matrix, matrix};
///
/// let matrix = Matrix::<i32>::from_default((2, 3))?;
/// assert_eq!(matrix, matrix![[0, 0, 0], [0, 0, 0]]);
/// #
/// # Ok::<(), matreex::Error>(())
/// ```
///
/// [`Error::SizeOverflow`]: crate::error::Error::SizeOverflow
/// [`Error::CapacityOverflow`]: crate::error::Error::CapacityOverflow
pub fn from_default<S>(shape: S) -> Result<Self>
where
S: AsShape,
T: Default,
{
let (layout, size) = Layout::from_shape(shape)?;
let mut data = Vec::with_capacity(size);
data.resize_with(size, T::default);
Ok(Self { layout, data })
}
/// Creates a new [`Matrix<T, O>`] with the specified shape, filled with the
/// given value.
///
/// # Errors
///
/// - [`Error::SizeOverflow`] if the size of the shape exceeds [`usize::MAX`].
/// - [`Error::CapacityOverflow`] if the required capacity in bytes exceeds [`isize::MAX`].
///
/// # Examples
///
/// ```
/// use matreex::{Matrix, matrix};
///
/// let matrix = Matrix::from_value((2, 3), 0)?;
/// assert_eq!(matrix, matrix![[0, 0, 0], [0, 0, 0]]);
/// #
/// # Ok::<(), matreex::Error>(())
/// ```
///
/// [`Error::SizeOverflow`]: crate::error::Error::SizeOverflow
/// [`Error::CapacityOverflow`]: crate::error::Error::CapacityOverflow
pub fn from_value<S>(shape: S, value: T) -> Result<Self>
where
S: AsShape,
T: Clone,
{
let (layout, size) = Layout::from_shape(shape)?;
let data = vec![value; size];
Ok(Self { layout, data })
}
/// Creates a new [`Matrix<T, O>`] with the specified shape, filled with values
/// generated based on their corresponding indices.
///
/// # Errors
///
/// - [`Error::SizeOverflow`] if the size of the shape exceeds [`usize::MAX`].
/// - [`Error::CapacityOverflow`] if the required capacity in bytes exceeds [`isize::MAX`].
///
/// # Examples
///
/// ```
/// use matreex::{Index, Matrix, matrix};
///
/// let matrix = Matrix::from_fn((2, 3), |index| index)?;
/// assert_eq!(
/// matrix,
/// matrix![
/// [Index::new(0, 0), Index::new(0, 1), Index::new(0, 2)],
/// [Index::new(1, 0), Index::new(1, 1), Index::new(1, 2)],
/// ]
/// );
/// #
/// # Ok::<(), matreex::Error>(())
/// ```
///
/// [`Error::SizeOverflow`]: crate::error::Error::SizeOverflow
/// [`Error::CapacityOverflow`]: crate::error::Error::CapacityOverflow
pub fn from_fn<S, F>(shape: S, mut f: F) -> Result<Self>
where
S: AsShape,
F: FnMut(Index) -> T,
{
let (layout, size) = Layout::from_shape(shape)?;
let stride = layout.stride();
let mut data = Vec::with_capacity(size);
for index in 0..size {
let index = Index::from_linear::<O>(index, stride);
let element = f(index);
data.push(element);
}
Ok(Self { layout, data })
}
}
impl<T, O> Default for Matrix<T, O>
where
O: Order,
{
fn default() -> Self {
Self::new()
}
}
#[cfg(test)]
mod tests {
use super::*;
use crate::error::Error;
use crate::index::Index;
use crate::shape::Shape;
use crate::{dispatch_unary, matrix};
#[test]
fn test_new() {
dispatch_unary! {{
let matrix = Matrix::<i32, O>::new();
assert_eq!(matrix.nrows(), 0);
assert_eq!(matrix.ncols(), 0);
assert!(matrix.is_empty());
}}
}
#[test]
fn test_with_capacity() -> Result<()> {
dispatch_unary! {{
let matrix = Matrix::<i32, O>::with_capacity(10)?;
assert_eq!(matrix.nrows(), 0);
assert_eq!(matrix.ncols(), 0);
assert!(matrix.is_empty());
assert!(matrix.capacity() >= 10);
}}
Ok(())
}
#[test]
fn test_from_default() -> Result<()> {
dispatch_unary! {{
let shape = Shape::new(2, 3);
let matrix = Matrix::<i32, O>::from_default(shape)?;
let expected = matrix![[0, 0, 0], [0, 0, 0]];
assert_eq!(matrix, expected);
let shape = Shape::new(2, usize::MAX);
let error = Matrix::<i32, O>::from_default(shape).unwrap_err();
assert_eq!(error, Error::SizeOverflow);
let shape = Shape::new(1, usize::MAX);
let error = Matrix::<i32, O>::from_default(shape).unwrap_err();
assert_eq!(error, Error::CapacityOverflow);
// Unable to cover.
// let shape = Shape::new(1, usize::MAX);
// assert!(Matrix::<(), O>::from_default(shape).is_ok());
}}
Ok(())
}
#[test]
fn test_from_value() -> Result<()> {
dispatch_unary! {{
let shape = Shape::new(2, 3);
let matrix = Matrix::<i32, O>::from_value(shape, 0)?;
let expected = matrix![[0, 0, 0], [0, 0, 0]];
assert_eq!(matrix, expected);
let shape = Shape::new(2, usize::MAX);
let error = Matrix::<i32, O>::from_value(shape, 0).unwrap_err();
assert_eq!(error, Error::SizeOverflow);
let shape = Shape::new(1, usize::MAX);
let error = Matrix::<i32, O>::from_value(shape, 0).unwrap_err();
assert_eq!(error, Error::CapacityOverflow);
let shape = Shape::new(1, usize::MAX);
assert!(Matrix::<(), O>::from_value(shape, ()).is_ok());
}}
Ok(())
}
#[test]
fn test_from_fn() -> Result<()> {
dispatch_unary! {{
let shape = Shape::new(2, 3);
let matrix = Matrix::<Index, O>::from_fn(shape, |index| index)?;
let expected = matrix![
[Index::new(0, 0), Index::new(0, 1), Index::new(0, 2)],
[Index::new(1, 0), Index::new(1, 1), Index::new(1, 2)],
];
assert_eq!(matrix, expected);
// Assert no panic from unraveling indices occurs.
let shape = Shape::new(2, 0);
let matrix = Matrix::<Index, O>::from_fn(shape, |index| index)?;
let expected = matrix![[Index::default(); 0]; 2];
assert_eq!(matrix, expected);
// Assert no panic from unraveling indices occurs.
let shape = Shape::new(0, 3);
let matrix = Matrix::<Index, O>::from_fn(shape, |index| index)?;
let expected = matrix![[Index::default(); 3]; 0];
assert_eq!(matrix, expected);
let shape = Shape::new(2, usize::MAX);
let error = Matrix::<i32, O>::from_fn(shape, |_| 0).unwrap_err();
assert_eq!(error, Error::SizeOverflow);
let shape = Shape::new(1, usize::MAX);
let error = Matrix::<i32, O>::from_fn(shape, |_| 0).unwrap_err();
assert_eq!(error, Error::CapacityOverflow);
// Unable to cover.
// let shape = Shape::new(1, usize::MAX);
// assert!(Matrix::<(), O>::from_fn(shape, |_| ()).is_ok());
}}
Ok(())
}
#[test]
fn test_default() {
dispatch_unary! {{
let matrix = Matrix::<i32, O>::default();
assert_eq!(matrix.nrows(), 0);
assert_eq!(matrix.ncols(), 0);
assert!(matrix.is_empty());
}}
}
}