batbox-la 0.16.0

Linear algebra
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

use super::*;

mod extra;
mod ops;
mod projection;
mod transform;

/// 3x3 matrix
#[allow(non_camel_case_types)]
#[repr(C)]
#[derive(Debug, Copy, Clone, Serialize, Deserialize)]
pub struct mat3<T>(pub(crate) [[T; 3]; 3]);

impl<T> mat3<T> {
    /// Map every element
    pub fn map<U, F: Fn(T) -> U>(self, f: F) -> mat3<U> {
        mat3(self.0.map(|row| row.map(&f)))
    }
}

impl<T: Copy> mat3<T> {
    /// Construct a matrix.
    ///
    /// # Examples
    /// ```
    /// # use batbox_la::*;
    /// let matrix = mat3::new([
    ///     [1, 2, 3],
    ///     [4, 5, 6],
    ///     [7, 8, 9],
    /// ]);
    /// ```
    pub fn new(values: [[T; 3]; 3]) -> Self {
        Self(values).transpose()
    }

    /// Get row as a [vec3]
    pub fn row(&self, row_index: usize) -> vec3<T> {
        vec3(
            self[(row_index, 0)],
            self[(row_index, 1)],
            self[(row_index, 2)],
        )
    }

    /// Get column as a [vec3]
    pub fn col(&self, col_index: usize) -> vec3<T> {
        vec3(
            self[(0, col_index)],
            self[(1, col_index)],
            self[(2, col_index)],
        )
    }
}

impl<T> Index<(usize, usize)> for mat3<T> {
    type Output = T;
    fn index(&self, (row, col): (usize, usize)) -> &T {
        &self.0[col][row]
    }
}

impl<T> IndexMut<(usize, usize)> for mat3<T> {
    fn index_mut(&mut self, (row, col): (usize, usize)) -> &mut T {
        &mut self.0[col][row]
    }
}

impl<T> mat3<T> {
    /// Get self as a flat array
    pub fn as_flat_array(&self) -> &[T; 9] {
        unsafe { std::mem::transmute(self) }
    }
    /// Get self as a mutable flat array
    pub fn as_flat_array_mut(&mut self) -> &mut [T; 9] {
        unsafe { std::mem::transmute(self) }
    }
}

impl<T: Num + Copy> mat3<T> {
    /// Construct zero matrix.
    ///
    /// # Examples
    /// ```
    /// # use batbox_la::*;
    /// let matrix = mat3::<i32>::zero();
    /// for i in 0..3 {
    ///     for j in 0..3 {
    ///         assert_eq!(matrix[(i, j)], 0);
    ///     }
    /// }
    /// ```
    pub fn zero() -> Self {
        mat3([[T::ZERO; 3]; 3])
    }

    /// Construct identity matrix.
    ///
    /// # Examples
    /// ```
    /// # use batbox_la::*;
    /// let matrix = mat3::<i32>::identity();
    /// for i in 0..3 {
    ///     for j in 0..3 {
    ///         assert_eq!(matrix[(i, j)], if i == j { 1 } else { 0 });
    ///     }
    /// }
    /// ```
    pub fn identity() -> Self {
        let mut result = Self::zero();
        for i in 0..3 {
            result[(i, i)] = T::ONE;
        }
        result
    }
}

impl<T: Float> Approx for mat3<T> {
    fn approx_distance_to(&self, other: &Self) -> f32 {
        let mut dist = 0.0;
        for i in 0..3 {
            for j in 0..3 {
                dist = partial_max(dist, (other[(i, j)] - self[(i, j)]).abs().as_f32());
            }
        }
        dist
    }
}