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
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

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

/// Trait for angle in degrees
pub trait Degrees
{
    /// The default modulo value for degrees
    const MOD_DEGREES: Self;

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

#[macro_export]
macro_rules! impl_degrees_signed
{
    ($ty:ty, $modd:expr) =>
    {
        impl Degrees for $ty
        {
            const MOD_DEGREES: Self = $modd;

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

impl_degrees_signed!(f64, 360.0);
impl_degrees_signed!(f32, 360.0);
impl_degrees_signed!(i128, 360);
impl_degrees_signed!(i64, 360);
impl_degrees_signed!(i32, 360);
impl_degrees_signed!(i16, 360);

#[macro_export]
macro_rules! impl_degrees_unsigned
{
    ($ty:ty, $modd:expr) =>
    {
        impl Degrees for $ty
        {
            const MOD_DEGREES: Self = $modd;

            fn norm_degrees(&self, re: Remainder) -> Self
            {
                match re
                {
                    Remainder::Euclidean => self.rem_euclid($modd),
                    Remainder::Symmetry => panic!("Invalid modulo for degrees in Symmetry mode"),
                    Remainder::InvertedSymmetry  => panic!("Invalid modulo for degrees in InvertedSymmetry mode"),
                }
            }
        }
    }
}

impl_degrees_unsigned!(u128, 360);
impl_degrees_unsigned!(u64, 360);
impl_degrees_unsigned!(u32, 360);
impl_degrees_unsigned!(u16, 360);

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

    #[rstest]
    #[case(-180i128, Remainder::Euclidean, 180i128)]
    #[case(-180i128, Remainder::Symmetry, -180i128)]
    #[case(-180i128, Remainder::InvertedSymmetry, 180i128)]
    #[case(-180i64, Remainder::Euclidean, 180i64)]
    #[case(-180i64, Remainder::Symmetry, -180i64)]
    #[case(-180i64, Remainder::InvertedSymmetry, 180i64)]
    #[case(-180i32, Remainder::Euclidean, 180i32)]
    #[case(-180i32, Remainder::Symmetry, -180i32)]
    #[case(-180i32, Remainder::InvertedSymmetry, 180i32)]
    #[case(-180i16, Remainder::Euclidean, 180i16)]
    #[case(-180i16, Remainder::Symmetry, -180i16)]
    #[case(-180i16, Remainder::InvertedSymmetry, 180i16)]
    fn test_degrees_norm_signed<T>(#[case] v: T, #[case] re: Remainder, #[case] expected: T) where
        T: Copy + Debug + Degrees + PartialEq
    {
        let actual = v.norm_degrees(re);
        assert_eq!(expected, actual);
    }

    #[rstest]
    #[case(360u128, Remainder::Euclidean, 0u128)]
    #[case(360u64, Remainder::Euclidean, 0u64)]
    #[case(360u32, Remainder::Euclidean, 0u32)]
    #[case(360u16, Remainder::Euclidean, 0u16)]
    fn test_degrees_norm_unsigned<T>(#[case] v: T, #[case] re: Remainder, #[case] expected: T) where
        T: Copy + Debug + Degrees + PartialEq
    {
        let actual = v.norm_degrees(re);
        assert_eq!(expected, actual);
    }

    #[rstest]
    #[case(360u128, Remainder::Symmetry, 0u128)]
    #[case(360u64, Remainder::Symmetry, 0u64)]
    #[case(360u32, Remainder::Symmetry, 0u32)]
    #[case(360u16, Remainder::Symmetry, 0u16)]
    #[case(360u128, Remainder::InvertedSymmetry, 0u128)]
    #[case(360u64, Remainder::InvertedSymmetry, 0u64)]
    #[case(360u32, Remainder::InvertedSymmetry, 0u32)]
    #[case(360u16, Remainder::InvertedSymmetry, 0u16)]
    #[should_panic]
    fn test_degrees_norm_panic<T>(#[case] v: T, #[case] re: Remainder, #[case] expected: T) where
        T: Copy + Debug + Degrees + PartialEq
    {
        let actual = v.norm_degrees(re);
        assert_eq!(expected, actual);
    }

    #[rstest]
    #[case(-180.0f64, Remainder::Euclidean, 180.0f64)]
    #[case(-180.0f64, Remainder::Symmetry, -180.0f64)]
    #[case(-180.0f64, Remainder::InvertedSymmetry, 180.0f64)]
    #[case(-180.0f32, Remainder::Euclidean, 180.0f32)]
    #[case(-180.0f32, Remainder::Symmetry, -180.0f32)]
    #[case(-180.0f32, Remainder::InvertedSymmetry, 180.0f32)]
    fn test_degrees_norm_fp<T>(#[case] v: T, #[case] re: Remainder, #[case] expected: T) where
        T: Copy + Debug + Degrees + ApproxEq
    {
        let actual = v.norm_degrees(re);
        assert_approx_eq!(T, expected, actual);
    }
}