malachite-base 0.4.6

A collection of utilities, including new arithmetic traits and iterators that generate all values of a type
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

use crate::num::arithmetic::traits::ModPowerOf2IsReduced;
use crate::num::logic::traits::SignificantBits;

macro_rules! impl_mod_power_of_2_is_reduced {
    ($t:ident) => {
        impl ModPowerOf2IsReduced for $t {
            /// Returns whether a number is reduced modulo another number $2^k$; in other words,
            /// whether it has no more than $k$ significant bits.
            ///
            /// $f(x, k) = (x < 2^k)$.
            ///
            /// # Worst-case complexity
            /// Constant time and additional memory.
            ///
            /// # Examples
            /// See [here](super::mod_power_of_2_is_reduced#mod_power_of_2_is_reduced).
            #[inline]
            fn mod_power_of_2_is_reduced(&self, pow: u64) -> bool {
                self.significant_bits() <= pow
            }
        }
    };
}
apply_to_unsigneds!(impl_mod_power_of_2_is_reduced);