Struct bitvector_simd::BitVector

pub struct BitVector { /* fields omitted */ }

Representation of a BitVector

see the module’s document for examples and details.

Implementations

impl BitVector

pub fn zeros(nbits: usize) -> Self

Create a empty bitvector with nbits initial elements.

pub fn ones(nbits: usize) -> Self

Create a bitvector containing all 0 .. nbits elements.

pub fn capacity(&self) -> usize

max number of elements that this bitvector can have

To get the number of elements, use count

pub fn shrink_to(&mut self, length: usize)

Shrink the vector to length. All elements between [length .. self.capacity()] will be removed. Panic if given length larger than current length.

pub fn set(&mut self, index: usize, flag: bool)

Remove or add index to the set. If index > self.capacity, the bitvector will be expanded to index.

pub fn get(&self, index: usize) -> Option<bool>

Check if index exists in current set. If exists, return Some(true) If index < current.capacity and element doesn’t exist, return Some(false). If index >= current.capacity, return None.

pub fn get_unchecked(&self, index: usize) -> bool

Directly return a bool instead of an Option If exists, return true If doesn’t exist or index >= current.capacity, retun false

equals to self.get(index).unwrap_or(false)

pub fn and(self, other: Self) -> Self

pub fn and_cloned(&self, other: &Self) -> Self

pub fn or(self, other: Self) -> Self

pub fn or_cloned(&self, other: &Self) -> Self

pub fn xor(self, other: Self) -> Self

pub fn xor_cloned(&self, other: &Self) -> Self

pub fn difference(self, other: Self) -> Self

difference operation

A.difference(B) calculates A\B, e.g.

A = [1,2,3], B = [2,4,5]
A\B = [1,3]

also notice that

A.difference(B) & B.difference(A) == A ^ B

pub fn difference_clone(&self, other: &Self) -> Self

pub fn not(self) -> Self

inverse every bits in the vector.

If your bitvector have capacity 1_000 and contains [1,5], after inverse it will contains 0, 2..=4, 6..=999

pub fn count(&self) -> usize

Count the number of elements existing in this bitvector.

pub fn any(&self) -> bool

return true if contains at least 1 element

pub fn all(&self) -> bool

return true if contains self.capacity elements

pub fn none(&self) -> bool

return true if set is empty

pub fn is_empty(&self) -> bool

return true if set is empty. totally the same with self.none()

pub fn eq_left(&self, other: &Self, bits: usize) -> bool

only compare the first bits instead of the whole bitvector.

require self and other are both no shorter than bits.

Trait Implementations

impl BitAnd<BitVector> for BitVector

type Output = Self

The resulting type after applying the & operator.

fn bitand(self, rhs: Self) -> Self::Output

Performs the & operation.

impl BitOr<BitVector> for BitVector

type Output = Self

The resulting type after applying the | operator.

fn bitor(self, rhs: Self) -> Self::Output

Performs the | operation.

impl BitXor<BitVector> for BitVector

type Output = Self

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: Self) -> Self::Output

Performs the ^ operation.

impl Clone for BitVector

fn clone(&self) -> BitVector

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BitVector

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

Formats the value using the given formatter.

impl Display for BitVector

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

Formats the value using the given formatter.

impl Index<usize> for BitVector

type Output = bool

The returned type after indexing.

fn index(&self, index: usize) -> &Self::Output

Performs the indexing (container[index]) operation.

impl Not for BitVector

type Output = Self

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

impl PartialEq<BitVector> for BitVector

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.