Struct SparseMatrix 

pub struct SparseMatrix { /* private fields */ }

A sparse matrix in compressed sparse row form.

Rows are stored in order and the column indices within each row are strictly increasing, so two matrices built from the same entries in any order are equal and every product is computed in the same order.

Implementations

impl SparseMatrix

pub fn from_triplets( rows: usize, cols: usize, triplets: &[(usize, usize, f64)], ) -> NumericResult<Self>

Build from (row, column, value) triplets. Entries naming the same position are summed, in the order given; entries that sum to zero are kept as explicit zeros.

Errors

NumericError::InvalidArgument for a triplet outside the rows x cols shape and NumericError::NonFiniteInput for a non-finite value.

pub fn rows(&self) -> usize

Number of rows.

pub fn cols(&self) -> usize

Number of columns.

pub fn nnz(&self) -> usize

Number of stored entries.

pub fn get(&self, i: usize, j: usize) -> f64

Entry (i, j); zero when it is not stored.

Panics

When (i, j) is outside the shape.

pub fn row(&self, i: usize) -> (&[usize], &[f64])

Column indices (increasing) and values of row i.

Panics

When i is not a row.

pub fn mul_vec(&self, x: &[f64]) -> NumericResult<Vec<f64>>

A x.

Errors

Refuses x of the wrong length.

Trait Implementations

impl Clone for SparseMatrix

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SparseMatrix

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

Formats the value using the given formatter.

impl PartialEq for SparseMatrix

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for SparseMatrix