bitintr 0.1.0

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

use int::Int;

/// Counts the number of trailing least significant zero bits.
///
/// When the source operand is 0, it returns its size in bits.
///
/// This is equivalent to searching for the least significant set bit and
/// returning its index.
///
/// **Keywords**: Count trailing zeros, Bit scan forward, find first set.
///
/// # Intrinsic (when available BMI1)
///
/// [`TZCNT`](http://www.felixcloutier.com/x86/TZCNT.html): Count the number of
/// trailing zero bits (supports 16/32/64 bit registers).
///
/// # Example
///
/// ```
/// use bitintr::bmi::tzcnt;
///
/// assert_eq!(tzcnt(0b1001_0000u16), 4u16);
/// assert_eq!(tzcnt(0b0000_0000u32), 32u32);
/// assert_eq!(tzcnt(0b0000_0001u64), 0u64);
/// ```
pub fn tzcnt<T: Int>(x: T) -> T {
    x.trailing_zeros() // TODO: ... write the algorithm
}

pub trait TZCNT {
    fn tzcnt(self) -> Self;
}

impl<T: Int> TZCNT for T {
    fn tzcnt(self) -> Self {
        tzcnt(self)
    }
}