Trait hi_sparse_bitset::BitBlock

pub trait BitBlock: BitAnd<Output = Self> + BitOr<Output = Self> + BitXor<Output = Self> + Eq + PartialEq + Sized + Copy + Clone {
    type BitsIter: BitQueue;

    const SIZE_POT_EXPONENT: usize;

    // Required methods
    fn zero() -> Self;
    fn into_bits_iter(self) -> Self::BitsIter;
    fn as_array(&self) -> &[u64];
    fn as_array_mut(&mut self) -> &mut [u64];

    // Provided methods
    fn size() -> usize { ... }
    fn is_zero(&self) -> bool { ... }
    fn set_bit<const BIT: bool>(&mut self, bit_index: usize) -> bool { ... }
    fn get_bit(&self, bit_index: usize) -> bool { ... }
    fn traverse_bits<F>(&self, f: F) -> ControlFlow<()>
       where F: FnMut(usize) -> ControlFlow<()> { ... }
    fn count_ones(&self) -> usize { ... }
}

Bit block.

Used in Config, to define bit blocks BitSet is built from.

Required Associated Types

type BitsIter: BitQueue

Required Associated Constants

const SIZE_POT_EXPONENT: usize

2^N bits

Required Methods

fn zero() -> Self

fn into_bits_iter(self) -> Self::BitsIter

fn as_array(&self) -> &[u64]

fn as_array_mut(&mut self) -> &mut [u64]

Provided Methods

fn size() -> usize

Size in bits

fn is_zero(&self) -> bool

fn set_bit<const BIT: bool>(&mut self, bit_index: usize) -> bool

Returns previous bit

bit_index is guaranteed to be valid

fn get_bit(&self, bit_index: usize) -> bool

bit_index is guaranteed to be valid

fn traverse_bits<F>(&self, f: F) -> ControlFlow<()>

where F: FnMut(usize) -> ControlFlow<()>,

Returns Break if traverse was interrupted (f returns Break).

fn count_ones(&self) -> usize

Object Safety

This trait is not object safe.

Implementations on Foreign Types

impl BitBlock for u64

const SIZE_POT_EXPONENT: usize = 6usize

fn zero() -> Self

fn set_bit<const BIT: bool>(&mut self, bit_index: usize) -> bool

fn get_bit(&self, bit_index: usize) -> bool

fn traverse_bits<F>(&self, f: F) -> ControlFlow<()>

where F: FnMut(usize) -> ControlFlow<()>,

type BitsIter = PrimitiveBitQueue<u64>

fn into_bits_iter(self) -> Self::BitsIter

fn as_array(&self) -> &[u64]

fn as_array_mut(&mut self) -> &mut [u64]

impl BitBlock for u64x2

Available on crate feature simd only.

const SIZE_POT_EXPONENT: usize = 7usize

fn zero() -> Self

fn is_zero(&self) -> bool

type BitsIter = ArrayBitQueue<u64, 2>

fn into_bits_iter(self) -> Self::BitsIter

fn as_array(&self) -> &[u64]

fn as_array_mut(&mut self) -> &mut [u64]

impl BitBlock for u64x4

Available on crate feature simd only.

const SIZE_POT_EXPONENT: usize = 8usize

fn zero() -> Self

type BitsIter = ArrayBitQueue<u64, 4>

fn into_bits_iter(self) -> Self::BitsIter

fn as_array(&self) -> &[u64]

fn as_array_mut(&mut self) -> &mut [u64]

Implementors