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

use crate::integer::Integer;
use crate::natural::Natural;
use malachite_base::num::logic::traits::LowMask;

impl LowMask for Integer {
    /// Returns an [`Integer`] whose least significant $b$ bits are `true` and whose other bits are
    /// `false`.
    ///
    /// $f(b) = 2^b - 1$.
    ///
    /// # Worst-case complexity
    /// $T(n) = O(n)$
    ///
    /// $M(n) = O(n)$
    ///
    /// where $T$ is time, $M$ is additional memory, and $n$ is `bits`.
    ///
    /// # Examples
    /// ```
    /// extern crate malachite_base;
    ///
    /// use malachite_base::num::logic::traits::LowMask;
    /// use malachite_nz::integer::Integer;
    ///
    /// assert_eq!(Integer::low_mask(0), 0);
    /// assert_eq!(Integer::low_mask(3), 7);
    /// assert_eq!(Integer::low_mask(100).to_string(), "1267650600228229401496703205375");
    /// ```
    #[inline]
    fn low_mask(bits: u64) -> Integer {
        Integer::from(Natural::low_mask(bits))
    }
}