Struct CooMatrix

pub struct CooMatrix<T> { /* private fields */ }

Coordinate (COO) matrix

A sparse matrix format that stores triplets (row, column, value), making it efficient for construction and modification.

Implementations

impl<T> CooMatrix<T>

where T: Clone + Copy + Zero + PartialEq,

pub fn get_triplets(&self) -> (Vec<usize>, Vec<usize>, Vec<T>)

Get the triplets (row indices, column indices, data)

pub fn new( data: Vec<T>, row_indices: Vec<usize>, col_indices: Vec<usize>, shape: (usize, usize), ) -> SparseResult<Self>

Create a new COO matrix from raw data

Arguments

• data - Vector of non-zero values
• row_indices - Vector of row indices for each non-zero value
• col_indices - Vector of column indices for each non-zero value
• shape - Tuple containing the matrix dimensions (rows, cols)

Returns

• A new COO matrix

Examples

use scirs2_sparse::coo::CooMatrix;

// Create a 3x3 sparse matrix with 5 non-zero elements
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 = CooMatrix::new(data, rows, cols, shape).unwrap();

pub fn empty(shape: (usize, usize)) -> Self

Create a new empty COO matrix

Arguments

• shape - Tuple containing the matrix dimensions (rows, cols)

Returns

• A new empty COO matrix

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

Add a value to the matrix at the specified position

Arguments

• row - Row index
• col - Column index
• value - Value to add

Returns

• Ok(()) if successful, Error otherwise

pub fn rows(&self) -> usize

Get the number of rows in the matrix

pub fn cols(&self) -> usize

Get the number of columns in the matrix

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

Get the shape (dimensions) of the matrix

pub fn nnz(&self) -> usize

Get the number of non-zero elements in the matrix

pub fn row_indices(&self) -> &[usize]

Get the row indices array

pub fn col_indices(&self) -> &[usize]

Get the column indices array

pub fn data(&self) -> &[T]

Get the data array

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

where T: Zero + Copy,

Convert to dense matrix (as Vec<Vec>)

pub fn to_csr(&self) -> CsrMatrix<T>

Convert to CSR format

pub fn to_csc(&self) -> CscMatrix<T>

Convert to CSC format

pub fn transpose(&self) -> Self

Transpose the matrix

pub fn sort_by_row_col(&mut self)

Sort the matrix elements by row, then column

pub fn sort_by_col_row(&mut self)

Sort the matrix elements by column, then row

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

where T: Zero,

Get the value at the specified position

pub fn sum_duplicates(&mut self)

where T: Add<Output = T>,

Sum duplicate entries (elements with the same row and column indices)

impl CooMatrix<f64>

pub fn dot(&self, vec: &[f64]) -> SparseResult<Vec<f64>>

Matrix-vector multiplication

Arguments

• vec - Vector to multiply with

Returns

• Result of matrix-vector multiplication