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
use crate::matrix_address::MatrixAddress;
use crate::tensor::Tensor;
use std::fmt::{Display, Formatter};
use std::ops::{Index, IndexMut};
#[derive(Debug, Eq, PartialEq, Clone)]
pub struct Matrix<T> {
width: usize,
height: usize,
data: Vec<T>,
}
impl<T> Matrix<T> {
/// Creates a new Matrix based on dimensions and a mapper function.
///
/// # Arguments
///
/// * `width`: The width, or number of columns in the matrix
/// * `height`: The height, or number of rows in the matrix
/// * `address_value_converter`: Converts a matrix address to a value.
///
/// Returns: Matrix<T>
///
/// # Examples
///
/// ```
/// use rust_tensors::matrix::Matrix;
/// use rust_tensors::tensor::Tensor;
///
/// // Creates a 1000x1000 zero matrix
/// let (width, height) = (1000, 1000);
/// let mut matrix = Matrix::new(width, height, |_address| 0usize);
/// matrix.address_iter()
/// .for_each(|address| assert_eq!(matrix[address], 0));
///
/// // Creates a 50x10 matrix where the value is the index of the array
/// let (width, height) = (1000, 1000);
/// let mut matrix = Matrix::new(width, height, |address| address.y * width as i32 + address.x);
/// matrix.address_iter()
/// .for_each(|address| assert_eq!(matrix[address], address.y * width as i32 + address.x));
/// ```
pub fn new<F>(width: usize, height: usize, address_value_converter: F) -> Self
where
F: Fn(MatrixAddress) -> T,
{
let mut matrix = Matrix {
width,
height,
data: Vec::<T>::with_capacity(width * height),
};
matrix
.address_iter()
.for_each(|address| matrix.data.push(address_value_converter(address)));
matrix
}
/// Makes a string fit for displaying the contents of the matrix
///
/// # Arguments
///
/// * `display_func`: Converts a value to a string
/// * `row_delimiter`: Separates the rows in the matrix
/// * `column_delimiter`: Separates the columns in the matrix
///
/// Returns: the formatted string
///
/// # Examples
///
/// ```
/// use rust_tensors::matrix::Matrix;
/// let mut matrix =
/// Matrix::<i32>::parse_matrix("1 2 3|4 5 6|7 8 9", " ", "|", |s| s.parse().unwrap())
/// .unwrap();
/// assert_eq!(
/// matrix.to_display_string(|i| i.to_string(), "-", "|"),
/// "1-2-3|4-5-6|7-8-9"
/// );
/// ```
pub fn to_display_string<T1: Display, F: Fn(&T) -> T1>(
&self,
display_func: F,
row_delimiter: &str,
column_delimiter: &str,
) -> String {
self.address_iter()
.enumerate()
.map(|(i, address)| {
format!(
"{}{}",
display_func(&self[address]),
if (i + 1) % (self.width) == 0 {
if i != self.width * self.height - 1 {
column_delimiter
} else {
""
}
} else {
row_delimiter
}
)
})
.fold("".to_string(), |a: String, b: String| a + &b)
}
/// Parses a matrix from a string.
/// Fallible, and will return an Err if the matrix cannot be parsed,
/// or if the matrix does not have a uniform row length
///
/// # Arguments
///
/// * `data_str`: The string to be parsed
/// * `column_delimiter`: The string which separates the items in the columns
/// * `row_delimiter`: The string which separates the rows
/// * `str_to_t_converter`: The function which converts the item strings to a value
///
/// Returns: Result<Matrix<T>, String>
///
/// # Examples
///
/// ```
/// use rust_tensors::matrix::Matrix;
///
/// let mut matrix =
/// Matrix::<i32>::parse_matrix("0 1 2|3 4 5|6 7 8", " ", "|", |s| s.parse().unwrap())
/// .unwrap();
///
/// assert_eq!(
/// matrix, Matrix::new(3, 3, |address| address.x + 3 * address.y)
/// );
/// ```
pub fn parse_matrix<F>(
data_str: &str,
column_delimiter: &str,
row_delimiter: &str,
str_to_t_converter: F,
) -> Result<Matrix<T>, String>
where
F: Fn(&str) -> T,
{
let values: Vec<Vec<&str>> = data_str
.split(row_delimiter)
.map(|row| {
row.split(column_delimiter)
.filter(|string| !string.is_empty())
.collect()
})
.filter(|row: &Vec<&str>| !row.is_empty())
.collect();
if values
.iter()
.skip(1)
.any(|row| row.len() != values.first().unwrap().len())
{
return Err("Row Lengths are not constant".into());
}
let height = values.len();
let width = values.first().unwrap().len();
Ok(Matrix::new(width, height, |address| {
str_to_t_converter(values[address.y as usize][address.x as usize])
}))
}
fn index_address(&self, address: MatrixAddress) -> usize {
address.y as usize * self.width + address.x as usize
}
}
impl<T> Tensor<T, i32, MatrixAddress, 2> for Matrix<T> {
fn smallest_contained_address(&self) -> MatrixAddress {
MatrixAddress { x: 0, y: 0 }
}
fn largest_contained_address(&self) -> MatrixAddress {
MatrixAddress {
x: (self.width - 1) as i32,
y: (self.height - 1) as i32,
}
}
}
impl<T: Display> Display for Matrix<T> {
fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
write!(
f,
"{}",
self.to_display_string(|t| t.to_string(), " ", "\n")
)
}
}
impl<T> Index<MatrixAddress> for Matrix<T> {
type Output = T;
fn index(&self, index: MatrixAddress) -> &Self::Output {
&self.data[self.index_address(index)]
}
}
impl<T> Index<(i32, i32)> for Matrix<T> {
type Output = T;
fn index(&self, index: (i32, i32)) -> &Self::Output {
&self[MatrixAddress {
x: index.0,
y: index.1,
}]
}
}
impl<T> IndexMut<MatrixAddress> for Matrix<T> {
fn index_mut(&mut self, index: MatrixAddress) -> &mut Self::Output {
let index = self.index_address(index);
&mut self.data[index]
}
}
impl<T> IndexMut<(i32, i32)> for Matrix<T> {
fn index_mut(&mut self, index: (i32, i32)) -> &mut Self::Output {
&mut self[MatrixAddress {
x: index.0,
y: index.1,
}]
}
}
#[cfg(test)]
mod tests {
use crate::address_iterator::AddressIterator;
use crate::matrix::Matrix;
use crate::matrix_address::MatrixAddress;
use crate::tensor::Tensor;
use proptest::proptest;
use std::str::FromStr;
#[test]
fn display_test() {
let (width, height) = (11, 11);
assert_eq!(
"0 1 2 3 4 5 6 0 1 2 3\n4 5 6 0 1 2 3 4 5 6 0\n1 2 3 4 5 6 0 1 2 3 4\n5 6 0 1 2 3 4 5 6 0 1\n2 3 4 5 6 0 1 2 3 4 5\n6 0 1 2 3 4 5 6 0 1 2\n3 4 5 6 0 1 2 3 4 5 6\n0 1 2 3 4 5 6 0 1 2 3\n4 5 6 0 1 2 3 4 5 6 0\n1 2 3 4 5 6 0 1 2 3 4\n5 6 0 1 2 3 4 5 6 0 1",
format!(
"{}",
Matrix::new(width, height, |address: MatrixAddress| {
(address.x as usize + address.y as usize * width) % 7
})
)
)
}
#[test]
fn set_test() {
let (width, height) = (1000, 1000);
let mut matrix = Matrix::new(width, height, |_address| 0usize);
matrix.address_iter().for_each(|address| {
assert_eq!(matrix[address], 0usize);
matrix[address] = matrix.index_address(address);
assert_eq!(matrix[address], matrix.index_address(address));
});
matrix
.address_iter()
.for_each(|address| assert_eq!(matrix.index_address(address), matrix[address]))
}
#[test]
fn get_test() {
let (width, height) = (1000, 1000);
let matrix = Matrix::new(width, height, |address| {
address.x as usize + address.y as usize * width
});
assert_eq!(matrix.index_address(MatrixAddress { x: 999, y: 0 }), 999);
assert_eq!(matrix.index_address(MatrixAddress { x: 0, y: 1 }), 1000);
assert_eq!(matrix.index_address(MatrixAddress { x: 1, y: 1 }), 1001);
matrix
.address_iter()
.for_each(|address| assert_eq!(matrix.index_address(address), matrix[address]))
}
#[test]
fn parse_test() {
let data_str = "0,1,2,3,4,5,6,0,1,2,3|4,5,6,0,1,2,3,4,5,6,0|1,2,3,4,5,6,0,1,2,3,4|5,6,0,1,2,3,4,5,6,0,1|2,3,4,5,6,0,1,2,3,4,5|6,0,1,2,3,4,5,6,0,1,2|3,4,5,6,0,1,2,3,4,5,6|0,1,2,3,4,5,6,0,1,2,3|4,5,6,0,1,2,3,4,5,6,0|1,2,3,4,5,6,0,1,2,3,4|5,6,0,1,2,3,4,5,6,0,1";
let (width, height) = (11, 11);
assert_eq!(
Matrix::new(width, height, |address: MatrixAddress| (address.y
* width as i32
+ address.x)
% 7),
Matrix::parse_matrix(data_str, ",", "|", |string| i32::from_str(string)
.expect(""))
.expect("")
);
}
#[test]
fn equality_test() {
let (width, height) = (100, 200);
let mut m1 = Matrix::new(width, height, |address| {
address.y * width as i32 + address.x
});
let m2 = Matrix::new(width, height, |address| {
address.y * width as i32 + address.x
});
assert_eq!(m1, m2);
for address in m1.address_iter() {
assert_eq!(m1, m2);
m1[address] += 1;
assert_ne!(m1, m2);
m1[address] -= 1;
}
}
#[test]
fn address_iterator_test() {
let iter: AddressIterator<_, MatrixAddress, 2> = AddressIterator::new([0, 0], [2, 4]);
let values = iter
.map(|address| (address.x, address.y))
.collect::<Vec<(i32, i32)>>();
assert_eq!(
values,
vec![
(0, 0),
(1, 0),
(2, 0),
(0, 1),
(1, 1),
(2, 1),
(0, 2),
(1, 2),
(2, 2),
(0, 3),
(1, 3),
(2, 3),
(0, 4),
(1, 4),
(2, 4),
]
)
}
proptest! {
#[test]
fn address_sugar_test(x in 0..100, y in 0..200) {
let matrix = Matrix::new(100, 200, |address| address.y * 100 + address.x);
let mut mut_matrix = matrix.clone();
let pos_tuple = (x, y);
let pos_address = MatrixAddress{x, y};
assert_eq!(matrix[pos_tuple], matrix[pos_address]);
let temp = matrix[pos_tuple];
mut_matrix[pos_address] = -1;
mut_matrix[pos_tuple] = temp;
assert_eq!(matrix, mut_matrix);
}
}
}