Crate scirs2_sparse

Sparse module

This module provides implementations of various sparse matrix and array formats and operations, similar to SciPy’s sparse module.

Overview

• Sparse formats (CSR, CSC, COO, DOK, LIL, DIA, BSR, etc.)
• Specialized sparse formats (Symmetric CSR, Symmetric COO)
• Basic operations (addition, multiplication, etc.)
• Sparse linear system solvers
• Sparse eigenvalue computation
• Conversion between different formats

Matrix vs. Array API

This module provides both a matrix-based API and an array-based API, following SciPy’s transition to a more NumPy-compatible array interface.

When using the array interface (e.g., CsrArray), please note that:

• * performs element-wise multiplication, not matrix multiplication
• Use dot() method for matrix multiplication
• Operations like sum produce arrays, not matrices
• Array-style slicing operations return scalars, 1D, or 2D arrays

For new code, we recommend using the array interface, which is more consistent with the rest of the numerical ecosystem.

Examples

Matrix API (Legacy)

use scirs2_sparse::csr::CsrMatrix;

// Create a sparse matrix in CSR format
let rows = vec![0, 0, 1, 2, 2];
let cols = vec![0, 2, 2, 0, 1];
let data = vec![1.0, 2.0, 3.0, 4.0, 5.0];
let shape = (3, 3);

let matrix = CsrMatrix::new(data, rows, cols, shape).unwrap();

Array API (Recommended)

use scirs2_sparse::csr_array::CsrArray;

// Create a sparse array in CSR format
let rows = vec![0, 0, 1, 2, 2];
let cols = vec![0, 2, 2, 0, 1];
let data = vec![1.0, 2.0, 3.0, 4.0, 5.0];
let shape = (3, 3);

// From triplets (COO-like construction)
let array = CsrArray::from_triplets(&rows, &cols, &data, shape, false).unwrap();

// Or directly from CSR components
// let array = CsrArray::new(...);

Re-exports

pub use error::SparseError;

pub use error::SparseResult;

pub use sparray::is_sparse;

pub use sparray::SparseArray;

pub use sparray::SparseSum;

pub use sym_sparray::SymSparseArray;

pub use csr_array::CsrArray;

pub use csc_array::CscArray;

pub use coo_array::CooArray;

pub use dok_array::DokArray;

pub use lil_array::LilArray;

pub use dia_array::DiaArray;

pub use bsr_array::BsrArray;

pub use sym_csr::SymCsrArray;

pub use sym_csr::SymCsrMatrix;

pub use sym_coo::SymCooArray;

pub use sym_coo::SymCooMatrix;

pub use csr::CsrMatrix;

pub use csc::CscMatrix;

pub use coo::CooMatrix;

pub use dok::DokMatrix;

pub use lil::LilMatrix;

pub use dia::DiaMatrix;

pub use bsr::BsrMatrix;

pub use linalg::add;

pub use linalg::bicg;

pub use linalg::bicgstab;

pub use linalg::cg;

pub use linalg::diag_matrix;

pub use linalg::expm;

pub use linalg::expm_multiply;

pub use linalg::eye;

pub use linalg::gmres;

pub use linalg::inv;

pub use linalg::matmul;

pub use linalg::matrix_power;

pub use linalg::multiply;

pub use linalg::norm;

pub use linalg::onenormest;

pub use linalg::sparse_direct_solve;

pub use linalg::sparse_lstsq;

pub use linalg::spsolve;

pub use linalg::AsLinearOperator;

pub use linalg::BiCGOptions;

pub use linalg::BiCGSTABOptions;

pub use linalg::BiCGSTABResult;

pub use linalg::CGOptions;

pub use linalg::CGSOptions;

pub use linalg::CGSResult;

pub use linalg::DiagonalOperator;

pub use linalg::GMRESOptions;

pub use linalg::ILU0Preconditioner;

pub use linalg::IdentityOperator;

pub use linalg::IterationResult;

pub use linalg::JacobiPreconditioner;

pub use linalg::LinearOperator;

pub use linalg::SSORPreconditioner;

pub use linalg::ScaledIdentityOperator;

pub use combine::block_diag;

pub use combine::bmat;

pub use combine::hstack;

pub use combine::kron;

pub use combine::kronsum;

pub use combine::tril;

pub use combine::triu;

pub use combine::vstack;

pub use index_dtype::can_cast_safely;

pub use index_dtype::get_index_dtype;

pub use index_dtype::safely_cast_index_arrays;

pub use sym_ops::sym_coo_matvec;

pub use sym_ops::sym_csr_matvec;

pub use sym_ops::sym_csr_quadratic_form;

pub use sym_ops::sym_csr_rank1_update;

pub use sym_ops::sym_csr_trace;

Modules

bsr

Block Sparse Row (BSR) matrix format

bsr_array

combine

construct

construct_sym

Construction utilities for symmetric sparse matrices

convert

Conversion utilities for sparse matrices

coo

Coordinate (COO) matrix format

coo_array

csc

Compressed Sparse Column (CSC) matrix format

csc_array

csr

Compressed Sparse Row (CSR) matrix format

csr_array

dia

Diagonal (DIA) matrix format

dia_array

dok

Dictionary of Keys (DOK) matrix format

dok_array

error

Error types for the SciRS2 sparse module

index_dtype

lil

List of Lists (LIL) matrix format

lil_array

linalg

Linear algebra operations for sparse matrices

sparray

sym_coo

Symmetric Coordinate (SymCOO) module

sym_csr

Symmetric Compressed Sparse Row (SymCSR) module

sym_ops

sym_sparray

Symmetric Sparse Array trait

utils

Utility functions for sparse matrices

Structs

SparseEfficiencyWarning

SparseWarning

Functions

is_sparse_array

Check if an object is a sparse array

is_sparse_matrix

Check if an object is a sparse matrix (legacy API)

is_sym_sparse_array

Check if an object is a symmetric sparse array