dana 0.4.0

Compile-time dimensional analysis via generic types.
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
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

use num_traits::Inv;
use dana::{assert_qty_approx, prelude::*, symbols::basic::*};


#[test]
pub fn test_macros() {
    //  Start with a basic length unit, and ensure `unit!` correctly
    //      produces one.
    let u: Length = m;
    assert_eq!(u.dimension(), u.inv().inv().dimension());

    //  Confirm that `utype!` produces types that agree.
    let _: utype!(L) = u;

    //  Check implicitly-positive exponents.
    let _: utype!(L^ 1) = u;
    let _: utype!(L^ 2) = u.squared();
    let _: utype!(L^ 3) = u.cubed();
    // let _: utype!(L^ 4) = u.pow(4.0);
    // let _: utype!(L^ 2.0) = u.pow(2.0);

    //  Check explicitly-positive exponents.
    let _: utype!(L^+1) = u;
    let _: utype!(L^+2) = u.squared();
    let _: utype!(L^+3) = u.cubed();
    // let _: utype!(L^+4) = u.pow(4.0);
    // let _: utype!(L^+2.0) = u.pow(2.0);

    //  Check explicitly-negative exponents.
    let _: utype!(L^-1) = u.inv();
    let _: utype!(L^-2) = u.squared().inv();
    let _: utype!(L^-3) = u.cubed().inv();
    // let _: utype!(L^-4) = u.pow(4.0).inv();
    // let _: utype!(L^-2.0) = u.pow(2.0).inv();


    //  Use that unit for a quantity, and ensure the `qty!` macro correctly
    //      produces one.
    let q: Quantity<Length> = qty!(2.0 u);
    assert_eq!(q, q.inv().inv());

    //  Confirm that `qtype!` produces types that agree.
    let _: qtype!(L) = q;

    //  Check implicitly-positive exponents.
    let _: qtype!(L^ 1) = q;
    let _: qtype!(L^ 2) = q.squared();
    let _: qtype!(L^ 3) = q.cubed();
    let _: qtype!(L^ 4) = q.squared().squared();
    // let _: qtype!(L^ 4) = q.pow(4.0);
    // let _: qtype!(L^ 2.0) = q.pow(2.0);

    //  Check explicitly-positive exponents.
    let _: qtype!(L^+1) = q;
    let _: qtype!(L^+2) = q.squared();
    let _: qtype!(L^+3) = q.cubed();
    let _: qtype!(L^+4) = q.squared().squared();
    // let _: qtype!(L^+4) = q.pow(4.0);
    // let _: qtype!(L^+2.0) = q.pow(2.0);

    //  Check explicitly-negative exponents.
    let _: qtype!(L^-1) = q.inv();
    let _: qtype!(L^-2) = q.squared().inv();
    let _: qtype!(L^-3) = q.cubed().inv();
    let _: qtype!(L^-4) = q.squared().squared().inv();
    // let _: qtype!(L^-4) = q.pow(4.0).inv();
    // let _: qtype!(L^-2.0) = q.pow(2.0).inv();

    //  Check powers and roots.
    assert_eq!(q.squared(), q.pow::<2>());
    assert_eq!(q.squared(), q.pow::<8>().root::<4>());
    assert_eq!(q.pow::<6>(), q.pow::<2>().pow::<3>());
}


#[test]
fn test_quantity_norm() {
    fn test<U: UnitStep>(q1: Quantity<U>) {
        let q2 = q1.normalize();

        // eprintln!("{q1:>9e} -> {q2:>8.3}");
        assert_eq!(q2, q1, "inconsistent precision loss");
        assert_qty_approx!(<= 1e-6, q1, q2);
    }

    test(qty![4.321_e+9  mm/s]);
    test(qty![4.321_e+8  mm/s]);
    test(qty![4.321_e+7  mm/s]);
    test(qty![4.321_e+6  mm/s]);
    // eprintln!();
    test(qty![4.321_e+5  mm/s]);
    test(qty![4.321_e+4  mm/s]);
    test(qty![4.321_e+3  mm/s]);
    // eprintln!();
    test(qty![4.321_e+2  mm/s]);
    test(qty![4.321_e+1  mm/s]);
    test(qty![4.321_e00  mm/s]);
    // eprintln!();
    test(qty![4.321_e-1  mm/s]);
    test(qty![4.321_e-2  mm/s]);
    test(qty![4.321_e-3  mm/s]);
    // eprintln!();
    test(qty![4.321_e-4  mm/s]);
    test(qty![4.321_e-5  mm/s]);
    test(qty![4.321_e-6  mm/s]);
    // eprintln!();
    test(qty![4.321_e-7  mm/s]);
    test(qty![4.321_e-8  mm/s]);
    test(qty![4.321_e-9  mm/s]);
    // eprintln!();
    test(qty![4.321_e-10 mm/s]);
    test(qty![4.321_e-11 mm/s]);
    test(qty![4.321_e-12 mm/s]);
}


#[test]
fn test_unit_step() {
    fn test<U: UnitStep + PartialOrd + core::fmt::Debug>() {
        let base = U::base();

        assert!(base >= base.step_to_bottom());
        assert!(base <= base.step_to_top());
    }

    test::<Length>();
    test::<Mass>();
    test::<Time>();
    test::<Current>();
    test::<Temp>();
    test::<Amount>();
    test::<Intensity>();

    test::<Charge>();
    test::<Energy>();
    test::<Force>();
    test::<Frequency>();
    test::<One>();
    test::<Power>();
    test::<Pressure>();
    test::<Resistance>();
    test::<Voltage>();
}


#[test]
fn test_scale() {
    use dana::symbols::volume_si::*;

    let dist = Length::MilliMeter.quantity(50.0);

    let as_mm = dist.with_unit(Length::MilliMeter).value;
    let as_cm = dist.with_unit(Length::CentiMeter).value;

    assert_eq!(as_mm, as_cm * 10.0);

    //region Specialized cases for metric units.
    assert_eq!(qty![1.0 uL].cbrt(), qty![  1.0 mm]);
    assert_eq!(qty![1.0 mL].cbrt(), qty![ 10.0 mm]);
    assert_eq!(qty![1.0  L].cbrt(), qty![100.0 mm]);
    assert_eq!(qty![1.0 kL].cbrt(), qty![  1.0  m]);
    assert_eq!(qty![1.0 ML].cbrt(), qty![ 10.0  m]);
    assert_eq!(qty![1.0 GL].cbrt(), qty![100.0  m]);
    assert_eq!(qty![1.0 TL].cbrt(), qty![  1.0 km]);

    assert_eq!(qty![1.0 uL], qty![  1.0 mm].cubed());
    assert_eq!(qty![1.0 mL], qty![ 10.0 mm].cubed());
    assert_eq!(qty![1.0  L], qty![100.0 mm].cubed());
    assert_eq!(qty![1.0 kL], qty![  1.0  m].cubed());
    assert_eq!(qty![1.0 ML], qty![ 10.0  m].cubed());
    assert_eq!(qty![1.0 GL], qty![100.0  m].cubed());
    assert_eq!(qty![1.0 TL], qty![  1.0 km].cubed());
    //endregion

    //  General case for non-metric units.
    for unit in [
        Volume::Dram, Volume::FlOunce, Volume::Cup,
        Volume::Pint, Volume::Quart, Volume::Gallon,
    ] {
        assert_qty_approx!(
            qty![1.0 L in unit].cbrt(), qty![0.1 m],
            "incorrect cube root for {unit:?}",
        );
        assert_qty_approx!(
            qty![1.0 L in unit], qty![0.1 m].cubed(),
            "incorrect cube for {m:?} to {unit:?}",
        );
    }
}


#[test]
fn test_rescale() {
    //  Simple rescaled operations.
    let cm10_div_s2 = cm.rescale(10.0) / s.rescale(2.0);
    assert_eq!(qty![* [40.0 cm10_div_s2        ] in m/s], 2.0);
    assert_eq!(qty![* [40.0 cm10_div_s2 * 3.0 s] in m  ], 6.0);
    assert_eq!(qty![* [8.0 m / 40.0 cm10_div_s2] in s  ], 4.0);

    //  Exponentiated rescale.
    let m_x5 = m.rescale(5.0);
    assert_eq!(qty![2.0 m_x5],           qty![10.0 m]);
    assert_eq!(qty![2.0 m_x5].squared(), qty![10.0 m].squared());
    assert_eq!(qty![2.0 m_x5].cubed(),   qty![10.0 m].cubed());

    //  Rescaled exponentiation.
    let m2_x4 = unit!(m^2).rescale(4.0);
    assert_eq!(qty![36.0 m^2],        qty![9.0 m2_x4]);
    assert_eq!(qty![36.0 m^2].sqrt(), qty![9.0 m2_x4].sqrt());
    assert_eq!(qty![36.0 m^2].sqrt(), qty![6.0 m]);

    //region Multiple rescaled exponentiations.
    let m2_x3 = unit!(m^2).rescale(3.0);
    let m4_x9 = unit!(m^4).rescale(9.0);

    //  Sanity check: Unit relationships with base.
    assert_eq!(m2_x3.dimension(), (m*m).dimension());
    assert_eq!(m2_x3.scale(),     (m*m).scale() * 3.0);
    assert_eq!(m4_x9.dimension(), (m*m*m*m).dimension());
    assert_eq!(m4_x9.scale(),     (m*m*m*m).scale() * 9.0);

    //  Sanity check: Relationship between units.
    assert_eq!(m4_x9.dimension(), (m2_x3 * m2_x3).dimension());
    assert_eq!(m4_x9.scale(),     (m2_x3 * m2_x3).scale());

    //  Compare quantities.
    assert_eq!(qty![36.0 m^2  ],        qty![ 12.0 m2_x3]);
    assert_eq!(qty![36.0 m4_x9],        qty![324.0 m^4  ]);
    assert_eq!(qty![36.0 m4_x9].sqrt(), qty![  6.0 m2_x3]);
    assert_eq!(qty![36.0 m4_x9],        qty![  6.0 m2_x3].squared());
    //endregion
}