batbox-approx 0.16.0

Approximate comparison
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

//! Approximate comparing of things
#![warn(missing_docs)]

/// Default EPS used for approx equality
pub const DEFAULT_EPS: f32 = 1e-9;

/// Implement this for types you want to check for approximate equality
pub trait Approx {
    /// Get an approximated distance between two values
    fn approx_distance_to(&self, other: &Self) -> f32;

    /// Check if values are approximately equal using [DEFAULT_EPS]
    fn approx_eq(&self, other: &Self) -> bool {
        self.approx_eq_eps(other, DEFAULT_EPS)
    }

    /// Check if values are approximately equal using supplied eps value
    fn approx_eq_eps(&self, other: &Self, eps: f32) -> bool {
        self.approx_distance_to(other) <= eps
    }
}

impl<T: batbox_num::Float> Approx for T {
    fn approx_distance_to(&self, other: &T) -> f32 {
        (self.as_f32() - other.as_f32()).abs()
    }
}

#[test]
fn test_approx_eq_f32() {
    assert!(1.0_f32.approx_eq_eps(&1.1_f32, 0.15));
    assert!(23_424.215_f32.approx_eq(&23_424.215_f32));
    assert!(!1.0_f32.approx_eq(&1.1_f32));
    assert!(!24352.64_f32.approx_eq(&-54.0_f32));
    assert!(!1.0_f32.approx_eq_eps(&2.0_f32, 0.5));
}

#[test]
fn test_approx_eq_f64() {
    assert!(1.0_f64.approx_eq_eps(&1.1_f64, 0.15_f32));
    assert!(23424.2143_f64.approx_eq(&23424.2143_f64));
    assert!(!1.0_f64.approx_eq(&1.1_f64));
    assert!(!24352.64_f64.approx_eq(&-54.0_f64));
    assert!(!1.0_f64.approx_eq_eps(&2.0_f64, 0.5_f32));
}