Struct rustc_data_structures::bit_set::BitMatrix

pub struct BitMatrix<R: Idx, C: Idx> { /* fields omitted */ }

A fixed-size 2D bit matrix type with a dense representation.

R and C are index types used to identify rows and columns respectively; typically newtyped usize wrappers, but they can also just be usize.

All operations that involve a row and/or column index will panic if the index exceeds the relevant bound.

Methods

impl<R: Idx, C: Idx> BitMatrix<R, C>

pub fn new(num_rows: usize, num_columns: usize) -> BitMatrix<R, C>

Creates a new rows x columns matrix, initially empty.

pub fn insert(&mut self, row: R, column: C) -> bool

Sets the cell at (row, column) to true. Put another way, insert column to the bitset for row.

Returns true if this changed the matrix.

pub fn contains(&self, row: R, column: C) -> bool

Do the bits from row contain column? Put another way, is the matrix cell at (row, column) true? Put yet another way, if the matrix represents (transitive) reachability, can row reach column?

pub fn intersect_rows(&self, row1: R, row2: R) -> Vec<C>

Returns those indices that are true in rows a and b. This is an O(n) operation where n is the number of elements (somewhat independent from the actual size of the intersection, in particular).

pub fn union_rows(&mut self, read: R, write: R) -> bool

Adds the bits from row read to the bits from row write, and returns true if anything changed.

This is used when computing transitive reachability because if you have an edge write -> read, because in that case write can reach everything that read can (and potentially more).

Important traits for BitIter<'a, T>

impl<'a, T: Idx> Iterator for BitIter<'a, T> type Item = T;

pub fn iter<'a>(&'a self, row: R) -> BitIter<'a, C>

Iterates through all the columns set to true in a given row of the matrix.

Trait Implementations

impl<R: Clone + Idx, C: Clone + Idx> Clone for BitMatrix<R, C>

fn clone(&self) -> BitMatrix<R, C>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<R: Debug + Idx, C: Debug + Idx> Debug for BitMatrix<R, C>

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

Formats the value using the given formatter.