ferrunitas 0.4.0

A type-safe unit conversion library with compile-time dimensional analysis
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

//! Dimensionless quantities and pure number-like units.
//!
//! Provides markers for ratios, angles, efficiency factors and any other
//! unitless constructs used in formulas.

use crate::system::constants::{LN_2, LN_10, PI, TAU};
use crate::system::prefixes::*;
use crate::{quantity, unit};
use typenum::*;

// ===========================
// BASE DIMENSIONLESS
// ===========================
quantity!(Dimensionless: M Z0, L Z0, T Z0, I Z0, Th Z0, N Z0, J Z0); // Dimensionless
unit!(base: One, "1", Dimensionless);
unit!(derived: Percent, "%", (0.01, One));
unit!(derived: Permille, "‰", (0.001, One));
unit!(derived: PartsPerMillion, "ppm", (1e-6, One));
unit!(derived: PartsPerBillion, "ppb", (1e-9, One));

// ===========================
// PLANE ANGLE
// ===========================
quantity!(Angle: M Z0, L Z0, T Z0, I Z0, Th Z0, N Z0, J Z0; marked); // Dimensionless
unit!(base: Radian, "rad", Angle);
unit!(derived: Degree, "°", (PI / 180.0, Radian));
unit!(derived: Gradian, "gon", (PI / 200.0, Radian));

unit!(derived: Turn, "tr", (TAU, Radian));
unit!(derived: Arcminute, "arcmin", (PI / 10800.0, Radian));
unit!(derived: Arcsecond, "arcsec", (1.0 / 60.0, Arcminute));

// ===========================
// SOLID ANGLE
// ===========================
quantity!(SolidAngle: M Z0, L Z0, T Z0, I Z0, Th Z0, N Z0, J Z0; marked); // Dimensionless
unit!(compound: Steradian, "sr", [(Radian, P2)]; marked SolidAngle);

// ===========================
// LOGARITHMIC RATIOS
// ===========================
quantity!(LogarithmicRatio: M Z0, L Z0, T Z0, I Z0, Th Z0, N Z0, J Z0; marked); // Dimensionless
unit!(base: Neper, "Np", LogarithmicRatio);
unit!(derived: Octave, "oct", (LN_2, Neper));
unit!(derived: Bel, "B", (LN_10, Neper));
unit!(prefix: Decibel, Deci, Bel);

// ==============================================================================

#[cfg(test)]
mod tests {
    use super::*;
    use crate::common::verify_unit;

    // BASE DIMENSIONLESS
    verify_unit!(One, Dimensionless, 1.0);
    verify_unit!(Percent, Dimensionless, 0.01);
    verify_unit!(Permille, Dimensionless, 0.001);
    verify_unit!(PartsPerMillion, Dimensionless, 1e-6);
    verify_unit!(PartsPerBillion, Dimensionless, 1e-9);

    // PLANE ANGLE
    verify_unit!(Radian, Angle, 1.0);
    verify_unit!(Degree, Angle, 0.017453292519943295);
    verify_unit!(Gradian, Angle, 0.015707963267948967);
    verify_unit!(Turn, Angle, TAU);
    verify_unit!(Arcminute, Angle, 0.0002908882086657216);
    verify_unit!(Arcsecond, Angle, 4.84813681109536e-6);

    // SOLID ANGLE
    verify_unit!(Steradian, SolidAngle, 1.0);

    // LOGARITHMIC RATIOS
    verify_unit!(Neper, LogarithmicRatio, 1.0);
    verify_unit!(Octave, LogarithmicRatio, LN_2);
    verify_unit!(Bel, LogarithmicRatio, LN_10);
    verify_unit!(Decibel, LogarithmicRatio, 0.23025850929940457);
}