nml-matrix 0.4.1

A small library to work with matrices.
Documentation 
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

pub mod matrix;
pub mod util;
use crate::matrix::NmlMatrix;

///unit tests for the Methods and Constructors of the NmlMatrix struct
#[cfg(test)]
mod tests {

    use super::*;

    #[test]
    fn nml_identity_and_matrix_equality() {
        let data: Vec<f64> = vec![1_f64,0_f64,0_f64,1_f64];
        let matrix_1 = NmlMatrix::new_with_data(2, 2, data.into_boxed_slice()).expect("Unable to create matrix");
        let matrix_2 = NmlMatrix::nml_mat_eye(2);
        let result: bool = matrix_1== matrix_2;
        assert_eq!(result, true);
    }

    #[test]
    fn nml_identity_and_matrix_equality_in_tolerance() {
        let data: Vec<f64> = vec![2_f64,1_f64,1_f64,2_f64];
        let matrix_1 = NmlMatrix::new_with_data(2, 2, data.into_boxed_slice()).expect("Unable to create matrix");
        let matrix_2 = NmlMatrix::nml_mat_eye(2);
        let result: bool = matrix_1.equality_in_tolerance(matrix_2, 1_f64);
        assert_eq!(result, true);
    }

    #[test]
    fn nml_identity_and_matrix_inequality() {
        let data: Vec<f64> = vec![1_f64,0_f64,1_f64,1_f64];
        let matrix_1 = NmlMatrix::new_with_data(2, 2, data.into_boxed_slice()).expect("Unable to create matrix");
        let matrix_2 = NmlMatrix::nml_mat_eye(2);
        let result: bool = matrix_1 == matrix_2;
        assert_eq!(result, false);
    }

    #[test]
    fn get_column_equal() {
        let data: Vec<f64> = vec![1_f64,2_f64,3_f64,4_f64];
        let matrix = NmlMatrix::new_with_data(2, 2, data.into_boxed_slice()).expect("Unable to create matrix");
        let column = matrix.get_column(1).expect("Unable to get column");
        let expected_data: Vec<f64> = vec![2_f64,4_f64];
        let expected = NmlMatrix::new_with_data(2, 1, expected_data.into_boxed_slice()).expect("Unable to create matrix");
        assert_eq!(column == expected, true);
    }

    #[test]
    fn get_column_unequal() {
        let data: Vec<f64> = vec![1_f64,2_f64,3_f64,4_f64];
        let matrix = NmlMatrix::new_with_data(2, 2, data.into_boxed_slice()).expect("Unable to create matrix");
        let column = matrix.get_column(1).expect("Unable to get column");
        let expected_data: Vec<f64> = vec![1_f64,4_f64];
        let expected = NmlMatrix::new_with_data(2, 1, expected_data.into_boxed_slice()).expect("Unable to create matrix");
        assert_eq!(column == expected, false);
    }

    #[test]
    fn copy_matrix_equality() {
        let data: Vec<f64> = vec![1_f64,2_f64,3_f64,4_f64];
        let matrix = NmlMatrix::new_with_data(2, 2, data.into_boxed_slice()).expect("Unable to create matrix");
        let copy = NmlMatrix::nml_mat_cp(&matrix);
        assert_eq!(matrix == copy, true);
    }

    #[test]
    fn copy_matrix_inequality() {
        let data: Vec<f64> = vec![1_f64,2_f64,3_f64,4_f64];
        let matrix = NmlMatrix::new_with_data(2, 2, data.into_boxed_slice()).expect("Unable to create matrix");
        let copy = NmlMatrix::nml_mat_cp(&matrix);
        let mut copy_data = copy.data;
        copy_data[0] = 0_f64;
        let copy = NmlMatrix::new_with_data(2, 2, copy_data).expect("Unable to create matrix");
        assert_eq!(matrix == copy, false);
    }

    #[test]
    fn rnd_matrix_tolerance_equality() {
        let rnd_matrix: NmlMatrix<f64> = NmlMatrix::nml_mat_rnd(2, 2, 0_f64, 1_f64);
        let matrix: NmlMatrix<f64> = NmlMatrix::nml_mat_sqr(2);
        assert_eq!(rnd_matrix.equality_in_tolerance(matrix, 1_f64), true);
    }

    #[test]
    fn rnd_matrix_tolerance_inequality() {
        let rnd_matrix: NmlMatrix<f64> = NmlMatrix::nml_mat_rnd(2, 2, 2_f64, 3_f64);
        let matrix: NmlMatrix<f64> = NmlMatrix::nml_mat_sqr(2);
        assert_eq!(rnd_matrix.equality_in_tolerance(matrix, 1_f64), false);
    }

    #[test]
    pub fn get_column_invalid() {
        let data: Vec<f64> = vec![1_f64,2_f64,3_f64,4_f64];
        let matrix = NmlMatrix::new_with_data(2, 2, data.into_boxed_slice()).expect("Unable to create matrix");
        let column = matrix.get_column(2);
        assert_eq!(column.is_err(), true);
    }

    #[test]
    pub fn get_row_equality() {
        let data: Vec<f64> = vec![1_f64,2_f64,3_f64, 4_f64];
        let matrix = NmlMatrix::new_with_data(1, 4, data.into_boxed_slice()).expect("Unable to create matrix");
        let row = matrix.get_row(0).expect("Unable to get row");
        assert_eq!(matrix == row, true);
    }

    #[test]
    pub fn get_row_inequality() {
        let data: Vec<f64> = vec![1_f64,2_f64,3_f64, 4_f64];
        let matrix = NmlMatrix::new_with_data(1, 4, data.into_boxed_slice()).expect("Unable to create matrix");
        let row = matrix.get_row(0).expect("Unable to get row");
        let mut row_data = row.data;
        row_data[0] = 0_f64;
        let row = NmlMatrix::new_with_data(1, 4, row_data).expect("Unable to create matrix");
        assert_eq!(matrix == row, false);
    }

    #[test]
    pub fn set_all_values_equality() {
        let data: Vec<f64> = vec![1_f64,2_f64,3_f64, 4_f64];
        let mut matrix = NmlMatrix::new_with_data(1, 4, data.into_boxed_slice()).expect("Unable to create matrix");
        matrix.set_all_values(0_f64);
        let expected_data: Vec<f64> = vec![0_f64,0_f64,0_f64, 0_f64];
        let expected = NmlMatrix::new_with_data(1, 4, expected_data.into_boxed_slice()).expect("Unable to create matrix");
        assert_eq!(matrix == expected, true);
    }

    #[test]
    pub fn set_all_values_ineqality() {
        let data: Vec<f64> = vec![1_f64,2_f64,3_f64, 4_f64];
        let mut matrix = NmlMatrix::new_with_data(1, 4, data.into_boxed_slice()).expect("Unable to create matrix");
        matrix.set_all_values(0_f64);
        let expected_data: Vec<f64> = vec![0_f64,0_f64,0_f64, 1_f64];
        let expected = NmlMatrix::new_with_data(1, 4, expected_data.into_boxed_slice()).expect("Unable to create matrix");
        assert_eq!(matrix == expected, false);
    }

    #[test]
    pub fn set_value_equality() {
        let data: Vec<f64> = vec![1_f64,2_f64,3_f64, 4_f64];
        let mut matrix = NmlMatrix::new_with_data(1, 4, data.into_boxed_slice()).expect("Unable to create matrix");
        matrix.set_value(0, 0, 0_f64);
        let expected_data: Vec<f64> = vec![0_f64,2_f64,3_f64, 4_f64];
        let expected = NmlMatrix::new_with_data(1, 4, expected_data.into_boxed_slice()).expect("Unable to create matrix");
        assert_eq!(matrix == expected, true);
    }

    #[test]
    pub fn set_value_inqality() {
        let data: Vec<f64> = vec![1_f64,2_f64,3_f64, 4_f64];
        let mut matrix = NmlMatrix::new_with_data(1, 4, data.into_boxed_slice()).expect("Unable to create matrix");
        let expected = NmlMatrix::nml_mat_cp(&matrix);
        matrix.set_value(0, 0, 0_f64);
        assert_eq!(matrix == expected, false);
    }

    #[test]
    pub fn set_diagonal_values_equality() {
        let data: Vec<f64> = vec![1_f64,2_f64,3_f64, 4_f64];
        let mut matrix = NmlMatrix::new_with_data(2, 2, data.into_boxed_slice()).expect("Unable to create matrix");
        matrix.set_dig_values(0_f64).expect("Matrix is not square");
        let expected_data: Vec<f64> = vec![0_f64,2_f64,3_f64, 0_f64];
        let expected = NmlMatrix::new_with_data(2, 2, expected_data.into_boxed_slice()).expect("Unable to create matrix");
        assert_eq!(matrix == expected, true);
    }

    #[test]
    pub fn  multiply_column_scalar() {
        let data: Vec<f64> = vec![1_f64,2_f64,3_f64, 4_f64];
        let mut matrix = NmlMatrix::new_with_data(2, 2, data.into_boxed_slice()).expect("Unable to create matrix");
        matrix.multiply_col_scalar(0, 2_f64).expect("Invalid column");
        let expected_data: Vec<f64> = vec![2_f64,2_f64,6_f64, 4_f64];
        let expected = NmlMatrix::new_with_data(2, 2, expected_data.into_boxed_slice()).expect("Unable to create matrix");
        assert_eq!(matrix == expected, true);
    }

    #[test]
    pub fn multiply_row_scalar() {
        let data: Vec<f64> = vec![1_f64,2_f64,3_f64, 4_f64];
        let mut matrix = NmlMatrix::new_with_data(2, 2, data.into_boxed_slice()).expect("Unable to create matrix");
        matrix.multiply_row_scalar(0, 2_f64).expect("Invalid row");
        let expected_data: Vec<f64> = vec![2_f64,4_f64,3_f64, 4_f64];
        let expected = NmlMatrix::new_with_data(2, 2, expected_data.into_boxed_slice()).expect("Unable to create matrix");
        assert_eq!(matrix == expected, true);
    }

    #[test]
    pub fn multiply_matrix_scalar() {
        let data: Vec<f64> = vec![1_f64,2_f64,3_f64, 4_f64];
        let mut matrix = NmlMatrix::new_with_data(2, 2, data.into_boxed_slice()).expect("Unable to create matrix");
        matrix.multiply_matrix_scalar(2_f64);
        let expected_data: Vec<f64> = vec![2_f64,4_f64,6_f64, 8_f64];
        let expected = NmlMatrix::new_with_data(2, 2, expected_data.into_boxed_slice()).expect("Unable to create matrix");
        assert_eq!(matrix == expected, true);
    }

    #[test]
    pub fn add_rows() {
        let data: Vec<f64> = vec![1_f64,2_f64,3_f64, 4_f64];
        let mut matrix = NmlMatrix::new_with_data(2, 2, data.into_boxed_slice()).expect("Unable to create matrix");
        matrix.add_rows(0, 2_f64, 1, 1_f64).expect("Invalid row");
        let expected_data: Vec<f64> = vec![5_f64,8_f64,3_f64, 4_f64];
        let expected = NmlMatrix::new_with_data(2, 2, expected_data.into_boxed_slice()).expect("Unable to create matrix");
        assert_eq!(matrix == expected, true);
    }

    #[test]
    pub fn remove_column() {
        let data: Vec<f64> = vec![1_f64,2_f64,3_f64, 4_f64, 5_f64, 6_f64];
        let matrix = NmlMatrix::new_with_data(3, 2, data.into_boxed_slice()).expect("Unable to create matrix");
        let result = matrix.remove_column(0).expect("Invalid column");
        let expected_data: Vec<f64> = vec![2_f64,4_f64, 6_f64];
        let expected = NmlMatrix::new_with_data(3, 1, expected_data.into_boxed_slice()).expect("Unable to create matrix");
        assert_eq!(result == expected, true);
    }

    #[test]
    pub fn remove_row() {
        let data: Vec<f64> = vec![1_f64,2_f64,3_f64, 4_f64, 5_f64, 6_f64];
        let matrix = NmlMatrix::new_with_data(2, 3, data.into_boxed_slice()).expect("Unable to create matrix");
        let result = matrix.remove_row(0).expect("Invalid row");
        let expected_data: Vec<f64> = vec![4_f64,5_f64, 6_f64];
        let expected = NmlMatrix::new_with_data(1, 3, expected_data.into_boxed_slice()).expect("Unable to create matrix");
        assert_eq!(result == expected, true);
    }

    #[test]
    pub fn swap_row() {
        let data: Vec<f64> = vec![1_f64,2_f64,3_f64, 4_f64, 5_f64, 6_f64];
        let mut matrix = NmlMatrix::new_with_data(2, 3, data.into_boxed_slice()).expect("Unable to create matrix");
        matrix.swap_rows(0, 1).expect("Invalid row");
        let expected_data: Vec<f64> = vec![4_f64,5_f64, 6_f64, 1_f64,2_f64,3_f64];
        let expected =    NmlMatrix::new_with_data(2, 3, expected_data.into_boxed_slice()).expect("Unable to create matrix");
        assert_eq!(matrix == expected, true);
    }

    #[test]
    pub fn add_matrix() {
        let data: Vec<f64> = vec![1_f64,2_f64,3_f64, 4_f64];
        let matrix_1 = NmlMatrix::new_with_data(2, 2, data.into_boxed_slice()).expect("Unable to create matrix");
        let matrix_2 = NmlMatrix::nml_mat_sqr(2);
        let expected_matrix: NmlMatrix<f64> = NmlMatrix::nml_mat_cp(&matrix_1);
        let result = matrix_1 + matrix_2;
        let result_matrix = result.expect("Unable to add matrices");
        assert_eq!(result_matrix == expected_matrix, true);
    }

    #[test]
    pub fn mul_naive() {
        let data_1: Vec<f64> = vec![1.0, 0.0, 0.0, 1.0];
        let data_2: Vec<f64> = vec![1.0, 2.0, 3.0, 4.0];
        let matrix_1 = NmlMatrix::new_with_data(2,2, data_1.into_boxed_slice()).expect("");
        let matrix_2 = NmlMatrix::new_with_data(2,2, data_2.into_boxed_slice()).expect("");
        let result = matrix_2.mul_naive(&matrix_1).expect("");
        let expect = NmlMatrix::nml_mat_cp(&matrix_2);
        assert_eq!(result == expect, true);
    }

    #[test]
    pub fn mul_transpose() {
        let data_1: Vec<f64> = vec![1.0, 0.0, 0.0, 1.0];
        let data_2: Vec<f64> = vec![1.0, 2.0, 3.0, 4.0];
        let matrix_1 = NmlMatrix::new_with_data(2,2, data_1.into_boxed_slice()).expect("");
        let matrix_2 = NmlMatrix::new_with_data(2,2, data_2.into_boxed_slice()).expect("");
        let result = matrix_2.mul_transpose(&matrix_1).expect("");
        let expect = NmlMatrix::nml_mat_cp(&matrix_2);
        assert_eq!(result == expect, true);
    }

    #[test]
    pub fn transpose() {
        let matrix_1: NmlMatrix<f64> = NmlMatrix::new_with_data(3,3, vec![1.0,0.0,0.0,0.0,1.0,0.0,0.0,0.0,1.0].into_boxed_slice()).expect("matrix not created");
        let matrix_2: NmlMatrix<f64> = matrix_1.transpose();
        assert_eq!(matrix_1 == matrix_2, true);
    }

    #[test]
    pub fn data_2d() {
        let mut data: Vec<Vec<f64>> = vec![vec![1.0, 0.0], vec![0.0, 1.0]];
        let matrix_1: NmlMatrix<f64> = NmlMatrix::new_with_2d_vec(2,2, &mut data).expect("matrix not created");
        let data_2d: Box<[f64]> = vec![1.0, 0.0, 0.0, 1.0].into_boxed_slice();
        assert_eq!(matrix_1.data, data_2d);
    }

}