bxvl 0.1.1

A datatype library that allows for measurement unit association, conversion, and operations for values.
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
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157

use std::fmt::Display;

use super::{BaseUnit, Convert, Metric, UnitFrequency, UnitTime};

impl Display for UnitFrequency {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "{}Hz", self.get_metric().as_str())
    }
}

impl From<UnitFrequency> for String {
    fn from(val: UnitFrequency) -> Self {
        val.to_string()
    }
}

impl Convert<UnitFrequency> for UnitFrequency {
    /// Returns the `f64` multiplier to convert a `Value`
    fn convert(&self, other: &UnitFrequency) -> f64 {
        self.scale() / other.scale()
    }
}

impl Convert<UnitTime> for UnitFrequency {
    /// Returns the `f64` multiplier to convert a `Value`
    fn convert(&self, other: &UnitTime) -> f64 {
        (self.scale() / other.scale()) * (self.base() / other.base())
    }
}

impl BaseUnit for UnitFrequency {
    /// Returns the metric scaler of an SI unit
    fn scale(&self) -> f64 {
        match self {
            Self::Hertz(m) => m.scale(),
        }
    }

    /// Returns the `Metric` prefix for the unit
    fn get_metric(&self) -> Metric {
        match self {
            Self::Hertz(m) => *m,
        }
    }

    fn base(&self) -> f64 {
        1.0
    }
}

#[cfg(test)]
mod frequency_testing {
    use crate::units::{BaseUnit, Metric, UnitFrequency};

    #[test]
    fn unit_angle_base_comparison() {
        assert!(UnitFrequency::Hertz(Metric::None).base() == 1.0);
    }

    #[test]
    fn unit_angle_to_string() {
        for i in [
            (UnitFrequency::Hertz(Metric::Ronto), "rHz"),
            (UnitFrequency::Hertz(Metric::Ronna), "RHz"),
            (UnitFrequency::Hertz(Metric::Quetta), "QHz"),
            (UnitFrequency::Hertz(Metric::Quecto), "qHz"),
            (UnitFrequency::Hertz(Metric::Atto), "aHz"),
            (UnitFrequency::Hertz(Metric::Centi), "cHz"),
            (UnitFrequency::Hertz(Metric::Deca), "daHz"),
            (UnitFrequency::Hertz(Metric::Deci), "dHz"),
            (UnitFrequency::Hertz(Metric::Exa), "EHz"),
            (UnitFrequency::Hertz(Metric::Femto), "fHz"),
            (UnitFrequency::Hertz(Metric::Giga), "GHz"),
            (UnitFrequency::Hertz(Metric::Hecto), "hHz"),
            (UnitFrequency::Hertz(Metric::Kilo), "kHz"),
            (UnitFrequency::Hertz(Metric::Mega), "MHz"),
            (UnitFrequency::Hertz(Metric::Micro), "μHz"),
            (UnitFrequency::Hertz(Metric::Milli), "mHz"),
            (UnitFrequency::Hertz(Metric::Nano), "nHz"),
            (UnitFrequency::Hertz(Metric::None), "Hz"),
            (UnitFrequency::Hertz(Metric::Peta), "PHz"),
            (UnitFrequency::Hertz(Metric::Pico), "pHz"),
            (UnitFrequency::Hertz(Metric::Tera), "THz"),
            (UnitFrequency::Hertz(Metric::Yocto), "yHz"),
            (UnitFrequency::Hertz(Metric::Yotta), "YHz"),
            (UnitFrequency::Hertz(Metric::Zepto), "zHz"),
            (UnitFrequency::Hertz(Metric::Zetta), "ZHz"),
        ] {
            assert_eq!(&i.0.to_string(), i.1);
            let t: String = i.0.into();
            assert_eq!(t, i.1.to_string());
        }
    }

    #[test]
    fn unit_angle_scale() {
        for i in [
            (UnitFrequency::Hertz(Metric::Ronto), Metric::Ronto),
            (UnitFrequency::Hertz(Metric::Ronna), Metric::Ronna),
            (UnitFrequency::Hertz(Metric::Quetta), Metric::Quetta),
            (UnitFrequency::Hertz(Metric::Quecto), Metric::Quecto),
            (UnitFrequency::Hertz(Metric::Atto), Metric::Atto),
            (UnitFrequency::Hertz(Metric::Centi), Metric::Centi),
            (UnitFrequency::Hertz(Metric::Deca), Metric::Deca),
            (UnitFrequency::Hertz(Metric::Deci), Metric::Deci),
            (UnitFrequency::Hertz(Metric::Exa), Metric::Exa),
            (UnitFrequency::Hertz(Metric::Femto), Metric::Femto),
            (UnitFrequency::Hertz(Metric::Giga), Metric::Giga),
            (UnitFrequency::Hertz(Metric::Hecto), Metric::Hecto),
            (UnitFrequency::Hertz(Metric::Kilo), Metric::Kilo),
            (UnitFrequency::Hertz(Metric::Mega), Metric::Mega),
            (UnitFrequency::Hertz(Metric::Micro), Metric::Micro),
            (UnitFrequency::Hertz(Metric::Milli), Metric::Milli),
            (UnitFrequency::Hertz(Metric::Nano), Metric::Nano),
            (UnitFrequency::Hertz(Metric::None), Metric::None),
            (UnitFrequency::Hertz(Metric::Peta), Metric::Peta),
            (UnitFrequency::Hertz(Metric::Pico), Metric::Pico),
            (UnitFrequency::Hertz(Metric::Tera), Metric::Tera),
            (UnitFrequency::Hertz(Metric::Yocto), Metric::Yocto),
            (UnitFrequency::Hertz(Metric::Yotta), Metric::Yotta),
            (UnitFrequency::Hertz(Metric::Zepto), Metric::Zepto),
            (UnitFrequency::Hertz(Metric::Zetta), Metric::Zetta),
        ] {
            assert_eq!(i.0.get_metric(), i.1);
        }

        for i in [
            (UnitFrequency::Hertz(Metric::Ronto), 1.0e-27),
            (UnitFrequency::Hertz(Metric::Ronna), 1.0e27),
            (UnitFrequency::Hertz(Metric::Quetta), 1.0e30),
            (UnitFrequency::Hertz(Metric::Quecto), 1.0e-30),
            (UnitFrequency::Hertz(Metric::Atto), 1.0e-18),
            (UnitFrequency::Hertz(Metric::Centi), 0.01),
            (UnitFrequency::Hertz(Metric::Deca), 10.0),
            (UnitFrequency::Hertz(Metric::Deci), 0.1),
            (UnitFrequency::Hertz(Metric::Exa), 1.0e18),
            (UnitFrequency::Hertz(Metric::Femto), 1.0e-15),
            (UnitFrequency::Hertz(Metric::Giga), 1.0e9),
            (UnitFrequency::Hertz(Metric::Hecto), 100.0),
            (UnitFrequency::Hertz(Metric::Kilo), 1.0e3),
            (UnitFrequency::Hertz(Metric::Mega), 1.0e6),
            (UnitFrequency::Hertz(Metric::Micro), 1.0e-6),
            (UnitFrequency::Hertz(Metric::Milli), 0.001),
            (UnitFrequency::Hertz(Metric::Nano), 1.0e-9),
            (UnitFrequency::Hertz(Metric::None), 1.0),
            (UnitFrequency::Hertz(Metric::Peta), 1.0e15),
            (UnitFrequency::Hertz(Metric::Pico), 1.0e-12),
            (UnitFrequency::Hertz(Metric::Tera), 1.0e12),
            (UnitFrequency::Hertz(Metric::Yocto), 1.0e-24),
            (UnitFrequency::Hertz(Metric::Yotta), 1.0e24),
            (UnitFrequency::Hertz(Metric::Zepto), 1.0e-21),
            (UnitFrequency::Hertz(Metric::Zetta), 1.0e21),
        ] {
            assert_eq!(i.0.scale(), i.1);
        }
    }
}