bnum 0.14.0

Arbitrary, fixed size numeric types that extend the functionality of primitive numeric types.
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
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298

use crate::{Int, Integer};
use crate::OverflowMode;

use core::ops::{
    Add, AddAssign, BitAnd, BitAndAssign, BitOr, BitOrAssign, BitXor, BitXorAssign, Div, DivAssign,
    Mul, MulAssign, Neg, Not, Rem, RemAssign, Shl, ShlAssign, Shr, ShrAssign, Sub, SubAssign,
};

impl<const S: bool, const N: usize, const B: usize, const OM: u8> BitAnd for Integer<S, N, B, OM> {
    type Output = Self;

    #[inline]
    fn bitand(self, rhs: Self) -> Self {
        Self::bitand(self, rhs)
    }
}

impl<const S: bool, const N: usize, const B: usize, const OM: u8> BitOr for Integer<S, N, B, OM> {
    type Output = Self;

    #[inline]
    fn bitor(self, rhs: Self) -> Self {
        Self::bitor(self, rhs)
    }
}

impl<const S: bool, const N: usize, const B: usize, const OM: u8> BitXor for Integer<S, N, B, OM> {
    type Output = Self;

    #[inline]
    fn bitxor(self, rhs: Self) -> Self {
        Self::bitxor(self, rhs)
    }
}

impl<const S: bool, const N: usize, const B: usize, const OM: u8> Not for Integer<S, N, B, OM> {
    type Output = Self;

    #[inline]
    fn not(self) -> Self {
        Self::not(self)
    }
}

impl<const S: bool, const N: usize, const B: usize, const OM: u8> Not for &Integer<S, N, B, OM> {
    type Output = Integer<S, N, B, OM>;

    #[inline]
    fn not(self) -> Integer<S, N, B, OM> {
        (*self).not()
    }
}

impl<const N: usize, const B: usize, const OM: u8> Neg for Int<N, B, OM> {
    type Output = Self;

    #[inline]
    fn neg(self) -> Self {
        Self::neg(self)
    }
}

impl<const N: usize, const B: usize, const OM: u8> Neg for &Int<N, B, OM> {
    type Output = Int<N, B, OM>;

    #[inline]
    fn neg(self) -> Int<N, B, OM> {
        Int::neg(*self)
    }
}

impl<const S: bool, const N: usize, const B: usize, const OM: u8> Add for Integer<S, N, B, OM> {
    type Output = Self;

    #[inline]
    fn add(self, rhs: Self) -> Self {
        Self::add(self, rhs)
    }
}

impl<const S: bool, const N: usize, const B: usize, const OM: u8> Sub for Integer<S, N, B, OM> {
    type Output = Self;

    #[inline]
    fn sub(self, rhs: Self) -> Self {
        Self::sub(self, rhs)
    }
}

impl<const S: bool, const N: usize, const B: usize, const OM: u8> Mul for Integer<S, N, B, OM> {
    type Output = Self;

    #[inline]
    fn mul(self, rhs: Self) -> Self {
        Self::mul(self, rhs)
    }
}

impl<const S: bool, const N: usize, const B: usize, const OM: u8> Div for Integer<S, N, B, OM> {
    type Output = Self;

    #[inline]
    fn div(self, rhs: Self) -> Self {
        Self::div(self, rhs)
    }
}

// impl<const N: usize> Div<u64> for Uint<N> {
//     type Output = Self;

//     #[inline]
//     fn div(self, rhs: u64) -> Self {
//         self.div_rem_u64(rhs).0
//     }
// }

impl<const S: bool, const N: usize, const B: usize, const OM: u8> Rem for Integer<S, N, B, OM> {
    type Output = Self;

    #[inline]
    fn rem(self, rhs: Self) -> Self {
        Self::rem(self, rhs)
    }
}

// impl<const N: usize> Rem<u64> for Uint<N> {
//     type Output = u64;

//     #[inline]
//     fn rem(self, rhs: u64) -> u64 {
//         self.div_rem_u64(rhs).1
//     }
// }

use crate::helpers::full_op_impl;

full_op_impl!(<const S: bool, const N: usize, const B: usize, const OM: u8> BitAnd, BitAndAssign, Integer<S, N, B, OM>, bitand, bitand_assign for Integer<S, N, B, OM>);
full_op_impl!(<const S: bool, const N: usize, const B: usize, const OM: u8> BitOr, BitOrAssign, Integer<S, N, B, OM>, bitor, bitor_assign for Integer<S, N, B, OM>);
full_op_impl!(<const S: bool, const N: usize, const B: usize, const OM: u8> BitXor, BitXorAssign, Integer<S, N, B, OM>, bitxor, bitxor_assign for Integer<S, N, B, OM>);
full_op_impl!(<const S: bool, const N: usize, const B: usize, const OM: u8> Add, AddAssign, Integer<S, N, B, OM>, add, add_assign for Integer<S, N, B, OM>);
full_op_impl!(<const S: bool, const N: usize, const B: usize, const OM: u8> Sub, SubAssign, Integer<S, N, B, OM>, sub, sub_assign for Integer<S, N, B, OM>);
full_op_impl!(<const S: bool, const N: usize, const B: usize, const OM: u8> Mul, MulAssign, Integer<S, N, B, OM>, mul, mul_assign for Integer<S, N, B, OM>);
full_op_impl!(<const S: bool, const N: usize, const B: usize, const OM: u8> Div, DivAssign, Integer<S, N, B, OM>, div, div_assign for Integer<S, N, B, OM>);
full_op_impl!(<const S: bool, const N: usize, const B: usize, const OM: u8> Rem, RemAssign, Integer<S, N, B, OM>, rem, rem_assign for Integer<S, N, B, OM>);

trait ConstOverflowMode {
    const OVERFLOW_MODE: OverflowMode;
}

macro_rules! shift_impl {
    (<$(const $C: ident : $CType: ty), *> $int: ty, $Trait: ident, $AssignTrait: ident, $method: ident, $assign: ident, $err: expr, shift_by: $rhs: ty) => {
        impl<$(const $C: $CType), *> $Trait<$rhs> for $int {
            type Output = $int;

            #[inline]
            fn $method(self, rhs: $rhs) -> Self {
                use crate::Exponent;
                use crate::cast::As;

                if <$rhs>::BITS <= Exponent::BITS {
                    return Self::$method(self, rhs.as_::<Exponent>());
                }

                let rhs: Exponent = match Self::OVERFLOW_MODE {
                    OverflowMode::Wrap => {
                        let bits: $rhs = Self::BITS.as_(); // need to cast to rhs as Self::BITS may not be power of two, so need to perform modulo in $rhs type
                        let rhs = rhs.rem_euclid(bits); // Euclidean remainder as must always be positive (since we could be using signed types)

                        rhs.as_() // now rhs is positive and is less than Self::BITS, so fits in Exponent, so safe to cast
                    },
                    OverflowMode::Panic => Exponent::try_from(rhs).expect(crate::errors::err_msg!($err)),
                    OverflowMode::Saturate => Exponent::try_from(rhs).unwrap_or(Exponent::MAX), // this is fine since we have the assertion in [`Self::from_bytes`] that N < 2^29, so any rhs >= Exponent::MAX will saturate
                };
                
                Self::$method(self, rhs)
            }
        }

        full_op_impl!(<$(const $C: $CType), *> $Trait, $AssignTrait, $rhs, $method, $assign for $int);
    }
}

macro_rules! all_shift_impls {
    ($($int: ty), *) => {
        $(
            impl ConstOverflowMode for $int {
                const OVERFLOW_MODE: OverflowMode = crate::OverflowMode::DEFAULT;
            } // we have to have this so then we can use Self::OVERFLOW_MODE in the same macro for primitive ints and Integer

            shift_impl!(<const S: bool, const N: usize, const B: usize, const OM: u8> Integer<S, N, B, OM>, Shl, ShlAssign, shl, shl_assign, "attempt to shift left with overflow", shift_by: $int);

            shift_impl!(<const S: bool, const N: usize, const B: usize, const OM: u8> Integer<S, N, B, OM>, Shr, ShrAssign, shr, shr_assign, "attempt to shift right with overflow", shift_by: $int);

            shift_impl!(<const S: bool, const N: usize, const B: usize, const OM: u8> $int, Shl, ShlAssign, shl, shl_assign, "attempt to shift left with overflow", shift_by: Integer<S, N, B, OM>);
            shift_impl!(<const S: bool, const N: usize, const B: usize, const OM: u8> $int, Shr, ShrAssign, shr, shr_assign, "attempt to shift right with overflow", shift_by: Integer<S, N, B, OM>);
        )*
    }
}

all_shift_impls!(u8, u16, u32, u64, u128, usize, i8, i16, i32, i64, i128, isize);

shift_impl!(<const S: bool, const N: usize, const B: usize, const R: bool, const M: usize, const A: usize, const OM: u8> Integer<S, N, B, OM>, Shl, ShlAssign, shl, shl_assign, "attempt to shift left with overflow", shift_by: Integer<R, M, A, OM>);
shift_impl!(<const S: bool, const N: usize, const B: usize, const R: bool, const M: usize, const A: usize, const OM: u8> Integer<S, N, B, OM>, Shr, ShrAssign, shr, shr_assign, "attempt to shift right with overflow", shift_by: Integer<R, M, A, OM>);

#[cfg(test)]
crate::test::test_all_custom_bit_widths! {
    use crate::test::test_bignum;
    use core::ops::{BitAnd, BitOr, BitXor, Not};

    test_bignum! {
        function: <utest as BitAnd>::bitand(a: utest, b: utest)
    }
    test_bignum! {
        function: <utest as BitOr>::bitor(a: utest, b: utest)
    }
    test_bignum! {
        function: <utest as BitXor>::bitxor(a: utest, b: utest)
    }
    test_bignum! {
        function: <utest as Not>::not(a: utest)
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::Exponent;
    use crate::test::{test_bignum, debug_skip};

    macro_rules! test_shifts {
        ($($rhs: ty), *) => {
            $(
                crate::test::test_bignum! {
                    function: <stest as Shl<$rhs> >::shl(a: stest, b: $rhs),
                    skip: debug_skip!(match Exponent::try_from(b) {
                        Ok(b) => b >= stest::BITS,
                        Err(_) => true,
                    })
                }
                crate::test::test_bignum! {
                    function: <stest as Shr<$rhs> >::shr(a: stest, b: $rhs),
                    skip: debug_skip!(match Exponent::try_from(b) {
                        Ok(b) => b >= <stest>::BITS,
                        Err(_) => true,
                    })
                }
            )*
        }
    }

    crate::test::test_all! {
        testing integers;

        test_bignum! {
            function: <stest as Add>::add(a: stest, b: stest),
            skip: a.checked_add(b).is_none()
        }
        test_bignum! {
            function: <stest as BitAnd>::bitand(a: stest, b: stest)
        }
        test_bignum! {
            function: <stest as BitOr>::bitor(a: stest, b: stest)
        }
        test_bignum! {
            function: <stest as BitXor>::bitxor(a: stest, b: stest)
        }
        test_bignum! {
            function: <stest as Div>::div(a: stest, b: stest),
            skip: a.checked_div(b).is_none()
        }
        test_bignum! {
            function: <stest as Rem>::rem(a: stest, b: stest),
            skip: a.checked_rem(b).is_none()
        }
        test_bignum! {
            function: <stest as Not>::not(a: stest)
        }
        test_bignum! {
            function: <stest as Sub>::sub(a: stest, b: stest),
            skip: a.checked_sub(b).is_none()
        }
        test_bignum! {
            function: <stest as Mul>::mul(a: stest, b: stest),
            skip: a.checked_mul(b).is_none()
        }

        test_shifts!(u8, u16, u32, u64, u128, usize, i8, i16, i32, i64, i128, isize);
    }

    crate::test::test_all! {
        testing signed;

        test_bignum! {
            function: <itest>::neg(a: itest),
            skip: debug_skip!(a == itest::MIN)
        }
    }
}