ferrix 0.1.0

A simple matrix library for Rust
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
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

#[cfg(test)]
mod tests {
    use ferrix::{DotProduct, Matrix, RowVector, Vector};

    #[test]
    fn test_vector_dot() {
        // Vector dot Vector
        let v1 = Vector::<f64, 3>::from([1.0, 2.0, 3.0]);
        let v2 = Vector::<f64, 3>::from([4.0, 5.0, 6.0]);
        assert!((v1.dot(v2) - 32.0).abs() < f64::EPSILON);

        // Vector dot VectorView
        let v1 = Vector::<f64, 3>::from([1.0, 2.0, 3.0]);
        let v2 = Vector::<f64, 5>::from([1.0, 2.0, 3.0, 4.0, 5.0]);
        let view = v2.view::<3>(0).unwrap();
        assert!((v1.dot(view) - 14.0).abs() < f64::EPSILON);

        // Vector dot VectorViewMut
        let v1 = Vector::<f64, 3>::from([1.0, 2.0, 3.0]);
        let mut v2 = Vector::<f64, 5>::from([1.0, 2.0, 3.0, 4.0, 5.0]);
        let view_mut = v2.view_mut::<3>(0).unwrap();
        assert!((v1.dot(view_mut) - 14.0).abs() < f64::EPSILON);

        // Vector dot Matrix
        let v1 = Vector::<f64, 3>::from([1.0, 2.0, 3.0]);
        let m = Matrix::<f64, 3, 1>::from([[1.0], [2.0], [3.0]]);
        assert!((v1.dot(m) - 14.0).abs() < f64::EPSILON);

        // Vector dot MatrixView
        let v1 = Vector::<f64, 3>::from([1.0, 2.0, 3.0]);
        let m = Matrix::<f64, 4, 1>::from([[1.0], [2.0], [3.0], [4.0]]);
        let view = m.view::<3, 1>((0, 0)).unwrap();
        assert!((v1.dot(view) - 14.0).abs() < f64::EPSILON);

        // Vector dot MatrixViewMut
        let v1 = Vector::<f64, 3>::from([1.0, 2.0, 3.0]);
        let mut m = Matrix::<f64, 4, 1>::from([[1.0], [2.0], [3.0], [4.0]]);
        let view_mut = m.view_mut::<3, 1>((0, 0)).unwrap();
        assert!((v1.dot(view_mut) - 14.0).abs() < f64::EPSILON);

        // Vector dot MatrixTransposeView
        let v1 = Vector::<f64, 3>::from([1.0, 2.0, 3.0]);
        let m = Matrix::<f64, 1, 3>::from([[1.0, 2.0, 3.0]]);
        assert!((v1.dot(m.t()) - 14.0).abs() < f64::EPSILON);

        // Vector dot MatrixTransposeViewMut
        let v1 = Vector::<f64, 3>::from([1.0, 2.0, 3.0]);
        let mut m = Matrix::<f64, 1, 3>::from([[1.0, 2.0, 3.0]]);
        assert!((v1.dot(m.t_mut()) - 14.0).abs() < f64::EPSILON);
    }

    #[test]
    fn test_vector_view_dot() {
        // VectorView dot Vector
        let v = Vector::<f64, 5>::from([1.0, 2.0, 3.0, 4.0, 5.0]);
        let v1 = v.view::<3>(0).unwrap();
        let v2 = Vector::<f64, 3>::from([4.0, 5.0, 6.0]);
        assert!((v1.dot(v2) - 32.0).abs() < f64::EPSILON);

        // VectorView dot VectorView
        let v1 = Vector::<f64, 5>::from([1.0, 2.0, 3.0, 4.0, 5.0]);
        let v2 = Vector::<f64, 5>::from([1.0, 2.0, 3.0, 4.0, 5.0]);
        let view1 = v1.view::<3>(0).unwrap();
        let view2 = v2.view::<3>(1).unwrap();
        assert!((view1.dot(view2) - 20.0).abs() < f64::EPSILON);

        // VectorView dot VectorViewMut
        let v1 = Vector::<f64, 5>::from([1.0, 2.0, 3.0, 4.0, 5.0]);
        let mut v2 = Vector::<f64, 5>::from([1.0, 2.0, 3.0, 4.0, 5.0]);
        let view1 = v1.view::<3>(0).unwrap();
        let view_mut = v2.view_mut::<3>(1).unwrap();
        assert!((view1.dot(view_mut) - 20.0).abs() < f64::EPSILON);

        // VectorView dot Matrix
        let v1 = Vector::<f64, 4>::from([1.0, 2.0, 3.0, 4.0]);
        let m = Matrix::<f64, 3, 1>::from([[1.0], [2.0], [3.0]]);
        let view = v1.view::<3>(0).unwrap();
        assert!((view.dot(m) - 14.0).abs() < f64::EPSILON);

        // VectorView dot MatrixView
        let v1 = Vector::<f64, 4>::from([1.0, 2.0, 3.0, 4.0]);
        let m = Matrix::<f64, 4, 1>::from([[1.0], [2.0], [3.0], [4.0]]);
        let view = v1.view::<3>(0).unwrap();
        let view2 = m.view::<3, 1>((0, 0)).unwrap();
        assert!((view.dot(view2) - 14.0).abs() < f64::EPSILON);

        // VectorView dot MatrixViewMut
        let v1 = Vector::<f64, 4>::from([1.0, 2.0, 3.0, 4.0]);
        let mut m = Matrix::<f64, 4, 1>::from([[1.0], [2.0], [3.0], [4.0]]);
        let view = v1.view::<3>(0).unwrap();
        let view_mut = m.view_mut::<3, 1>((0, 0)).unwrap();
        assert!((view.dot(view_mut) - 14.0).abs() < f64::EPSILON);

        // VectorView dot MatrixTransposeView
        let v1 = Vector::<f64, 4>::from([1.0, 2.0, 3.0, 4.0]);
        let m = Matrix::<f64, 1, 3>::from([[1.0, 2.0, 3.0]]);
        let view = v1.view::<3>(0).unwrap();
        assert!((view.dot(m.t()) - 14.0).abs() < f64::EPSILON);

        // VectorView dot MatrixTransposeViewMut
        let v1 = Vector::<f64, 4>::from([1.0, 2.0, 3.0, 4.0]);
        let mut m = Matrix::<f64, 1, 3>::from([[1.0, 2.0, 3.0]]);
        let view = v1.view::<3>(0).unwrap();
        assert!((view.dot(m.t_mut()) - 14.0).abs() < f64::EPSILON);
    }

    #[test]
    fn test_vector_view_mut_dot() {
        // VectorViewMut dot Vector
        let mut v = Vector::<f64, 5>::from([1.0, 2.0, 3.0, 4.0, 5.0]);
        let v1 = v.view_mut::<3>(0).unwrap();
        let v2 = Vector::<f64, 3>::from([4.0, 5.0, 6.0]);
        assert!((v1.dot(v2) - 32.0).abs() < f64::EPSILON);

        // VectorViewMut dot VectorView
        let mut v1 = Vector::<f64, 5>::from([1.0, 2.0, 3.0, 4.0, 5.0]);
        let v2 = Vector::<f64, 5>::from([1.0, 2.0, 3.0, 4.0, 5.0]);
        let view1 = v1.view_mut::<3>(0).unwrap();
        let view2 = v2.view::<3>(1).unwrap();
        assert!((view1.dot(view2) - 20.0).abs() < f64::EPSILON);

        // VectorViewMut dot VectorViewMut
        let mut v1 = Vector::<f64, 5>::from([1.0, 2.0, 3.0, 4.0, 5.0]);
        let mut v2 = Vector::<f64, 5>::from([1.0, 2.0, 3.0, 4.0, 5.0]);
        let view1 = v1.view_mut::<3>(0).unwrap();
        let view2 = v2.view_mut::<3>(1).unwrap();
        assert!((view1.dot(view2) - 20.0).abs() < f64::EPSILON);

        // VectorViewMut dot Matrix
        let mut v1 = Vector::<f64, 4>::from([1.0, 2.0, 3.0, 4.0]);
        let m = Matrix::<f64, 3, 1>::from([[1.0], [2.0], [3.0]]);
        let view = v1.view_mut::<3>(0).unwrap();
        assert!((view.dot(m) - 14.0).abs() < f64::EPSILON);

        // VectorViewMut dot MatrixView
        let mut v1 = Vector::<f64, 4>::from([1.0, 2.0, 3.0, 4.0]);
        let m = Matrix::<f64, 4, 1>::from([[1.0], [2.0], [3.0], [4.0]]);
        let view = v1.view_mut::<3>(0).unwrap();
        let view2 = m.view::<3, 1>((0, 0)).unwrap();
        assert!((view.dot(view2) - 14.0).abs() < f64::EPSILON);

        // VectorViewMut dot MatrixViewMut
        let mut v1 = Vector::<f64, 4>::from([1.0, 2.0, 3.0, 4.0]);
        let mut m = Matrix::<f64, 4, 1>::from([[1.0], [2.0], [3.0], [4.0]]);
        let view = v1.view_mut::<3>(0).unwrap();
        let view2 = m.view_mut::<3, 1>((0, 0)).unwrap();
        assert!((view.dot(view2) - 14.0).abs() < f64::EPSILON);

        // VectorViewMut dot MatrixTransposeView
        let mut v1 = Vector::<f64, 4>::from([1.0, 2.0, 3.0, 4.0]);
        let m = Matrix::<f64, 1, 3>::from([[1.0, 2.0, 3.0]]);
        let view = v1.view_mut::<3>(0).unwrap();
        assert!((view.dot(m.t()) - 14.0).abs() < f64::EPSILON);

        // VectorViewMut dot MatrixTransposeViewMut
        let mut v1 = Vector::<f64, 4>::from([1.0, 2.0, 3.0, 4.0]);
        let mut m = Matrix::<f64, 1, 3>::from([[1.0, 2.0, 3.0]]);
        let view = v1.view_mut::<3>(0).unwrap();
        assert!((view.dot(m.t_mut()) - 14.0).abs() < f64::EPSILON);
    }

    #[test]
    fn test_row_vector_dot() {
        // RowVector dot RowVector
        let v1 = RowVector::<f64, 3>::from([1.0, 2.0, 3.0]);
        let v2 = RowVector::<f64, 3>::from([4.0, 5.0, 6.0]);
        assert!((v1.dot(v2) - 32.0).abs() < f64::EPSILON);

        // RowVector dot RowVectorView
        let v1 = RowVector::<f64, 3>::from([1.0, 2.0, 3.0]);
        let v2 = RowVector::<f64, 5>::from([1.0, 2.0, 3.0, 4.0, 5.0]);
        let view = v2.view::<3>(0).unwrap();
        assert!((v1.dot(view) - 14.0).abs() < f64::EPSILON);

        // RowVector dot RowVectorViewMut
        let v1 = RowVector::<f64, 3>::from([1.0, 2.0, 3.0]);
        let mut v2 = RowVector::<f64, 5>::from([1.0, 2.0, 3.0, 4.0, 5.0]);
        let view_mut = v2.view_mut::<3>(0).unwrap();
        assert!((v1.dot(view_mut) - 14.0).abs() < f64::EPSILON);

        // RowVector dot Matrix
        let v1 = RowVector::<f64, 3>::from([1.0, 2.0, 3.0]);
        let m = Matrix::<f64, 1, 3>::from([[1.0, 2.0, 3.0]]);
        assert!((v1.dot(m) - 14.0).abs() < f64::EPSILON);

        // RowVector dot MatrixView
        let v1 = RowVector::<f64, 3>::from([1.0, 2.0, 3.0]);
        let m = Matrix::<f64, 1, 4>::from([[1.0, 2.0, 3.0, 4.0]]);
        let view = m.view::<1, 3>((0, 0)).unwrap();
        assert!((v1.dot(view) - 14.0).abs() < f64::EPSILON);

        // RowVector dot MatrixViewMut
        let v1 = RowVector::<f64, 3>::from([1.0, 2.0, 3.0]);
        let mut m = Matrix::<f64, 1, 4>::from([[1.0, 2.0, 3.0, 4.0]]);
        let view = m.view_mut::<1, 3>((0, 0)).unwrap();
        assert!((v1.dot(view) - 14.0).abs() < f64::EPSILON);

        // RowVector dot MatrixTransposeView
        let v1 = RowVector::<f64, 3>::from([1.0, 2.0, 3.0]);
        let m = Matrix::<f64, 3, 1>::from([[1.0], [2.0], [3.0]]);
        assert!((v1.dot(m.t()) - 14.0).abs() < f64::EPSILON);

        // RowVector dot MatrixTransposeViewMut
        let v1 = RowVector::<f64, 3>::from([1.0, 2.0, 3.0]);
        let mut m = Matrix::<f64, 3, 1>::from([[1.0], [2.0], [3.0]]);
        assert!((v1.dot(m.t_mut()) - 14.0).abs() < f64::EPSILON);
    }

    #[test]
    fn test_row_vector_view_dot() {
        // RowVectorView dot RowVector
        let v = RowVector::<f64, 5>::from([1.0, 2.0, 3.0, 4.0, 5.0]);
        let v1 = v.view::<3>(0).unwrap();
        let v2 = RowVector::<f64, 3>::from([4.0, 5.0, 6.0]);
        assert!((v1.dot(v2) - 32.0).abs() < f64::EPSILON);

        // RowVectorView dot RowVectorView
        let v1 = RowVector::<f64, 5>::from([1.0, 2.0, 3.0, 4.0, 5.0]);
        let v2 = RowVector::<f64, 5>::from([1.0, 2.0, 3.0, 4.0, 5.0]);
        let view1 = v1.view::<3>(0).unwrap();
        let view2 = v2.view::<3>(1).unwrap();
        assert!((view1.dot(view2) - 20.0).abs() < f64::EPSILON);

        // RowVectorView dot RowVectorViewMut
        let v1 = RowVector::<f64, 5>::from([1.0, 2.0, 3.0, 4.0, 5.0]);
        let mut v2 = RowVector::<f64, 5>::from([1.0, 2.0, 3.0, 4.0, 5.0]);
        let view1 = v1.view::<3>(0).unwrap();
        let view2 = v2.view_mut::<3>(1).unwrap();
        assert!((view1.dot(view2) - 20.0).abs() < f64::EPSILON);

        // RowVectorView dot Matrix
        let v1 = RowVector::<f64, 4>::from([1.0, 2.0, 3.0, 4.0]);
        let m = Matrix::<f64, 1, 3>::from([[1.0, 2.0, 3.0]]);
        let view = v1.view::<3>(0).unwrap();
        assert!((view.dot(m) - 14.0).abs() < f64::EPSILON);

        // RowVectorView dot MatrixView
        let v1 = RowVector::<f64, 4>::from([1.0, 2.0, 3.0, 4.0]);
        let m = Matrix::<f64, 1, 4>::from([[1.0, 2.0, 3.0, 4.0]]);
        let view = v1.view::<3>(0).unwrap();
        let view2 = m.view::<1, 3>((0, 0)).unwrap();
        assert!((view.dot(view2) - 14.0).abs() < f64::EPSILON);

        // RowVectorView dot MatrixViewMut
        let v1 = RowVector::<f64, 4>::from([1.0, 2.0, 3.0, 4.0]);
        let mut m = Matrix::<f64, 1, 4>::from([[1.0, 2.0, 3.0, 4.0]]);
        let view = v1.view::<3>(0).unwrap();
        let view2 = m.view_mut::<1, 3>((0, 0)).unwrap();
        assert!((view.dot(view2) - 14.0).abs() < f64::EPSILON);

        // RowVectorView dot MatrixTransposeView
        let v1 = RowVector::<f64, 4>::from([1.0, 2.0, 3.0, 4.0]);
        let m = Matrix::<f64, 3, 1>::from([[1.0], [2.0], [3.0]]);
        let view = v1.view::<3>(0).unwrap();
        assert!((view.dot(m.t()) - 14.0).abs() < f64::EPSILON);

        // RowVectorView dot MatrixTransposeViewMut
        let v1 = RowVector::<f64, 4>::from([1.0, 2.0, 3.0, 4.0]);
        let mut m = Matrix::<f64, 3, 1>::from([[1.0], [2.0], [3.0]]);
        let view = v1.view::<3>(0).unwrap();
        assert!((view.dot(m.t_mut()) - 14.0).abs() < f64::EPSILON);
    }

    #[test]
    fn test_row_vector_view_mut_dot() {
        // RowVectorViewMut dot RowVector
        let mut v = RowVector::<f64, 5>::from([1.0, 2.0, 3.0, 4.0, 5.0]);
        let v1 = v.view_mut::<3>(0).unwrap();
        let v2 = RowVector::<f64, 3>::from([4.0, 5.0, 6.0]);
        assert!((v1.dot(v2) - 32.0).abs() < f64::EPSILON);

        // RowVectorViewMut dot RowVectorView
        let mut v1 = RowVector::<f64, 5>::from([1.0, 2.0, 3.0, 4.0, 5.0]);
        let v2 = RowVector::<f64, 5>::from([1.0, 2.0, 3.0, 4.0, 5.0]);
        let view1 = v1.view_mut::<3>(0).unwrap();
        let view2 = v2.view::<3>(1).unwrap();
        assert!((view1.dot(view2) - 20.0).abs() < f64::EPSILON);

        // RowVectorViewMut dot RowVectorViewMut
        let mut v1 = RowVector::<f64, 5>::from([1.0, 2.0, 3.0, 4.0, 5.0]);
        let mut v2 = RowVector::<f64, 5>::from([1.0, 2.0, 3.0, 4.0, 5.0]);
        let view1 = v1.view_mut::<3>(0).unwrap();
        let view2 = v2.view_mut::<3>(1).unwrap();
        assert!((view1.dot(view2) - 20.0).abs() < f64::EPSILON);

        // RowVectorViewMut dot Matrix
        let mut v1 = RowVector::<f64, 4>::from([1.0, 2.0, 3.0, 4.0]);
        let m = Matrix::<f64, 1, 3>::from([[1.0, 2.0, 3.0]]);
        let view = v1.view_mut::<3>(0).unwrap();
        assert!((view.dot(m) - 14.0).abs() < f64::EPSILON);

        // RowVectorViewMut dot MatrixView
        let mut v1 = RowVector::<f64, 4>::from([1.0, 2.0, 3.0, 4.0]);
        let m = Matrix::<f64, 1, 4>::from([[1.0, 2.0, 3.0, 4.0]]);
        let view = v1.view_mut::<3>(0).unwrap();
        let view2 = m.view::<1, 3>((0, 0)).unwrap();
        assert!((view.dot(view2) - 14.0).abs() < f64::EPSILON);

        // RowVectorViewMut dot MatrixViewMut
        let mut v1 = RowVector::<f64, 4>::from([1.0, 2.0, 3.0, 4.0]);
        let mut m = Matrix::<f64, 1, 4>::from([[1.0, 2.0, 3.0, 4.0]]);
        let view = v1.view_mut::<3>(0).unwrap();
        let view2 = m.view_mut::<1, 3>((0, 0)).unwrap();
        assert!((view.dot(view2) - 14.0).abs() < f64::EPSILON);

        // RowVectorViewMut dot MatrixTransposeView
        let mut v1 = RowVector::<f64, 4>::from([1.0, 2.0, 3.0, 4.0]);
        let m = Matrix::<f64, 3, 1>::from([[1.0], [2.0], [3.0]]);
        let view = v1.view_mut::<3>(0).unwrap();
        assert!((view.dot(m.t()) - 14.0).abs() < f64::EPSILON);

        // RowVectorViewMut dot MatrixTransposeViewMut
        let mut v1 = RowVector::<f64, 4>::from([1.0, 2.0, 3.0, 4.0]);
        let mut m = Matrix::<f64, 3, 1>::from([[1.0], [2.0], [3.0]]);
        let view = v1.view_mut::<3>(0).unwrap();
        assert!((view.dot(m.t_mut()) - 14.0).abs() < f64::EPSILON);
    }
}