micromath 2.1.0

Embedded-friendly math library featuring fast floating point approximations (with small code size) for common arithmetic operations, trigonometry, 2D/3D vector types, statistical analysis, and quaternions. Optimizes for performance and small code size at the cost of precision.
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

//! Returns a number that represents the sign of `self`.

use super::F32;

impl F32 {
    /// Returns a number that represents the sign of `self`.
    ///
    /// * `1.0` if the number is positive, `+0.0` or `INFINITY`
    /// * `-1.0` if the number is negative, `-0.0` or `NEG_INFINITY`
    /// * `NAN` if the number is `NAN`
    pub fn signum(self) -> Self {
        if self.is_nan() {
            Self::NAN
        } else {
            F32(1.0).copysign(self)
        }
    }
}

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

    #[test]
    fn sanity_check() {
        assert_eq!(F32::INFINITY.signum(), F32(1.0));
        assert_eq!(F32(0.0).signum(), F32(1.0));
        assert_eq!(F32(1.0).signum(), F32(1.0));
        assert_eq!(F32::NEG_INFINITY.signum(), F32(-1.0));
        assert_eq!(F32(-0.0).signum(), F32(-1.0));
        assert_eq!(F32(-1.0).signum(), F32(-1.0));
    }
}