Struct bitmagic::BVector

pub struct BVector { /* fields omitted */ }

A bitvector

Implementations

impl BVector

pub fn new() -> BVector

Create a new bit-vector container with runtime compression of bits

pub fn with_capacity(capacity: usize) -> BVector

Create a new bit-vector container with capacity (maximum number of allowed bits).

BitMagic recommends ALWAYS setting the size to maximum, so it is preferable to use new instead.

pub fn grow(&mut self, bits: usize)

Grow capacity to bits, all new bits initialized to zero

pub fn len(&self) -> usize

Return the length of the BVector in bits.

pub fn is_empty(&self) -> bool

Check if any bits are set

pub fn contains(&self, bit: usize) -> bool

Return true if the bit is enabled in the BVector, false otherwise.

Note: bits outside the capacity are always disabled.

Note: Also available with index syntax: bvector[bit].

pub fn clear(&mut self)

Clear all bits.

pub fn insert(&mut self, bit: usize)

Enable bit.

Panics if bit is out of bounds.

pub fn put(&mut self, bit: usize) -> bool

Enable bit, and return its previous value.

Panics if bit is out of bounds.

pub fn toggle(&mut self, bit: usize)

Toggle bit (inverting its state).

Panics if bit is out of bounds

pub fn set(&mut self, bit: usize, enabled: bool)

Panics if bit is out of bounds.

pub fn copy_bit(&mut self, from: usize, to: usize)

Copies boolean value from specified bit to the specified bit.

Panics if to is out of bounds.

pub fn count_ones<T: IndexRange>(&self, range: T) -> usize

Count the number of set bits in the given bit range.

Use .. to count the whole content of the bitset.

Panics if the range extends past the end of the bitset.

pub fn set_range<T: IndexRange>(&mut self, range: T, enabled: bool)

Sets every bit in the given range to the given state (enabled)

Use .. to set the whole bitset.

Panics if the range extends past the end of the bitset.

pub fn insert_range<T: IndexRange>(&mut self, range: T)

Enables every bit in the given range.

Use .. to make the whole bitset ones.

Panics if the range extends past the end of the bitset.

pub fn toggle_range<T: IndexRange>(&mut self, range: T)

Toggles (inverts) every bit in the given range.

Use .. to toggle the whole bitset.

Panics if the range extends past the end of the bitset.

pub fn ones(&self) -> Ones<'_>

Iterates over all enabled bits.

Iterator element is the index of the 1 bit, type usize.

pub fn intersection<'a>(&'a self, other: &'a BVector) -> Intersection<'a>

Returns a lazy iterator over the intersection of two BVectors

pub fn union<'a>(&'a self, other: &'a BVector) -> Union<'a>

Returns a lazy iterator over the union of two BVectors.

pub fn difference<'a>(&'a self, other: &'a BVector) -> Difference<'a>

Returns a lazy iterator over the difference of two BVectors. The difference of a and b is the elements of a which are not in b.

pub fn symmetric_difference<'a>(
    &'a self,
    other: &'a BVector
) -> SymmetricDifference<'a>

Returns a lazy iterator over the symmetric difference of two BVectors. The symmetric difference of a and b is the elements of one, but not both, sets.

pub fn union_with(&mut self, other: &BVector)

In-place union of two BVectors.

On calling this method, self’s capacity may be increased to match other’s.

pub fn intersect_with(&mut self, other: &BVector)

In-place intersection of two BVectors.

On calling this method, self’s capacity will remain the same as before.

pub fn difference_with(&mut self, other: &BVector)

In-place difference of two BVectors.

On calling this method, self’s capacity will remain the same as before.

pub fn symmetric_difference_with(&mut self, other: &BVector)

In-place symmetric difference of two BVectors.

On calling this method, self’s capacity may be increased to match other’s.

pub fn is_disjoint(&self, other: &BVector) -> bool

Returns true if self has no elements in common with other. This is equivalent to checking for an empty intersection.

pub fn is_subset(&self, other: &BVector) -> bool

Returns true if the set is a subset of another, i.e. other contains at least all the values in self.

pub fn is_superset(&self, other: &BVector) -> bool

Returns true if the set is a superset of another, i.e. self contains at least all the values in other.

impl BVector

pub fn serialize<W>(&self, wtr: W) -> Result<(), Box<dyn Error>> where
    W: Write, 

Serialize bit vector

pub fn deserialize<R>(rdr: R) -> Result<Self, Box<dyn Error>> where
    R: Read, 

Deserialize bit vector

pub fn intersection_count(&self, other: &BVector) -> usize

Size of the intersection of two BVectors.

Equivalent to the population count of AND of two bit vectors

pub fn union_count(&self, other: &BVector) -> usize

Size of the union of two BVectors.

Equivalent to the population count of OR of two bit vectors

pub fn difference_count(&self, other: &BVector) -> usize

Size of the difference of two BVectors.

Equivalent to the population count of SUB of two bit vectors

pub fn symmetric_difference_count(&self, other: &BVector) -> usize

Size of the symmetric difference of two BVectors.

Equivalent to the population count of XOR of two bit vectors

Trait Implementations

impl Binary for BVector

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

Formats the value using the given formatter.

impl<'a> BitAnd<&'a BVector> for &'a BVector

type Output = BVector

The resulting type after applying the & operator.

fn bitand(self, other: &BVector) -> BVector

Performs the & operation.

impl<'a> BitAndAssign<&'_ BVector> for BVector

fn bitand_assign(&mut self, other: &Self)

Performs the &= operation.

impl<'a> BitAndAssign<BVector> for BVector

fn bitand_assign(&mut self, other: Self)

Performs the &= operation.

impl<'a> BitOr<&'a BVector> for &'a BVector

type Output = BVector

The resulting type after applying the | operator.

fn bitor(self, other: &BVector) -> BVector

Performs the | operation.

impl<'a> BitOrAssign<&'_ BVector> for BVector

fn bitor_assign(&mut self, other: &Self)

Performs the |= operation.

impl<'a> BitOrAssign<BVector> for BVector

fn bitor_assign(&mut self, other: Self)

Performs the |= operation.

impl<'a> BitXor<&'a BVector> for &'a BVector

type Output = BVector

The resulting type after applying the ^ operator.

fn bitxor(self, other: &BVector) -> BVector

Performs the ^ operation.

impl<'a> BitXorAssign<&'_ BVector> for BVector

fn bitxor_assign(&mut self, other: &Self)

Performs the ^= operation.

impl<'a> BitXorAssign<BVector> for BVector

fn bitxor_assign(&mut self, other: Self)

Performs the ^= operation.

impl Clone for BVector

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BVector

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

Formats the value using the given formatter.

impl Default for BVector

fn default() -> Self

Returns the “default value” for a type.

impl Display for BVector

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

Formats the value using the given formatter.

impl Drop for BVector

fn drop(&mut self)

Executes the destructor for this type.

impl Extend<usize> for BVector

Sets the bit at index i to true for each item i in the input src.

fn extend<I: IntoIterator<Item = usize>>(&mut self, src: I)

Extends a collection with the contents of an iterator.

pub fn extend_one(&mut self, item: A)

🔬 This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

pub fn extend_reserve(&mut self, additional: usize)

🔬 This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl FromIterator<usize> for BVector

Return a BVector containing bits set to true for every bit index in the iterator, other bits are set to false.

fn from_iter<I: IntoIterator<Item = usize>>(src: I) -> Self

Creates a value from an iterator.

impl Index<usize> for BVector

Return true if the bit is enabled in the bitset, or false otherwise.

Note: bits outside the capacity are always disabled, and thus indexing a BVector will not panic.

type Output = bool

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl PartialEq<BVector> for BVector

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

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

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<BVector> for BVector

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]pub fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.