bitintr 0.1.13

Portable Bit Manipulation Intrinsics.
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

use int::Int;

/// Sets all bits below the least significant one of `x` and clears all other
/// bits.
///
/// If the least significant bit of `x` is 1, it returns zero.
///
/// # Assembly Instructions
///
/// - [`TZMSK`](http://support.amd.com/TechDocs/24594.pdf):
///   - Description: Mask from trailing zeros.
///   - Architecture: x86.
///   - Instruction set: TBM.
///   - Registers: 32/64 bit.
///
/// # Example
///
/// ```
/// use bitintr::x86::tbm::*;
///
/// assert_eq!(tzmsk(0b0101_1000u8), 0b0000_0111u8);
/// assert_eq!(0b0101_1001u8.tzmsk(), 0b0000_0000u8);
/// ```
#[inline]
pub fn tzmsk<T: Int>(x: T) -> T {
    !x & (x.wrapping_sub(T::one()))
}

/// Method version of [`tzmsk`](fn.tzmsk.html).
pub trait TZMSK {
    #[inline]
    fn tzmsk(self) -> Self;
}

impl<T: Int> TZMSK for T {
    #[inline]
    fn tzmsk(self) -> T {
        tzmsk(self)
    }
}