f8 0.1.2

It's a float! It's a unorm! It's only one byte!
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

//! A no-standard crate which provides an f8 type.

#![no_std]

#[cfg(feature = "serde")]
#[macro_use]
extern crate serde;

const RECIP: f32 = 1.0 / ((u8::MAX) as f32 + 1.0);

/// An 8-bit floating point number constrained to a value within the inclusive range of [0, 1].
#[allow(non_camel_case_types)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
#[derive(Clone, Copy, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
pub struct f8(u8);

impl f8 {
    /// Returns this `f8` as a `u8`.
    #[inline]
    pub fn byte(self) -> u8 {
        self.0
    }

    /// Returns this `f8` as a `f32`.
    #[inline]
    pub fn float(self) -> f32 {
        self.into()
    }
}

impl From<u8> for f8 {
    #[inline]
    fn from(val: u8) -> Self {
        Self(val)
    }
}

impl From<f32> for f8 {
    #[inline]
    fn from(val: f32) -> Self {
        Self((val / RECIP) as _)
    }
}

impl From<f8> for u8 {
    #[inline]
    fn from(val: f8) -> Self {
        val.0
    }
}

impl From<f8> for f32 {
    #[inline]
    fn from(val: f8) -> Self {
        val.0 as f32 / u8::MAX as f32
    }
}

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

    #[test]
    fn basic_conversions() {
        assert_eq![0.0, f8::from(0).float()];
        assert_eq![1.0, f8::from(255).float()];

        assert_eq![0, f8::from(0.0).byte()];
        assert_eq![1, f8::from(RECIP).byte()];
        assert_eq![255, f8::from(1.0).byte()];
    }
}