ux/
lib.rs

1//! # uX - non-standard-width integers types
2//!
3//! When non-standard-width integers is required in an applications, the norm is to use a larger container and make sure the value is within range after manipulation. uX aims to take care of this once and for all by:
4//!
5//! - Providing `u1`-`u127` and `i1`-`i127` types that should behave as similar as possible to the built in rust types
6//!     - The methods of the defined types are the same as for the built in types (far from all is implemented at this point but fill out an issue or create a PR if something essential for you is missing)
7//!     - Overflow will panic in debug and wrap in release.
8//! - All possible infallible conversions is possible by using `From` and all fallible conversion by using `TryFrom`.
9//!
10//! The uX types take up as much space as the smallest integer type that can contain them;
11//! the compiler can not yet be made aware of further optimization potential,
12//! and thus does not use it:
13//! an `Option<u7>` still takes up two bytes.
14
15#![cfg_attr(not(feature = "std"), no_std)]
16
17mod lib {
18    pub use core;
19}
20
21mod conversion;
22
23use lib::core::ops::{
24    BitAnd, BitAndAssign, BitOr, BitOrAssign, BitXor, BitXorAssign, Not, Shl, ShlAssign, Shr,
25    ShrAssign,
26};
27
28use lib::core::hash::{Hash, Hasher};
29
30use lib::core::cmp::{Ord, Ordering, PartialOrd};
31
32use lib::core::fmt::{Binary, Display, Formatter, LowerHex, Octal, UpperHex};
33
34macro_rules! define_unsigned {
35    ($name:ident, $bits:expr, $type:ident) => {define_unsigned!(#[doc=""], $name, $bits, $type);};
36    (#[$doc:meta], $name:ident, $bits:expr, $type:ident) => {
37
38       #[$doc]
39        #[allow(non_camel_case_types)]
40        #[derive(Default, Clone, Copy, Debug)]
41        pub struct $name($type);
42
43        impl $name {
44            pub const MAX: Self = $name(((1 as $type) << $bits) -1 );
45            pub const MIN: Self = $name(0);
46            pub const BITS: u32 = $bits;
47
48            fn mask(self) -> Self {
49                $name(self.0 & ( ((1 as $type) << $bits).overflowing_sub(1).0))
50            }
51        }
52
53        implement_common!($name, $bits, $type);
54
55    }
56}
57
58macro_rules! define_signed {
59    ($name:ident, $bits:expr, $type:ident) => {define_signed!(#[doc=""], $name, $bits, $type);};
60    (#[$doc:meta], $name:ident, $bits:expr, $type:ident) => {
61
62        #[$doc]
63        #[allow(non_camel_case_types)]
64        #[derive(Default, Clone, Copy, Debug)]
65        pub struct $name($type);
66
67        #[$doc]
68        impl $name {
69            pub const MAX: Self = $name(((1 as $type) << ($bits - 1)) - 1);
70            pub const MIN: Self = $name(-((1 as $type) << ($bits - 1)));
71            pub const BITS: u32 = $bits;
72
73            fn mask(self) -> Self {
74                if ( self.0 & (1<<($bits-1)) ) == 0 {
75                    $name(self.0 & ( ((1 as $type) << $bits).overflowing_sub(1).0))
76                } else {
77                    $name(self.0 | !( ((1 as $type) << $bits).overflowing_sub(1).0))
78                }
79            }
80        }
81
82        implement_common!($name, $bits, $type);
83
84    }
85}
86
87macro_rules! implement_common {
88    ($name:ident, $bits:expr, $type:ident) => {
89        impl $name {
90            /// Returns the smallest value that can be represented by this integer type.
91            pub fn min_value() -> $name {
92                $name::MIN
93            }
94            /// Returns the largest value that can be represented by this integer type.
95            pub fn max_value() -> $name {
96                $name::MAX
97            }
98
99            /// Crates a new variable
100            ///
101            /// This function mainly exists as there is currently not a better way to construct these types.
102            /// May be deprecated or removed if a better way to construct these types becomes available.
103            ///
104            /// # Examples
105            ///
106            /// Basic usage:
107            ///
108            /// ```
109            /// use ux::*;
110            ///
111            /// assert_eq!(u31::new(64), u31::from(64u8));
112            ///
113            /// ```
114            ///
115            /// # Panic
116            ///
117            /// This function will panic if `value` is not representable by this type
118            pub const fn new(value: $type) -> $name {
119                assert!(value <= $name::MAX.0 && value >= $name::MIN.0);
120                $name(value)
121            }
122
123            /// Wrapping (modular) subtraction. Computes `self - other`,
124            /// wrapping around at the boundary of the type.
125            ///
126            /// # Examples
127            ///
128            /// Basic usage:
129            ///
130            /// ```
131            /// use ux::*;
132            ///
133            /// assert_eq!(i5::MIN.wrapping_sub(i5::new(1)), i5::MAX);
134            ///
135            /// assert_eq!(i5::new(-10).wrapping_sub(i5::new(5)), i5::new(-15));
136            /// assert_eq!(i5::new(-15).wrapping_sub(i5::new(5)), i5::new(12));
137            /// ```
138            pub fn wrapping_sub(self, rhs: Self) -> Self {
139                $name(self.0.wrapping_sub(rhs.0)).mask()
140            }
141
142            /// Wrapping (modular) addition. Computes `self + other`,
143            /// wrapping around at the boundary of the type.
144            ///
145            /// # Examples
146            ///
147            /// Basic usage:
148            ///
149            /// ```
150            /// use ux::*;
151            ///
152            /// assert_eq!(i5::MAX.wrapping_add(i5::new(1)), i5::MIN);
153            ///
154            /// assert_eq!(i5::new(10).wrapping_add(i5::new(5)), i5::new(15));
155            /// assert_eq!(i5::new(15).wrapping_add(i5::new(5)), i5::new(-12));
156            /// ```
157            pub fn wrapping_add(self, rhs: Self) -> Self {
158                $name(self.0.wrapping_add(rhs.0)).mask()
159            }
160        }
161
162        impl PartialEq for $name {
163            fn eq(&self, other: &Self) -> bool {
164                self.0 == other.0
165            }
166        }
167
168        impl Eq for $name {}
169
170        impl PartialOrd for $name {
171            fn partial_cmp(&self, other: &$name) -> Option<Ordering> {
172                Some(self.cmp(other))
173            }
174        }
175
176        impl Ord for $name {
177            fn cmp(&self, other: &$name) -> Ordering {
178                self.0.cmp(&other.0)
179            }
180        }
181
182        impl Hash for $name {
183            fn hash<H: Hasher>(&self, h: &mut H) {
184                self.0.hash(h)
185            }
186        }
187
188        // Implement formating functions
189        impl Display for $name {
190            fn fmt(&self, f: &mut Formatter) -> Result<(), lib::core::fmt::Error> {
191                let $name(ref value) = self;
192                <$type as Display>::fmt(value, f)
193            }
194        }
195        impl UpperHex for $name {
196            fn fmt(&self, f: &mut Formatter) -> Result<(), lib::core::fmt::Error> {
197                let $name(ref value) = self;
198                <$type as UpperHex>::fmt(value, f)
199            }
200        }
201        impl LowerHex for $name {
202            fn fmt(&self, f: &mut Formatter) -> Result<(), lib::core::fmt::Error> {
203                let $name(ref value) = self;
204                <$type as LowerHex>::fmt(value, f)
205            }
206        }
207        impl Octal for $name {
208            fn fmt(&self, f: &mut Formatter) -> Result<(), lib::core::fmt::Error> {
209                let $name(ref value) = self;
210                <$type as Octal>::fmt(value, f)
211            }
212        }
213        impl Binary for $name {
214            fn fmt(&self, f: &mut Formatter) -> Result<(), lib::core::fmt::Error> {
215                let $name(ref value) = self;
216                <$type as Binary>::fmt(value, f)
217            }
218        }
219
220        impl<T> Shr<T> for $name
221        where
222            $type: Shr<T, Output = $type>,
223        {
224            type Output = $name;
225
226            fn shr(self, rhs: T) -> $name {
227                $name(self.0.shr(rhs))
228            }
229        }
230
231        impl<T> Shl<T> for $name
232        where
233            $type: Shl<T, Output = $type>,
234        {
235            type Output = $name;
236
237            fn shl(self, rhs: T) -> $name {
238                $name(self.0.shl(rhs)).mask()
239            }
240        }
241
242        impl<T> ShrAssign<T> for $name
243        where
244            $type: ShrAssign<T>,
245        {
246            fn shr_assign(&mut self, rhs: T) {
247                self.0.shr_assign(rhs);
248            }
249        }
250
251        impl<T> ShlAssign<T> for $name
252        where
253            $type: ShlAssign<T>,
254        {
255            fn shl_assign(&mut self, rhs: T) {
256                self.0.shl_assign(rhs);
257                *self = self.mask();
258            }
259        }
260
261        impl BitOr<$name> for $name {
262            type Output = $name;
263
264            fn bitor(self, rhs: $name) -> Self::Output {
265                $name(self.0.bitor(rhs.0))
266            }
267        }
268
269        impl<'a> BitOr<&'a $name> for $name {
270            type Output = <$name as BitOr<$name>>::Output;
271
272            fn bitor(self, rhs: &'a $name) -> Self::Output {
273                $name(self.0.bitor(rhs.0))
274            }
275        }
276
277        impl<'a> BitOr<$name> for &'a $name {
278            type Output = <$name as BitOr<$name>>::Output;
279
280            fn bitor(self, rhs: $name) -> Self::Output {
281                $name(self.0.bitor(rhs.0))
282            }
283        }
284
285        impl<'a> BitOr<&'a $name> for &'a $name {
286            type Output = <$name as BitOr<$name>>::Output;
287
288            fn bitor(self, rhs: &'a $name) -> Self::Output {
289                $name(self.0.bitor(rhs.0))
290            }
291        }
292
293        impl BitOrAssign<$name> for $name {
294            fn bitor_assign(&mut self, other: $name) {
295                self.0.bitor_assign(other.0)
296            }
297        }
298
299        impl BitXor<$name> for $name {
300            type Output = $name;
301
302            fn bitxor(self, rhs: $name) -> Self::Output {
303                $name(self.0.bitxor(rhs.0))
304            }
305        }
306
307        impl<'a> BitXor<&'a $name> for $name {
308            type Output = <$name as BitOr<$name>>::Output;
309
310            fn bitxor(self, rhs: &'a $name) -> Self::Output {
311                $name(self.0.bitxor(rhs.0))
312            }
313        }
314
315        impl<'a> BitXor<$name> for &'a $name {
316            type Output = <$name as BitOr<$name>>::Output;
317
318            fn bitxor(self, rhs: $name) -> Self::Output {
319                $name(self.0.bitxor(rhs.0))
320            }
321        }
322
323        impl<'a> BitXor<&'a $name> for &'a $name {
324            type Output = <$name as BitOr<$name>>::Output;
325
326            fn bitxor(self, rhs: &'a $name) -> Self::Output {
327                $name(self.0.bitxor(rhs.0))
328            }
329        }
330
331        impl BitXorAssign<$name> for $name {
332            fn bitxor_assign(&mut self, other: $name) {
333                self.0.bitxor_assign(other.0)
334            }
335        }
336
337        impl Not for $name {
338            type Output = $name;
339
340            fn not(self) -> $name {
341                $name(self.0.not()).mask()
342            }
343        }
344
345        impl<'a> Not for &'a $name {
346            type Output = <$name as Not>::Output;
347
348            fn not(self) -> $name {
349                $name(self.0.not()).mask()
350            }
351        }
352
353        impl BitAnd<$name> for $name {
354            type Output = $name;
355
356            fn bitand(self, rhs: $name) -> Self::Output {
357                $name(self.0.bitand(rhs.0))
358            }
359        }
360
361        impl<'a> BitAnd<&'a $name> for $name {
362            type Output = <$name as BitOr<$name>>::Output;
363
364            fn bitand(self, rhs: &'a $name) -> Self::Output {
365                $name(self.0.bitand(rhs.0))
366            }
367        }
368
369        impl<'a> BitAnd<$name> for &'a $name {
370            type Output = <$name as BitOr<$name>>::Output;
371
372            fn bitand(self, rhs: $name) -> Self::Output {
373                $name(self.0.bitand(rhs.0))
374            }
375        }
376
377        impl<'a> BitAnd<&'a $name> for &'a $name {
378            type Output = <$name as BitOr<$name>>::Output;
379
380            fn bitand(self, rhs: &'a $name) -> Self::Output {
381                $name(self.0.bitand(rhs.0))
382            }
383        }
384
385        impl BitAndAssign<$name> for $name {
386            fn bitand_assign(&mut self, other: $name) {
387                self.0.bitand_assign(other.0)
388            }
389        }
390
391        impl lib::core::ops::Add<$name> for $name {
392            type Output = $name;
393            #[allow(unused_comparisons)]
394            fn add(self, other: $name) -> $name {
395                if self.0 > 0 && other.0 > 0 {
396                    debug_assert!(Self::MAX.0 - other.0 >= self.0);
397                } else if self.0 < 0 && other.0 < 0 {
398                    debug_assert!(Self::MIN.0 - other.0 <= self.0);
399                }
400                self.wrapping_add(other)
401            }
402        }
403
404        impl lib::core::ops::Sub<$name> for $name {
405            type Output = $name;
406            #[allow(unused_comparisons)]
407            fn sub(self, other: $name) -> $name {
408                if self > other {
409                    debug_assert!(Self::MAX.0 + other.0 >= self.0);
410                } else if self < other {
411                    debug_assert!(Self::MIN.0 + other.0 <= self.0);
412                }
413                self.wrapping_sub(other)
414            }
415        }
416    };
417}
418
419define_unsigned!(#[doc="The 1-bit unsigned integer type."], u1, 1, u8);
420define_unsigned!(#[doc="The 2-bit unsigned integer type."], u2, 2, u8);
421define_unsigned!(#[doc="The 3-bit unsigned integer type."], u3, 3, u8);
422define_unsigned!(#[doc="The 4-bit unsigned integer type."], u4, 4, u8);
423define_unsigned!(#[doc="The 5-bit unsigned integer type."], u5, 5, u8);
424define_unsigned!(#[doc="The 6-bit unsigned integer type."], u6, 6, u8);
425define_unsigned!(#[doc="The 7-bit unsigned integer type."], u7, 7, u8);
426
427define_unsigned!(#[doc="The 9-bit unsigned integer type."], u9, 9, u16);
428define_unsigned!(#[doc="The 10-bit unsigned integer type."], u10, 10, u16);
429define_unsigned!(#[doc="The 11-bit unsigned integer type."], u11, 11, u16);
430define_unsigned!(#[doc="The 12-bit unsigned integer type."], u12, 12, u16);
431define_unsigned!(#[doc="The 13-bit unsigned integer type."], u13, 13, u16);
432define_unsigned!(#[doc="The 14-bit unsigned integer type."], u14, 14, u16);
433define_unsigned!(#[doc="The 15-bit unsigned integer type."], u15, 15, u16);
434
435define_unsigned!(#[doc="The 17-bit unsigned integer type."], u17, 17, u32);
436define_unsigned!(#[doc="The 18-bit unsigned integer type."], u18, 18, u32);
437define_unsigned!(#[doc="The 19-bit unsigned integer type."], u19, 19, u32);
438define_unsigned!(#[doc="The 20-bit unsigned integer type."], u20, 20, u32);
439define_unsigned!(#[doc="The 21-bit unsigned integer type."], u21, 21, u32);
440define_unsigned!(#[doc="The 22-bit unsigned integer type."], u22, 22, u32);
441define_unsigned!(#[doc="The 23-bit unsigned integer type."], u23, 23, u32);
442define_unsigned!(#[doc="The 24-bit unsigned integer type."], u24, 24, u32);
443
444define_unsigned!(#[doc="The 25-bit unsigned integer type."], u25, 25, u32);
445define_unsigned!(#[doc="The 26-bit unsigned integer type."], u26, 26, u32);
446define_unsigned!(#[doc="The 27-bit unsigned integer type."], u27, 27, u32);
447define_unsigned!(#[doc="The 28-bit unsigned integer type."], u28, 28, u32);
448define_unsigned!(#[doc="The 29-bit unsigned integer type."], u29, 29, u32);
449define_unsigned!(#[doc="The 30-bit unsigned integer type."], u30, 30, u32);
450define_unsigned!(#[doc="The 31-bit unsigned integer type."], u31, 31, u32);
451
452define_unsigned!(#[doc="The 33-bit unsigned integer type."], u33, 33, u64);
453define_unsigned!(#[doc="The 34-bit unsigned integer type."], u34, 34, u64);
454define_unsigned!(#[doc="The 35-bit unsigned integer type."], u35, 35, u64);
455define_unsigned!(#[doc="The 36-bit unsigned integer type."], u36, 36, u64);
456define_unsigned!(#[doc="The 37-bit unsigned integer type."], u37, 37, u64);
457define_unsigned!(#[doc="The 38-bit unsigned integer type."], u38, 38, u64);
458define_unsigned!(#[doc="The 39-bit unsigned integer type."], u39, 39, u64);
459define_unsigned!(#[doc="The 40-bit unsigned integer type."], u40, 40, u64);
460
461define_unsigned!(#[doc="The 41-bit unsigned integer type."], u41, 41, u64);
462define_unsigned!(#[doc="The 42-bit unsigned integer type."], u42, 42, u64);
463define_unsigned!(#[doc="The 43-bit unsigned integer type."], u43, 43, u64);
464define_unsigned!(#[doc="The 44-bit unsigned integer type."], u44, 44, u64);
465define_unsigned!(#[doc="The 45-bit unsigned integer type."], u45, 45, u64);
466define_unsigned!(#[doc="The 46-bit unsigned integer type."], u46, 46, u64);
467define_unsigned!(#[doc="The 47-bit unsigned integer type."], u47, 47, u64);
468define_unsigned!(#[doc="The 48-bit unsigned integer type."], u48, 48, u64);
469
470define_unsigned!(#[doc="The 49-bit unsigned integer type."], u49, 49, u64);
471define_unsigned!(#[doc="The 50-bit unsigned integer type."], u50, 50, u64);
472define_unsigned!(#[doc="The 51-bit unsigned integer type."], u51, 51, u64);
473define_unsigned!(#[doc="The 52-bit unsigned integer type."], u52, 52, u64);
474define_unsigned!(#[doc="The 53-bit unsigned integer type."], u53, 53, u64);
475define_unsigned!(#[doc="The 54-bit unsigned integer type."], u54, 54, u64);
476define_unsigned!(#[doc="The 55-bit unsigned integer type."], u55, 55, u64);
477define_unsigned!(#[doc="The 56-bit unsigned integer type."], u56, 56, u64);
478
479define_unsigned!(#[doc="The 57-bit unsigned integer type."], u57, 57, u64);
480define_unsigned!(#[doc="The 58-bit unsigned integer type."], u58, 58, u64);
481define_unsigned!(#[doc="The 59-bit unsigned integer type."], u59, 59, u64);
482define_unsigned!(#[doc="The 60-bit unsigned integer type."], u60, 60, u64);
483define_unsigned!(#[doc="The 61-bit unsigned integer type."], u61, 61, u64);
484define_unsigned!(#[doc="The 62-bit unsigned integer type."], u62, 62, u64);
485define_unsigned!(#[doc="The 63-bit unsigned integer type."], u63, 63, u64);
486
487define_unsigned!(#[doc="The 65-bit unsigned integer type."], u65, 65, u128);
488define_unsigned!(#[doc="The 66-bit unsigned integer type."], u66, 66, u128);
489define_unsigned!(#[doc="The 67-bit unsigned integer type."], u67, 67, u128);
490define_unsigned!(#[doc="The 68-bit unsigned integer type."], u68, 68, u128);
491define_unsigned!(#[doc="The 69-bit unsigned integer type."], u69, 69, u128);
492define_unsigned!(#[doc="The 70-bit unsigned integer type."], u70, 70, u128);
493define_unsigned!(#[doc="The 71-bit unsigned integer type."], u71, 71, u128);
494define_unsigned!(#[doc="The 72-bit unsigned integer type."], u72, 72, u128);
495
496define_unsigned!(#[doc="The 73-bit unsigned integer type."], u73, 73, u128);
497define_unsigned!(#[doc="The 74-bit unsigned integer type."], u74, 74, u128);
498define_unsigned!(#[doc="The 75-bit unsigned integer type."], u75, 75, u128);
499define_unsigned!(#[doc="The 76-bit unsigned integer type."], u76, 76, u128);
500define_unsigned!(#[doc="The 77-bit unsigned integer type."], u77, 77, u128);
501define_unsigned!(#[doc="The 78-bit unsigned integer type."], u78, 78, u128);
502define_unsigned!(#[doc="The 79-bit unsigned integer type."], u79, 79, u128);
503define_unsigned!(#[doc="The 80-bit unsigned integer type."], u80, 80, u128);
504
505define_unsigned!(#[doc="The 81-bit unsigned integer type."], u81, 81, u128);
506define_unsigned!(#[doc="The 82-bit unsigned integer type."], u82, 82, u128);
507define_unsigned!(#[doc="The 83-bit unsigned integer type."], u83, 83, u128);
508define_unsigned!(#[doc="The 84-bit unsigned integer type."], u84, 84, u128);
509define_unsigned!(#[doc="The 85-bit unsigned integer type."], u85, 85, u128);
510define_unsigned!(#[doc="The 86-bit unsigned integer type."], u86, 86, u128);
511define_unsigned!(#[doc="The 87-bit unsigned integer type."], u87, 87, u128);
512define_unsigned!(#[doc="The 88-bit unsigned integer type."], u88, 88, u128);
513
514define_unsigned!(#[doc="The 89-bit unsigned integer type."], u89, 89, u128);
515define_unsigned!(#[doc="The 90-bit unsigned integer type."], u90, 90, u128);
516define_unsigned!(#[doc="The 91-bit unsigned integer type."], u91, 91, u128);
517define_unsigned!(#[doc="The 92-bit unsigned integer type."], u92, 92, u128);
518define_unsigned!(#[doc="The 93-bit unsigned integer type."], u93, 93, u128);
519define_unsigned!(#[doc="The 94-bit unsigned integer type."], u94, 94, u128);
520define_unsigned!(#[doc="The 95-bit unsigned integer type."], u95, 95, u128);
521define_unsigned!(#[doc="The 96-bit unsigned integer type."], u96, 96, u128);
522
523define_unsigned!(#[doc="The 97-bit unsigned integer type."], u97, 97, u128);
524define_unsigned!(#[doc="The 98-bit unsigned integer type."], u98, 98, u128);
525define_unsigned!(#[doc="The 99-bit unsigned integer type."], u99, 99, u128);
526define_unsigned!(#[doc="The 100-bit unsigned integer type."], u100, 100, u128);
527define_unsigned!(#[doc="The 101-bit unsigned integer type."], u101, 101, u128);
528define_unsigned!(#[doc="The 102-bit unsigned integer type."], u102, 102, u128);
529define_unsigned!(#[doc="The 103-bit unsigned integer type."], u103, 103, u128);
530define_unsigned!(#[doc="The 104-bit unsigned integer type."], u104, 104, u128);
531
532define_unsigned!(#[doc="The 105-bit unsigned integer type."], u105, 105, u128);
533define_unsigned!(#[doc="The 106-bit unsigned integer type."], u106, 106, u128);
534define_unsigned!(#[doc="The 107-bit unsigned integer type."], u107, 107, u128);
535define_unsigned!(#[doc="The 108-bit unsigned integer type."], u108, 108, u128);
536define_unsigned!(#[doc="The 109-bit unsigned integer type."], u109, 109, u128);
537define_unsigned!(#[doc="The 110-bit unsigned integer type."], u110, 110, u128);
538define_unsigned!(#[doc="The 111-bit unsigned integer type."], u111, 111, u128);
539define_unsigned!(#[doc="The 112-bit unsigned integer type."], u112, 112, u128);
540
541define_unsigned!(#[doc="The 113-bit unsigned integer type."], u113, 113, u128);
542define_unsigned!(#[doc="The 114-bit unsigned integer type."], u114, 114, u128);
543define_unsigned!(#[doc="The 115-bit unsigned integer type."], u115, 115, u128);
544define_unsigned!(#[doc="The 116-bit unsigned integer type."], u116, 116, u128);
545define_unsigned!(#[doc="The 117-bit unsigned integer type."], u117, 117, u128);
546define_unsigned!(#[doc="The 118-bit unsigned integer type."], u118, 118, u128);
547define_unsigned!(#[doc="The 119-bit unsigned integer type."], u119, 119, u128);
548define_unsigned!(#[doc="The 120-bit unsigned integer type."], u120, 120, u128);
549
550define_unsigned!(#[doc="The 121-bit unsigned integer type."], u121, 121, u128);
551define_unsigned!(#[doc="The 122-bit unsigned integer type."], u122, 122, u128);
552define_unsigned!(#[doc="The 123-bit unsigned integer type."], u123, 123, u128);
553define_unsigned!(#[doc="The 124-bit unsigned integer type."], u124, 124, u128);
554define_unsigned!(#[doc="The 125-bit unsigned integer type."], u125, 125, u128);
555define_unsigned!(#[doc="The 126-bit unsigned integer type."], u126, 126, u128);
556define_unsigned!(#[doc="The 127-bit unsigned integer type."], u127, 127, u128);
557
558define_signed!(#[doc="The 1-bit signed integer type."], i1, 1, i8);
559define_signed!(#[doc="The 2-bit signed integer type."], i2, 2, i8);
560define_signed!(#[doc="The 3-bit signed integer type."], i3, 3, i8);
561define_signed!(#[doc="The 4-bit signed integer type."], i4, 4, i8);
562define_signed!(#[doc="The 5-bit signed integer type."], i5, 5, i8);
563define_signed!(#[doc="The 6-bit signed integer type."], i6, 6, i8);
564define_signed!(#[doc="The 7-bit signed integer type."], i7, 7, i8);
565
566define_signed!(#[doc="The 9-bit signed integer type."], i9, 9, i16);
567define_signed!(#[doc="The 10-bit signed integer type."], i10, 10, i16);
568define_signed!(#[doc="The 11-bit signed integer type."], i11, 11, i16);
569define_signed!(#[doc="The 12-bit signed integer type."], i12, 12, i16);
570define_signed!(#[doc="The 13-bit signed integer type."], i13, 13, i16);
571define_signed!(#[doc="The 14-bit signed integer type."], i14, 14, i16);
572define_signed!(#[doc="The 15-bit signed integer type."], i15, 15, i16);
573
574define_signed!(#[doc="The 17-bit signed integer type."], i17, 17, i32);
575define_signed!(#[doc="The 18-bit signed integer type."], i18, 18, i32);
576define_signed!(#[doc="The 19-bit signed integer type."], i19, 19, i32);
577define_signed!(#[doc="The 20-bit signed integer type."], i20, 20, i32);
578define_signed!(#[doc="The 21-bit signed integer type."], i21, 21, i32);
579define_signed!(#[doc="The 22-bit signed integer type."], i22, 22, i32);
580define_signed!(#[doc="The 23-bit signed integer type."], i23, 23, i32);
581define_signed!(#[doc="The 24-bit signed integer type."], i24, 24, i32);
582
583define_signed!(#[doc="The 25-bit signed integer type."], i25, 25, i32);
584define_signed!(#[doc="The 26-bit signed integer type."], i26, 26, i32);
585define_signed!(#[doc="The 27-bit signed integer type."], i27, 27, i32);
586define_signed!(#[doc="The 28-bit signed integer type."], i28, 28, i32);
587define_signed!(#[doc="The 29-bit signed integer type."], i29, 29, i32);
588define_signed!(#[doc="The 30-bit signed integer type."], i30, 30, i32);
589define_signed!(#[doc="The 31-bit signed integer type."], i31, 31, i32);
590
591define_signed!(#[doc="The 33-bit signed integer type."], i33, 33, i64);
592define_signed!(#[doc="The 34-bit signed integer type."], i34, 34, i64);
593define_signed!(#[doc="The 35-bit signed integer type."], i35, 35, i64);
594define_signed!(#[doc="The 36-bit signed integer type."], i36, 36, i64);
595define_signed!(#[doc="The 37-bit signed integer type."], i37, 37, i64);
596define_signed!(#[doc="The 38-bit signed integer type."], i38, 38, i64);
597define_signed!(#[doc="The 39-bit signed integer type."], i39, 39, i64);
598define_signed!(#[doc="The 40-bit signed integer type."], i40, 40, i64);
599
600define_signed!(#[doc="The 41-bit signed integer type."], i41, 41, i64);
601define_signed!(#[doc="The 42-bit signed integer type."], i42, 42, i64);
602define_signed!(#[doc="The 43-bit signed integer type."], i43, 43, i64);
603define_signed!(#[doc="The 44-bit signed integer type."], i44, 44, i64);
604define_signed!(#[doc="The 45-bit signed integer type."], i45, 45, i64);
605define_signed!(#[doc="The 46-bit signed integer type."], i46, 46, i64);
606define_signed!(#[doc="The 47-bit signed integer type."], i47, 47, i64);
607define_signed!(#[doc="The 48-bit signed integer type."], i48, 48, i64);
608
609define_signed!(#[doc="The 49-bit signed integer type."], i49, 49, i64);
610define_signed!(#[doc="The 50-bit signed integer type."], i50, 50, i64);
611define_signed!(#[doc="The 51-bit signed integer type."], i51, 51, i64);
612define_signed!(#[doc="The 52-bit signed integer type."], i52, 52, i64);
613define_signed!(#[doc="The 53-bit signed integer type."], i53, 53, i64);
614define_signed!(#[doc="The 54-bit signed integer type."], i54, 54, i64);
615define_signed!(#[doc="The 55-bit signed integer type."], i55, 55, i64);
616define_signed!(#[doc="The 56-bit signed integer type."], i56, 56, i64);
617
618define_signed!(#[doc="The 57-bit signed integer type."], i57, 57, i64);
619define_signed!(#[doc="The 58-bit signed integer type."], i58, 58, i64);
620define_signed!(#[doc="The 59-bit signed integer type."], i59, 59, i64);
621define_signed!(#[doc="The 60-bit signed integer type."], i60, 60, i64);
622define_signed!(#[doc="The 61-bit signed integer type."], i61, 61, i64);
623define_signed!(#[doc="The 62-bit signed integer type."], i62, 62, i64);
624define_signed!(#[doc="The 63-bit signed integer type."], i63, 63, i64);
625
626define_signed!(#[doc="The 65-bit signed integer type."], i65, 65, i128);
627define_signed!(#[doc="The 66-bit signed integer type."], i66, 66, i128);
628define_signed!(#[doc="The 67-bit signed integer type."], i67, 67, i128);
629define_signed!(#[doc="The 68-bit signed integer type."], i68, 68, i128);
630define_signed!(#[doc="The 69-bit signed integer type."], i69, 69, i128);
631define_signed!(#[doc="The 70-bit signed integer type."], i70, 70, i128);
632define_signed!(#[doc="The 71-bit signed integer type."], i71, 71, i128);
633define_signed!(#[doc="The 72-bit signed integer type."], i72, 72, i128);
634
635define_signed!(#[doc="The 73-bit signed integer type."], i73, 73, i128);
636define_signed!(#[doc="The 74-bit signed integer type."], i74, 74, i128);
637define_signed!(#[doc="The 75-bit signed integer type."], i75, 75, i128);
638define_signed!(#[doc="The 76-bit signed integer type."], i76, 76, i128);
639define_signed!(#[doc="The 77-bit signed integer type."], i77, 77, i128);
640define_signed!(#[doc="The 78-bit signed integer type."], i78, 78, i128);
641define_signed!(#[doc="The 79-bit signed integer type."], i79, 79, i128);
642define_signed!(#[doc="The 80-bit signed integer type."], i80, 80, i128);
643
644define_signed!(#[doc="The 81-bit signed integer type."], i81, 81, i128);
645define_signed!(#[doc="The 82-bit signed integer type."], i82, 82, i128);
646define_signed!(#[doc="The 83-bit signed integer type."], i83, 83, i128);
647define_signed!(#[doc="The 84-bit signed integer type."], i84, 84, i128);
648define_signed!(#[doc="The 85-bit signed integer type."], i85, 85, i128);
649define_signed!(#[doc="The 86-bit signed integer type."], i86, 86, i128);
650define_signed!(#[doc="The 87-bit signed integer type."], i87, 87, i128);
651define_signed!(#[doc="The 88-bit signed integer type."], i88, 88, i128);
652
653define_signed!(#[doc="The 89-bit signed integer type."], i89, 89, i128);
654define_signed!(#[doc="The 90-bit signed integer type."], i90, 90, i128);
655define_signed!(#[doc="The 91-bit signed integer type."], i91, 91, i128);
656define_signed!(#[doc="The 92-bit signed integer type."], i92, 92, i128);
657define_signed!(#[doc="The 93-bit signed integer type."], i93, 93, i128);
658define_signed!(#[doc="The 94-bit signed integer type."], i94, 94, i128);
659define_signed!(#[doc="The 95-bit signed integer type."], i95, 95, i128);
660define_signed!(#[doc="The 96-bit signed integer type."], i96, 96, i128);
661
662define_signed!(#[doc="The 97-bit signed integer type."], i97, 97, i128);
663define_signed!(#[doc="The 98-bit signed integer type."], i98, 98, i128);
664define_signed!(#[doc="The 99-bit signed integer type."], i99, 99, i128);
665define_signed!(#[doc="The 100-bit signed integer type."], i100, 100, i128);
666define_signed!(#[doc="The 101-bit signed integer type."], i101, 101, i128);
667define_signed!(#[doc="The 102-bit signed integer type."], i102, 102, i128);
668define_signed!(#[doc="The 103-bit signed integer type."], i103, 103, i128);
669define_signed!(#[doc="The 104-bit signed integer type."], i104, 104, i128);
670
671define_signed!(#[doc="The 105-bit signed integer type."], i105, 105, i128);
672define_signed!(#[doc="The 106-bit signed integer type."], i106, 106, i128);
673define_signed!(#[doc="The 107-bit signed integer type."], i107, 107, i128);
674define_signed!(#[doc="The 108-bit signed integer type."], i108, 108, i128);
675define_signed!(#[doc="The 109-bit signed integer type."], i109, 109, i128);
676define_signed!(#[doc="The 110-bit signed integer type."], i110, 110, i128);
677define_signed!(#[doc="The 111-bit signed integer type."], i111, 111, i128);
678define_signed!(#[doc="The 112-bit signed integer type."], i112, 112, i128);
679
680define_signed!(#[doc="The 113-bit signed integer type."], i113, 113, i128);
681define_signed!(#[doc="The 114-bit signed integer type."], i114, 114, i128);
682define_signed!(#[doc="The 115-bit signed integer type."], i115, 115, i128);
683define_signed!(#[doc="The 116-bit signed integer type."], i116, 116, i128);
684define_signed!(#[doc="The 117-bit signed integer type."], i117, 117, i128);
685define_signed!(#[doc="The 118-bit signed integer type."], i118, 118, i128);
686define_signed!(#[doc="The 119-bit signed integer type."], i119, 119, i128);
687define_signed!(#[doc="The 120-bit signed integer type."], i120, 120, i128);
688
689define_signed!(#[doc="The 121-bit signed integer type."], i121, 121, i128);
690define_signed!(#[doc="The 122-bit signed integer type."], i122, 122, i128);
691define_signed!(#[doc="The 123-bit signed integer type."], i123, 123, i128);
692define_signed!(#[doc="The 124-bit signed integer type."], i124, 124, i128);
693define_signed!(#[doc="The 125-bit signed integer type."], i125, 125, i128);
694define_signed!(#[doc="The 126-bit signed integer type."], i126, 126, i128);
695define_signed!(#[doc="The 127-bit signed integer type."], i127, 127, i128);
696
697#[cfg(test)]
698mod tests {
699    use super::*;
700
701    #[test]
702    fn test_masking() {
703        assert_eq!(u4(0b11000110).mask().0, 0b00000110);
704        assert_eq!(u4(0b00001000).mask().0, 0b00001000);
705        assert_eq!(u4(0b00001110).mask().0, 0b00001110);
706
707        assert_eq!(i4(0b11000110u8 as i8).mask().0, 0b00000110u8 as i8);
708        assert_eq!(i4(0b00001000u8 as i8).mask().0, 0b11111000u8 as i8);
709        assert_eq!(i4(0b00001110u8 as i8).mask().0, 0b11111110u8 as i8);
710    }
711
712    #[test]
713    fn min_max_values() {
714        assert_eq!(u1::MAX, u1(1));
715        assert_eq!(u2::MAX, u2(3));
716        assert_eq!(u3::MAX, u3(7));
717        assert_eq!(u7::MAX, u7(127));
718        assert_eq!(u9::MAX, u9(511));
719
720        assert_eq!(i1::MAX, i1(0));
721        assert_eq!(i2::MAX, i2(1));
722        assert_eq!(i3::MAX, i3(3));
723        assert_eq!(i7::MAX, i7(63));
724        assert_eq!(i9::MAX, i9(255));
725
726        assert_eq!(u1::MIN, u1(0));
727        assert_eq!(u2::MIN, u2(0));
728        assert_eq!(u3::MIN, u3(0));
729        assert_eq!(u7::MIN, u7(0));
730        assert_eq!(u9::MIN, u9(0));
731        assert_eq!(u127::MIN, u127(0));
732
733        assert_eq!(i1::MIN, i1(-1));
734        assert_eq!(i2::MIN, i2(-2));
735        assert_eq!(i3::MIN, i3(-4));
736        assert_eq!(i7::MIN, i7(-64));
737        assert_eq!(i9::MIN, i9(-256));
738    }
739
740    #[test]
741    fn test_bits_values() {
742        assert_eq!(u1::BITS, 1);
743        assert_eq!(i7::BITS, 7);
744        assert_eq!(u127::BITS, 127);
745    }
746
747    #[test]
748    fn test_wrapping_add() {
749        assert_eq!(u1::MAX.wrapping_add(u1(1)), u1(0));
750        assert_eq!(u1::MAX.wrapping_add(u1(0)), u1(1));
751
752        assert_eq!(u5::MAX.wrapping_add(u5(1)), u5(0));
753        assert_eq!(u5::MAX.wrapping_add(u5(4)), u5(3));
754
755        assert_eq!(u127::MAX.wrapping_add(u127(100)), u127(99));
756        assert_eq!(u127::MAX.wrapping_add(u127(1)), u127(0));
757
758        assert_eq!(i1::MAX.wrapping_add(i1(0)), i1(0));
759        assert_eq!(i1::MAX.wrapping_add(i1(-1)), i1(-1));
760
761        assert_eq!(i7::MAX.wrapping_add(i7(1)), i7::MIN);
762        assert_eq!(i7::MAX.wrapping_add(i7(4)), i7(-61));
763    }
764
765    #[test]
766    fn test_wrapping_sub() {
767        assert_eq!(u1::MIN.wrapping_sub(u1(1)), u1(1));
768        assert_eq!(u3(1).wrapping_sub(u3(2)), u3::MAX);
769    }
770
771    #[test]
772    #[should_panic]
773    fn test_add_overflow_u5() {
774        let _s = u5::MAX + u5(1);
775    }
776
777    #[test]
778    #[should_panic]
779    fn test_add_overflow_u127() {
780        let _s = u127::MAX + u127(1);
781    }
782
783    #[test]
784    #[should_panic]
785    fn test_add_overflow_i96() {
786        let _s = i96::MAX + i96(100);
787    }
788
789    #[test]
790    #[should_panic]
791    fn test_add_underflow_i96() {
792        let _s = i96::MIN + i96(-100);
793    }
794
795    #[test]
796    #[should_panic]
797    fn test_add_underflow_i17() {
798        let _s = i17::MIN + i17(-1);
799    }
800
801    #[test]
802    fn test_add() {
803        assert_eq!(u5(1) + u5(2), u5(3));
804
805        assert_eq!(i7::MAX + i7::MIN, i7(-1));
806        assert_eq!(i7(4) + i7(-3), i7(1));
807        assert_eq!(i7(-4) + i7(3), i7(-1));
808        assert_eq!(i7(-3) + i7(-20), i7(-23));
809    }
810
811    #[test]
812    #[should_panic]
813    fn test_sub_overflow_i23() {
814        let _s = i23::MIN - i23::MAX;
815    }
816
817    #[test]
818    #[should_panic]
819    fn test_sub_underflow_u5() {
820        let _s = u5::MIN - u5(1);
821    }
822
823    #[test]
824    #[should_panic]
825    fn test_sub_underflow_i5() {
826        let _s = i5::MIN - i5(1);
827    }
828
829    #[test]
830    fn test_sub() {
831        assert_eq!(u5(1) - u5(1), u5(0));
832        assert_eq!(u5(3) - u5(2), u5(1));
833
834        assert_eq!(i1(-1) - i1(-1), i1(0));
835        assert_eq!(i7::MIN - i7::MIN, i7(0));
836        assert_eq!(i7(4) - i7(-3), i7(7));
837        assert_eq!(i7(-4) - i7(3), i7(-7));
838        assert_eq!(i7(-3) - i7(-20), i7(17));
839    }
840
841    #[test]
842    fn test_shr() {
843        assert_eq!(u5(8) >> 1usize, u5(4));
844        assert_eq!(u5(8) >> 1u8, u5(4));
845        assert_eq!(u5(8) >> 1u16, u5(4));
846        assert_eq!(u5(8) >> 1u32, u5(4));
847        assert_eq!(u5(8) >> 1u64, u5(4));
848        assert_eq!(u5(8) >> 1isize, u5(4));
849        assert_eq!(u5(8) >> 1i8, u5(4));
850        assert_eq!(u5(8) >> 1i16, u5(4));
851        assert_eq!(u5(8) >> 1i32, u5(4));
852        assert_eq!(u5(8) >> 1i64, u5(4));
853
854        assert_eq!(u5::MAX >> 4, u5(1));
855
856        assert_eq!(i7(-1) >> 5, i7(-1));
857    }
858
859    #[test]
860    fn test_shl() {
861        assert_eq!(u5(16) << 1usize, u5(0));
862        assert_eq!(u5(16) << 1u8, u5(0));
863        assert_eq!(u5(16) << 1u16, u5(0));
864        assert_eq!(u5(16) << 1u32, u5(0));
865        assert_eq!(u5(16) << 1u64, u5(0));
866        assert_eq!(u5(16) << 1isize, u5(0));
867        assert_eq!(u5(16) << 1i8, u5(0));
868        assert_eq!(u5(16) << 1i16, u5(0));
869        assert_eq!(u5(16) << 1i32, u5(0));
870        assert_eq!(u5(16) << 1i64, u5(0));
871
872        assert_eq!(u5::MAX << 4, u5(16));
873
874        assert_eq!(i5(16) << 1, i5(0));
875        assert_eq!(i7(1) << 3, i7(8));
876    }
877
878    #[test]
879    fn test_shr_assign() {
880        let mut x = u10(512);
881        x >>= 1usize;
882        assert_eq!(x, u10(256));
883        x >>= 1isize;
884        assert_eq!(x, u10(128));
885        x >>= 1u8;
886        assert_eq!(x, u10(64));
887        x >>= 1i8;
888        assert_eq!(x, u10(32));
889        x >>= 2u64;
890        assert_eq!(x, u10(8));
891        x >>= 3i32;
892        assert_eq!(x, u10(1));
893    }
894
895    #[test]
896    fn test_shl_assign() {
897        let mut x = u9(1);
898        x <<= 3i32;
899        assert_eq!(x, u9(8));
900        x <<= 2u64;
901        assert_eq!(x, u9(32));
902        x <<= 1usize;
903        assert_eq!(x, u9(64));
904        x <<= 1isize;
905        assert_eq!(x, u9(128));
906        x <<= 1u8;
907        assert_eq!(x, u9(256));
908        x <<= 1u8;
909        assert_eq!(x, u9(0));
910    }
911
912    #[test]
913    fn test_bitor() {
914        assert_eq!(u9(1) | u9(8), u9(9));
915        assert_eq!(&u9(1) | u9(8), u9(9));
916        assert_eq!(u9(1) | &u9(8), u9(9));
917        assert_eq!(&u9(1) | &u9(8), u9(9));
918    }
919
920    #[test]
921    fn test_bitor_assign() {
922        let mut x = u12(4);
923        x |= u12(1);
924        assert_eq!(x, u12(5));
925        x |= u12(128);
926        assert_eq!(x, u12(133));
927        x = u12(1);
928        x |= u12(127);
929        assert_eq!(x, u12(127));
930    }
931
932    #[test]
933    fn test_bitxor() {
934        assert_eq!(u7(0x7F) ^ u7(42), u7(85));
935        assert_eq!(&u7(0) ^ u7(42), u7(42));
936        assert_eq!(u7(0x10) ^ &u7(0x1), u7(0x11));
937        assert_eq!(&u7(11) ^ &u7(1), u7(10));
938    }
939
940    #[test]
941    fn test_bitxor_assign() {
942        let mut x = u12(4);
943        x ^= u12(1);
944        assert_eq!(x, u12(5));
945        x ^= u12(128);
946        assert_eq!(x, u12(133));
947        x ^= u12(1);
948        assert_eq!(x, u12(132));
949        x ^= u12(127);
950        assert_eq!(x, u12(251));
951    }
952
953    #[test]
954    fn test_bitand() {
955        assert_eq!(i9(-7) & i9(-9), i9::from(-7i8 & -9i8));
956        assert_eq!(&i9(-7) & i9(-9), i9::from(&-7i8 & -9i8));
957        assert_eq!(i9(-7) & &i9(-9), i9::from(-7i8 & &-9i8));
958        assert_eq!(&i9(-7) & &i9(-9), i9::from(&-7i8 & &-9i8));
959
960        assert_eq!(u9(8) & u9(9), u9(8));
961        assert_eq!(&u9(8) & u9(9), u9(8));
962        assert_eq!(u9(8) & &u9(9), u9(8));
963        assert_eq!(&u9(8) & &u9(9), u9(8));
964    }
965
966    #[test]
967    fn test_bitand_assign() {
968        let mut x = u12(255);
969        x &= u12(127);
970        assert_eq!(x, u12(127));
971        x &= u12(7);
972        assert_eq!(x, u12(7));
973        x &= u12(127);
974        assert_eq!(x, u12(7));
975        x &= u12(4);
976        assert_eq!(x, u12(4));
977    }
978
979    #[test]
980    fn test_not() {
981        assert_eq!(!u7(42), u7(85));
982        assert_eq!(!u7(0x7F), u7(0));
983        assert_eq!(!u7(0), u7(0x7F));
984        assert_eq!(!u7(56), u7(71));
985    }
986}
ux/lib.rs

ux/
lib.rs
