Struct SparseMatrix 

pub struct SparseMatrix { /* private fields */ }

Compressed Sparse Row (CSR) matrix for memory-efficient storage of mostly-zero 2-D data, mirroring scipy.sparse csr_matrix.

Three arrays define the non-zero entries:

• indptr (length nrows + 1): row i occupies indptr[i]..indptr[i+1] in indices/data.
• indices: column index of each non-zero.
• data: value of each non-zero.

Implementations

impl SparseMatrix

pub fn new( nrows: usize, ncols: usize, indptr: Vec<usize>, indices: Vec<usize>, data: Vec<f64>, ) -> Result<Self>

Build a CSR matrix from raw CSR arrays.

indptr must be non-decreasing and stay within the stored-entry count. Column indices must be strictly increasing within every row.

pub fn from_triplets( nrows: usize, ncols: usize, triplets: &[(usize, usize, f64)], ) -> Result<Self>

Build from (row, col, value) triplets. Zero-valued triplets are dropped automatically. Within a row, entries are sorted by column and duplicate coordinates are summed.

pub fn zeros(nrows: usize, ncols: usize) -> Result<Self>

Create an all-zeros sparse matrix with the given shape.

pub fn nrows(&self) -> usize

Returns the number of rows.

pub fn ncols(&self) -> usize

Returns the number of columns.

pub fn nnz(&self) -> usize

Number of stored non-zero entries.

pub fn density(&self) -> f64

Density (fraction of non-zero entries).

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

Get element at (i, j). Returns 0.0 if not stored.

Panics

Panics if i >= nrows() or j >= ncols(). Use checked_get for bounds-checked access.

pub fn checked_get(&self, i: usize, j: usize) -> Option<f64>

Returns Some(element) at row i, column j, including Some(0.0) when the value is not stored, or None if either index is out of bounds.

pub fn row_nz(&self, i: usize) -> impl Iterator<Item = (usize, f64)> + '_

Iterate over (col, value) non-zero entries in row i.

Panics

Panics if i >= nrows().

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

Convert to a dense Matrix.

Trait Implementations

impl Clone for SparseMatrix

fn clone(&self) -> SparseMatrix

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<'de> Deserialize<'de> for SparseMatrix

Available on crate feature serde only.

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for SparseMatrix

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for SparseMatrix

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for SparseMatrix