diman 0.5.1

Zero-cost 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
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

#[cfg(any(feature = "f32", feature = "f64"))]
macro_rules! gen_tests_for_float {
    ($float_name: ident, $assert_is_close: path) => {
        mod $float_name {
            use crate::example_system::dimensions::{Energy, Length, Time, Velocity};
            use crate::example_system::units;
            use crate::make_annotated_unit_constructor;
            use $assert_is_close as assert_is_close;
            make_annotated_unit_constructor!(meters, Length<$float_name>, $float_name);
            make_annotated_unit_constructor!(kilometers, Length<$float_name>, $float_name);
            make_annotated_unit_constructor!(seconds, Time<$float_name>, $float_name);
            make_annotated_unit_constructor!(joules, Energy<$float_name>, $float_name);

            #[test]
            fn deserialize_float() {
                let q: Length<$float_name> = serde_yaml::from_str("5.0 km").unwrap();
                assert_is_close(q, kilometers(5.0));
                let q: Velocity<$float_name> = serde_yaml::from_str("5.0 km s^-1").unwrap();
                assert_is_close(q, kilometers(5.0) / seconds(1.0));
            }

            #[test]
            #[should_panic(expected = "mismatch in dimensions")]
            fn deserialize_float_dimension_mismatch() {
                let q: Length<$float_name> = serde_yaml::from_str("5.0 kg").unwrap();
                assert_is_close(q, kilometers(5.0));
            }

            #[test]
            fn serialize_float() {
                assert_eq!(
                    serde_yaml::to_string(&kilometers(5.0)).unwrap().trim(),
                    "5000 m"
                );
                assert_eq!(serde_yaml::to_string(&joules(5.0)).unwrap().trim(), "5 J");
            }

            #[test]
            fn serialize_float_unnamed_dimension() {
                let unnamed_dimension = joules(5.0) * meters(1.0);
                assert_eq!(
                    serde_yaml::to_string(&unnamed_dimension).unwrap().trim(),
                    "5 m^3 s^-2 kg"
                );
            }
        }
    };
}

#[cfg(any(feature = "glam-vec2", feature = "glam-dvec2"))]
macro_rules! gen_tests_for_vector_2 {
    ($float_name: ident, $mod_name: ident, $vec_name: ty, $assert_is_close: path) => {
        mod $mod_name {
            use crate::example_system::dimensions::Length;
            use crate::example_system::units;
            use crate::example_system::units::{dimensionless, meters};
            use $assert_is_close as assert_is_close;
            use $vec_name as Vec2;

            use crate::make_annotated_unit_constructor;
            make_annotated_unit_constructor!(kilometers, Length<$float_name>, $float_name);

            #[test]
            fn deserialize_vector() {
                let q: Length<Vec2> = serde_yaml::from_str("(5.0 3.0) km").unwrap();
                assert_is_close(q.x(), kilometers(5.0));
                assert_is_close(q.y(), kilometers(3.0));
            }

            #[test]
            #[should_panic]
            fn deserialize_vector_fails_with_fewer_than_2_components() {
                let _: Length<Vec2> = serde_yaml::from_str("(5.0) km").unwrap();
            }

            #[test]
            #[should_panic]
            fn deserialize_vector_fails_with_more_than_2_components() {
                let _: Length<Vec2> = serde_yaml::from_str("(5.0 3.0 7.0) km").unwrap();
            }

            #[test]
            fn serialize_vector() {
                let x = meters * Vec2::new(5.3, 1.1);
                let result: String = serde_yaml::to_string(&x).unwrap();
                assert_eq!(result, "(5.3 1.1) m\n");
            }

            #[test]
            fn serialize_dimensionless_vector() {
                let x = dimensionless * Vec2::new(5.3, 1.1);
                let result: String = serde_yaml::to_string(&x).unwrap();
                assert_eq!(result, "(5.3 1.1)\n");
            }
        }
    };
}

#[cfg(any(feature = "glam-vec3", feature = "glam-dvec3"))]
macro_rules! gen_tests_for_vector_3 {
    ($float_name: ident, $mod_name: ident, $vec_name: ty, $assert_is_close: path) => {
        mod $mod_name {
            use crate::example_system::dimensions::Length;
            use crate::example_system::units;
            use crate::example_system::units::{dimensionless, meters};
            use $assert_is_close as assert_is_close;
            use $vec_name as Vec3;

            use crate::make_annotated_unit_constructor;
            make_annotated_unit_constructor!(kilometers, Length<$float_name>, $float_name);

            #[test]
            fn deserialize_vector() {
                let q: Length<Vec3> = serde_yaml::from_str("(5.0 3.0 7.0) km").unwrap();
                assert_is_close(q.x(), kilometers(5.0));
                assert_is_close(q.y(), kilometers(3.0));
                assert_is_close(q.z(), kilometers(7.0));
            }

            #[test]
            #[should_panic]
            fn deserialize_vector_fails_with_fewer_than_3_components() {
                let _: Length<Vec3> = serde_yaml::from_str("(5.0 4.0) km").unwrap();
            }

            #[test]
            #[should_panic]
            fn deserialize_vector_fails_with_more_than_3_components() {
                let _: Length<Vec3> = serde_yaml::from_str("(5.0 3.0 7.0 9.0) km").unwrap();
            }

            #[test]
            fn serialize_vector() {
                let x = meters * Vec3::new(5.3, 1.1, 2.2);
                let result: String = serde_yaml::to_string(&x).unwrap();
                assert_eq!(result, "(5.3 1.1 2.2) m\n");
            }

            #[test]
            fn serialize_dimensionless_vector() {
                let x = dimensionless * Vec3::new(5.3, 1.1, 2.2);
                let result: String = serde_yaml::to_string(&x).unwrap();
                assert_eq!(result, "(5.3 1.1 2.2)\n");
            }
        }
    };
}

#[cfg(feature = "f32")]
gen_tests_for_float!(f32, crate::utils::assert_is_close_f32);

#[cfg(feature = "f64")]
gen_tests_for_float!(f64, crate::utils::assert_is_close_f64);

#[cfg(all(feature = "f32", feature = "glam-vec2"))]
gen_tests_for_vector_2!(f32, vec2, glam::Vec2, crate::utils::assert_is_close_f32);

#[cfg(all(feature = "f64", feature = "glam-dvec2"))]
gen_tests_for_vector_2!(f64, dvec2, glam::DVec2, crate::utils::assert_is_close_f64);

#[cfg(all(feature = "f32", feature = "glam-vec3"))]
gen_tests_for_vector_3!(f32, vec3, glam::Vec3, crate::utils::assert_is_close_f32);

#[cfg(all(feature = "f64", feature = "glam-dvec3"))]
gen_tests_for_vector_3!(f64, dvec3, glam::DVec3, crate::utils::assert_is_close_f64);