devela/code/util/asserts/
dynamic.rs

Help
1// devela::code::util::asserts
2//
3//! Additional assertion macros
4//
5// TODO
6// - update panic docs.
7// - make non-panicking (non-asserting) comparing.
8// - inspiration: https://docs.rs/approx/0.5.1/approx/
9// - replace tolerance arg for other options:
10//   - absolute:
11//   - relative:
12//   - Ulps: (absolute+units-in-last-place)
13//   (only eq, ne is !prefix)
14// - use it in some Float wrapper fns.
15//
16// - eq_all![]
17// - approx_eq_all![]
18
19/// Asserts the equality of a series of expressions.
20///
21/// Similar to [`assert_eq`] but supports more than 2 terms to test for equality.
22///
23/// # Panics
24// TODO
25#[macro_export]
26#[cfg_attr(cargo_primary_package, doc(hidden))]
27macro_rules! assert_eq_all {
28    ($first:expr, $($rest:expr),+ $(,)?) => {{
29        let first_val = &$first;
30        $(
31            let rest_val = &$rest;
32            assert!(
33                first_val == rest_val,
34                "Assertion failed: ({}) is not equal to ({})\n  left: {}\n right: {}",
35                stringify!($first),
36                stringify!($rest),
37                first_val,
38                rest_val,
39            );
40        )+
41    }};
42}
43#[doc(inline)]
44pub use assert_eq_all;
45
46/// Asserts the approximate equality of a series of expressions within `tolerance`.
47///
48/// This macro should work with any numeric type that supports comparison and
49/// subtraction, including signed and unsigned integers and floating-point numbers.
50///
51/// The given `$tolerance` must be a non-negative number.
52///
53/// # Panics
54// TODO
55///
56/// # Examples
57/// The following examples compile:
58/// ```
59/// # use devela::assert_approx_eq_all;
60/// assert_approx_eq_all![tolerance: 0.01, 1.0, 1.001, 0.999]; // up to 0.01 away from 1.0
61/// assert_approx_eq_all![tolerance: 1_u32, 4, 3, 5]; // up to 1 away from 4
62///
63/// assert_approx_eq_all![tolerance: 0.01, -1.0, -1.001, -0.999];
64/// assert_approx_eq_all![tolerance: 1_i32, -4, -3, -5];
65/// assert_approx_eq_all![tolerance: 0_i32, 3, 3];
66/// ```
67/// The following examples panic:
68/// ```should_panic
69/// # use devela::assert_approx_eq_all;
70/// assert_approx_eq_all![tolerance: 0.01, 1.0, 1.001, 0.989]; // |0.989 - 1.0| > |0.01|
71/// ```
72/// ```should_panic
73/// # use devela::assert_approx_eq_all;
74/// assert_approx_eq_all![tolerance: 1_u32, 4, 3, 5, 6]; // |6 - 4| > |1|
75/// ```
76/// ```should_panic
77/// # use devela::assert_approx_eq_all;
78/// assert_approx_eq_all![tolerance: 1_u32, 3, 4, 5]; // |5 - 3| > |1|
79/// ```
80/// ```should_panic
81/// # use devela::assert_approx_eq_all;
82/// assert_approx_eq_all![tolerance: -0.01, 1.0, 1.001, 0.999]; // tolerance: -0.01 < 0
83/// ```
84/// ```should_panic
85/// # use devela::assert_approx_eq_all;
86/// assert_approx_eq_all![tolerance: -1_i32, 4, 3, 5]; // tolerance: -1 < 0
87/// ```
88#[macro_export]
89#[cfg_attr(cargo_primary_package, doc(hidden))]
90macro_rules! assert_approx_eq_all {
91    (tolerance: $tolerance:expr, $first:expr, $($rest:expr),+ $(,)?) => {{
92        let first_val = $first;
93        $(
94            let rest_val = $rest;
95            // Calculate the absolute difference without relying on `abs`:
96            let difference = if first_val > rest_val {
97                first_val - rest_val
98            } else {
99                rest_val - first_val
100            };
101            assert!(
102                difference <= $tolerance,
103                "Assertion failed: ({}) is not approximately equal to ({})
104      left: {}\n     right: {}\n tolerance: {}",
105                stringify!($first), stringify!($rest), first_val, rest_val, $tolerance,
106            );
107        )+
108    }};
109}
110#[doc(inline)]
111pub use assert_approx_eq_all;
devela/code/util/asserts/dynamic.rs

devela/code/util/asserts/
dynamic.rs
