vectorama 0.1.1

Very simple linear algebra 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

#[cfg(test)]
mod tests {
    use approx::assert_relative_eq;
    use vectorama::vector::vec3::Vec3;

    #[test]
    fn test_vec3_new_and_fields() {
        let v = Vec3::new(1.0, 2.0, 3.0);
        assert_relative_eq!(v.x, 1.0, epsilon = f32::EPSILON);
        assert_relative_eq!(v.y, 2.0, epsilon = f32::EPSILON);
        assert_relative_eq!(v.z, 3.0, epsilon = f32::EPSILON);
    }

    #[test]
    fn test_vec3_from_array() {
        let v = Vec3::from([4.0, 5.0, 6.0]);
        assert_relative_eq!(v.x, 4.0, epsilon = f32::EPSILON);
        assert_relative_eq!(v.y, 5.0, epsilon = f32::EPSILON);
        assert_relative_eq!(v.z, 6.0, epsilon = f32::EPSILON);
    }

    #[test]
    fn test_vec3_add() {
        let a = Vec3::new(1.0, 2.0, 3.0);
        let b = Vec3::new(4.0, 5.0, 6.0);
        let result = a + b;
        assert_relative_eq!(result.x, 5.0, epsilon = f32::EPSILON);
        assert_relative_eq!(result.y, 7.0, epsilon = f32::EPSILON);
        assert_relative_eq!(result.z, 9.0, epsilon = f32::EPSILON);
    }

    #[test]
    fn test_vec3_sub() {
        let a = Vec3::new(7.0, 8.0, 9.0);
        let b = Vec3::new(1.0, 2.0, 3.0);
        let result = a - b;
        assert_relative_eq!(result.x, 6.0, epsilon = f32::EPSILON);
        assert_relative_eq!(result.y, 6.0, epsilon = f32::EPSILON);
        assert_relative_eq!(result.z, 6.0, epsilon = f32::EPSILON);
    }

    #[test]
    fn test_vec3_mul_scalar() {
        let v = Vec3::new(2.0, 3.0, 4.0);
        let result = v * 2.0;
        assert_relative_eq!(result.x, 4.0, epsilon = f32::EPSILON);
        assert_relative_eq!(result.y, 6.0, epsilon = f32::EPSILON);
        assert_relative_eq!(result.z, 8.0, epsilon = f32::EPSILON);
    }

    #[test]
    fn test_vec3_div_scalar() {
        let v = Vec3::new(8.0, 6.0, 4.0);
        let result = v / 2.0;
        assert_relative_eq!(result.x, 4.0, epsilon = f32::EPSILON);
        assert_relative_eq!(result.y, 3.0, epsilon = f32::EPSILON);
        assert_relative_eq!(result.z, 2.0, epsilon = f32::EPSILON);
    }

    #[test]
    fn test_vec3_neg() {
        let v = Vec3::new(1.0, -2.0, 3.0);
        let result = -v;
        assert_relative_eq!(result.x, -1.0, epsilon = f32::EPSILON);
        assert_relative_eq!(result.y, 2.0, epsilon = f32::EPSILON);
        assert_relative_eq!(result.z, -3.0, epsilon = f32::EPSILON);
    }

    #[test]
    fn test_vec3_swizzle_xy() {
        let v = Vec3::new(1.0, 2.0, 3.0);
        let xy = v.xy();
        assert_relative_eq!(xy.x, 1.0, epsilon = f32::EPSILON);
        assert_relative_eq!(xy.y, 2.0, epsilon = f32::EPSILON);
    }

    #[test]
    fn test_vec3_swizzle_yz() {
        let v = Vec3::new(1.0, 2.0, 3.0);
        let yz = v.yz();
        assert_relative_eq!(yz.x, 2.0, epsilon = f32::EPSILON);
        assert_relative_eq!(yz.y, 3.0, epsilon = f32::EPSILON);
    }

    #[test]
    fn test_vec3_swizzle_xz() {
        let v = Vec3::new(1.0, 2.0, 3.0);
        let xz = v.xz();
        assert_relative_eq!(xz.x, 1.0, epsilon = f32::EPSILON);
        assert_relative_eq!(xz.y, 3.0, epsilon = f32::EPSILON);
    }

    #[test]
    fn test_vec3_dot() {
        let a = Vec3::new(1.0, 2.0, 3.0);
        let b = Vec3::new(4.0, -5.0, 6.0);
        let dot = a.dot(&b);
        assert_relative_eq!(
            dot,
            1.0 * 4.0 + 2.0 * -5.0 + 3.0 * 6.0,
            epsilon = f32::EPSILON
        );
    }

    #[test]
    fn test_vec3_magnitude() {
        let v = Vec3::new(3.0, 4.0, 12.0);
        let mag = v.magnitude();
        assert_relative_eq!(mag, 13.0, epsilon = f32::EPSILON);
    }

    #[test]
    fn test_vec3_normalize() {
        let v = Vec3::new(0.0, 3.0, 4.0);
        let n = v.normalize();
        let mag = n.magnitude();
        assert_relative_eq!(mag, 1.0, epsilon = f32::EPSILON);
        assert_relative_eq!(n.x, 0.0, epsilon = f32::EPSILON);
        assert_relative_eq!(n.y, 3.0 / 5.0, epsilon = f32::EPSILON);
        assert_relative_eq!(n.z, 4.0 / 5.0, epsilon = f32::EPSILON);
    }

    #[test]
    fn test_vec3_cross() {
        let a = Vec3::new(1.0, 2.0, 3.0);
        let b = Vec3::new(4.0, 5.0, 6.0);
        let cross = a.cross(&b);
        assert_relative_eq!(cross.x, -3.0, epsilon = f32::EPSILON);
        assert_relative_eq!(cross.y, 6.0, epsilon = f32::EPSILON);
        assert_relative_eq!(cross.z, -3.0, epsilon = f32::EPSILON);
    }

    #[test]
    fn test_vec3_xyzw() {
        let v = Vec3::new(1.0, 2.0, 3.0);
        let w = 4.0;
        let vec4 = v.xyzw(w);
        assert_relative_eq!(vec4.x, 1.0, epsilon = f32::EPSILON);
        assert_relative_eq!(vec4.y, 2.0, epsilon = f32::EPSILON);
        assert_relative_eq!(vec4.z, 3.0, epsilon = f32::EPSILON);
        assert_relative_eq!(vec4.w, 4.0, epsilon = f32::EPSILON);
    }
}