bog 0.1.0

The highly-modular abstraction standard
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

//! X-Y-Z Objects



use std::{
    fmt::Debug,
    ops::{Add, AddAssign, Sub, SubAssign},
};



// ================================================================================================



/// An x-y-z value.
pub struct Xyz<T> {
    pub x: T,
    pub y: T,
    pub z: T,
}

impl<T> Xyz<T> {
    #[inline]
    pub const fn new(x: T, y: T, z: T) -> Self {
        Self { x, y, z }
    }
}



// ================================================================================================



impl<T: Clone> Clone for Xyz<T> {
    fn clone(&self) -> Self {
        Self {
            x: self.x.clone(),
            y: self.y.clone(),
            z: self.z.clone(),
        }
    }
}

impl<T: Copy> Copy for Xyz<T> {}

impl<T: Debug> Debug for Xyz<T> {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.debug_struct("Xyz")
            .field("x", &self.x)
            .field("y", &self.y)
            .field("z", &self.z)
            .finish()
    }
}

impl<T: Default> Default for Xyz<T> {
    fn default() -> Self {
        Self {
            x: T::default(),
            y: T::default(),
            z: T::default(),
        }
    }
}

impl<T: Eq> Eq for Xyz<T> {}

impl<T: PartialEq> PartialEq for Xyz<T> {
    fn eq(&self, other: &Self) -> bool {
        self.x == other.x && self.y == other.y && self.z == other.z
    }
}



// ================================================================================================



impl <T: Add<Output = T>> Add<Xyz<T>> for Xyz<T> {
    type Output = Xyz<T>;

    fn add(self, rhs: Xyz<T>) -> Self::Output {
        Self {
            x: self.x + rhs.x,
            y: self.y + rhs.y,
            z: self.z + rhs.z,
        }
    }
}

impl<T: AddAssign> AddAssign<Xyz<T>> for Xyz<T> {
    fn add_assign(&mut self, rhs: Xyz<T>) {
        self.x += rhs.x;
        self.y += rhs.y;
        self.z += rhs.z;
    }
}

impl <T: Sub<Output = T>> Sub<Xyz<T>> for Xyz<T> {
    type Output = Xyz<T>;

    fn sub(self, rhs: Xyz<T>) -> Self::Output {
        Self {
            x: self.x - rhs.x,
            y: self.y - rhs.y,
            z: self.z - rhs.z,
        }
    }
}

impl<T: SubAssign> SubAssign<Xyz<T>> for Xyz<T> {
    fn sub_assign(&mut self, rhs: Xyz<T>) {
        self.x -= rhs.x;
        self.y -= rhs.y;
        self.z -= rhs.z;
    }
}

impl Xyz<f32> {
    // TODO: Check this before commiting it!
    // pub fn normalize(&self) -> Self {
    //     let v = ((self.x * self.x) + (self.y * self.y) + (self.z * self.z)).sqrt();
    //     Self {
    //         x: self.x / v,
    //         y: self.y / v,
    //         z: self.z / v,
    //     }
    // }
}



// ================================================================================================



#[cfg(test)]
mod tests {
    use super::*;

    /// Assert that [`Xyz`] implements Debug, Eq, Clone, etc... whenever its generic does.
    #[test]
    fn assert_implementations() {
        let u32xyz_a: Xyz<u32> = Xyz::new(1, 3, 2);
        let u32xyz_b: Xyz<u32> = Xyz::new(3, 1, 2);

        assert_eq!(u32xyz_a, u32xyz_a.clone());
        assert_ne!(u32xyz_a, u32xyz_b);
    }
}