Struct SparseMatrix 

pub struct SparseMatrix<S: Semiring> {
    pub rows: usize,
    pub cols: usize,
    pub entries: Vec<SparseEntry<S>>,
}

A coordinate-list sparse matrix.

Fields

rows: usize

Number of rows.

cols: usize

Number of columns.

entries: Vec<SparseEntry<S>>

Stored entries (canonical after SparseMatrix::canonicalize).

Implementations

impl<S: Semiring> SparseMatrix<S>

pub fn new(rows: usize, cols: usize) -> Self

An empty rows x cols sparse matrix.

pub fn try_new(rows: usize, cols: usize) -> Result<Self, AlgebraError>

Checked empty rows x cols sparse matrix.

pub fn row_count(&self) -> usize

Number of sparse matrix rows.

pub fn col_count(&self) -> usize

Number of sparse matrix columns.

pub fn entries(&self) -> &[SparseEntry<S>]

Read-only sparse entries.

pub fn from_entries( rows: usize, cols: usize, entries: Vec<SparseEntry<S>>, ) -> Result<Self, AlgebraError>

Build from entries, rejecting any whose coordinates are out of range.

pub fn validate(&self) -> Result<(), AlgebraError>

Validate public sparse dimensions and entry coordinates.

pub fn canonicalize(&mut self)

Sort entries by (row, col), merge duplicates by semiring add, and drop entries equal to zero.

pub fn to_dense(&self) -> Result<Matrix<S>, AlgebraError>

Densify, filling absent positions with the semiring zero.

pub fn from_dense_nonzero(dense: &Matrix<S>) -> Result<Self, AlgebraError>

Build a canonical sparse matrix from a dense one, keeping non-zero entries only.

Trait Implementations

impl<S: Clone + Semiring> Clone for SparseMatrix<S>

fn clone(&self) -> SparseMatrix<S>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<S: Debug + Semiring> Debug for SparseMatrix<S>

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

Formats the value using the given formatter.

impl<S: PartialEq + Semiring> PartialEq for SparseMatrix<S>

fn eq(&self, other: &SparseMatrix<S>) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<S: PartialEq + Semiring> StructuralPartialEq for SparseMatrix<S>