numera 0.5.0

numbers
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

// numera::number::integer::trait
//
//!
//
// TOC
//
// - define the `Integer` trait
// - impl for integer primitives

use crate::number::traits::{ConstZero, Number};
use core::num::{
    NonZeroI128, NonZeroI16, NonZeroI32, NonZeroI64, NonZeroI8, NonZeroIsize, NonZeroU128,
    NonZeroU16, NonZeroU32, NonZeroU64, NonZeroU8, NonZeroUsize,
};
use devela::convert::az::CheckedAs;

#[cfg(not(feature = "std"))]
use crate::all::is_prime;
#[cfg(feature = "std")]
use crate::all::is_prime_sieve;

/// Common trait for all integers.
pub trait Integer: Number {
    /// Returns `true` if this integer is even.
    fn integer_is_even(&self) -> bool;
    /// Returns `true` if this integer is odd.
    fn integer_is_odd(&self) -> bool {
        !self.integer_is_even()
    }

    /// Returns `true` if this integer is a multiple of the `other`.
    fn integer_is_multiple_of(&self, other: &Self) -> bool;
    /// Returns `true` if this integer is a divisor of the `other`.
    fn integer_is_divisor_of(&self, other: &Self) -> bool {
        other.integer_is_multiple_of(self)
    }

    /// Returns `Some(true)` if this integer is prime, `Some(false)` if it's not
    /// prime, or `None` if it can not be determined.
    ///
    /// Returns `None` if this integer can't be represented as a [`usize`],
    /// or as a [`u32`] in `no-std`.
    fn integer_is_prime(&self) -> Option<bool>;

    /// Calculates the *Greatest Common Divisor* of this integer and `other`.
    ///
    /// Returns `None` if the operation can't return an integer of the same kind,
    /// e.g. for a `NegativeInteger`.
    #[rustfmt::skip]
    #[must_use]
    fn integer_gcd(&self, other: &Self) -> Option<Self> where Self: Sized;

    /// Calculates the *Lowest Common Multiple* of this integer and `other`.
    ///
    /// Returns `None` if the operation can't return an integer of the same kind,
    /// e.g. for `NegativeInteger`.
    #[rustfmt::skip]
    #[must_use]
    fn integer_lcm(&self, other: &Self) -> Option<Self> where Self: Sized;

    // /// Calculates the Greatest Common Divisor of `self` and `other`.
    // fn gcd_lcm(&self, other: &Self) -> Result<(Self, Self)> where Self: Sized;

    /// Returns the number of digits in base 10, without the sign.
    #[must_use]
    fn integer_digits(&self) -> usize;
}

/// Implements `Integer` for integer primitives.
///
/// # Args
/// - `$t`:
macro_rules! impl_integer {
    (many $($t:ident),+) => { $( impl_integer![$t]; )+ };
    ($t:ident) => {
        impl Integer for $t {
            #[inline]
            fn integer_is_even(&self) -> bool {
                *self & 1 == 0
            }
            #[inline]
            fn integer_is_multiple_of(&self, other: &Self) -> bool {
                *self % *other == 0
            }

            #[inline]
            fn integer_is_prime(&self) -> Option<bool> {
                #[cfg(feature = "std")]
                return Some(is_prime_sieve((*self).checked_as::<usize>()?));
                #[cfg(not(feature = "std"))]
                return Some(is_prime((*self).checked_as::<u32>()?));
            }

            #[inline]
            fn integer_gcd(&self, other: &Self) -> Option<Self> {
                let (mut a, mut b) = (*self, *other);
                while b != Self::ZERO {
                    let temp = b;
                    b = a % b;
                    a = temp;
                }
                Some(a)
            }
            #[inline]
            fn integer_lcm(&self, other: &Self) -> Option<Self> {
                Some(*self * *other / self.integer_gcd(other).unwrap())
            }

            fn integer_digits(&self) -> usize {
                self.checked_ilog10().unwrap_or(0) as usize
            }
        }
    };

    (many_nonzero $($t:ident),+) => { $( impl_integer![nonzero $t]; )+ };
    (nonzero $t:ident) => {
        impl Integer for $t {
            #[inline]
            fn integer_is_even(&self) -> bool {
                self.get() & 1 == 0
            }
            #[inline]
            fn integer_is_multiple_of(&self, other: &Self) -> bool {
                self.get() % other.get() == 0
            }
            #[inline]
            fn integer_is_prime(&self) -> Option<bool> {
                #[cfg(feature = "std")]
                return Some(is_prime_sieve(self.get().checked_as::<usize>()?));
                #[cfg(not(feature = "std"))]
                return Some(is_prime(self.get().checked_as::<u32>()?));
            }
            #[inline]
            fn integer_gcd(&self, other: &Self) -> Option<Self> {
                let (mut a, mut b) = (self.get(), other.get());
                while b != 0 {
                    let temp = b;
                    b = a % b;
                    a = temp;
                }
                Some($t::new(a).unwrap())
            }
            #[inline]
            fn integer_lcm(&self, other: &Self) -> Option<Self> {
                Some($t::new(
                    self.get() * other.get() / self.get().integer_gcd(&other.get()).unwrap()
                ).unwrap())
            }

            fn integer_digits(&self) -> usize {
                self.get().ilog10().try_into().expect("more than usize::MAX digits")
            }
        }
    };
}

impl_integer![many i8, i16, i32, i64, i128, isize, u8, u16, u32, u64, u128, usize];
impl_integer![many_nonzero
    NonZeroI128, NonZeroI16, NonZeroI32, NonZeroI64, NonZeroI8, NonZeroIsize, NonZeroU128,
    NonZeroU16, NonZeroU32, NonZeroU64, NonZeroU8, NonZeroUsize
];