Struct hi_sparse_bitset::BitSet

pub struct BitSet<Conf: Config> { /* private fields */ }

Hierarchical sparse bitset.

Tri-level hierarchy. Highest uint it can hold is Level0Mask::BITS * Level1Mask::BITS * DenseBlock::BITS.

Only last level contains blocks of actual data. Empty(skipped) data blocks are not allocated.

Structure optimized for intersection speed. (Other inter-bitset operations are in fact fast too - but intersection has lowest algorithmic complexity.) Insert/remove/contains is fast O(1) too.

Implementations

impl<Conf: Config> BitSet<Conf>

pub fn new() -> Self

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

Safety

Will panic, if index is out of range.

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

Returns false if index is invalid/not in bitset.

pub unsafe fn remove_unchecked(&mut self, index: usize)

Safety

index MUST exists in HiSparseBitset!

Trait Implementations

impl<'a, Conf, Rhs> BitAnd<Rhs> for &'a BitSet<Conf>

where Conf: Config,

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

Returns intersection of self and rhs bitsets.

type Output = BitSetOp<BitAndOp, &'a BitSet<Conf>, Rhs>

The resulting type after applying the & operator.

impl<'a, Conf, Rhs> BitOr<Rhs> for &'a BitSet<Conf>

where Conf: Config,

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

Returns union of self and rhs bitsets.

type Output = BitSetOp<BitOrOp, &'a BitSet<Conf>, Rhs>

The resulting type after applying the | operator.

impl<Conf: Config> BitSetBase for BitSet<Conf>

type Conf = Conf

impl<'a, Conf, Rhs> BitXor<Rhs> for &'a BitSet<Conf>

where Conf: Config,

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

Returns symmetric difference of self and rhs bitsets.

type Output = BitSetOp<BitXorOp, &'a BitSet<Conf>, Rhs>

The resulting type after applying the ^ operator.

impl<Conf: Config> Clone for BitSet<Conf>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Conf: Config> Default for BitSet<Conf>

fn default() -> Self

Returns the “default value” for a type.

impl<Conf: Config, const N: usize> From<[usize; N]> for BitSet<Conf>

fn from(value: [usize; N]) -> Self

Converts to this type from the input type.

impl<Conf: Config> FromIterator<usize> for BitSet<Conf>

fn from_iter<T: IntoIterator<Item = usize>>(iter: T) -> Self

Creates a value from an iterator.

impl<'a, Conf> IntoIterator for &'a BitSet<Conf>

where Conf: Config,

type Item = usize

The type of the elements being iterated over.

type IntoIter = <<&'a BitSet<Conf> as BitSetInterface>::IntoBlockIter as BlockIterator>::IndexIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<Conf> IntoIterator for BitSet<Conf>

where Conf: Config,

type Item = usize

The type of the elements being iterated over.

type IntoIter = <<BitSet<Conf> as BitSetInterface>::IntoBlockIter as BlockIterator>::IndexIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, Conf, Rhs> Sub<Rhs> for &'a BitSet<Conf>

where Conf: Config,

fn sub(self, rhs: Rhs) -> Self::Output

Returns difference of self and rhs bitsets.

Or relative complement of rhs in self.

type Output = BitSetOp<BitSubOp, &'a BitSet<Conf>, Rhs>

The resulting type after applying the - operator.