arkley_traits 0.0.2

This crate provides several traits for common mathematical operations
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

/// Trait for types that represent a zero value.
pub trait Zero : PartialEq + Sized {
    /// Checks if the value is zero.
    ///
    /// # Returns
    ///
    /// `true` if the value is zero, `false` otherwise.
    fn is_zero(&self) -> bool {
        *self == Self::zero()
    }

    /// The zero value for the implementing type.
    fn zero() -> Self;
}

macro_rules! impl_zero {
    ($($t:ty => $v : expr)*) => {
        $(
            impl Zero for $t {
                fn zero() -> Self { $v }
            }
        )*
    };
}

impl_zero!(
    i8 => 0
    i16 => 0
    i32 => 0
    i64 => 0

    u8 => 0
    u16 => 0
    u32 => 0
    u64 => 0

    f32 => 0.0
    f64 => 0.0
);

#[cfg(test)]
mod tests {
    use super::*;
    
    #[test]
    fn test_is_zero_i8() {
        let value: i8 = 0;
        assert!(value.is_zero());
    
        let value: i8 = 42;
        assert!(!value.is_zero());
    }
    
    #[test]
    fn test_is_zero_i16() {
        let value: i16 = 0;
        assert!(value.is_zero());
    
        let value: i16 = -10;
        assert!(!value.is_zero());
    }
    
    #[test]
    fn test_is_zero_i32() {
        let value: i32 = 0;
        assert!(value.is_zero());
    
        let value: i32 = 12345;
        assert!(!value.is_zero());
    }
    
    #[test]
    fn test_is_zero_i64() {
        let value: i64 = 0;
        assert!(value.is_zero());
    
        let value: i64 = -9876543210;
        assert!(!value.is_zero());
    }
}