isclose 0.3.0

A collection of trait and macros for comparing approximate equality
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

use crate::IsClose;

use half::{bf16, f16};

impl IsClose for f16 {
    type Tolerance = Self;
    const ZERO_TOL: Self = Self::ZERO;
    const ABS_TOL: Self = Self::from_f32_const(1e-3);
    const REL_TOL: Self = Self::from_f32_const(1e-3);

    #[inline]
    fn is_close_tol(&self, other: &Self, rel_tol: &Self, abs_tol: &Self) -> bool {
        self.to_f32()
            .is_close_tol(&other.to_f32(), &rel_tol.to_f32(), &abs_tol.to_f32())
    }
}

impl IsClose for bf16 {
    type Tolerance = Self;
    const ZERO_TOL: Self = Self::ZERO;
    const ABS_TOL: Self = Self::from_f32_const(1e-2);
    const REL_TOL: Self = Self::from_f32_const(1e-2);

    #[inline]
    fn is_close_tol(&self, other: &Self, rel_tol: &Self, abs_tol: &Self) -> bool {
        self.to_f32()
            .is_close_tol(&other.to_f32(), &rel_tol.to_f32(), &abs_tol.to_f32())
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn f16_is_close_tol() {
        use half::f16;
        assert!((f16::from_f32(0.1) + f16::from_f32(0.2)).is_close(&f16::from_f32(0.3)));
        assert!(!(f16::from_f32(0.1) + f16::from_f32(0.2)).is_close_tol(
            &f16::from_f32(0.3),
            &f16::from_f32(1e-6),
            &f16::from_f32(1e-6)
        ));
    }

    #[test]
    fn bf16_is_close_tol() {
        use half::bf16;
        assert!((bf16::from_f32(0.3) + bf16::EPSILON).is_close(&bf16::from_f32(0.3)));
        assert!(!(bf16::from_f32(0.3) + bf16::EPSILON).is_close_tol(
            &bf16::from_f32(0.3),
            &bf16::from_f32(1e-4),
            &bf16::from_f32(1e-4)
        ));
    }
}