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 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280
//! Assert a number is within epsilon of another number.
//!
//! Pseudocode:<br>
//! | a - b | ≤ ε * min(a, b)
//!
//! # Example
//!
//! ```rust
//! # #[macro_use] extern crate assertables;
//! # fn main() {
//! let a: i8 = 10;
//! let b: i8 = 20;
//! let epsilon: i8 = 1;
//! assert_in_epsilon!(a, b, epsilon);
//! # }
//! ```
//!
//! The macros `assert_in_delta` and `assert_in_epsilon` can test
//! approximations:
//!
//! * For an approximation, the absolute error (i.e. delta) is the magnitude of
//! the difference between the exact value and the approximation.
//!
//! * For an approximation, the relative error (i.e. epsilon) is the absolute
//! error divided by the magnitude of the exact value. This can be used to
//! compare approximations of numbers of wildly differing size.
//!
//! * For example, approximating the number 1,000 with an absolute error of 3
//! is, in most applications, much worse than approximating the number
//! 1,000,000 with an absolute error of 3; in the first case the relative
//! error is 0.003 and in the second it is only 0.000003.
//!
//! * Thanks to Ruby minitest for the example and documentation.
//!
//! # Module macros
//!
//! * [`assert_in_epsilon`](macro@crate::assert_in_epsilon)
//! * [`assert_in_epsilon_as_result`](macro@crate::assert_in_epsilon_as_result)
//! * [`debug_assert_in_epsilon`](macro@crate::debug_assert_in_epsilon)
/// Assert a number is within epsilon of another number.
///
/// Pseudocode:<br>
/// | a - b | ≤ ε * min(a, b)
///
/// * If true, return Result `Ok(())`.
///
/// * When false, return [`Err`] with a message and the values of the
/// expressions with their debug representations.
///
/// This macro provides the same statements as [`assert_`](macro.assert_.html),
/// except this macro returns a Result, rather than doing a panic.
///
/// This macro is useful for runtime checks, such as checking parameters,
/// or sanitizing inputs, or handling different results in different ways.
///
/// # Module macros
///
/// * [`assert_in_epsilon`](macro@crate::assert_in_epsilon)
/// * [`assert_in_epsilon_as_result`](macro@crate::assert_in_epsilon_as_result)
/// * [`debug_assert_in_epsilon`](macro@crate::debug_assert_in_epsilon)
///
#[macro_export]
macro_rules! assert_in_epsilon_as_result {
($a:expr, $b:expr, $epsilon:expr $(,)?) => ({
match (&$a, &$b, &$epsilon) {
(a, b, epsilon) => {
if a == b {
Ok(())
} else {
let diff = if (a > b) { a - b } else { b - a };
let min = if (a < b) { a } else { b };
let rhs = *epsilon * min;
if diff <= rhs {
Ok(())
} else {
Err(format!(
concat!(
"assertion failed: `assert_in_epsilon!(a, b, epsilon)`\n",
"https://docs.rs/assertables/8.7.0/assertables/macro.assert_in_epsilon.html\n",
" a label: `{}`,\n",
" a debug: `{:?}`,\n",
" b label: `{}`,\n",
" b debug: `{:?}`,\n",
" epsilon label: `{}`,\n",
" epsilon debug: `{:?}`,\n",
" | a - b |: `{:?}`,\n",
" epsilon * min(a, b): `{:?}`,\n",
" | a - b | ≤ epsilon * min(a, b): {}",
),
stringify!($a),
a,
stringify!($b),
b,
stringify!($epsilon),
epsilon,
diff,
rhs,
false
))
}
}
}
}
});
}
#[cfg(test)]
mod tests {
#[test]
fn test_assert_in_epsilon_as_result_x_success() {
let a: i8 = 10;
let b: i8 = 20;
let epsilon: i8 = 1;
let result = assert_in_epsilon_as_result!(a, b, epsilon);
assert_eq!(result, Ok(()));
}
#[test]
fn test_assert_in_epsilon_as_result_x_failure() {
let a: i8 = 10;
let b: i8 = 30;
let e: i8 = 1;
let result = assert_in_epsilon_as_result!(a, b, e);
assert!(result.is_err());
assert_eq!(
result.unwrap_err(),
concat!(
"assertion failed: `assert_in_epsilon!(a, b, epsilon)`\n",
"https://docs.rs/assertables/8.7.0/assertables/macro.assert_in_epsilon.html\n",
" a label: `a`,\n",
" a debug: `10`,\n",
" b label: `b`,\n",
" b debug: `30`,\n",
" epsilon label: `e`,\n",
" epsilon debug: `1`,\n",
" | a - b |: `20`,\n",
" epsilon * min(a, b): `10`,\n",
" | a - b | ≤ epsilon * min(a, b): false"
)
);
}
}
/// Assert a number is within epsilon of another number.
///
/// Pseudocode:<br>
/// | a - b | ≤ ε * min(a, b)
///
/// * If true, return `()`.
///
/// * Otherwise, call [`panic!`] with a message and the values of the
/// expressions with their debug representations.
///
/// # Examples
///
/// ```rust
/// # #[macro_use] extern crate assertables;
/// # use std::panic;
/// # fn main() {
/// let a: i8 = 10;
/// let b: i8 = 20;
/// let epsilon: i8 = 1;
/// assert_in_epsilon!(a, b, epsilon);
///
/// # let result = panic::catch_unwind(|| {
/// let a: i8 = 10;
/// let b: i8 = 30;
/// let e: i8 = 1;
/// assert_in_epsilon!(a, b, e);
/// # });
/// // assertion failed: `assert_in_epsilon!(a, b, epsilon)`
/// // https://docs.rs/assertables/8.7.0/assertables/macro.assert_in_epsilon.html
/// // a label: `a`,
/// // a debug: `10`,
/// // b label: `b`,
/// // b debug: `30`,
/// // epsilon label: `e`,
/// // epsilon debug: `1`,
/// // | a - b |: `20`,
/// // epsilon * min(a, b): `10`,\n",
/// // | a - b | ≤ epsilon * min(a, b): false"
/// # let actual = result.unwrap_err().downcast::<String>().unwrap().to_string();
/// # let expect = concat!(
/// # "assertion failed: `assert_in_epsilon!(a, b, epsilon)`\n",
/// # "https://docs.rs/assertables/8.7.0/assertables/macro.assert_in_epsilon.html\n",
/// # " a label: `a`,\n",
/// # " a debug: `10`,\n",
/// # " b label: `b`,\n",
/// # " b debug: `30`,\n",
/// # " epsilon label: `e`,\n",
/// # " epsilon debug: `1`,\n",
/// # " | a - b |: `20`,\n",
/// # " epsilon * min(a, b): `10`,\n",
/// # " | a - b | ≤ epsilon * min(a, b): false"
/// # );
/// # assert_eq!(actual, expect);
/// # }
/// ```
///
/// The macros `assert_in_delta` and `assert_in_epsilon` can test
/// approximations:
///
/// * For an approximation, the absolute error (i.e. delta) is the magnitude of
/// the difference between the exact value and the approximation. For this,
/// use the macro
///
/// * For an approximation, the relative error (i.e. epsilon) is the absolute
/// error divided by the magnitude of the exact value. This can be used to
/// compare approximations of numbers of wildly differing size.
///
/// * For example, approximating the number 1,000 with an absolute error of 3
/// is, in most applications, much worse than approximating the number
/// 1,000,000 with an absolute error of 3; in the first case the relative
/// error is 0.003 and in the second it is only 0.000003.
///
/// * Thanks to Ruby minitest for the example and documentation.
///
/// # Module macros
///
/// * [`assert_in_epsilon`](macro@crate::assert_in_epsilon)
/// * [`assert_in_epsilon_as_result`](macro@crate::assert_in_epsilon_as_result)
/// * [`debug_assert_in_epsilon`](macro@crate::debug_assert_in_epsilon)
///
#[macro_export]
macro_rules! assert_in_epsilon {
($a:expr, $b:expr, $epsilon:expr $(,)?) => ({
match assert_in_epsilon_as_result!($a, $b, $epsilon) {
Ok(()) => (),
Err(err) => panic!("{}", err),
}
});
($a:expr, $b:expr, $epsilon:expr, $($message:tt)+) => ({
match assert_in_epsilon_as_result!($a, $b, $epsilon) {
Ok(()) => (),
Err(_err) => panic!("{}", $($message)+),
}
});
}
/// Assert a number is within epsilon of another number.
///
/// Pseudocode:<br>
/// | a - b | ≤ ε * min(a, b)
///
/// This macro provides the same statements as [`assert_in_epsilon`](macro.assert_in_epsilon.html),
/// except this macro's statements are only enabled in non-optimized
/// builds by default. An optimized build will not execute this macro's
/// statements unless `-C debug-assertions` is passed to the compiler.
///
/// This macro is useful for checks that are too expensive to be present
/// in a release build but may be helpful during development.
///
/// The result of expanding this macro is always type checked.
///
/// An unchecked assertion allows a program in an inconsistent state to
/// keep running, which might have unexpected consequences but does not
/// introduce unsafety as long as this only happens in safe code. The
/// performance cost of assertions, however, is not measurable in general.
/// Replacing `assert*!` with `debug_assert*!` is thus only encouraged
/// after thorough profiling, and more importantly, only in safe code!
///
/// This macro is intended to work in a similar way to
/// [`std::debug_assert`](https://doc.rust-lang.org/std/macro.debug_assert.html).
///
/// # Module macros
///
/// * [`assert_in_epsilon`](macro@crate::assert_in_epsilon)
/// * [`assert_in_epsilon`](macro@crate::assert_in_epsilon)
/// * [`debug_assert_in_epsilon`](macro@crate::debug_assert_in_epsilon)
///
#[macro_export]
macro_rules! debug_assert_in_epsilon {
($($arg:tt)*) => {
if $crate::cfg!(debug_assertions) {
$crate::assert_in_epsilon!($($arg)*);
}
};
}