pub struct ChunkedBitSet<T> { /* private fields */ }
Expand description

A fixed-size bitset type with a partially dense, partially sparse representation. The bitset is broken into chunks, and chunks that are all zeros or all ones are represented and handled very efficiently.

This type is especially efficient for sets that typically have a large domain_size with significant stretches of all zeros or all ones, and also some stretches with lots of 0s and 1s mixed in a way that causes trouble for IntervalSet.

T is an index type, typically a newtyped usize wrapper, but it can also just be usize.

All operations that involve an element will panic if the element is equal to or greater than the domain size. All operations that involve two bitsets will panic if the bitsets have differing domain sizes.

Implementations§

source§

impl<T> ChunkedBitSet<T>

source

pub fn domain_size(&self) -> usize

source§

impl<T: Idx> ChunkedBitSet<T>

source

pub fn new_empty(domain_size: usize) -> Self

Creates a new, empty bitset with a given domain_size.

source

pub fn new_filled(domain_size: usize) -> Self

Creates a new, filled bitset with a given domain_size.

source

pub fn count(&self) -> usize

Count the number of bits in the set.

source

pub fn contains(&self, elem: T) -> bool

Returns true if self contains elem.

source

pub fn iter(&self) -> ChunkedBitIter<'_, T>

source

pub fn insert(&mut self, elem: T) -> bool

Insert elem. Returns whether the set has changed.

source

pub fn insert_all(&mut self)

Sets all bits to true.

source

pub fn remove(&mut self, elem: T) -> bool

Returns true if the set has changed.

source

pub fn union<Rhs>(&mut self, other: &Rhs) -> bool
where Self: BitRelations<Rhs>,

Sets self = self | other and returns true if self changed (i.e., if new bits were added).

source

pub fn subtract<Rhs>(&mut self, other: &Rhs) -> bool
where Self: BitRelations<Rhs>,

Sets self = self - other and returns true if self changed. (i.e., if any bits were removed).

source

pub fn intersect<Rhs>(&mut self, other: &Rhs) -> bool
where Self: BitRelations<Rhs>,

Sets self = self & other and return true if self changed. (i.e., if any bits were removed).

Trait Implementations§

source§

impl<T: Idx> BitRelations<ChunkedBitSet<T>> for BitSet<T>

source§

fn union(&mut self, other: &ChunkedBitSet<T>) -> bool

source§

fn subtract(&mut self, _other: &ChunkedBitSet<T>) -> bool

source§

fn intersect(&mut self, other: &ChunkedBitSet<T>) -> bool

source§

impl<T: Idx> BitRelations<ChunkedBitSet<T>> for ChunkedBitSet<T>

source§

fn union(&mut self, other: &ChunkedBitSet<T>) -> bool

source§

fn subtract(&mut self, _other: &ChunkedBitSet<T>) -> bool

source§

fn intersect(&mut self, _other: &ChunkedBitSet<T>) -> bool

source§

impl<T: Idx> BitRelations<HybridBitSet<T>> for ChunkedBitSet<T>

source§

fn union(&mut self, other: &HybridBitSet<T>) -> bool

source§

fn subtract(&mut self, other: &HybridBitSet<T>) -> bool

source§

fn intersect(&mut self, _other: &HybridBitSet<T>) -> bool

source§

impl<T> Clone for ChunkedBitSet<T>

source§

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

WARNING: this implementation of clone_from will panic if the two bitsets have different domain sizes. This constraint is not inherent to clone_from, but it works with the existing call sites and allows a faster implementation, which is important because this function is hot.

source§

fn clone(&self) -> Self

Returns a copy of the value. Read more
source§

impl<T: Idx> Debug for ChunkedBitSet<T>

source§

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

Formats the value using the given formatter. Read more
source§

impl<T: PartialEq> PartialEq for ChunkedBitSet<T>

source§

fn eq(&self, other: &ChunkedBitSet<T>) -> bool

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl<T: Eq> Eq for ChunkedBitSet<T>

source§

impl<T> StructuralPartialEq for ChunkedBitSet<T>

Auto Trait Implementations§

§

impl<T> RefUnwindSafe for ChunkedBitSet<T>
where T: RefUnwindSafe,

§

impl<T> !Send for ChunkedBitSet<T>

§

impl<T> !Sync for ChunkedBitSet<T>

§

impl<T> Unpin for ChunkedBitSet<T>
where T: Unpin,

§

impl<T> UnwindSafe for ChunkedBitSet<T>
where T: UnwindSafe,

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.