relp-num 0.1.14

Number types for the relp crate
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

//! # NonZero signs of integers
use std::cmp::Ordering;
use std::num::{NonZeroU128, NonZeroU16, NonZeroU32, NonZeroU64, NonZeroU8, NonZeroUsize};
use std::num::{NonZeroI128, NonZeroI16, NonZeroI32, NonZeroI64, NonZeroI8, NonZeroIsize};

use crate::Negateable;
use crate::Sign;
use crate::Signed;

macro_rules! unsigned {
    ($ty:ty) => {
        impl Signed for $ty {
            #[inline]
            fn signum(&self) -> Sign {
                if *self == 0 {
                    Sign::Zero
                } else {
                    Sign::Positive
                }
            }
        }
    }
}

unsigned!(u8);
unsigned!(u16);
unsigned!(u32);
unsigned!(u64);
unsigned!(u128);
unsigned!(usize);

macro_rules! signed {
    ($ty:ty) => {
        impl Signed for $ty {
            #[inline]
            fn signum(&self) -> Sign {
                match self.cmp(&0) {
                    Ordering::Less => Sign::Negative,
                    Ordering::Equal => Sign::Zero,
                    Ordering::Greater => Sign::Positive,
                }
            }
        }

        impl Negateable for $ty {
            #[inline]
            fn negate(&mut self) {
                *self = -*self;
            }
        }
    }
}

signed!(i8);
signed!(i16);
signed!(i32);
signed!(i64);
signed!(i128);
signed!(isize);

macro_rules! non_zero_unsigned {
    ($ty:ty) => {
        impl Signed for $ty {
            #[inline]
            fn signum(&self) -> Sign {
                Sign::Positive
            }
        }
    }
}

non_zero_unsigned!(NonZeroU8);
non_zero_unsigned!(NonZeroU16);
non_zero_unsigned!(NonZeroU32);
non_zero_unsigned!(NonZeroU64);
non_zero_unsigned!(NonZeroU128);
non_zero_unsigned!(NonZeroUsize);

macro_rules! non_zero_signed {
    ($ty:ty) => {
        impl Signed for $ty {
            #[inline]
            fn signum(&self) -> Sign {
                if self.get() > 0 {
                    Sign::Positive
                } else {
                    Sign::Negative
                }
            }
        }

        impl Negateable for $ty {
            #[inline]
            fn negate(&mut self) {
                *self = unsafe {
                    // SAFETY: Was non zero before, only sign gets flipped.
                    <$ty>::new_unchecked(-self.get())
                };
            }
        }
    }
}

non_zero_signed!(NonZeroI8);
non_zero_signed!(NonZeroI16);
non_zero_signed!(NonZeroI32);
non_zero_signed!(NonZeroI64);
non_zero_signed!(NonZeroI128);
non_zero_signed!(NonZeroIsize);

#[cfg(test)]
mod test {
    use std::num::{NonZeroI8, NonZeroU8};

    use crate::{NonZeroSign, NonZeroSigned};

    #[test]
    fn test_zero_sign() {
        assert_eq!(1_u32.non_zero_signum(), NonZeroSign::Positive);
        assert_eq!(-1_u32.non_zero_signum(), NonZeroSign::Negative);

        assert_eq!(NonZeroU8::new(1).unwrap().non_zero_signum(), NonZeroSign::Positive);
        assert_eq!(NonZeroI8::new(1).unwrap().non_zero_signum(), NonZeroSign::Positive);
        assert_eq!(NonZeroI8::new(-1).unwrap().non_zero_signum(), NonZeroSign::Negative);
    }

    #[test]
    #[should_panic]
    fn test_non_zero_on_zero() {
        0_u32.non_zero_signum();
    }

    #[test]
    #[should_panic]
    fn test_non_zero_on_zero_signed() {
        0_i8.non_zero_signum();
    }
}