bit-string 0.4.1

A compact owned bit string type with editing, matching, and bitwise operations.
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
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58

use alloc::vec::Vec;

/// SIMD-accelerated word-level operations on `[u64]` backing storage.
///
/// Owned methods allocate a new `Vec<u64>` and return it. Assign methods
/// operate in place.
pub(crate) trait BitsArith {
    /// Returns `self & rhs`, allocating a new result.
    fn and(&self, rhs: &[u64]) -> Vec<u64>;
    /// Performs `self &= rhs` in place.
    fn and_assign(&mut self, rhs: &[u64]);

    /// Returns `self | rhs`, allocating a new result.
    fn or(&self, rhs: &[u64]) -> Vec<u64>;
    /// Performs `self |= rhs` in place.
    fn or_assign(&mut self, rhs: &[u64]);

    /// Returns `self ^ rhs`, allocating a new result.
    fn xor(&self, rhs: &[u64]) -> Vec<u64>;
    /// Performs `self ^= rhs` in place.
    fn xor_assign(&mut self, rhs: &[u64]);

    /// Returns `!self`, allocating a new result.
    ///
    /// `bit_len` is used to mask unused high bits in the last word.
    fn not(&self, bit_len: usize) -> Vec<u64>;
    /// Performs `self = !self` in place, masking with `bit_len`.
    fn not_assign(&mut self, bit_len: usize);

    /// Returns `self << amount` (zero-fill), allocating a new result.
    ///
    /// `bit_len` is used to mask unused high bits in the last word.
    fn shl(&self, bit_len: usize, amount: usize) -> Vec<u64>;
    /// Performs `self <<= amount` (zero-fill) in place, masking with
    /// `bit_len`.
    fn shl_assign(&mut self, bit_len: usize, amount: usize);

    /// Returns `self >> amount` (zero-fill), allocating a new result.
    ///
    /// `bit_len` is used to mask unused high bits in the last word.
    fn shr(&self, bit_len: usize, amount: usize) -> Vec<u64>;
    /// Performs `self >>= amount` (zero-fill) in place, masking with
    /// `bit_len`.
    fn shr_assign(&mut self, bit_len: usize, amount: usize);

    /// Returns the number of ones (set bits) in the first `bit_len` bits.
    ///
    /// Bits beyond `bit_len` are assumed to already be zero (masked by
    /// prior calls to [`BitsEdit::mask_unused_bits`]).
    fn count_ones(&self, bit_len: usize) -> usize;
}

pub(crate) mod funcs_for_binary_core;
pub(crate) mod funcs_for_count_ones;
pub(crate) mod funcs_for_not_core;
pub(crate) mod funcs_for_shl_core;
pub(crate) mod funcs_for_shr_core;
pub(crate) mod impls_for_u64_slice;