tiny_vect 0.1.3

A minimal vector math library for 2D and 3D operations in 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
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
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
use std::convert::{From, TryFrom};
use std::fmt::{Display, Formatter, Result as FmtResult};
use std::hash::{Hash, Hasher};
use std::ops::{
    Add, AddAssign, Div, DivAssign, Index, IndexMut, Mul, MulAssign, Neg, Sub, SubAssign,
};

#[derive(Debug, Clone, Copy, PartialEq, Default)]
pub struct Vect2 {
    pub x: f32,
    pub y: f32,
}

impl Vect2 {
    pub fn new(x: f32, y: f32) -> Self {
        Self { x, y }
    }

    pub fn length_squared(&self) -> f32 {
        let result = self.x * self.x + self.y * self.y;
        debug_assert!(
            result.is_finite(),
            "Vect2::length_squared produced NaN or infinity"
        );
        result
    }

    pub fn length(&self) -> f32 {
        let result = (self.x * self.x + self.y * self.y).sqrt();
        debug_assert!(result.is_finite(), "Vect2::length produced NaN or infinity");
        result
    }

    pub fn normalize(&self) -> Self {
        // Compute squared length without any early debug_assert
        let sq = self.x * self.x + self.y * self.y;
        // If that overflowed to infinity or is NaN, error out here
        debug_assert!(
            sq.is_finite(),
            "Vect2::normalize produced non-finite result"
        );

        // Safe to sqrt now
        let len = sq.sqrt();
        // Zero‑length stays zero‑vector
        if len == 0.0 {
            *self
        } else {
            let result = *self / len;
            // Final sanity check (should never fire if sq was finite)
            debug_assert!(
                result.x.is_finite() && result.y.is_finite(),
                "Vect2::normalize produced non-finite result"
            );
            result
        }
    }

    pub fn dot(&self, other: &Self) -> f32 {
        let result = self.x * other.x + self.y * other.y;
        debug_assert!(result.is_finite(), "Vect2::dot produced NaN or infinity");
        result
    }

    pub fn cross(&self, other: &Self) -> f32 {
        let result = self.x * other.y - self.y * other.x;
        debug_assert!(result.is_finite(), "Vect2::cross produced NaN or infinity");
        result
    }

    pub fn rotate(&self, angle: f32) -> Self {
        let cos = angle.cos();
        let sin = angle.sin();
        let x = self.x * cos - self.y * sin;
        let y = self.x * sin + self.y * cos;
        debug_assert!(
            x.is_finite() && y.is_finite(),
            "Vect2::rotate produced non-finite result"
        );
        Self { x, y }
    }

    pub fn distance(&self, other: &Self) -> f32 {
        let result = (*self - *other).length();
        debug_assert!(
            result.is_finite(),
            "Vect2::distance produced NaN or infinity"
        );
        result
    }

    pub fn distance_squared(&self, other: &Self) -> f32 {
        let dx = self.x - other.x;
        let dy = self.y - other.y;
        let result = dx * dx + dy * dy;
        debug_assert!(
            result.is_finite(),
            "Vect2::distance_squared produced NaN or infinity"
        );
        result
    }

    pub fn angle(&self, other: &Self) -> f32 {
        let dot = self.dot(other);
        let cross = self.cross(other);
        let result = cross.atan2(dot);
        debug_assert!(result.is_finite(), "Vect2::angle produced NaN or infinity");
        result
    }

    pub fn lerp(&self, other: &Self, t: f32) -> Self {
        let x = self.x + (other.x - self.x) * t;
        let y = self.y + (other.y - self.y) * t;
        debug_assert!(
            x.is_finite() && y.is_finite(),
            "Vect2::lerp produced non-finite result"
        );
        Self { x, y }
    }

    pub fn reflect(&self, normal: &Self) -> Self {
        let normal = normal.normalize();
        let result = *self - normal * 2.0 * self.dot(&normal);
        debug_assert!(
            result.x.is_finite() && result.y.is_finite(),
            "Vect2::reflect produced non-finite result"
        );
        result
    }

    pub fn project(&self, other: &Self) -> Self {
        let len_sq = other.length_squared();
        if len_sq == 0.0 {
            Vect2::default()
        } else {
            let scalar = self.dot(other) / len_sq;
            let result = *other * scalar;
            debug_assert!(
                result.x.is_finite() && result.y.is_finite(),
                "Vect2::project produced non-finite result"
            );
            result
        }
    }

    pub fn angle_between(&self, other: &Self) -> f32 {
        // Identical vectors → zero
        if self == other {
            return 0.0;
        }
        // Guard against zero‑length
        let denom = self.length() * other.length();
        if denom == 0.0 {
            return 0.0;
        }
        // Compute cosine, clamped to [-1,1]
        let cos = (self.dot(other) / denom).clamp(-1.0, 1.0);
        // Mitigate tiny rounding drift near 1.0
        if (cos - 1.0).abs() < f32::EPSILON {
            return 0.0;
        }
        let result = cos.acos();
        debug_assert!(
            result.is_finite(),
            "Vect2::angle_between produced NaN or infinity"
        );
        result
    }

    pub fn is_zero(&self) -> bool {
        self.x == 0.0 && self.y == 0.0
    }

    pub fn is_normalized(&self) -> bool {
        (self.length_squared() - 1.0).abs() < f32::EPSILON
    }

    pub fn is_parallel(&self, other: &Self) -> bool {
        self.cross(other).abs() < f32::EPSILON
    }
}

// Checked operations
impl Vect2 {
    pub fn debug_checked_add(self, other: Self) -> Self {
        let result = self + other;
        debug_assert!(
            result.x.is_finite() && result.y.is_finite(),
            "Vect2 overflow in add"
        );
        result
    }

    pub fn debug_checked_sub(self, other: Self) -> Self {
        let result = self - other;
        debug_assert!(
            result.x.is_finite() && result.y.is_finite(),
            "Vect2 overflow in sub"
        );
        result
    }

    pub fn debug_checked_mul(self, scalar: f32) -> Self {
        let result = self * scalar;
        debug_assert!(
            result.x.is_finite() && result.y.is_finite(),
            "Vect2 overflow in mul"
        );
        result
    }

    pub fn debug_checked_div(self, scalar: f32) -> Self {
        let result = self / scalar;
        debug_assert!(scalar != 0.0, "Vect2 division by zero");
        debug_assert!(
            result.x.is_finite() && result.y.is_finite(),
            "Vect2 overflow in div"
        );
        result
    }
}

// Arithmetic operations
impl Add for Vect2 {
    type Output = Self;
    fn add(self, rhs: Self) -> Self::Output {
        Self {
            x: self.x + rhs.x,
            y: self.y + rhs.y,
        }
    }
}

impl Sub for Vect2 {
    type Output = Self;
    fn sub(self, rhs: Self) -> Self::Output {
        Self {
            x: self.x - rhs.x,
            y: self.y - rhs.y,
        }
    }
}

impl Mul<f32> for Vect2 {
    type Output = Self;
    fn mul(self, rhs: f32) -> Self::Output {
        Self {
            x: self.x * rhs,
            y: self.y * rhs,
        }
    }
}

impl Div<f32> for Vect2 {
    type Output = Self;
    fn div(self, rhs: f32) -> Self::Output {
        Self {
            x: self.x / rhs,
            y: self.y / rhs,
        }
    }
}

impl Neg for Vect2 {
    type Output = Self;
    fn neg(self) -> Self::Output {
        Self {
            x: -self.x,
            y: -self.y,
        }
    }
}

impl AddAssign for Vect2 {
    fn add_assign(&mut self, rhs: Self) {
        self.x += rhs.x;
        self.y += rhs.y;
    }
}

impl SubAssign for Vect2 {
    fn sub_assign(&mut self, rhs: Self) {
        self.x -= rhs.x;
        self.y -= rhs.y;
    }
}

impl MulAssign<f32> for Vect2 {
    fn mul_assign(&mut self, rhs: f32) {
        self.x *= rhs;
        self.y *= rhs;
    }
}

impl DivAssign<f32> for Vect2 {
    fn div_assign(&mut self, rhs: f32) {
        self.x /= rhs;
        self.y /= rhs;
    }
}

// Indexing
impl Index<usize> for Vect2 {
    type Output = f32;
    fn index(&self, i: usize) -> &Self::Output {
        match i {
            0 => &self.x,
            1 => &self.y,
            _ => panic!("Index out of bounds for Vect2"),
        }
    }
}

impl IndexMut<usize> for Vect2 {
    fn index_mut(&mut self, i: usize) -> &mut Self::Output {
        match i {
            0 => &mut self.x,
            1 => &mut self.y,
            _ => panic!("Index out of bounds for Vect2"),
        }
    }
}

// From conversions
impl From<[f32; 2]> for Vect2 {
    fn from(arr: [f32; 2]) -> Self {
        Self {
            x: arr[0],
            y: arr[1],
        }
    }
}

impl From<(f32, f32)> for Vect2 {
    fn from(tuple: (f32, f32)) -> Self {
        Self {
            x: tuple.0,
            y: tuple.1,
        }
    }
}

impl From<[i32; 2]> for Vect2 {
    fn from(arr: [i32; 2]) -> Self {
        Self {
            x: arr[0] as f32,
            y: arr[1] as f32,
        }
    }
}

impl From<(i32, i32)> for Vect2 {
    fn from(tuple: (i32, i32)) -> Self {
        Self {
            x: tuple.0 as f32,
            y: tuple.1 as f32,
        }
    }
}

impl From<Vect2> for [f32; 2] {
    fn from(v: Vect2) -> Self {
        [v.x, v.y]
    }
}

impl TryFrom<&[f32]> for Vect2 {
    type Error = &'static str;

    fn try_from(slice: &[f32]) -> Result<Self, Self::Error> {
        if slice.len() == 2 {
            Ok(Self {
                x: slice[0],
                y: slice[1],
            })
        } else {
            Err("Expected slice of length 2 for Vect2<f32>")
        }
    }
}

impl TryFrom<&[i32]> for Vect2 {
    type Error = &'static str;

    fn try_from(slice: &[i32]) -> Result<Self, Self::Error> {
        if slice.len() == 2 {
            Ok(Self {
                x: slice[0] as f32,
                y: slice[1] as f32,
            })
        } else {
            Err("Expected slice of length 2 for Vect2<i32>")
        }
    }
}

// Display and parsing
impl Display for Vect2 {
    fn fmt(&self, f: &mut Formatter<'_>) -> FmtResult {
        write!(f, "({}, {})", self.x, self.y)
    }
}

// Hashing
impl Hash for Vect2 {
    fn hash<H: Hasher>(&self, state: &mut H) {
        state.write_u32(self.x.to_bits());
        state.write_u32(self.y.to_bits());
    }
}