anyint 0.1.0

provides traits and structs for working with integers of any bit size
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

use crate::convert::UncheckedFrom;
use crate::integer::int;
use crate::non_standard_integer::{NonStandardInteger, NonStandardIntegerCommon};

use num_traits::{
    AsPrimitive, Bounded, CheckedAdd, CheckedDiv, CheckedMul, CheckedShl, CheckedShr, CheckedSub,
    FromPrimitive, One, SaturatingAdd, SaturatingMul, SaturatingSub, ToPrimitive, WrappingAdd,
    WrappingMul, WrappingSub, Zero,
};

impl<T, const BITS: u32> Bounded for int<T, BITS>
where
    T: PartialOrd + Copy,
    Self: NonStandardInteger<T, BITS>,
{
    fn min_value() -> Self {
        NonStandardInteger::<T, BITS>::min_value()
    }

    fn max_value() -> Self {
        NonStandardInteger::<T, BITS>::max_value()
    }
}

impl<T, const BITS: u32> AsPrimitive<T> for int<T, BITS>
where
    T: 'static + PartialOrd + Copy,
    Self: NonStandardInteger<T, BITS>,
{
    fn as_(self) -> T {
        self.0
    }
}

impl<T, const BITS: u32> FromPrimitive for int<T, BITS>
where
    T: PartialOrd + Copy + AsPrimitive<i64> + From<i64> + AsPrimitive<u64> + From<u64>,
    Self: NonStandardInteger<T, BITS> + UncheckedFrom<T>,
{
    fn from_u64(n: u64) -> Option<Self> {
        let min: u64 = Self::MIN.as_();
        let max: u64 = Self::MAX.as_();
        (min <= n && n < max).then(|| unsafe { Self::from_unchecked(n.into()) })
    }

    fn from_i64(n: i64) -> Option<Self> {
        let min: i64 = Self::MIN.as_();
        let max: i64 = Self::MAX.as_();
        (min <= n && n < max).then(|| unsafe { Self::from_unchecked(n.into()) })
    }
}

impl<T, const BITS: u32> ToPrimitive for int<T, BITS>
where
    T: PartialOrd + Copy + ToPrimitive,
    Self: NonStandardInteger<T, BITS>,
{
    fn to_i64(&self) -> Option<i64> {
        self.0.to_i64()
    }

    fn to_u64(&self) -> Option<u64> {
        self.0.to_u64()
    }
}

impl<T, const BITS: u32> One for int<T, BITS>
where
    T: PartialOrd + Copy + One,
    Self: NonStandardIntegerCommon<T, BITS> + UncheckedFrom<T>,
{
    fn one() -> Self {
        // lazy
        Self(One::one())
    }
}

impl<T, const BITS: u32> Zero for int<T, BITS>
where
    T: PartialOrd + Copy + Zero,
    Self: NonStandardIntegerCommon<T, BITS> + UncheckedFrom<T>,
{
    fn zero() -> Self {
        // lazy
        Self(Zero::zero())
    }

    fn is_zero(&self) -> bool {
        self.0 == Zero::zero()
    }
}

#[doc(hidden)]
/// Forward methods from `NonStandardIntegerCommon` for num-traits
pub macro num_trait_impl($trait_name:ident, $method:ident, $ty:ty) {
    impl<T, const BITS: u32> $trait_name for int<T, BITS>
    where
        T: PartialOrd + Copy,
        Self: NonStandardIntegerCommon<T, BITS>,
    {
        #[inline]
        fn $method(&self, v: &Self) -> $ty {
            <Self as NonStandardIntegerCommon<T, BITS>>::$method(*self, *v)
        }
    }
}

#[doc(hidden)]
/// Forward shr and shl methods from `NonStandardIntegerCommon` for num-traits
pub macro num_trait_shift_impl($trait_name:path, $method:ident, $ty:ty) {
    impl<T, const BITS: u32> $trait_name for int<T, BITS>
    where
        T: PartialOrd + Copy,
        Self: NonStandardIntegerCommon<T, BITS>,
    {
        #[inline]
        fn $method(&self, v: u32) -> $ty {
            <Self as NonStandardIntegerCommon<T, BITS>>::$method(*self, v)
        }
    }
}

num_trait_impl!(CheckedAdd, checked_add, Option<Self>);
num_trait_impl!(CheckedSub, checked_sub, Option<Self>);
num_trait_impl!(CheckedMul, checked_mul, Option<Self>);
num_trait_impl!(CheckedDiv, checked_div, Option<Self>);
// checked_impl!(num_traits::CheckedRem, checked_rem);
num_trait_shift_impl!(CheckedShl, checked_shl, Option<Self>);
num_trait_shift_impl!(CheckedShr, checked_shr, Option<Self>);

num_trait_impl!(WrappingAdd, wrapping_add, Self);
num_trait_impl!(WrappingSub, wrapping_sub, Self);
num_trait_impl!(WrappingMul, wrapping_mul, Self);
// num_trait_shift_impl!(num_traits::WrappingShl, wrapping_shl, Self);
// num_trait_shift_impl!(num_traits::WrappingShr, wrapping_shr, Self);

num_trait_impl!(SaturatingAdd, saturating_add, Self);
num_trait_impl!(SaturatingSub, saturating_sub, Self);
num_trait_impl!(SaturatingMul, saturating_mul, Self);

#[cfg(test)]
mod tests {
    #![allow(non_camel_case_types)]

    use super::*;
    type u6 = int<u8, 6>;

    #[test]
    fn as_primative() {
        let n = u6::new(5);
        assert_eq!(AsPrimitive::as_(n), 5)
    }

    fn checked_add() {
        let n = u6::new(5);
        assert_eq!(CheckedAdd::checked_add(&n, &n), Some(u6::new(10)))
    }
}