munum 0.2.0

Micro 3D Math Library
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

//! Float type helpers.

use crate::{Matrix, Quaternion};
use num::{traits::{float::FloatCore, NumAssign, NumCast}, Zero};

/// Standard tolerance epsilon
pub const EPSILON: f32 = 128. * f32::EPSILON;

/// Returns a standard tolerance epsilon
pub fn epsilon<T: NumCast + Zero>() -> T {
    NumCast::from(EPSILON).unwrap_or(T::zero())
}

/// Trait for float operations
pub trait FloatOps: Copy {
    /// Returns arc cosine of self.
    fn acos(self) -> Self;

    /// Returns cosine of self.
    fn cos(self) -> Self;

    /// Returns sine of self.
    fn sin(self) -> Self;

    /// Returns square root of self.
    fn sqrt(self) -> Self;

    /// Returns tangent of self.
    fn tan(self) -> Self;
}

#[cfg(all(any(feature = "std", feature = "libm"), not(all(target_arch = "wasm32", feature = "jsmath"))))]
impl<T: num::traits::Float> FloatOps for T {
    #[inline]
    fn acos(self) -> T {
        T::acos(self)
    }

    #[inline]
    fn cos(self) -> T {
        T::cos(self)
    }

    #[inline]
    fn sin(self) -> T {
        T::sin(self)
    }

    #[inline]
    fn sqrt(self) -> T {
        T::sqrt(self)
    }

    #[inline]
    fn tan(self) -> T {
        T::tan(self)
    }
}

/// Trait for checking if 2 floats or float arrays are equal within an epsilon.
pub trait FloatEq<T: Copy> {
    /// Checks if self equals to RHS within an epsilon.
    /// # Examples
    /// ```
    /// # use munum::FloatEq;
    /// assert!(1_f32.float_eq(1.000001, 0.0001));
    /// assert!(!1_f32.float_eq(1.1, 0.0001));
    /// ```
    fn float_eq(&self, rhs: Self, epsilon: T) -> bool;
}

impl FloatEq<f32> for f32 {
    fn float_eq(&self, rhs: Self, epsilon: f32) -> bool {
        FloatCore::abs(*self - rhs) < epsilon
    }
}

impl FloatEq<f64> for f64 {
    fn float_eq(&self, rhs: Self, epsilon: f64) -> bool {
        FloatCore::abs(*self - rhs) < epsilon
    }
}

impl<T: Copy, V: Copy + FloatEq<T>> FloatEq<T> for &[V] {
    fn float_eq(&self, rhs: Self, epsilon: T) -> bool {
        if self.len() != rhs.len() {
            return false;
        }

        for i in 0..self.len() {
            if !self[i].float_eq(rhs[i], epsilon) {
                return false;
            }
        }

        true
    }
}

impl<T: Copy + FloatEq<T> + NumAssign, const R: usize, const C: usize> FloatEq<T>
    for Matrix<T, R, C>
{
    #[inline]
    fn float_eq(&self, rhs: Self, epsilon: T) -> bool {
        self.as_ref().float_eq(rhs.as_ref(), epsilon)
    }
}

impl<T: Copy + FloatEq<T> + NumAssign> FloatEq<T> for Quaternion<T> {
    #[inline]
    fn float_eq(&self, rhs: Self, epsilon: T) -> bool {
        self.as_ref().float_eq(rhs.as_ref(), epsilon)
    }
}

/// Asserts two floats or float arrays are equal within an epsilon.
/// # Examples
/// ```
/// # use munum::assert_float_eq;
/// assert_float_eq!(1.0, 1.000001, 0.0001);
/// ```
#[macro_export]
macro_rules! assert_float_eq {
    ($left:expr, $right:expr) => {
        assert_float_eq!(($left), ($right), $crate::float::epsilon())
    };

    ($left:expr, $right:expr, $epsilon:expr) => {
        match (&($left), &($right), ($epsilon)) {
            (left_val, right_val, epsilon_val) => {
                if !$crate::FloatEq::float_eq(left_val, *right_val, epsilon_val) {
                    panic!(
                        "assertion failed: `left.float_eq(right, epsilon)` \
                                (left: `{:?}`, right: `{:?}`, epsilon: `{:?}`)",
                        *left_val, *right_val, epsilon_val
                    );
                }
            }
        }
    };
}