hipparchus-az 0.1.2

Utility for angle representation, conversion and 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

use crate::modulo::{Modulo, Remainder};

/// Trait for angle in radians
pub trait Radians
{
    /// The default modulo value for radians
    const MOD_RADIANS: Self;

    /// To normalize an angle in radians with the given remainder algorithm
    fn norm_radians(&self, re: Remainder) -> Self;
}

#[macro_export]
macro_rules! impl_radians
{
    ($ty:ty, $modr:expr) =>
    {
        impl Radians for $ty
        {
            const MOD_RADIANS: Self = $modr;

            fn norm_radians(&self, re: Remainder) -> Self
            {
                match re
                {
                    Remainder::Euclidean => self.umod($modr),
                    Remainder::Symmetry => self.smod($modr),
                    Remainder::InvertedSymmetry => self.smod(-$modr),
                }
            }
        }
    }
}

impl_radians!(f64, std::f64::consts::TAU);
impl_radians!(f32, std::f32::consts::TAU);

#[cfg(test)]
mod tests 
{
    use super::*;
    use rstest::*;
    use core::fmt::Debug;
    use float_cmp::{ assert_approx_eq, ApproxEq };

    #[rstest]
    #[case(-std::f64::consts::PI, Remainder::Euclidean, std::f64::consts::PI)]
    #[case(-std::f64::consts::PI, Remainder::Symmetry, -std::f64::consts::PI)]
    #[case(-std::f64::consts::PI, Remainder::InvertedSymmetry, std::f64::consts::PI)]
    #[case(-std::f32::consts::PI, Remainder::Euclidean, std::f32::consts::PI)]
    #[case(-std::f32::consts::PI, Remainder::Symmetry, -std::f32::consts::PI)]
    #[case(-std::f32::consts::PI, Remainder::InvertedSymmetry, std::f32::consts::PI)]
    fn test_radians_norm<T>(#[case] v: T, #[case] re: Remainder, #[case] expected: T) where
        T: Copy + Debug + Radians + ApproxEq
    {
        let actual = v.norm_radians(re);
        assert_approx_eq!(T, expected, actual);
    }
}