Struct SparseMatrix

pub struct SparseMatrix<T> {
    pub shape: (usize, usize),
    pub nnz: usize,
    pub format: SparseFormat,
    pub coo: SparseMatrixCOO<T>,
    pub csr: Option<SparseMatrixCSR<T>>,
    pub csc: Option<SparseMatrixCSC<T>>,
    pub metadata: HashMap<String, String>,
}

Comprehensive sparse matrix supporting multiple formats

Fields

shape: (usize, usize)

Matrix dimensions (rows, cols)

nnz: usize

Number of non-zero elements

format: SparseFormat

Primary format for storage

coo: SparseMatrixCOO<T>

COO format data (always available)

csr: Option<SparseMatrixCSR<T>>

CSR format data (computed on demand)

csc: Option<SparseMatrixCSC<T>>

CSC format data (computed on demand)

metadata: HashMap<String, String>

Additional metadata

Implementations

impl<T> SparseMatrix<T>

where T: Clone + Default + PartialEq,

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

Create a new empty sparse matrix

pub fn from_coo(coo: SparseMatrixCOO<T>) -> Self

Create a sparse matrix from COO data

pub fn from_triplets( rows: usize, cols: usize, row_indices: Vec<usize>, col_indices: Vec<usize>, values: Vec<T>, ) -> Result<Self>

Create a sparse matrix from triplets (row, col, value)

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

Add a non-zero element to the matrix

pub fn nnz(&self) -> usize

Get the number of non-zero elements

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

Get matrix dimensions

pub fn density(&self) -> f64

Get sparsity density (nnz / total_elements)

pub fn to_csr(&mut self) -> Result<&SparseMatrixCSR<T>>

Convert to CSR format (cached)

pub fn to_csc(&mut self) -> Result<&SparseMatrixCSC<T>>

Convert to CSC format (cached)

pub fn to_coo(&self) -> &SparseMatrixCOO<T>

Convert to COO format (always available)

pub fn stats(&mut self) -> Result<SparseStats>

Get comprehensive statistics about the sparse matrix

impl<T> SparseMatrix<T>

where T: Clone + Default + PartialEq + PartialOrd,

pub fn from_dense_2d(array: &Array2<T>, threshold: T) -> Result<Self>

Create a sparse matrix from a dense 2D array with threshold

pub fn from_dense<S, D>(array: &ArrayBase<S, D>, threshold: T) -> Result<Self>

where S: Data<Elem = T>, D: Dimension,

Create a sparse matrix from a dense array with threshold (generic version)

pub fn to_dense(&self) -> Array2<T>

Convert sparse matrix to dense array

impl SparseMatrix<f64>

pub fn load_matrix_market<P: AsRef<Path>>(path: P) -> Result<Self>

Load a sparse matrix from a Matrix Market file

pub fn save_matrix_market<P: AsRef<Path>>(&self, path: P) -> Result<()>

Save the sparse matrix to a Matrix Market file

pub fn transpose(&self) -> Self

Transpose the sparse matrix

Trait Implementations

impl Add for &SparseMatrix<f64>

type Output = Result<SparseMatrix<f64>, IoError>

The resulting type after applying the + operator.

fn add(self, other: &SparseMatrix<f64>) -> Self::Output

Performs the + operation.

impl<T: Clone> Clone for SparseMatrix<T>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for SparseMatrix<T>

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

Formats the value using the given formatter.