Struct hibitset::BitSet

pub struct BitSet { /* fields omitted */ }

A BitSet is a simple set designed to track which indices are placed into it.

Note, a BitSet is limited by design to only usize**4 indices. Adding beyond this limit will cause the BitSet to panic.

Methods

impl BitSet

pub fn new() -> BitSet

Creates an empty BitSet.

pub fn with_capacity(max: u32) -> BitSet

Creates an empty BitSet, preallocated for up to max indices.

pub fn add(&mut self, id: u32) -> bool

Adds id to the BitSet. Returns true if the value was already in the set.

pub fn remove(&mut self, id: u32) -> bool

Removes id from the set, returns true if the value was removed, and false if the value was not set to begin with.

pub fn contains(&self, id: u32) -> bool

Returns true if id is in the set.

pub fn contains_set(&self, other: &BitSet) -> bool

Returns true if all ids in other are contained in this set

pub fn clear(&mut self)

Completely wipes out the bit set.

Trait Implementations

impl BitSetLike for BitSet

fn layer3(&self) -> usize

Return a usize where each bit represents if any word in layer2 has been set.

fn layer2(&self, i: usize) -> usize

Return the usize from the array of usizes that indicates if any bit has been set in layer1

fn layer1(&self, i: usize) -> usize

Return the usize from the array of usizes that indicates if any bit has been set in layer0

fn layer0(&self, i: usize) -> usize

Return a usize that maps to the direct 1:1 association with each index of the set

fn contains(&self, i: u32) -> bool

Allows checking if set bit is contained in the bit set.

fn get_from_layer(&self, layer: usize, idx: usize) -> usize

Gets the usize corresponding to layer and index.

fn is_empty(&self) -> bool

Returns true if this BitSetLike contains nothing, and false otherwise.

Important traits for BitIter<T>

impl<T> Iterator for BitIter<T> where
    T: BitSetLike,  type Item = u32;

fn iter(self) -> BitIter<Self> where
    Self: Sized, 

Create an iterator that will scan over the keyspace

fn par_iter(self) -> BitParIter<Self> where
    Self: Sized, 

Create a parallel iterator that will scan over the keyspace

impl DrainableBitSet for BitSet

fn remove(&mut self, i: u32) -> bool

Removes bit from the bit set.

Important traits for DrainBitIter<'a, T>

impl<'a, T> Iterator for DrainBitIter<'a, T> where
    T: DrainableBitSet,  type Item = u32;

fn drain<'a>(&'a mut self) -> DrainBitIter<'a, Self> where
    Self: Sized, 

Create a draining iterator that will scan over the keyspace and clears it while doing so.

impl Extend<u32> for BitSet

fn extend<T>(&mut self, iter: T) where
    T: IntoIterator<Item = u32>, 

Extends a collection with the contents of an iterator.

impl<'a> Extend<&'a u32> for BitSet

fn extend<T>(&mut self, iter: T) where
    T: IntoIterator<Item = &'a u32>, 

Extends a collection with the contents of an iterator.

impl Eq for BitSet

impl Clone for BitSet

fn clone(&self) -> BitSet

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialEq<BitSet> for BitSet

fn eq(&self, rhv: &BitSet) -> bool

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

#[must_use]

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

This method tests for !=.

impl Default for BitSet

fn default() -> BitSet

Returns the "default value" for a type.

impl IntoIterator for BitSet

type Item = <BitIter<Self> as Iterator>::Item

The type of the elements being iterated over.

type IntoIter = BitIter<Self>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a> IntoIterator for &'a BitSet

type Item = <BitIter<Self> as Iterator>::Item

The type of the elements being iterated over.

type IntoIter = BitIter<Self>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl Debug for BitSet

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

Formats the value using the given formatter.

impl Not for BitSet

type Output = BitSetNot<Self>

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

impl<'a> Not for &'a BitSet

type Output = BitSetNot<Self>

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

impl<T> BitAnd<T> for BitSet where
    T: BitSetLike, 

type Output = BitSetAnd<Self, T>

The resulting type after applying the & operator.

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

Performs the & operation.

impl<'a, T> BitAnd<T> for &'a BitSet where
    T: BitSetLike, 

type Output = BitSetAnd<Self, T>

The resulting type after applying the & operator.

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

Performs the & operation.

impl<T> BitOr<T> for BitSet where
    T: BitSetLike, 

type Output = BitSetOr<Self, T>

The resulting type after applying the | operator.

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

Performs the | operation.

impl<'a, T> BitOr<T> for &'a BitSet where
    T: BitSetLike, 

type Output = BitSetOr<Self, T>

The resulting type after applying the | operator.

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

Performs the | operation.

impl<T> BitXor<T> for BitSet where
    T: BitSetLike, 

type Output = BitSetXor<Self, T>

The resulting type after applying the ^ operator.

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

Performs the ^ operation.

impl<'a, T> BitXor<T> for &'a BitSet where
    T: BitSetLike, 

type Output = BitSetXor<Self, T>

The resulting type after applying the ^ operator.

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

Performs the ^ operation.

impl<'a, B> BitAndAssign<&'a B> for BitSet where
    B: BitSetLike, 

fn bitand_assign(&mut self, lhs: &B)

Performs the &= operation.

impl<'a, B> BitOrAssign<&'a B> for BitSet where
    B: BitSetLike, 

fn bitor_assign(&mut self, lhs: &B)

Performs the |= operation.

impl<'a, B> BitXorAssign<&'a B> for BitSet where
    B: BitSetLike, 

fn bitxor_assign(&mut self, lhs: &B)

Performs the ^= operation.

impl FromIterator<u32> for BitSet

fn from_iter<T>(iter: T) -> Self where
    T: IntoIterator<Item = u32>, 

Creates a value from an iterator.

impl<'a> FromIterator<&'a u32> for BitSet

fn from_iter<T>(iter: T) -> Self where
    T: IntoIterator<Item = &'a u32>, 

Creates a value from an iterator.