textiler-core 0.1.0

Provides the core utilities to get textiler to work
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

use serde::{Deserialize, Serialize};
use std::cmp::Ordering;
use std::fmt::{Debug, Display, Formatter};
use std::hash::{Hash, Hasher};
use std::ops::{Add, Deref, Sub};

#[derive(Copy, Clone, PartialEq, PartialOrd, Serialize, Deserialize)]
#[serde(transparent)]
pub struct BoundedFloat<const LOW: i16, const HIGH: i16> {
    num: f32,
}

impl<const LOW: i16, const HIGH: i16> Debug for BoundedFloat<LOW, HIGH> {
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        write!(f, "{:.?}", self.num)
    }
}

impl<const LOW: i16, const HIGH: i16> Display for BoundedFloat<LOW, HIGH> {
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        write!(f, "{}", self.num)
    }
}

impl<const LOW: i16, const HIGH: i16> Sub for BoundedFloat<LOW, HIGH> {
    type Output = f32;

    fn sub(self, rhs: Self) -> Self::Output {
        *self - *rhs
    }
}

impl<const LOW: i16, const HIGH: i16> Add for BoundedFloat<LOW, HIGH> {
    type Output = f32;

    fn add(self, rhs: Self) -> Self::Output {
        *self + *rhs
    }
}

impl<const LOW: i16, const HIGH: i16> Eq for BoundedFloat<LOW, HIGH> {}

impl<const LOW: i16, const HIGH: i16> Ord for BoundedFloat<LOW, HIGH> {
    fn cmp(&self, other: &Self) -> Ordering {
        self.partial_cmp(other)
            .expect("should always be successful")
    }
}

impl<const LOW: i16, const HIGH: i16> Hash for BoundedFloat<LOW, HIGH> {
    fn hash<H: Hasher>(&self, state: &mut H) {
        let raw_bytes = self.to_be_bytes();
        u32::from_be_bytes(raw_bytes).hash(state);
    }
}

impl<const LOW: i16, const HIGH: i16> Deref for BoundedFloat<LOW, HIGH> {
    type Target = f32;

    fn deref(&self) -> &Self::Target {
        &self.num
    }
}

impl<const LOW: i16, const HIGH: i16> BoundedFloat<LOW, HIGH> {
    pub const MIN: BoundedFloat<LOW, HIGH> = BoundedFloat { num: LOW as f32 };

    pub const MAX: BoundedFloat<LOW, HIGH> = BoundedFloat { num: HIGH as f32 };

    /// Creates a bounded float value, if the given val is within the range given
    pub fn new(val: f32) -> Option<Self> {
        if val >= LOW as f32 && val <= HIGH as f32 {
            Some(Self { num: val })
        } else {
            None
        }
    }
}

#[cfg(test)]
mod tests {
    use crate::utils::bounded_float::BoundedFloat;
    use std::collections::BTreeSet;

    #[test]
    fn bounded_floats() {
        BoundedFloat::<0, 1>::new(0.1).expect("is valid");
        assert!(BoundedFloat::<0, 1>::new(1.1).is_none());
    }

    #[test]
    fn bounded_floats_inclusive() {
        BoundedFloat::<0, 1>::new(0.).expect("is valid");
        BoundedFloat::<0, 1>::new(1.).expect("is valid");
    }

    #[test]
    fn bounded_float_rejects_nan() {
        assert!(BoundedFloat::<0, 1>::new(f32::NAN).is_none());
    }

    #[test]
    fn bounded_float_btree() {
        let mut map = BTreeSet::<BoundedFloat<0, 1>>::new();
        map.insert(BoundedFloat::new(0.7).unwrap());
        map.insert(BoundedFloat::new(0.03).unwrap());
        map.insert(BoundedFloat::new(0.9).unwrap());
        map.insert(BoundedFloat::new(0.8).unwrap());
        map.insert(BoundedFloat::new(0.2).unwrap());

        map.iter()
            .inspect(|f| println!("{f:#?}"))
            .try_fold(
                f32::MIN,
                |acc, &next| {
                    if *next > acc {
                        Ok(*next)
                    } else {
                        Err(())
                    }
                },
            )
            .expect("should be okay");
    }
}