Struct BitMatrix

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

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.

Implementations

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 from_row_n(row: &DenseBitSet<C>, num_rows: usize) -> BitMatrix<R, C>

Creates a new matrix, with row used as the value for every row.

pub fn rows(&self) -> impl Iterator<Item = R>

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).

pub fn union_row_with(&mut self, with: &DenseBitSet<C>, write: R) -> bool

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

pub fn insert_all_into_row(&mut self, row: R)

Sets every cell in row to true.

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

Gets a slice of the underlying words.

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

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

pub fn count(&self, row: R) -> usize

Returns the number of elements in row.

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: Idx, C: Idx> Debug for BitMatrix<R, C>

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

Formats the value using the given formatter.

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

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

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

fn eq(&self, other: &BitMatrix<R, C>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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

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