Struct indexical::IndexMatrix

pub struct IndexMatrix<R, C: IndexedValue, S: BitSet, P: PointerFamily> { /* private fields */ }

An unordered collections of pairs (R, C), implemented with a sparse bit-matrix.

“Sparse” means “hash map from rows to bit-sets of columns”. Subsequently, only column types C must be indexed, while row types R only need be hashable.

Implementations

impl<R, C, S, P> IndexMatrix<R, C, S, P>

where R: PartialEq + Eq + Hash + Clone, C: IndexedValue, S: BitSet, P: PointerFamily,

pub fn new(col_domain: &P::Pointer<IndexedDomain<C>>) -> Self

Creates an empty matrix.

pub fn insert<M>(&mut self, row: R, col: impl ToIndex<C, M>) -> bool

Inserts a pair (row, col) into the matrix, returning true if self changed.

pub fn union_into_row(&mut self, into: R, from: &IndexSet<C, S, P>) -> bool

Adds all elements of from into the row into.

pub fn union_rows(&mut self, from: R, to: R) -> bool

Adds all elements from the row from into the row into.

pub fn row(&self, row: &R) -> impl Iterator<Item = &C> + '_

Returns an iterator over the elements in row.

pub fn rows(&self) -> impl Iterator<Item = (&R, &IndexSet<C, S, P>)> + '_

Returns an iterator over all rows in the matrix.

pub fn row_set(&self, row: &R) -> &IndexSet<C, S, P>

Returns the IndexSet for a particular row.

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

Clears all the elements from the row.

pub fn col_domain(&self) -> &P::Pointer<IndexedDomain<C>>

Returns the IndexedDomain for the column type.

Trait Implementations

impl<R, C, S, P> Clone for IndexMatrix<R, C, S, P>

where R: PartialEq + Eq + Hash + Clone, C: IndexedValue, S: BitSet, P: PointerFamily,

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<R, C, S, P> Debug for IndexMatrix<R, C, S, P>

where R: PartialEq + Eq + Hash + Clone + Debug, C: IndexedValue + Debug, S: BitSet, P: PointerFamily,

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

Formats the value using the given formatter.

impl<R, C, S, P> JoinSemiLattice for IndexMatrix<R, C, S, P>

where R: PartialEq + Eq + Hash + Clone, C: IndexedValue, S: BitSet, P: PointerFamily,

fn join(&mut self, other: &Self) -> bool

Computes the least upper bound of two elements, storing the result in self and returning true if self has changed.

impl<R, C, S, P> PartialEq for IndexMatrix<R, C, S, P>

where R: PartialEq + Eq + Hash, C: IndexedValue, S: BitSet, P: PointerFamily,

fn eq(&self, other: &Self) -> bool

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

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.

impl<R, C, S, P> Eq for IndexMatrix<R, C, S, P>

where R: PartialEq + Eq + Hash, C: IndexedValue, S: BitSet, P: PointerFamily,