Struct CooMatrix 

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

Coordinate-format (COO / triplet) sparse matrix.

Stores non-zero entries as (row, col, value) triplets. Duplicate entries at the same position are summed during conversion to CSR/CSC. This format is most convenient for construction; prefer CsrMatrix or CscMatrix for arithmetic.

Type Parameter

T — the scalar type stored in the matrix. No additional bounds are required for construction; conversion methods impose their own bounds.

Implementations

impl<T> CooMatrix<T>

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

Create an empty COO matrix with the given shape.

Arguments

• n_rows — number of rows.
• n_cols — number of columns.

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

Create a COO matrix with the given shape and pre-allocated capacity.

Arguments

• n_rows — number of rows.
• n_cols — number of columns.
• capacity — expected number of non-zero entries.

pub fn from_triplets( n_rows: usize, n_cols: usize, row_inds: Vec<usize>, col_inds: Vec<usize>, data: Vec<T>, ) -> Result<Self, FerroError>

Build a CooMatrix from raw triplet components.

All three slices must have the same length. Row indices must be less than n_rows; column indices must be less than n_cols.

Errors

Returns FerroError::InvalidParameter if the slice lengths differ or if any index is out of bounds.

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

Append a single non-zero entry (row, col, value).

Errors

Returns FerroError::InvalidParameter if row >= n_rows() or col >= n_cols().

pub fn n_rows(&self) -> usize

Returns the number of rows.

pub fn n_cols(&self) -> usize

Returns the number of columns.

pub fn nnz(&self) -> usize

Returns the number of stored non-zero entries (counting duplicates).

pub fn inner(&self) -> &TriMat<T>

Returns a reference to the underlying sprs::TriMat<T>.

pub fn into_inner(self) -> TriMat<T>

Consume this matrix and return the underlying sprs::TriMat<T>.

impl<T> CooMatrix<T>

where T: Clone + Zero + NumAssign + 'static,

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

Convert this COO matrix to a dense Array2<T>.

Duplicate entries at the same position are summed.

Trait Implementations

impl<T: Clone> Clone for CooMatrix<T>

fn clone(&self) -> Self

Clone by rebuilding the inner sprs::TriMat from raw components.

sprs::TriMat does not implement Clone generically, so we reconstruct it from the stored row indices, column indices, and data.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for CooMatrix<T>

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

Formats the value using the given formatter.