algebrix 0.1.0

Vectors, matrices, quaternions, and geometry for game engines; column vectors, optional SIMD.
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
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371

//! Boolean vectors (BVec2/3/4): component-wise masks for select, all, any.
//!
//! Use [`select`](BVec2::select) to pick components from two vectors by mask (where true take first,
//! where false take second). [`all`](BVec2::all) / [`any`](BVec2::any) / [`none`](BVec2::none) for reduction.
//!
//! # Example
//!
//! ```rust
//! use algebrix::{BVec2, Vec2};
//!
//! let mask = BVec2::new(true, false);
//! let a = Vec2::new(1.0, 2.0);
//! let b = Vec2::new(10.0, 20.0);
//! let c = mask.select(a, b);
//! assert_eq!(c.x, 1.0);
//! assert_eq!(c.y, 20.0);
//!
//! assert!(BVec2::TRUE.all());
//! assert!(BVec2::new(true, false).any());
//! ```

use crate::{Vec2, Vec3, Vec4};

/// 2D boolean vector (component-wise mask).
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub struct BVec2 {
    pub x: bool,
    pub y: bool,
}

impl BVec2 {
    pub const FALSE: BVec2 = BVec2 { x: false, y: false };
    pub const TRUE: BVec2 = BVec2 { x: true, y: true };

    #[inline(always)]
    pub const fn new(x: bool, y: bool) -> Self {
        Self { x, y }
    }

    #[inline(always)]
    pub const fn splat(v: bool) -> Self {
        Self { x: v, y: v }
    }

    /// Returns true if all components are true
    #[inline(always)]
    pub fn all(self) -> bool {
        self.x && self.y
    }

    /// Returns true if any component is true
    #[inline(always)]
    pub fn any(self) -> bool {
        self.x || self.y
    }

    /// Returns true if no components are true
    #[inline(always)]
    pub fn none(self) -> bool {
        !self.x && !self.y
    }

    /// Component-wise AND
    #[inline(always)]
    pub fn and(self, other: Self) -> Self {
        Self { x: self.x && other.x, y: self.y && other.y }
    }

    /// Component-wise OR
    #[inline(always)]
    pub fn or(self, other: Self) -> Self {
        Self { x: self.x || other.x, y: self.y || other.y }
    }

    /// Component-wise XOR
    #[inline(always)]
    pub fn xor(self, other: Self) -> Self {
        Self { x: self.x ^ other.x, y: self.y ^ other.y }
    }

    /// Select components: if mask is true, use a, else use b
    #[inline(always)]
    pub fn select(self, a: Vec2, b: Vec2) -> Vec2 {
        Vec2::new(
            if self.x { a.x } else { b.x },
            if self.y { a.y } else { b.y },
        )
    }
}

impl std::ops::Not for BVec2 {
    type Output = Self;
    #[inline]
    fn not(self) -> Self {
        Self { x: !self.x, y: !self.y }
    }
}

impl std::ops::BitAnd for BVec2 {
    type Output = Self;
    #[inline]
    fn bitand(self, other: Self) -> Self {
        self.and(other)
    }
}

impl std::ops::BitOr for BVec2 {
    type Output = Self;
    #[inline]
    fn bitor(self, other: Self) -> Self {
        self.or(other)
    }
}

impl std::ops::BitXor for BVec2 {
    type Output = Self;
    #[inline]
    fn bitxor(self, other: Self) -> Self {
        self.xor(other)
    }
}

/// 3D boolean vector (component-wise mask).
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub struct BVec3 {
    pub x: bool,
    pub y: bool,
    pub z: bool,
}

impl BVec3 {
    pub const FALSE: BVec3 = BVec3 { x: false, y: false, z: false };
    pub const TRUE: BVec3 = BVec3 { x: true, y: true, z: true };

    #[inline(always)]
    pub const fn new(x: bool, y: bool, z: bool) -> Self {
        Self { x, y, z }
    }

    #[inline(always)]
    pub const fn splat(v: bool) -> Self {
        Self { x: v, y: v, z: v }
    }

    #[inline(always)]
    pub fn all(self) -> bool {
        self.x && self.y && self.z
    }

    #[inline(always)]
    pub fn any(self) -> bool {
        self.x || self.y || self.z
    }

    #[inline(always)]
    pub fn none(self) -> bool {
        !self.x && !self.y && !self.z
    }

    #[inline(always)]
    pub fn and(self, other: Self) -> Self {
        Self {
            x: self.x && other.x,
            y: self.y && other.y,
            z: self.z && other.z,
        }
    }

    #[inline(always)]
    pub fn or(self, other: Self) -> Self {
        Self {
            x: self.x || other.x,
            y: self.y || other.y,
            z: self.z || other.z,
        }
    }

    #[inline(always)]
    pub fn xor(self, other: Self) -> Self {
        Self {
            x: self.x ^ other.x,
            y: self.y ^ other.y,
            z: self.z ^ other.z,
        }
    }

    #[inline(always)]
    pub fn select(self, a: Vec3, b: Vec3) -> Vec3 {
        Vec3::new(
            if self.x { a.x } else { b.x },
            if self.y { a.y } else { b.y },
            if self.z { a.z } else { b.z },
        )
    }
}

impl std::ops::Not for BVec3 {
    type Output = Self;
    #[inline]
    fn not(self) -> Self {
        Self { x: !self.x, y: !self.y, z: !self.z }
    }
}

impl std::ops::BitAnd for BVec3 {
    type Output = Self;
    #[inline]
    fn bitand(self, other: Self) -> Self {
        self.and(other)
    }
}

impl std::ops::BitOr for BVec3 {
    type Output = Self;
    #[inline]
    fn bitor(self, other: Self) -> Self {
        self.or(other)
    }
}

impl std::ops::BitXor for BVec3 {
    type Output = Self;
    #[inline]
    fn bitxor(self, other: Self) -> Self {
        self.xor(other)
    }
}

/// 4D boolean vector (component-wise mask).
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub struct BVec4 {
    pub x: bool,
    pub y: bool,
    pub z: bool,
    pub w: bool,
}

impl BVec4 {
    pub const FALSE: BVec4 = BVec4 { x: false, y: false, z: false, w: false };
    pub const TRUE: BVec4 = BVec4 { x: true, y: true, z: true, w: true };

    #[inline(always)]
    pub const fn new(x: bool, y: bool, z: bool, w: bool) -> Self {
        Self { x, y, z, w }
    }

    #[inline(always)]
    pub const fn splat(v: bool) -> Self {
        Self { x: v, y: v, z: v, w: v }
    }

    #[inline(always)]
    pub fn all(self) -> bool {
        self.x && self.y && self.z && self.w
    }

    #[inline(always)]
    pub fn any(self) -> bool {
        self.x || self.y || self.z || self.w
    }

    #[inline(always)]
    pub fn none(self) -> bool {
        !self.x && !self.y && !self.z && !self.w
    }

    #[inline(always)]
    pub fn and(self, other: Self) -> Self {
        Self {
            x: self.x && other.x,
            y: self.y && other.y,
            z: self.z && other.z,
            w: self.w && other.w,
        }
    }

    #[inline(always)]
    pub fn or(self, other: Self) -> Self {
        Self {
            x: self.x || other.x,
            y: self.y || other.y,
            z: self.z || other.z,
            w: self.w || other.w,
        }
    }

    #[inline(always)]
    pub fn xor(self, other: Self) -> Self {
        Self {
            x: self.x ^ other.x,
            y: self.y ^ other.y,
            z: self.z ^ other.z,
            w: self.w ^ other.w,
        }
    }

    #[inline(always)]
    pub fn select(self, a: Vec4, b: Vec4) -> Vec4 {
        Vec4::new(
            if self.x { a.x } else { b.x },
            if self.y { a.y } else { b.y },
            if self.z { a.z } else { b.z },
            if self.w { a.w } else { b.w },
        )
    }
}

impl std::ops::Not for BVec4 {
    type Output = Self;
    #[inline]
    fn not(self) -> Self {
        Self { x: !self.x, y: !self.y, z: !self.z, w: !self.w }
    }
}

impl std::ops::BitAnd for BVec4 {
    type Output = Self;
    #[inline]
    fn bitand(self, other: Self) -> Self {
        self.and(other)
    }
}

impl std::ops::BitOr for BVec4 {
    type Output = Self;
    #[inline]
    fn bitor(self, other: Self) -> Self {
        self.or(other)
    }
}

impl std::ops::BitXor for BVec4 {
    type Output = Self;
    #[inline]
    fn bitxor(self, other: Self) -> Self {
        self.xor(other)
    }
}

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

    #[test]
    fn test_bvec2_all_any() {
        assert!(BVec2::TRUE.all());
        assert!(!BVec2::FALSE.all());
        assert!(BVec2::new(true, false).any());
        assert!(!BVec2::FALSE.any());
    }

    #[test]
    fn test_bvec3_select() {
        let mask = BVec3::new(true, false, true);
        let a = Vec3::new(1.0, 2.0, 3.0);
        let b = Vec3::new(4.0, 5.0, 6.0);
        let result = mask.select(a, b);
        assert_eq!(result.x, 1.0);
        assert_eq!(result.y, 5.0);
        assert_eq!(result.z, 3.0);
    }

    #[test]
    fn test_bvec4_bitops() {
        let a = BVec4::new(true, false, true, false);
        let b = BVec4::new(true, true, false, false);
        assert_eq!(a & b, BVec4::new(true, false, false, false));
        assert_eq!(a | b, BVec4::new(true, true, true, false));
        assert_eq!(a ^ b, BVec4::new(false, true, true, false));
    }
}