Struct DokMatrix

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

Dictionary of Keys (DOK) matrix

A sparse matrix format that stores elements in a dictionary (hash map), making it efficient for incremental construction.

Implementations

impl<T> DokMatrix<T>

where T: Clone + Copy + Zero + PartialEq,

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

Create a new DOK matrix

Arguments

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

Returns

• A new empty DOK matrix

Examples

use scirs2_sparse::dok::DokMatrix;

// Create a 3x3 sparse matrix
let mut matrix = DokMatrix::<f64>::new((3, 3));

// Set some values
matrix.set(0, 0, 1.0);
matrix.set(0, 2, 2.0);
matrix.set(1, 2, 3.0);
matrix.set(2, 0, 4.0);
matrix.set(2, 1, 5.0);

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

Set a value in the matrix

Arguments

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

Returns

• Ok(()) if successful, Error otherwise

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

Get a value from the matrix

Arguments

• row - Row index
• col - Column index

Returns

• Value at the specified position, or zero if not set

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 to_dense(&self) -> Vec<Vec<T>>

where T: Zero + Copy,

Convert to dense matrix (as Vec<Vec>)

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

Convert to COO representation

Returns

• Tuple of (data, row_indices, col_indices)