Struct BitVec 

pub struct BitVec { /* private fields */ }

A compact bit vector.

Bits are stored in u64 chunks. The bit at logical index i lives in chunk i / 64 at bit position i % 64.

Implementations

impl BitVec

pub fn new(n_bits: usize) -> Self

Creates a new BitVec of n_bits bits, all initialised to false.

pub fn all_ones(n_bits: usize) -> Self

Creates a BitVec of n_bits bits, all initialised to true.

pub fn n_bits(&self) -> usize

Returns the total number of logical bits.

pub fn is_empty(&self) -> bool

Returns true if the bit vector has zero capacity.

pub fn set(&mut self, i: usize, val: bool)

Sets bit i to val.

Panics

Panics if i >= self.n_bits().

pub fn get(&self, i: usize) -> bool

Returns the value of bit i.

Returns false for out-of-range indices (does not panic).

pub fn flip(&mut self, i: usize)

Toggles bit i.

Panics

Panics if i >= self.n_bits().

pub fn count_ones(&self) -> usize

Returns the number of bits set to 1.

pub fn count_zeros(&self) -> usize

Returns the number of bits set to 0.

pub fn iter_ones(&self) -> IterOnes<'_>

Returns an iterator over the indices of all 1-bits in ascending order.

pub fn iter_zeros(&self) -> impl Iterator<Item = usize> + '_

Returns an iterator over the indices of all 0-bits in ascending order.

pub fn clear(&mut self)

Clears all bits (sets every bit to 0).

pub fn set_all(&mut self)

Sets all bits to 1.

pub fn and_assign(&mut self, other: &BitVec)

self &= other. Panics if the bit-widths differ.

pub fn or_assign(&mut self, other: &BitVec)

self |= other. Panics if the bit-widths differ.

pub fn xor_assign(&mut self, other: &BitVec)

self ^= other. Panics if the bit-widths differ.

pub fn and(&self, other: &BitVec) -> BitVec

Returns self & other. Panics if the bit-widths differ.

pub fn or(&self, other: &BitVec) -> BitVec

Returns self | other. Panics if the bit-widths differ.

pub fn xor(&self, other: &BitVec) -> BitVec

Returns self ^ other. Panics if the bit-widths differ.

pub fn not(&self) -> BitVec

Returns the bitwise NOT of self.

Trait Implementations

impl Clone for BitVec

fn clone(&self) -> BitVec

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for BitVec

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Eq for BitVec

impl PartialEq for BitVec

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.