Struct SparseMatrix 

pub struct SparseMatrix { /* private fields */ }

A sparse matrix in COO (coordinate) format.

Implementations

impl SparseMatrix

pub fn new(n_rows: usize, n_cols: usize) -> Self

Create an empty sparse matrix with the given dimensions.

pub fn from_triplets( rows: Vec<usize>, cols: Vec<usize>, values: Vec<f64>, n_rows: usize, n_cols: usize, ) -> Result<Self>

Create a sparse matrix from triplet vectors.

All three vectors must have the same length, and all indices must be within bounds.

pub fn insert(&mut self, row: usize, col: usize, value: f64) -> Result<()>

Insert a single entry. Returns an error if indices are out of bounds.

pub fn get(&self, row: usize, col: usize) -> f64

Get the value at (row, col). Returns 0.0 if no entry is stored.

This is an O(nnz) scan.

pub fn nnz(&self) -> usize

Number of stored (non-zero) entries.

pub fn density(&self) -> f64

Fraction of entries that are stored: nnz / (n_rows * n_cols).

pub fn shape(&self) -> (usize, usize)

(n_rows, n_cols).

pub fn to_dense(&self) -> Vec<Vec<f64>>

Convert to a dense 2D vector.

pub fn from_dense(data: &[Vec<f64>], threshold: f64) -> Self

Create a sparse matrix from dense data, storing only values where |value| > threshold.

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

Number of stored entries in a given row.

pub fn col_nnz(&self, col: usize) -> usize

Number of stored entries in a given column.

pub fn to_csr(&self) -> (Vec<f64>, Vec<usize>, Vec<usize>)

Convert COO to CSR format.

Returns (data, indices, indptr) where:

• data contains the non-zero values
• indices contains the column index for each value
• indptr[i]..indptr[i+1] gives the range of entries for row i

pub fn from_csr( data: Vec<f64>, indices: Vec<usize>, indptr: Vec<usize>, n_rows: usize, n_cols: usize, ) -> Result<Self>

Create a sparse matrix from CSR format.

• data — non-zero values
• indices — column index for each value
• indptr — row pointer array (length n_rows + 1)

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

Iterate over stored triplets (row, col, value).

pub fn column_sums(&self) -> Vec<f64>

Sum of values in each column.

pub fn column_means(&self) -> Vec<f64>

Mean value of each column (dividing by n_rows, treating missing as zero).

pub fn row_sums(&self) -> Vec<f64>

Sum of values in each row.

pub fn scale_rows(&mut self, factors: &[f64])

Multiply each row’s values by the corresponding factor.

factors must have length n_rows.

pub fn map_values(&mut self, f: impl Fn(f64) -> f64)

Apply a function to every stored value in place.

pub fn n_rows(&self) -> usize

Number of rows.

pub fn n_cols(&self) -> usize

Number of columns.

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 Summarizable for SparseMatrix

fn summary(&self) -> String

A one-line summary suitable for display.