askew 0.1.0

Angles (degrees, radians, and turns)
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

#[cfg(all(feature = "libm", not(feature = "std")))]
mod impl_libm;

#[cfg(all(feature = "libm", not(feature = "std")))]
#[allow(unused_imports)]
pub use impl_libm::*;

#[cfg(feature = "std")]
mod impl_std;

#[cfg(feature = "std")]
pub use impl_std::*;

/// An implementation of `rem_euclid` that is const-compatible.
#[inline]
pub const fn rem_euclid_f32_const(x: f32, y: f32) -> f32 {
    let r = x % y;
    if r < 0.0 { r + y.abs() } else { r }
}

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

    #[track_caller]
    fn compare_v_stdlib(x: f32, y: f32) {
        let expected = x.rem_euclid(y);
        let actual = rem_euclid_f32_const(x, y);
        assert!(
            (expected - actual).abs() < f32::EPSILON,
            "Expected: {expected}, Actual: {actual}"
        );
    }

    #[test]
    #[allow(clippy::float_cmp)]
    fn test_rem_euclid_f32_const() {
        compare_v_stdlib(5.0, 2.0);
        compare_v_stdlib(-1.0, 3.0);
        compare_v_stdlib(7.0, 4.0);
        compare_v_stdlib(-5.0, 3.0);

        // Test with negative y values
        compare_v_stdlib(3.0, -2.0);
        compare_v_stdlib(-3.0, -2.0);
        compare_v_stdlib(5.0, -3.0);
        compare_v_stdlib(-5.0, -3.0);

        // Test with zero
        compare_v_stdlib(0.0, 3.0);
        compare_v_stdlib(0.0, -3.0);

        // Test with y = 1 and y = -1
        compare_v_stdlib(7.0, 1.0);
        compare_v_stdlib(7.0, -1.0);

        // Test with x = y and x = -y
        compare_v_stdlib(2.0, 2.0);
        compare_v_stdlib(-2.0, 2.0);
        compare_v_stdlib(2.0, -2.0);
        compare_v_stdlib(-2.0, -2.0);
    }
}