lowdim 0.7.2

Library for two- to four-dimensional integer geometry.
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

//! 4d matrices.

use std::ops::Add;
use std::ops::Mul;

use crate::v4d;
use crate::Integer;
use crate::Matrix;
use crate::MatrixOps;
use crate::Vec4d;

const DIM: usize = 4;

/// A 4d discrete matrix.
#[derive(Clone, Copy, Debug, Default, Eq, PartialEq, Hash)]
pub struct Matrix4d<S: Integer> {
    a: [[S; DIM]; DIM],
}

impl<S: Integer> Matrix4d<S> {
    /// Returns a row vector of a matrix.
    pub fn row_vec(&self, i: usize) -> Vec4d<S> {
        v4d(self.a[i][0], self.a[i][1], self.a[i][2], self.a[i][3])
    }
    /// Returns a column vector of a matrix.
    pub fn col_vec(&self, j: usize) -> Vec4d<S> {
        v4d(self.a[0][j], self.a[1][j], self.a[2][j], self.a[3][j])
    }
    /// Returns the diagonal vector of a matrix.
    pub fn diag_vec(&self) -> Vec4d<S> {
        v4d(self.a[0][0], self.a[1][1], self.a[2][2], self.a[3][3])
    }
}

impl<S: Integer> MatrixOps<S, Matrix4d<S>> for Matrix4d<S> {}
impl<'a, S: Integer> MatrixOps<S, &'a Matrix4d<S>> for Matrix4d<S> {}
impl<'a, S: Integer> MatrixOps<S, Matrix4d<S>, Matrix4d<S>> for &'a Matrix4d<S> {}
impl<'a, S: Integer> MatrixOps<S, &'a Matrix4d<S>, Matrix4d<S>> for &'a Matrix4d<S> {}

impl<S: Integer> MatrixOps<S, Vec4d<S>, Vec4d<S>> for Matrix4d<S> {}
impl<'a, S: Integer> MatrixOps<S, &'a Vec4d<S>, Vec4d<S>> for Matrix4d<S> {}
impl<'a, S: Integer> MatrixOps<S, Vec4d<S>, Vec4d<S>> for &'a Matrix4d<S> {}
impl<'a, S: Integer> MatrixOps<S, &'a Vec4d<S>, Vec4d<S>> for &'a Matrix4d<S> {}

impl<S: Integer> Matrix<S> for Matrix4d<S> {
    type V = Vec4d<S>;

    fn with<F>(f: F) -> Matrix4d<S>
    where
        F: Fn(usize, usize) -> S,
    {
        let r0 = [f(0, 0), f(0, 1), f(0, 2), f(0, 3)];
        let r1 = [f(1, 0), f(1, 1), f(1, 2), f(1, 3)];
        let r2 = [f(2, 0), f(2, 1), f(2, 2), f(2, 3)];
        let r3 = [f(3, 0), f(3, 1), f(3, 2), f(3, 3)];
        Matrix4d {
            a: [r0, r1, r2, r3],
        }
    }
}

impl<S: Integer> Mul<Vec4d<S>> for Matrix4d<S>
where
    S: Copy + Add<Output = S> + Mul<Output = S>,
{
    type Output = Vec4d<S>;

    fn mul(self, other: Vec4d<S>) -> Vec4d<S> {
        let x = self.row_vec(0) * other;
        let y = self.row_vec(1) * other;
        let z = self.row_vec(2) * other;
        let w = self.row_vec(3) * other;
        v4d(x, y, z, w)
    }
}

impl<'a, S: Integer> Mul<&'a Vec4d<S>> for Matrix4d<S>
where
    S: Copy + Add<Output = S> + Mul<Output = S>,
{
    type Output = Vec4d<S>;

    fn mul(self, other: &'a Vec4d<S>) -> Vec4d<S> {
        let x = self.row_vec(0) * other;
        let y = self.row_vec(1) * other;
        let z = self.row_vec(2) * other;
        let w = self.row_vec(3) * other;
        v4d(x, y, z, w)
    }
}

impl<'a, S: Integer> Mul<Vec4d<S>> for &'a Matrix4d<S>
where
    S: Copy + Add<Output = S> + Mul<Output = S>,
{
    type Output = Vec4d<S>;

    fn mul(self, other: Vec4d<S>) -> Vec4d<S> {
        let x = self.row_vec(0) * other;
        let y = self.row_vec(1) * other;
        let z = self.row_vec(2) * other;
        let w = self.row_vec(3) * other;
        v4d(x, y, z, w)
    }
}

impl<'a, S: Integer> Mul<&'a Vec4d<S>> for &'a Matrix4d<S>
where
    S: Copy + Add<Output = S> + Mul<Output = S>,
{
    type Output = Vec4d<S>;

    fn mul(self, other: &'a Vec4d<S>) -> Vec4d<S> {
        let x = self.row_vec(0) * other;
        let y = self.row_vec(1) * other;
        let z = self.row_vec(2) * other;
        let w = self.row_vec(3) * other;
        v4d(x, y, z, w)
    }
}

impl<S: Integer> Mul<Matrix4d<S>> for Matrix4d<S>
where
    S: Copy + Add<Output = S> + Mul<Output = S>,
{
    type Output = Matrix4d<S>;

    fn mul(self, other: Matrix4d<S>) -> Matrix4d<S> {
        Matrix4d::with(|i, j| self.row_vec(i) * other.col_vec(j))
    }
}

impl<'a, S: Integer> Mul<&'a Matrix4d<S>> for Matrix4d<S>
where
    S: Copy + Add<Output = S> + Mul<Output = S>,
{
    type Output = Matrix4d<S>;

    fn mul(self, other: &'a Matrix4d<S>) -> Matrix4d<S> {
        Matrix4d::with(|i, j| self.row_vec(i) * other.col_vec(j))
    }
}

impl<'a, S: Integer> Mul<Matrix4d<S>> for &'a Matrix4d<S>
where
    S: Copy + Add<Output = S> + Mul<Output = S>,
{
    type Output = Matrix4d<S>;

    fn mul(self, other: Matrix4d<S>) -> Matrix4d<S> {
        Matrix4d::with(|i, j| self.row_vec(i) * other.col_vec(j))
    }
}

impl<'a, S: Integer> Mul<&'a Matrix4d<S>> for &'a Matrix4d<S>
where
    S: Copy + Add<Output = S> + Mul<Output = S>,
{
    type Output = Matrix4d<S>;

    fn mul(self, other: &'a Matrix4d<S>) -> Matrix4d<S> {
        Matrix4d::with(|i, j| self.row_vec(i) * other.col_vec(j))
    }
}
#[cfg(test)]
mod tests {
    use core::convert::TryFrom;

    use crate::v4d;
    use crate::Matrix;
    use crate::Matrix4d;

    #[test]
    fn test_zero() {
        let m = Matrix4d::zero();
        assert_eq!(v4d(0, 0, 0, 0), m.row_vec(0));
        assert_eq!(v4d(0, 0, 0, 0), m.row_vec(1));
        assert_eq!(v4d(0, 0, 0, 0), m.row_vec(2));
        assert_eq!(v4d(0, 0, 0, 0), m.row_vec(3));
    }

    #[test]
    fn test_unit() {
        let m = Matrix4d::unit();
        assert_eq!(v4d(1, 0, 0, 0), m.row_vec(0));
        assert_eq!(v4d(0, 1, 0, 0), m.row_vec(1));
        assert_eq!(v4d(0, 0, 1, 0), m.row_vec(2));
        assert_eq!(v4d(0, 0, 0, 1), m.row_vec(3));
    }

    #[test]
    fn test_row_vec() {
        let m = Matrix4d::with(|i, j| i64::try_from(4 * i + j).unwrap());
        assert_eq!(v4d(0, 1, 2, 3), m.row_vec(0));
        assert_eq!(v4d(4, 5, 6, 7), m.row_vec(1));
        assert_eq!(v4d(8, 9, 10, 11), m.row_vec(2));
        assert_eq!(v4d(12, 13, 14, 15), m.row_vec(3));
    }

    #[test]
    fn test_col_vec() {
        let m = Matrix4d::with(|i, j| i64::try_from(4 * i + j).unwrap());
        assert_eq!(v4d(0, 4, 8, 12), m.col_vec(0));
        assert_eq!(v4d(1, 5, 9, 13), m.col_vec(1));
        assert_eq!(v4d(2, 6, 10, 14), m.col_vec(2));
        assert_eq!(v4d(3, 7, 11, 15), m.col_vec(3));
    }

    #[test]
    fn test_diag_vec() {
        let m = Matrix4d::with(|i, j| i64::try_from(4 * i + j).unwrap());
        assert_eq!(v4d(0, 5, 10, 15), m.diag_vec());
    }

    #[test]
    fn test_mul_mv() {
        let m = Matrix4d::with(|i, j| i64::try_from(if i == j { i + 2 } else { 0 }).unwrap());
        let v = v4d(2, 3, 4, 5);
        assert_eq!(v4d(4, 9, 16, 25), m * v);
        assert_eq!(v4d(4, 9, 16, 25), m * &v);
        assert_eq!(v4d(4, 9, 16, 25), &m * v);
        assert_eq!(v4d(4, 9, 16, 25), &m * &v);
    }

    #[test]
    fn test_mul_mm() {
        let m = Matrix4d::with(|i, j| i64::try_from(if i == j { i + 2 } else { 0 }).unwrap());
        assert_eq!(v4d(4, 9, 16, 25), (m * m).diag_vec());
        assert_eq!(v4d(4, 9, 16, 25), (m * &m).diag_vec());
        assert_eq!(v4d(4, 9, 16, 25), (&m * m).diag_vec());
        assert_eq!(v4d(4, 9, 16, 25), (&m * &m).diag_vec());
    }
}