assertables/assert_approx/

assert_approx_eq.rs

//! Assert a number is approximately equal to another.
//!
//! Pseudocode:<br>
//! | a - b | ≤ 1e-6
//!
//! # Example
//!
//! ```rust
//! use assertables::*;
//!
//! let a: f32 = 1.0000001;
//! let b: f32 = 1.0000011;
//! assert_approx_eq!(a, b);
//! ```
//!
//!
//! ## Comparisons
//!
//! This crate provides macro groups that test approximations and nearness:
//!
//! * [`assert_approx_eq`](macro@crate::assert_approx_eq) and
//!   [`assert_approx_ne`](macro@crate::assert_approx_ne) test the approximate
//!   equality within 1e-6. The macro name and the approximate value are chosen
//!   to be similar to the longtime popular rust crate `assert_approx_eq`.
//!
//! * [`assert_in_delta`](macro@crate::assert_in_delta) tests the absolute error
//!   (i.e. delta). This is the magnitude of the difference between the exact
//!   value and the approximation.
//!
//! * [`assert_in_epsilon`](macro@crate::assert_in_epsilon) tests the relative
//!   error (i.e. epsilon). This 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.
//!
//! Examples:
//!
//! * Approximating the number 100 and 103 has an absolute error (approx) of 3
//!   and a relative error (epsilon) of 0.03.
//!
//! * Approximating the number 1,000,000 and 1,000,003 has an absolute error
//!   (approx) of 3, and a relative error (epsilon) of 0.000003.
//!
//! * For many kinds of applications, the relative error is more important than
//!   the absolute error.
//!
//!
//! ## Thanks
//!
//! * Thanks to [Ashley Williams](https://github.com/ashleygwilliams) for
//!   creating and maintaining the `assert_approx_eq` crate.
//!
//! * Thanks to [Ryan Davis](https://github.com/zenspider) and Ruby minitest for
//!   creating and maintaining `assert_in_approx` and `assert_in_epsilon` code.
//!
//!
//! # Module macros
//!
//! * [`assert_approx_eq`](macro@crate::assert_approx_eq)
//! * [`assert_approx_eq_as_result`](macro@crate::assert_approx_eq_as_result)
//! * [`debug_assert_approx_eq`](macro@crate::debug_assert_approx_eq)

/// Assert a number is approximately equal to another.
///
/// Pseudocode:<br>
/// | a - b | ≤ 1e-6
///
/// * If true, return Result `Ok(abs_diff, approx)`.
///
/// * 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_approx_eq`](macro@crate::assert_approx_eq)
/// * [`assert_approx_eq_as_result`](macro@crate::assert_approx_eq_as_result)
/// * [`debug_assert_approx_eq`](macro@crate::debug_assert_approx_eq)
///
#[macro_export]
macro_rules! assert_approx_eq_as_result {
    ($a:expr, $b:expr $(,)?) => {
        match (&$a, &$b) {
            (a, b) => {
                let abs_diff = if (a >= b) { a - b } else { b - a };
                let approx = 1.0e-6;
                if abs_diff <= approx {
                    Ok((abs_diff, approx))
                } else {
                    Err(format!(
                        concat!(
                            "assertion failed: `assert_approx_eq!(a, b)`\n",
                            "https://docs.rs/assertables/",
                            env!("CARGO_PKG_VERSION"),
                            "/assertables/macro.assert_approx_eq.html\n",
                            "            a label: `{}`,\n",
                            "            a debug: `{:?}`,\n",
                            "            b label: `{}`,\n",
                            "            b debug: `{:?}`,\n",
                            "          | a - b |: `{:?}`,\n",
                            "             approx: `{:?}`,\n",
                            " | a - b | ≤ approx: false"
                        ),
                        stringify!($a),
                        a,
                        stringify!($b),
                        b,
                        abs_diff,
                        approx
                    ))
                }
            }
        }
    };
}

#[cfg(test)]
mod test_assert_approx_eq_as_result {
    use std::sync::Once;

    #[test]
    fn eq() {
        let a: f32 = 1.0000001;
        let b: f32 = 1.0000011;
        for _ in 0..1 {
            let actual = assert_approx_eq_as_result!(a, b);
            assert_eq!(actual.unwrap(), (9.536743e-7, 1e-6));
        }
    }

    #[test]
    fn eq_once() {
        static A: Once = Once::new();
        fn a() -> f32 {
            if A.is_completed() {
                panic!("A.is_completed()")
            } else {
                A.call_once(|| {})
            }
            1.0000001
        }

        static B: Once = Once::new();
        fn b() -> f32 {
            if B.is_completed() {
                panic!("B.is_completed()")
            } else {
                B.call_once(|| {})
            }
            1.0000011
        }

        assert_eq!(A.is_completed(), false);
        assert_eq!(B.is_completed(), false);
        let result = assert_approx_eq_as_result!(a(), b());
        assert!(result.is_ok());
        assert_eq!(A.is_completed(), true);
        assert_eq!(B.is_completed(), true);
    }

    #[test]
    fn ne() {
        let a: f32 = 1.0000001;
        let b: f32 = 1.0000012;
        let actual = assert_approx_eq_as_result!(a, b);
        let message = concat!(
            "assertion failed: `assert_approx_eq!(a, b)`\n",
            "https://docs.rs/assertables/",
            env!("CARGO_PKG_VERSION"),
            "/assertables/macro.assert_approx_eq.html\n",
            "            a label: `a`,\n",
            "            a debug: `1.0000001`,\n",
            "            b label: `b`,\n",
            "            b debug: `1.0000012`,\n",
            "          | a - b |: `1.0728836e-6`,\n",
            "             approx: `1e-6`,\n",
            " | a - b | ≤ approx: false"
        );
        assert_eq!(actual.unwrap_err(), message);
    }
}

/// Assert a number is approximately equal to another.
///
/// Pseudocode:<br>
/// | a - b | ≤ 1e-6
///
/// * If true, return `(diff, approx)`.
///
/// * Otherwise, call [`panic!`] with a message and the values of the
///   expressions with their debug representations.
///
/// # Examples
///
/// ```rust
/// use assertables::*;
/// # use std::panic;
///
/// # fn main() {
/// let a: f32 = 1.0000001;
/// let b: f32 = 1.0000011;
/// assert_approx_eq!(a, b);
///
/// # let result = panic::catch_unwind(|| {
/// // This will panic
/// let a: f32 = 1.0000001;
/// let b: f32 = 1.0000012;
/// assert_approx_eq!(a, b);
/// # });
/// // assertion failed: `assert_approx_eq!(a, b)`
/// // https://docs.rs/assertables/9.7.0/assertables/macro.assert_approx_eq.html
/// //             a label: `a`,
/// //             a debug: `1.0000001`,
/// //             b label: `b`,
/// //             b debug: `1.0000012`,
/// //           | a - b |: `1.0728836e-6`,
/// //              approx: `1e-6`,
/// //  | a - b | ≤ approx: false
/// # let actual = result.unwrap_err().downcast::<String>().unwrap().to_string();
/// # let message = concat!(
/// #     "assertion failed: `assert_approx_eq!(a, b)`\n",
/// #     "https://docs.rs/assertables/", env!("CARGO_PKG_VERSION"), "/assertables/macro.assert_approx_eq.html\n",
/// #     "            a label: `a`,\n",
/// #     "            a debug: `1.0000001`,\n",
/// #     "            b label: `b`,\n",
/// #     "            b debug: `1.0000012`,\n",
/// #     "          | a - b |: `1.0728836e-6`,\n",
/// #     "             approx: `1e-6`,\n",
/// #     " | a - b | ≤ approx: false",
/// # );
/// # assert_eq!(actual, message);
/// # }
/// ```
///
/// The macros `assert_approx_eq` and `assert_in_epsilon` can test
/// approximations:
///
/// * For an approximation, the absolute error (i.e. approx) 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_approx_eq`](macro@crate::assert_approx_eq)
/// * [`assert_approx_eq_as_result`](macro@crate::assert_approx_eq_as_result)
/// * [`debug_assert_approx_eq`](macro@crate::debug_assert_approx_eq)
///
#[macro_export]
macro_rules! assert_approx_eq {
    ($a:expr, $b:expr $(,)?) => {
        match $crate::assert_approx_eq_as_result!($a, $b) {
            Ok(x) => x,
            Err(err) => panic!("{}", err),
        }
    };
    ($a:expr, $b:expr, $($message:tt)+) => {
        match $crate::assert_approx_eq_as_result!($a, $b) {
            Ok(x) => x,
            Err(err) => panic!("{}\n{}", format_args!($($message)+), err),
        }
    };
}

#[cfg(test)]
mod test_assert_approx_eq {
    use std::panic;

    #[test]
    fn eq() {
        let a: f32 = 1.0000001;
        let b: f32 = 1.0000011;
        for _ in 0..1 {
            let actual = assert_approx_eq!(a, b);
            assert_eq!(actual, (9.536743e-7, 1e-6));
        }
    }

    #[test]
    fn ne() {
        let result = panic::catch_unwind(|| {
            let a: f32 = 1.0000001;
            let b: f32 = 1.0000012;
            let _actual = assert_approx_eq!(a, b);
        });
        let message = concat!(
            "assertion failed: `assert_approx_eq!(a, b)`\n",
            "https://docs.rs/assertables/",
            env!("CARGO_PKG_VERSION"),
            "/assertables/macro.assert_approx_eq.html\n",
            "            a label: `a`,\n",
            "            a debug: `1.0000001`,\n",
            "            b label: `b`,\n",
            "            b debug: `1.0000012`,\n",
            "          | a - b |: `1.0728836e-6`,\n",
            "             approx: `1e-6`,\n",
            " | a - b | ≤ approx: false"
        );
        assert_eq!(
            result
                .unwrap_err()
                .downcast::<String>()
                .unwrap()
                .to_string(),
            message
        );
    }
}

/// Assert a number is approximately equal to another.
///
/// Pseudocode:<br>
/// | a - b | ≤ 1e-6
///
/// This macro provides the same statements as [`assert_approx_eq`](macro.assert_approx_eq.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_approx_eq`](macro@crate::assert_approx_eq)
/// * [`assert_approx_eq`](macro@crate::assert_approx_eq)
/// * [`debug_assert_approx_eq`](macro@crate::debug_assert_approx_eq)
///
#[macro_export]
macro_rules! debug_assert_approx_eq {
    ($($arg:tt)*) => {
        if $crate::cfg!(debug_assertions) {
            $crate::assert_approx_eq!($($arg)*);
        }
    };
}