microfloat 0.1.1

8-bit and sub-byte floating point types
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
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

use microfloat::f8e8m0fnu;
use proptest::prelude::*;

prop_compose! {
    fn any_f8e8m0fnu() (bits in 0u8..) -> f8e8m0fnu {
        f8e8m0fnu::from_bits(bits)
    }
}

#[test]
fn roundtrip_from_bits_to_bits() {
    proptest!(|(bits in 0u8..)| {
        let v = f8e8m0fnu::from_bits(bits);
        assert_eq!(v.to_bits(), bits);
    });
}

#[test]
fn add_zero_identity() {
    proptest!(|(v in any_f8e8m0fnu())| {
        if v.is_finite() {
            let result = v + f8e8m0fnu::ZERO;
            if result.is_finite() {
                let diff = (result.to_f32() - v.to_f32()).abs();
                assert!(diff <= 1.0);
            }
        }
    });
}

#[test]
fn mul_one_identity() {
    proptest!(|(v in any_f8e8m0fnu())| {
        if v.is_finite() {
            let result = v * f8e8m0fnu::ONE;
            if result.is_finite() {
                let diff = (result.to_f32() - v.to_f32()).abs();
                assert!(diff <= 1.0);
            }
        }
    });
}

#[test]
fn abs_non_negative() {
    proptest!(|(v in any_f8e8m0fnu())| {
        if v.is_finite() {
            let abs = v.abs();
            assert!(!abs.is_sign_negative());
        }
    });
}

#[test]
fn floor_ceil_ordering() {
    proptest!(|(v in any_f8e8m0fnu())| {
        if v.is_finite() {
            let f = v.floor();
            let c = v.ceil();
            let fv = v.to_f32();
            if f.is_finite() {
                assert!(f.to_f32() <= fv);
            }
            if c.is_finite() {
                assert!(c.to_f32() >= fv);
            }
        }
    });
}

#[test]
fn total_cmp_reflexive() {
    proptest!(|(v in any_f8e8m0fnu())| {
        if !v.is_nan() {
            assert_eq!(v.total_cmp(&v), core::cmp::Ordering::Equal);
        }
    });
}

#[test]
fn one_is_finite() {
    assert!(f8e8m0fnu::ONE.is_finite());
    assert!(f8e8m0fnu::ONE.is_normal());
}

#[test]
fn display_does_not_panic() {
    proptest!(|(v in any_f8e8m0fnu())| {
        let _ = format!("{v}");
    });
}

#[test]
fn nan_propagates_on_add() {
    proptest!(|(v in any_f8e8m0fnu())| {
        assert!((v + f8e8m0fnu::NAN).is_nan());
        assert!((f8e8m0fnu::NAN + v).is_nan());
    });
}

#[test]
fn nan_propagates_on_sub() {
    proptest!(|(v in any_f8e8m0fnu())| {
        assert!((v - f8e8m0fnu::NAN).is_nan());
        assert!((f8e8m0fnu::NAN - v).is_nan());
    });
}

#[test]
fn nan_propagates_on_mul() {
    proptest!(|(v in any_f8e8m0fnu())| {
        assert!((v * f8e8m0fnu::NAN).is_nan());
        assert!((f8e8m0fnu::NAN * v).is_nan());
    });
}

#[test]
fn compound_assign_eq_binary_add() {
    proptest!(|(a in any_f8e8m0fnu().prop_filter("non-nan", |v| !v.is_nan()), b in any_f8e8m0fnu().prop_filter("non-nan", |v| !v.is_nan()))| {
        let mut x = a;
        x += b;
        prop_assert!(x == a + b || (x.is_nan() && (a + b).is_nan()));
    });
}

#[test]
fn compound_assign_eq_binary_sub() {
    proptest!(|(a in any_f8e8m0fnu().prop_filter("non-nan", |v| !v.is_nan()), b in any_f8e8m0fnu().prop_filter("non-nan", |v| !v.is_nan()))| {
        let mut x = a;
        x -= b;
        prop_assert!(x == a - b || (x.is_nan() && (a - b).is_nan()));
    });
}

#[test]
fn compound_assign_eq_binary_mul() {
    proptest!(|(a in any_f8e8m0fnu().prop_filter("non-nan", |v| !v.is_nan()), b in any_f8e8m0fnu().prop_filter("non-nan", |v| !v.is_nan()))| {
        let mut x = a;
        x *= b;
        prop_assert!(x == a * b || (x.is_nan() && (a * b).is_nan()));
    });
}

#[test]
fn compound_assign_eq_binary_div() {
    proptest!(|(a in any_f8e8m0fnu().prop_filter("non-nan", |v| !v.is_nan()), b in any_f8e8m0fnu().prop_filter("non-nan", |v| !v.is_nan()))| {
        let mut x = a;
        x /= b;
        prop_assert!(x == a / b || (x.is_nan() && (a / b).is_nan()));
    });
}

#[test]
fn compound_assign_eq_binary_rem() {
    proptest!(|(a in any_f8e8m0fnu().prop_filter("non-nan", |v| !v.is_nan()), b in any_f8e8m0fnu().prop_filter("non-nan", |v| !v.is_nan()))| {
        let mut x = a;
        x %= b;
        prop_assert!(x == a % b || (x.is_nan() && (a % b).is_nan()));
    });
}

#[test]
fn iter_sum() {
    proptest!(|(a in any_f8e8m0fnu().prop_filter("non-nan", |v| !v.is_nan()), b in any_f8e8m0fnu().prop_filter("non-nan", |v| !v.is_nan()), c in any_f8e8m0fnu().prop_filter("non-nan", |v| !v.is_nan()))| {
        let values = [a, b, c];
        prop_assert!(values.into_iter().sum::<f8e8m0fnu>() == a + b + c || (values.into_iter().sum::<f8e8m0fnu>().is_nan() && (a + b + c).is_nan()));
        prop_assert!(values.iter().sum::<f8e8m0fnu>() == a + b + c || (values.iter().sum::<f8e8m0fnu>().is_nan() && (a + b + c).is_nan()));
    });
}

#[test]
fn iter_product() {
    proptest!(|(a in any_f8e8m0fnu().prop_filter("non-nan", |v| !v.is_nan()), b in any_f8e8m0fnu().prop_filter("non-nan", |v| !v.is_nan()), c in any_f8e8m0fnu().prop_filter("non-nan", |v| !v.is_nan()))| {
        let values = [a, b, c];
        prop_assert!(values.into_iter().product::<f8e8m0fnu>() == a * b * c || (values.into_iter().product::<f8e8m0fnu>().is_nan() && (a * b * c).is_nan()));
        prop_assert!(values.iter().product::<f8e8m0fnu>() == a * b * c || (values.iter().product::<f8e8m0fnu>().is_nan() && (a * b * c).is_nan()));
    });
}