irox_units/units/
mod.rs

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
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
// SPDX-License-Identifier: MIT
// Copyright 2023 IROX Contributors

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

macro_rules! impl_unitstruct {
    ($struct_type:ident, $units_type: ident, $($slf:ty)+) => {
        impl $crate::units::UnitStruct<$units_type> for $($slf)+ {
            type Output = $struct_type;

            fn new(value: f64, units: $units_type) -> $struct_type {
                $struct_type { value, units }
            }

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

            fn units(&self) -> $units_type {
                self.units
            }
        }
        impl Unit<$units_type> for $($slf)+ {
            type Output = $struct_type;
            fn as_unit(&self, units: $units_type) -> $struct_type
            where
                Self: Sized,
            {
                $struct_type {
                    value: units.from(self.value, self.units),
                    units,
                }
            }
        }
    };
}

macro_rules! impl_sub {
    ($($out:ty)+, $units_type:ident, $($sub:ty)+, $($slf:ty)+) => {
        impl<'a> core::ops::Sub<$($sub)+> for $($slf)+ {
            type Output = $($out)+;

            fn sub(self, rhs: $($sub)+) -> $($out)+ {
                let val = <$($sub)+ as $crate::units::Unit::<$units_type>>::as_unit(&rhs, self.units()).value();
                <$($slf)+ as $crate::units::UnitStruct::<$units_type>>::new(self.value() - val, self.units())
            }
        }
    };
}
macro_rules! impl_add {
    ($($out:ty)+, $units_type:ident, $($add:ty)+, $($slf:ty)+) => {
        impl<'a> core::ops::Add<$($add)+> for $($slf)+ {
            type Output = $($out)+;

            fn add(self, rhs: $($add)+) -> $($out)+ {
                let val = <$($add)+ as $crate::units::Unit::<$units_type>>::as_unit(&rhs, self.units()).value();
                <$($slf)+ as $crate::units::UnitStruct::<$units_type>>::new(self.value() + val, self.units())
            }
        }
    };
}
macro_rules! impl_subassign {
    ($($out:ty)+, $units_type:ident, $($sub:ty)+, $($slf:ty)+) => {
        impl<'a> core::ops::SubAssign<$($sub)+> for $($slf)+ {
            fn sub_assign(&mut self, rhs: $($sub)+) {
                let val = <$($sub)+ as $crate::units::Unit::<$units_type>>::as_unit(&rhs, self.units()).value();
                self.value -= val;
            }

        }
    };
}
macro_rules! impl_addassign {
    ($($out:ty)+, $units_type:ident, $($add:ty)+, $($slf:ty)+) => {
        impl<'a> core::ops::AddAssign<$($add)+> for $($slf)+ {
            fn add_assign(&mut self, rhs: $($add)+) {
                let val = <$($add)+ as $crate::units::Unit::<$units_type>>::as_unit(&rhs, self.units()).value();
                self.value += val;
            }
        }
    };
}
macro_rules! impl_div {
    ($($out:ty)+, $units_type:ident, $($div:ty)+, $($slf:ty)+) => {
        impl<'a> core::ops::Div<$($div)+> for $($slf)+ {
            type Output = $($out)+ ;
            fn div(self, rhs: $($div)+) -> $($out)+  {
                <$($slf)+ as $crate::units::UnitStruct::<$units_type>>::new(self.value() / rhs, self.units())
            }
        }
        impl<'a> core::ops::Div<$($slf)+> for $($slf)+ {
            type Output = f64;
            fn div(self, rhs: $($slf)+) -> Self::Output {
                let upper = self.value();
                let lower = <$($slf)+ as $crate::units::Unit::<$units_type>>::as_unit(&rhs, self.units()).value();
                upper / lower
            }
        }
    };
}

macro_rules! impl_divassign {
    ($($out:ty)+, $units_type:ident, $($div:ty)+, $($slf:ty)+) => {
        impl<'a> core::ops::DivAssign<$($div)+> for $($slf)+ {
            fn div_assign(&mut self, rhs: $($div)+) {
                self.value /= rhs;
            }
        }
    };
}

macro_rules! impl_mul {
    ($($out:ty)+, $units_type:ident, $($mul:ty)+, $($slf:ty)+) => {
         impl<'a> core::ops::Mul<$($mul)+> for $($slf)+ {
            type Output = $($out)+ ;
            fn mul(self, rhs: $($mul)+) -> $($out)+  {
                <$($slf)+ as $crate::units::UnitStruct::<$units_type>>::new(self.value() * rhs, self.units())
            }
        }
        impl<'a> core::ops::Mul<$($slf)+> for $($slf)+ {
            type Output = $($mul)+;
            fn mul(self, rhs: $($slf)+) -> Self::Output {
                let upper = self.value();
                let lower = <$($slf)+ as $crate::units::Unit::<$units_type>>::as_unit(&rhs, self.units()).value();
                upper * lower
            }
        }
        impl<'a> core::ops::Mul<$($slf)+> for f64 {
            type Output = $($out)+;
            fn mul(self, rhs: $($slf)+) -> Self::Output {
                rhs * self
            }
        }
    };
}
macro_rules! impl_mulassign {
    ($($out:ty)+, $units_type:ident, $($mul:ty)+, $($slf:ty)+) => {
        impl<'a> core::ops::MulAssign<$($mul)+> for $($slf)+ {
            fn mul_assign(&mut self, rhs: $($mul)+) {
                self.value *= rhs;
            }
        }
        // impl core::ops::MulAssign<f64> for $struct_type {
        //     fn mul_assign(&mut self, rhs: f64) {
        //         self.value *= rhs
        //     }
        // }
    };
}

macro_rules! impl_op {
    ($op:ident, $units_type:ident, $($operand:ty)+) => {
        $op!($($operand)+, $units_type, $($operand)+, $($operand)+);
        $op!($($operand)+, $units_type, $($operand)+, &$($operand)+);
        $op!($($operand)+, $units_type, $($operand)+, &mut $($operand)+);
        $op!($($operand)+, $units_type, &$($operand)+, $($operand)+);
        $op!($($operand)+, $units_type, &$($operand)+, &$($operand)+);
        $op!($($operand)+, $units_type, &$($operand)+, &mut $($operand)+);
        $op!($($operand)+, $units_type, &mut $($operand)+, $($operand)+);
        $op!($($operand)+, $units_type, &mut $($operand)+, &$($operand)+);
        $op!($($operand)+, $units_type, &mut $($operand)+, &mut $($operand)+);
    };
}
macro_rules! impl_mutop {
    ($op:ident, $units_type:ident, $($operand:ty)+) => {
        $op!($($operand)+, $units_type, $($operand)+, $($operand)+);
        $op!($($operand)+, $units_type, $($operand)+, &mut $($operand)+);
        $op!($($operand)+, $units_type, &$($operand)+, $($operand)+);
        $op!($($operand)+, $units_type, &$($operand)+, &mut $($operand)+);
        $op!($($operand)+, $units_type, &mut $($operand)+, $($operand)+);
        $op!($($operand)+, $units_type, &mut $($operand)+, &mut $($operand)+);
    };
}

#[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_unitstruct!($struct_type, $units_type, $struct_type);
        impl_unitstruct!($struct_type, $units_type, &$struct_type);
        impl_unitstruct!($struct_type, $units_type, &mut $struct_type);

        impl_op!(impl_sub, $units_type, $struct_type);
        impl_mutop!(impl_subassign, $units_type, $struct_type);
        impl_op!(impl_add, $units_type, $struct_type);
        impl_mutop!(impl_addassign, $units_type, $struct_type);
        impl_div!($struct_type, $units_type, f64, $struct_type);
        impl_div!($struct_type, $units_type, f64, &$struct_type);
        impl_div!($struct_type, $units_type, f64, &mut $struct_type);
        impl_divassign!($struct_type, $units_type, f64, $struct_type);
        impl_divassign!($struct_type, $units_type, f64, &mut $struct_type);
        impl_mul!($struct_type, $units_type, f64, $struct_type);
        impl_mul!($struct_type, $units_type, f64, &$struct_type);
        impl_mul!($struct_type, $units_type, f64, &mut $struct_type);
        impl_mulassign!($struct_type, $units_type, f64, $struct_type);
        impl_mulassign!($struct_type, $units_type, f64, &mut $struct_type);

        impl core::cmp::PartialOrd<$struct_type> for $struct_type {
            fn partial_cmp(&self, rhs: &$struct_type) -> Option<core::cmp::Ordering> {
                Some(self.cmp(rhs))
            }
        }
        impl core::cmp::Ord for $struct_type {
            fn cmp(&self, other: &Self) -> core::cmp::Ordering {
                self.value.total_cmp(&other.as_unit(self.units).value)
            }
        }
        impl core::cmp::Eq for $struct_type {}

        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> {
    type Output;

    /// Creates a new type
    fn new(value: f64, units: T) -> <Self as UnitStruct<T>>::Output;

    /// 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> {
    type Output;
    #[must_use]
    fn as_unit(&self, unit: T) -> Self::Output
    where
        Self: Sized;
}

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