num-primitive 0.1.0

Traits for 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

use crate::{PrimitiveInteger, PrimitiveIntegerRef, PrimitiveSigned};

/// Trait for all primitive [unsigned integer types], including the supertraits
/// [`PrimitiveInteger`] and [`PrimitiveNumber`][crate::PrimitiveNumber].
///
/// This encapsulates trait implementations and inherent methods that are common among all of the
/// primitive unsigned integer types: [`u8`], [`u16`], [`u32`], [`u64`], [`u128`], and [`usize`].
///
/// See the corresponding items on the individual types for more documentation and examples.
///
/// This trait is sealed with a private trait to prevent downstream implementations, so we may
/// continue to expand along with the standard library without worrying about breaking changes for
/// implementors.
///
/// [unsigned integer types]: https://doc.rust-lang.org/reference/types/numeric.html#r-type.numeric.int.unsigned
///
/// # Examples
///
/// ```
/// use num_primitive::PrimitiveUnsigned;
///
/// // Greatest Common Divisor (Euclidean algorithm)
/// fn gcd<T: PrimitiveUnsigned>(mut a: T, mut b: T) -> T {
///     let zero = T::from(0u8);
///     while b != zero {
///         (a, b) = (b, a % b);
///     }
///     a
/// }
///
/// assert_eq!(gcd::<u8>(48, 18), 6);
/// assert_eq!(gcd::<u16>(1071, 462), 21);
/// assert_eq!(gcd::<u32>(6_700_417, 2_147_483_647), 1);
/// ```
pub trait PrimitiveUnsigned: PrimitiveInteger + From<u8> {
    /// The signed integer type used by methods like
    /// [`checked_add_signed`][Self::checked_add_signed].
    type Signed: PrimitiveSigned;

    /// Computes the absolute difference between `self` and `other`.
    fn abs_diff(self, other: Self) -> Self;

    /// Checked addition with a signed integer. Computes `self + rhs`, returning `None` if overflow
    /// occurred.
    fn checked_add_signed(self, rhs: Self::Signed) -> Option<Self>;

    /// Calculates the smallest value greater than or equal to `self` that is a multiple of `rhs`.
    /// Returns `None` if `rhs` is zero or the operation would result in overflow.
    fn checked_next_multiple_of(self, rhs: Self) -> Option<Self>;

    /// Returns the smallest power of two greater than or equal to `self`. If the next power of two
    /// is greater than the type's maximum value, `None` is returned, otherwise the power of two is
    /// wrapped in Some.
    fn checked_next_power_of_two(self) -> Option<Self>;

    /// Calculates the quotient of `self` and rhs, rounding the result towards positive infinity.
    fn div_ceil(self, rhs: Self) -> Self;

    /// Returns true if and only if `self == 2^k` for some `k`.
    fn is_power_of_two(self) -> bool;

    /// Calculates the middle point of `self` and `other`.
    fn midpoint(self, other: Self) -> Self;

    /// Calculates the smallest value greater than or equal to `self` that is a multiple of `rhs`.
    fn next_multiple_of(self, rhs: Self) -> Self;

    /// Returns the smallest power of two greater than or equal to `self`.
    fn next_power_of_two(self) -> Self;

    /// Calculates `self + rhs` with a signed `rhs`. Returns a tuple of the addition along with a
    /// boolean indicating whether an arithmetic overflow would occur.
    fn overflowing_add_signed(self, rhs: Self::Signed) -> (Self, bool);

    /// Saturating addition with a signed integer. Computes `self + rhs`, saturating at the numeric
    /// bounds instead of overflowing.
    fn saturating_add_signed(self, rhs: Self::Signed) -> Self;

    /// Wrapping (modular) addition with a signed integer. Computes `self + rhs`, wrapping around
    /// at the boundary of the type.
    fn wrapping_add_signed(self, rhs: Self::Signed) -> Self;
}

/// Trait for references to primitive unsigned integer types ([`PrimitiveUnsigned`]).
///
/// This enables traits like the standard operators in generic code,
/// e.g. `where &T: PrimitiveUnsignedRef<T>`.
pub trait PrimitiveUnsignedRef<T>: PrimitiveIntegerRef<T> {}

macro_rules! impl_unsigned {
    ($Unsigned:ident, $Signed:ty) => {
        impl PrimitiveUnsigned for $Unsigned {
            type Signed = $Signed;

            forward! {
                fn abs_diff(self, other: Self) -> Self;
                fn checked_add_signed(self, rhs: Self::Signed) -> Option<Self>;
                fn checked_next_multiple_of(self, rhs: Self) -> Option<Self>;
                fn checked_next_power_of_two(self) -> Option<Self>;
                fn div_ceil(self, rhs: Self) -> Self;
                fn is_power_of_two(self) -> bool;
                fn midpoint(self, other: Self) -> Self;
                fn next_multiple_of(self, rhs: Self) -> Self;
                fn next_power_of_two(self) -> Self;
                fn overflowing_add_signed(self, rhs: Self::Signed) -> (Self, bool);
                fn saturating_add_signed(self, rhs: Self::Signed) -> Self;
                fn wrapping_add_signed(self, rhs: Self::Signed) -> Self;
            }
        }

        impl PrimitiveUnsignedRef<$Unsigned> for &$Unsigned {}
    };
}

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