test_help-rs 0.1.2

Test helpers for Rust
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

// evaluate_scalar.rs : src/api

use crate::{
    traits::{
        ApproximateEqualityEvaluator,
        TestableAsF64,
    },
    ComparisonResult,
};

use std::fmt as std_fmt;


// API functions

/// Compares two scalar values using `evaluator` without asserting.
///
/// Converts `expected` and `actual` to `f64` via [`TestableAsF64`], then
/// delegates to [`ApproximateEqualityEvaluator::evaluate`].
///
/// Used by [`assert_scalar_eq_approx!`] and
/// [`assert_scalar_ne_approx!`]; may also be used when building custom
/// assertion macros for application-defined types.
///
/// # Returns
///
/// A tuple of:
///
/// * [`ComparisonResult`];
/// * `margin_factor` reported by the evaluator, if any;
/// * `multiplier_factor` reported by the evaluator, if any;
///
/// # Examples
///
/// ```
/// use test_helpers::{
///     evaluate_scalar_eq_approx,
///     margin,
///     ComparisonResult,
/// };
///
/// let (result, _, _) = evaluate_scalar_eq_approx(&3.0, &3.0001, &margin(0.0001));
/// assert_eq!(ComparisonResult::ApproximatelyEqual, result);
/// ```
pub fn evaluate_scalar_eq_approx<T_expected, T_actual>(
    expected : &T_expected,
    actual : &T_actual,
    evaluator : &dyn ApproximateEqualityEvaluator,
) -> (
    ComparisonResult, // comparison_result
    Option<f64>,      // margin_factor
    Option<f64>,      // multiplier_factor
)
where
    T_expected : TestableAsF64 + std_fmt::Debug,
    T_actual : TestableAsF64 + std_fmt::Debug,
{
    let (expected, actual) = {
        let expected : &dyn TestableAsF64 = expected;
        let actual : &dyn TestableAsF64 = actual;

        let expected = expected.testable_as_f64();
        let actual = actual.testable_as_f64();

        (expected, actual)
    };

    evaluator.evaluate(expected, actual)
}


// ///////////////////////////// end of file //////////////////////////// //