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
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
// SPDX-License-Identifier: MIT
// Copyright 2023 IROX Contributors

///
/// Matches (struct, units, default) to make a new basic struct

#[macro_export]
macro_rules! basic_unit {
    ($struct_type:ident, $units_type: ident, $default_units: ident) => {
        #[derive(Debug, Clone, Copy, Default)]
        pub struct $struct_type {
            value: f64,
            units: $units_type,
        }

        impl $struct_type {
            #[must_use]
            pub const fn new(value: f64, units: $units_type) -> Self {
                Self { value, units }
            }

            #[must_use]
            pub fn value(&self) -> f64 {
                self.value
            }

            #[must_use]
            pub fn units(&self) -> $units_type {
                self.units
            }
        }

        impl $crate::units::UnitStruct<$units_type> for $struct_type {
            fn new(value: f64, units: $units_type) -> Self {
                Self { value, units }
            }

            fn value(&self) -> f64 {
                self.value
            }

            fn units(&self) -> $units_type {
                self.units
            }
        }

        impl core::ops::Add for $struct_type {
            type Output = $struct_type;

            fn add(self, rhs: Self) -> Self::Output {
                let val = $crate::units::Unit::<$units_type>::as_unit(&rhs, self.units()).value();
                $crate::units::UnitStruct::<$units_type>::new(self.value() + val, self.units())
            }
        }

        impl core::ops::Add for &$struct_type {
            type Output = $struct_type;

            fn add(self, rhs: Self) -> Self::Output {
                let val = $crate::units::Unit::<$units_type>::as_unit(rhs, self.units()).value();
                $crate::units::UnitStruct::<$units_type>::new(self.value() + val, self.units())
            }
        }

        impl core::ops::Add<&Self> for &$struct_type {
            type Output = $struct_type;

            fn add(self, rhs: &Self) -> Self::Output {
                let val = $crate::units::Unit::<$units_type>::as_unit(*rhs, self.units()).value();
                $crate::units::UnitStruct::<$units_type>::new(self.value() + val, self.units())
            }
        }

        impl core::ops::AddAssign for $struct_type {
            fn add_assign(&mut self, rhs: Self) {
                let val = $crate::units::Unit::<$units_type>::as_unit(&rhs, self.units()).value();
                self.value += val;
            }
        }

        impl core::ops::Sub for $struct_type {
            type Output = $struct_type;

            fn sub(self, rhs: Self) -> Self::Output {
                let val = $crate::units::Unit::<$units_type>::as_unit(&rhs, self.units()).value();
                $crate::units::UnitStruct::<$units_type>::new(self.value() - val, self.units())
            }
        }

        impl<'a> core::ops::Sub<&'a $struct_type> for &'a $struct_type {
            type Output = $struct_type;

            fn sub(self, rhs: Self) -> Self::Output {
                let val = $crate::units::Unit::<$units_type>::as_unit(rhs, self.units()).value();
                $crate::units::UnitStruct::<$units_type>::new(self.value() - val, self.units())
            }
        }

        impl core::ops::SubAssign for $struct_type {
            fn sub_assign(&mut self, rhs: Self) {
                let val = $crate::units::Unit::<$units_type>::as_unit(&rhs, self.units()).value();
                self.value -= val;
            }
        }

        impl core::ops::Div<f64> for $struct_type {
            type Output = $struct_type;

            fn div(self, rhs: f64) -> Self::Output {
                $crate::units::UnitStruct::<$units_type>::new(self.value() / rhs, self.units())
            }
        }

        impl core::ops::Div for $struct_type {
            type Output = f64;

            fn div(self, rhs: Self) -> Self::Output {
                let upper = self.value();
                let lower = $crate::units::Unit::<$units_type>::as_unit(&rhs, self.units()).value();
                upper / lower
            }
        }

        impl core::ops::DivAssign<f64> for $struct_type {
            fn div_assign(&mut self, rhs: f64) {
                self.value /= rhs
            }
        }

        impl core::ops::Mul<f64> for $struct_type {
            type Output = $struct_type;

            fn mul(self, rhs: f64) -> Self::Output {
                $crate::units::UnitStruct::<$units_type>::new(self.value() * rhs, self.units())
            }
        }

        impl core::ops::Mul<f64> for &$struct_type {
            type Output = $struct_type;

            fn mul(self, rhs: f64) -> Self::Output {
                $crate::units::UnitStruct::<$units_type>::new(self.value() * rhs, self.units())
            }
        }
        impl core::ops::Mul<&$struct_type> for f64 {
            type Output = $struct_type;

            fn mul(self, rhs: &$struct_type) -> Self::Output {
                rhs * self
            }
        }
        impl core::ops::Mul<$struct_type> for f64 {
            type Output = $struct_type;

            fn mul(self, rhs: $struct_type) -> Self::Output {
                rhs * self
            }
        }

        impl core::ops::MulAssign<f64> for $struct_type {
            fn mul_assign(&mut self, rhs: f64) {
                self.value *= rhs
            }
        }

        impl core::cmp::PartialOrd<$struct_type> for $struct_type {
            fn partial_cmp(&self, rhs: &$struct_type) -> Option<core::cmp::Ordering> {
                let val = $crate::units::Unit::<$units_type>::as_unit(rhs, self.units()).value();
                self.value().partial_cmp(&val)
            }
        }

        impl core::cmp::PartialEq<$struct_type> for $struct_type {
            fn eq(&self, rhs: &$struct_type) -> bool {
                if let Some(val) = self.partial_cmp(rhs) {
                    return val == core::cmp::Ordering::Equal;
                }
                false
            }
        }

        pub const ZERO: $struct_type = $struct_type::new(0.0, $units_type::$default_units);
    };
}

///
/// Trait to allow the direct conversion of a unit scalar to another unit scalar
pub trait FromUnits<T> {
    /// Converts the value with unit units into this (self) unit
    fn from(&self, value: T, units: Self) -> T;
}

///
/// Represents a Value/Unit pairing
pub trait UnitStruct<T>: Unit<T> {
    /// Creates a new type
    fn new(value: f64, units: T) -> Self
    where
        Self: Sized;

    /// Returns the value of this struct
    fn value(&self) -> f64;

    /// Returns the unit type of this struct
    fn units(&self) -> T;
}

///
/// Trait to provide access to unit conversions
pub trait Unit<T> {
    #[must_use]
    fn as_unit(&self, unit: T) -> Self
    where
        Self: Sized;
}

pub mod angle;
pub mod compass;
pub mod datasize;
pub mod duration;
pub mod length;
pub mod speed;
pub mod temperature;