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

#[test]
fn dim() {
    use dana::{
        prelude::*,
        quantity::QuantityAnon,
        symbols::{basic::*, dimensions::*},
    };

    //  Scalar.
    let _qty: QuantityAnon<dim!(1)> = qty![1.0 m/m as ?];
    let _qty: QuantityAnon<dim!(1*1)> = qty![1.0 m/m as ?];
    let _qty: QuantityAnon<dim!(_L^0)> = qty![1.0 m/m as ?];
    let _qty: QuantityAnon<dim!(1*_L^0)> = qty![1.0 m/m as ?];

    //  Positive exponents.
    let _qty: QuantityAnon<dim!(_L)> = qty![1.0 m as ?];
    let _qty: QuantityAnon<dim!(_L^1)> = qty![1.0 m as ?];
    let _qty: QuantityAnon<dim!(_L^2)> = qty![1.0 m^2 as ?];
    let _qty: QuantityAnon<dim!(_L*_L)> = qty![1.0 m^2 as ?];

    //  Negative exponents.
    let _qty: QuantityAnon<dim!(_L^-1)> = qty![1.0/m as ?];
    let _qty: QuantityAnon<dim!(_L^-1)> = qty![1.0 m^-1 as ?];
    let _qty: QuantityAnon<dim!(_L^-2)> = qty![1.0 m^-2 as ?];
    let _qty: QuantityAnon<dim!(_L^-2)> = qty![1.0/m^2 as ?];

    let _qty: QuantityAnon<dim!(_L^-2)> = qty![1.0/m/m as ?];
    let _qty: QuantityAnon<dim!(_L^-2)> = qty![1.0/m^2 as ?];
    let _qty: QuantityAnon<dim!(_L^-1 * _T)> = qty![1.0/m*s as ?];

    //  Combination form.
    let _qty: QuantityAnon<dim!(<3, 0, -1> * _L^-2 * _T)> = qty![1.0 m as ?];
}


#[test]
fn qty_invalid() {
    let test = trybuild::TestCases::new();

    test.compile_fail("tests/err_qty/*.rs");
}


#[test]
fn qty_valid() {
    use dana::{prelude::*, symbols::basic::*};

    //  Test basic definitions against fully-explicit types.
    let _qty: Quantity<L> = qty![1.0 m];
    let _qty: Quantity<L> = qty![1.0 m,];

    let _qty: Quantity<UnitSquared<L>> = qty![1.0 m^2];
    let _qty: Quantity<UnitMul<L, PerUnit<L>>> = qty![1.0 m * 1/m];
    let _qty: Quantity<UnitMul<L, PerUnit<L>>> = qty![1.0 m * 1/(m)];

    //  Test inverse-unit definitions.
    let _qty: Quantity<PerUnit<T>> = qty![1.0/s];
    let _qty: Quantity<PerUnit<PerUnit<T>>> = qty![1.0/1/s]; // TODO: Discourage?
    let _qty: Quantity<PerUnit<UnitSquared<L>>> = qty![1.0/m^2];
    let _qty: Quantity<UnitDiv<PerUnit<L>, T>> = qty![1.0/m/s];
    let _qty: Quantity<UnitMul<PerUnit<L>, M>> = qty![1.0/m*kg];

    //  Test sum definitions.
    assert_eq!(qty![250.0 cm], qty![2.0 m,  50.0 cm]);
    assert_eq!(qty![150.0 cm], qty![2.0 m, -50.0 cm]);
    // assert_eq!(qty![250.0 cm], qty![2.0 m, +50.0 cm]); // Forbidden by Rust.

    //  Test basic operations and signs.
    assert_eq!(qty![250.0 cm], qty![2.0 m +  50.0 cm]);
    assert_eq!(qty![150.0 cm], qty![2.0 m + -50.0 cm]);
    assert_eq!(qty![150.0 cm], qty![2.0 m -  50.0 cm]);
    assert_eq!(qty![250.0 cm], qty![2.0 m - -50.0 cm]);

    //  Test chained definition, multiplication, and conversion.
    assert_eq!(qty![6.0 m^2], qty![2.0 m * 3.0 m as L^2]);

    //  Test chained definition, addition, conversion, and deref with all
    //      combinations of recursion brackets.
    //  NOTE: Deref on multiple literals should probably not be encouraged, but
    //      to explicitly forbid it would likely cause more problems than being
    //      able to write confusing invocations could cause. Just use recursion
    //      brackets to make it clear.
    assert_eq!(qty![*   2.0 m  +  10.0 cm   in mm ], 2.1e3);
    assert_eq!(qty![*  [2.0 m] + [10.0 cm]  in mm ], 2.1e3);
    assert_eq!(qty![* [ 2.0 m  +  10.0 cm ] in mm ], 2.1e3);
    assert_eq!(qty![* [[2.0 m] + [10.0 cm]] in mm ], 2.1e3);
    assert_eq!(qty![*[  2.0 m  +  10.0 cm   in mm]], 2.1e3);
    assert_eq!(qty![*[ [2.0 m] + [10.0 cm]  in mm]], 2.1e3);
    assert_eq!(qty![*[[ 2.0 m  +  10.0 cm ] in mm]], 2.1e3);
    assert_eq!(qty![*[[[2.0 m] + [10.0 cm]] in mm]], 2.1e3);
    //               ^^^ 3-bit index of case.
}


#[test]
fn qty_ops() {
    use dana::{constants::*, prelude::*, symbols::{electrical::*, physics::*}};

    let v: Quantity<Voltage> = qty![3.3 V];
    let r: Quantity<Resistance> = qty![150.0 Ω];
    let i: Quantity<Current> = qty![v/r as _];

    assert_eq!(22.0, qty![*     i              in mA]);
    assert_eq!(22.0, qty![*     v  /        r  in mA]);
    assert_eq!(22.0, qty![*     v  / [150.0 Ω] in mA]);
    assert_eq!(22.0, qty![*[3.3 V] /        r  in mA]);
    assert_eq!(22.0, qty![*[3.3 V] / [150.0 Ω] in mA]);

    assert_eq!(
        qty![*[[9.80665 N] / GFORCE] as M * {CONST_C2} in kJ].floor(),
        89_875_517_873_681.0,
    );

    //  Test heavily mixed chains of operations.
    let accel: Quantity<Accel> = qty![30.0 cm/s/s];
    let added: f64 = 25.0;

    let _qty: Quantity<Force> = qty![
        1.0 kg, 50.0 g,
        * {CONST_C2} as (::dana::units::Energy)
        + {added} TJ
        / {CONST_C2} in (::dana::units::Mass::MetricTon)
        * {accel} as Force
        + 3.0 N
        + 1.0 Force::Newton
    ];
}


#[test]
fn qty_ops_adv() {
    use dana::{prelude::*, symbols::{basic::*, electrical::*}};

    let n = 5.0;
    let w_4: Quantity<Power> = qty![4.0 W];
    let kg_3: Quantity<Mass> = qty![3.0 kg];
    let m_s_12: Quantity<Speed> = qty![12.0 m/s];

    //  Test reuse of units.
    assert_eq!(qty![3.0 mW], qty![3e-3 w_4.unit]);
    assert_eq!(qty![3.0 kW], qty![3e+3 w_4.unit]);

    //  Test reuse of scalars.
    assert_eq!(qty![5e+3 W], qty![n kW]);
    assert_eq!(qty![5e+3 W], qty![{n} kW]);
    assert_eq!(qty![3e+3 W], qty![{kg_3.value} kW]);
    assert_eq!(qty![12e-3 W], qty![{m_s_12.value} mW]);

    //  Test entirely reused definitions, in combination with operations.
    assert_eq!(qty![36.0 kg*(m/s)], qty![
        {kg_3.value} kg_3.unit
        * {m_s_12.value} m_s_12.unit
        as Momentum
    ]);
    assert_eq!(qty![36.0 kg*(m/s)], qty![
        {m_s_12.value} kg_3.unit
        * {kg_3.value} m_s_12.unit
        as Momentum
    ]);

    //  Test...this.
    //  TODO: Allowing field access at all may make it too easy to accidentally
    //      break unit safety like this. Should it be reverted?
    assert_eq!(qty![16.0 W], qty![w_4 * w_4.value]);
}


#[test]
fn qtype_valid() {
    use dana::{prelude::*, symbols::basic::*};

    let u = Length::Meter / Time::Second.squared();

    //  Unspecified inner type.
    let _: qtype!(L^1/T^2) = u.quantity(1.0);
    let _: qtype!(L^1/T^2) = u.quantity(1f64);
    let _: qtype!(L^1/T^2) = u.quantity(1 as _);

    //  Inferred inner type.
    let _: qtype!(_; L^1/T^2) = u.quantity(1.0);
    let _: qtype!(_; L^1/T^2) = u.quantity(1f64);
    let _: qtype!(_; L^1/T^2) = u.quantity(1f32);
    let _: qtype!(_; L^1/T^2) = u.quantity(1i32);
    let _: qtype!(_; L^1/T^2) = u.quantity(1u128);
    let _: qtype!(_; L^1/T^2) = u.quantity(1usize);

    //  Explicit inner type (f32).
    let _: qtype!(f32; L^1/T^2) = u.quantity(1.0);
    let _: qtype!(f32; L^1/T^2) = u.quantity(1f32);
    let _: qtype!(f32; L^1/T^2) = u.quantity(1 as _);

    //  Explicit inner type (f64).
    let _: qtype!(f64; L^1/T^2) = u.quantity(1.0);
    let _: qtype!(f64; L^1/T^2) = u.quantity(1f64);
    let _: qtype!(f64; L^1/T^2) = u.quantity(1 as _);

    //  Explicit inner type (usize).
    let _: qtype!(usize; L^1/T^2) = u.quantity(1);
    let _: qtype!(usize; L^1/T^2) = u.quantity(1usize);
    let _: qtype!(usize; L^1/T^2) = u.quantity(1 as _);
}