absolute_unit 0.11.4

A unit system for Rust's type system to catch unit errors in your physical calculations.
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
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
use crate::{Length, LengthUnit, Quantity, Scalar, V3};
use approx::{AbsDiffEq, RelativeEq, abs_diff_eq, relative_eq};
use glam::{DMat4, DQuat, DVec3, DVec4};
#[cfg(feature = "nalgebra")]
use nalgebra as na;
use std::{
    fmt,
    marker::PhantomData,
    ops::{Add, AddAssign, Div, Mul, Neg, Sub, SubAssign},
};

/// A 64-bit 3-vec with length in <LengthUnit>s.
#[derive(Clone, Copy, Debug, PartialEq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[cfg_attr(feature = "bevy_reflect", derive(bevy_reflect::Reflect))]
pub struct Pt3<Unit>
where
    Unit: LengthUnit,
{
    vec: DVec3,
    #[cfg_attr(feature = "serde", serde(skip))]
    #[cfg_attr(feature = "bevy_reflect", reflect(ignore))]
    unit: PhantomData<Unit>,
}

impl<Unit> Pt3<Unit>
where
    Unit: LengthUnit,
{
    #[inline]
    pub fn new(x: Length<Unit>, y: Length<Unit>, z: Length<Unit>) -> Self {
        Self {
            vec: DVec3::new(x.f64(), y.f64(), z.f64()),
            unit: PhantomData,
        }
    }

    #[inline]
    pub fn new_unit(x: f64, y: f64, z: f64) -> Self {
        Self {
            vec: DVec3::new(x, y, z),
            unit: PhantomData,
        }
    }

    #[inline]
    pub fn new_dvec3(vec: DVec3) -> Self {
        Self {
            vec,
            unit: PhantomData,
        }
    }

    #[inline]
    pub fn zero() -> Self {
        Self {
            vec: DVec3::ZERO,
            unit: PhantomData,
        }
    }

    #[inline]
    pub fn infinity() -> Self {
        Self {
            vec: DVec3::INFINITY,
            unit: PhantomData,
        }
    }

    #[inline]
    pub fn neg_infinity() -> Self {
        Self {
            vec: DVec3::NEG_INFINITY,
            unit: PhantomData,
        }
    }

    #[inline]
    pub fn is_finite(&self) -> bool {
        self.vec.is_finite()
    }

    #[inline]
    pub fn to_array(&self) -> [Length<Unit>; 3] {
        [self.x(), self.y(), self.z()]
    }

    #[inline]
    pub fn x(&self) -> Length<Unit> {
        Length::<Unit>::from(&self.vec.x)
    }

    #[inline]
    pub fn y(&self) -> Length<Unit> {
        Length::<Unit>::from(&self.vec.y)
    }

    #[inline]
    pub fn z(&self) -> Length<Unit> {
        Length::<Unit>::from(&self.vec.z)
    }

    #[inline]
    pub fn set_x<T: LengthUnit>(&mut self, value: Length<T>) {
        self.vec.x = Length::<Unit>::from(&value).f64();
    }

    #[inline]
    pub fn set_y<T: LengthUnit>(&mut self, value: Length<T>) {
        self.vec.y = Length::<Unit>::from(&value).f64();
    }

    #[inline]
    pub fn set_z<T: LengthUnit>(&mut self, value: Length<T>) {
        self.vec.z = Length::<Unit>::from(&value).f64();
    }

    #[inline]
    pub fn with_x<T: LengthUnit>(&self, value: Length<T>) -> Self {
        Self::new(Length::<Unit>::from(&value), self.y(), self.z())
    }

    #[inline]
    pub fn with_y<T: LengthUnit>(&self, value: Length<T>) -> Self {
        Self::new(self.x(), Length::<Unit>::from(&value), self.z())
    }

    #[inline]
    pub fn with_z<T: LengthUnit>(&self, value: Length<T>) -> Self {
        Self::new(self.x(), self.y(), Length::<Unit>::from(&value))
    }

    #[inline]
    pub fn x_as<T: LengthUnit>(&self) -> Length<T> {
        Length::<T>::from(&Length::<Unit>::from(&self.vec.x))
    }

    #[inline]
    pub fn y_as<T: LengthUnit>(&self) -> Length<T> {
        Length::<T>::from(&Length::<Unit>::from(&self.vec.y))
    }

    #[inline]
    pub fn z_as<T: LengthUnit>(&self) -> Length<T> {
        Length::<T>::from(&Length::<Unit>::from(&self.vec.z))
    }

    pub fn at(&self, index: usize) -> Length<Unit> {
        match index {
            0 => Length::<Unit>::from(self.vec.x),
            1 => Length::<Unit>::from(self.vec.y),
            2 => Length::<Unit>::from(self.vec.z),
            _ => panic!("invalid pt3 index at: {index}"),
        }
    }

    pub fn set(&mut self, index: usize, value: Length<Unit>) {
        match index {
            0 => self.vec.x = value.f64(),
            1 => self.vec.y = value.f64(),
            2 => self.vec.z = value.f64(),
            _ => panic!("invalid pt3 index set: {index}"),
        }
    }

    pub fn transform_by(&self, m: &DMat4) -> Self {
        Self::new_dvec3(m.transform_point3(self.vec))
    }

    #[inline]
    pub fn length(&self) -> Length<Unit> {
        Length::<Unit>::from(self.vec.length())
    }

    #[inline]
    pub fn cross(&self, rhs: Pt3<Unit>) -> V3<Length<Unit>> {
        V3::new_dvec3(self.vec.cross(rhs.vec))
    }

    #[inline]
    pub fn to(&self, other: Pt3<Unit>) -> V3<Length<Unit>> {
        V3::new_dvec3(other.vec - self.vec)
    }

    #[inline]
    pub fn v3(&self) -> V3<Length<Unit>> {
        V3::new_dvec3(self.vec)
    }

    #[inline]
    pub fn dvec3(&self) -> DVec3 {
        self.vec
    }

    #[inline]
    pub fn dvec4(&self, w: f64) -> DVec4 {
        DVec4::from((self.vec, w))
    }

    #[cfg(feature = "nalgebra")]
    #[inline]
    pub fn na_dvec3(&self) -> na::Vector3<f64> {
        na::Vector3::new(self.vec.x, self.vec.y, self.vec.z)
    }
}

impl<Unit> AbsDiffEq for Pt3<Unit>
where
    Unit: LengthUnit,
{
    type Epsilon = f64;

    fn default_epsilon() -> Self::Epsilon {
        f64::default_epsilon()
    }

    fn abs_diff_eq(&self, other: &Self, epsilon: Self::Epsilon) -> bool {
        abs_diff_eq!(self.vec, other.vec, epsilon = epsilon)
    }
}

impl<Unit> RelativeEq for Pt3<Unit>
where
    Unit: LengthUnit,
{
    fn default_max_relative() -> Self::Epsilon {
        f64::default_epsilon()
    }

    fn relative_eq(
        &self,
        other: &Self,
        epsilon: Self::Epsilon,
        max_relative: Self::Epsilon,
    ) -> bool {
        relative_eq!(
            self.vec,
            other.vec,
            epsilon = epsilon,
            max_relative = max_relative
        )
    }
}

impl<A, B> Add<Pt3<B>> for Pt3<A>
where
    A: LengthUnit,
    B: LengthUnit,
{
    type Output = Pt3<A>;

    fn add(self, rhs: Pt3<B>) -> Self::Output {
        let rhs = Pt3::<A>::from(&rhs);
        Pt3::new_dvec3(self.vec + rhs.vec)
    }
}

impl<A, B> AddAssign<Pt3<B>> for Pt3<A>
where
    A: LengthUnit,
    B: LengthUnit,
{
    fn add_assign(&mut self, rhs: Pt3<B>) {
        let rhs = Pt3::<A>::from(&rhs);
        self.vec += rhs.vec;
    }
}

impl<A, B> Add<V3<Length<B>>> for Pt3<A>
where
    A: LengthUnit,
    B: LengthUnit,
{
    type Output = Pt3<A>;

    fn add(self, rhs: V3<Length<B>>) -> Self::Output {
        let rhs = Pt3::<B>::new(rhs.x(), rhs.y(), rhs.z());
        let rhs = Pt3::<A>::from(&rhs);
        Pt3::new_dvec3(self.vec + rhs.vec)
    }
}

impl<A, B> Sub<Pt3<B>> for Pt3<A>
where
    A: LengthUnit,
    B: LengthUnit,
{
    type Output = Pt3<A>;

    fn sub(self, rhs: Pt3<B>) -> Self::Output {
        let rhs = Pt3::<A>::from(&rhs);
        Pt3::new_dvec3(self.vec - rhs.vec)
    }
}

impl<A, B> SubAssign<Pt3<B>> for Pt3<A>
where
    A: LengthUnit,
    B: LengthUnit,
{
    fn sub_assign(&mut self, rhs: Pt3<B>) {
        let rhs = Pt3::<A>::from(&rhs);
        self.vec -= rhs.vec;
    }
}

impl<A, B> Sub<V3<Length<B>>> for Pt3<A>
where
    A: LengthUnit,
    B: LengthUnit,
{
    type Output = Pt3<A>;

    fn sub(self, rhs: V3<Length<B>>) -> Self::Output {
        let rhs = Pt3::<B>::new(rhs.x(), rhs.y(), rhs.z());
        let rhs = Pt3::<A>::from(&rhs);
        Pt3::new_dvec3(self.vec - rhs.vec)
    }
}

impl<Unit> Mul<Pt3<Unit>> for DQuat
where
    Unit: LengthUnit,
{
    type Output = Pt3<Unit>;

    fn mul(self, rhs: Pt3<Unit>) -> Self::Output {
        Pt3::new_dvec3(self * rhs.vec)
    }
}

impl<Unit> Mul<Pt3<Unit>> for DMat4
where
    Unit: LengthUnit,
{
    type Output = Pt3<Unit>;

    fn mul(self, rhs: Pt3<Unit>) -> Self::Output {
        Pt3::new_dvec3(self.transform_point3(rhs.vec))
    }
}

impl<Unit> Mul<Pt3<Unit>> for Scalar
where
    Unit: LengthUnit,
{
    type Output = Pt3<Unit>;

    fn mul(self, rhs: Pt3<Unit>) -> Self::Output {
        Pt3::new_dvec3(self.f64() * rhs.vec)
    }
}

impl<Unit> Neg for Pt3<Unit>
where
    Unit: LengthUnit,
{
    type Output = Pt3<Unit>;

    fn neg(self) -> Self::Output {
        Pt3::new_dvec3(-self.vec)
    }
}

impl<Unit> Div<Scalar> for Pt3<Unit>
where
    Unit: LengthUnit,
{
    type Output = Pt3<Unit>;

    fn div(self, rhs: Scalar) -> Self::Output {
        Pt3::new_dvec3(self.vec / rhs.0.0)
    }
}

impl<Unit> fmt::Display for Pt3<Unit>
where
    Unit: LengthUnit,
{
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "[")?;
        fmt::Display::fmt(&self.vec.x, f)?;
        write!(f, ", ")?;
        fmt::Display::fmt(&self.vec.y, f)?;
        write!(f, ", ")?;
        fmt::Display::fmt(&self.vec.z, f)?;
        write!(f, "]{}", Unit::UNIT_SHORT_NAME)
    }
}

impl<'a, UnitA, UnitB> From<&'a Pt3<UnitB>> for Pt3<UnitA>
where
    UnitA: LengthUnit,
    UnitB: LengthUnit,
{
    fn from(value: &'a Pt3<UnitB>) -> Self {
        Self::new(
            value.x_as::<UnitA>(),
            value.y_as::<UnitA>(),
            value.z_as::<UnitA>(),
        )
    }
}

#[cfg(feature = "nalgebra")]
impl From<&na::Point3<f64>> for Pt3<crate::Meters> {
    fn from(value: &na::Point3<f64>) -> Self {
        Self::new(
            crate::meters!(value.x),
            crate::meters!(value.y),
            crate::meters!(value.z),
        )
    }
}

#[cfg(feature = "nalgebra")]
impl From<na::Point3<f64>> for Pt3<crate::Meters> {
    fn from(value: na::Point3<f64>) -> Self {
        Self::new(
            crate::meters!(value.x),
            crate::meters!(value.y),
            crate::meters!(value.z),
        )
    }
}