Struct rustc_index::bit_set::BitSet

pub struct BitSet<T> {
    domain_size: usize,
    words: Vec<Word>,
    marker: PhantomData<T>,
}

A fixed-size bitset type with a dense representation.

NOTE: Use GrowableBitSet if you need support for resizing after creation.

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.

Fields

domain_size: usize

words: Vec<Word>

marker: PhantomData<T>

Implementations

impl<T> BitSet<T>

pub fn domain_size(&self) -> usize

Gets the domain size.

impl<T: Idx> BitSet<T>

pub fn new_empty(domain_size: usize) -> BitSet<T>

Creates a new, empty bitset with a given domain_size.

pub fn new_filled(domain_size: usize) -> BitSet<T>

Creates a new, filled bitset with a given domain_size.

pub fn clear(&mut self)

Clear all elements.

fn clear_excess_bits(&mut self)

Clear excess bits in the final word.

pub fn count(&self) -> usize

Count the number of set bits in the set.

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

Returns true if self contains elem.

pub fn superset(&self, other: &BitSet<T>) -> bool

Is self is a (non-strict) superset of other?

pub fn is_empty(&self) -> bool

Is the set empty?

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

Insert elem. Returns whether the set has changed.

pub fn insert_all(&mut self)

Sets all bits to true.

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

Returns true if the set has changed.

pub fn union(&mut self, other: &impl UnionIntoBitSet<T>) -> bool

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

pub fn subtract(&mut self, other: &impl SubtractFromBitSet<T>) -> bool

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

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

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

pub fn words(&self) -> &[Word]

Gets a slice of the underlying words.

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

Iterates over the indices of set bits in a sorted order.

pub fn to_hybrid(&self) -> HybridBitSet<T>

Duplicates the set as a hybrid set.

fn reverse_union_sparse(&mut self, sparse: &SparseBitSet<T>) -> bool

Set self = self | other. In contrast to union returns true if the set contains at least one bit that is not in other (i.e. other is not a superset of self).

This is an optimization for union of a hybrid bitset.

Trait Implementations

impl<T> Clone for BitSet<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

impl<T, __D: Decoder> Decodable<__D> for BitSet<T> where
    T: Decodable<__D>, 

fn decode(__decoder: &mut __D) -> Result<Self, <__D as Decoder>::Error>

impl<T, __E: Encoder> Encodable<__E> for BitSet<T> where
    T: Encodable<__E>, 

fn encode(&self, __encoder: &mut __E) -> Result<(), <__E as Encoder>::Error>

impl<T: PartialEq> PartialEq<BitSet<T>> for BitSet<T>

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

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

fn ne(&self, other: &BitSet<T>) -> bool

This method tests for !=.

impl<T: Idx> SubtractFromBitSet<T> for BitSet<T>

fn subtract_from(&self, other: &mut BitSet<T>) -> bool

impl<T: Idx> ToString for BitSet<T>

fn to_string(&self) -> String

Converts the given value to a String.

impl<T: Idx> UnionIntoBitSet<T> for BitSet<T>

fn union_into(&self, other: &mut BitSet<T>) -> bool

impl<T: Eq> Eq for BitSet<T>

impl<T> StructuralEq for BitSet<T>

impl<T> StructuralPartialEq for BitSet<T>