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
use crate::natural::Natural;
use malachite_base::num::arithmetic::traits::ModIsReduced;
use malachite_base::num::basic::traits::Zero;
impl ModIsReduced for Natural {
/// Returns whether a [`Natural`] is reduced modulo another [`Natural`] $m$; in other words,
/// whether it is less than $m$.
///
/// $m$ cannot be zero.
///
/// $f(x, m) = (x < m)$.
///
/// # Worst-case complexity
/// $T(n) = O(n)$
///
/// $M(n) = O(1)$
///
/// where $T$ is time, $M$ is additional memory, and $n$ is `self.significant_bits()`.
///
/// # Panics
/// Panics if `m` is 0.
///
/// # Examples
/// ```
/// extern crate malachite_base;
///
/// use malachite_base::num::arithmetic::traits::{ModIsReduced, Pow};
/// use malachite_base::num::basic::traits::{One, Zero};
/// use malachite_nz::natural::Natural;
///
/// assert_eq!(Natural::ZERO.mod_is_reduced(&Natural::from(5u32)), true);
/// assert_eq!(
/// Natural::from(10u32).pow(12).mod_is_reduced(&Natural::from(10u32).pow(12)),
/// false
/// );
/// assert_eq!(
/// Natural::from(10u32).pow(12)
/// .mod_is_reduced(&(Natural::from(10u32).pow(12) + Natural::ONE)),
/// true
/// );
/// ```
#[inline]
fn mod_is_reduced(&self, m: &Natural) -> bool {
assert_ne!(*m, Natural::ZERO);
self < m
}
}