Struct CscMatrix 

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

Compressed Sparse Column (CSC) sparse matrix.

Stores non-zero entries in column-major order using three arrays: indptr (column pointer array of length n_cols + 1), indices (row indices of each non-zero), and data (values of each non-zero).

Type Parameter

T — the scalar element type.

Implementations

impl<T> CscMatrix<T>

where T: Clone,

pub fn new( n_rows: usize, n_cols: usize, indptr: Vec<usize>, indices: Vec<usize>, data: Vec<T>, ) -> Result<Self, FerroError>

Construct a CSC matrix from raw components.

Arguments

• n_rows — number of rows.
• n_cols — number of columns.
• indptr — column pointer array of length n_cols + 1.
• indices — row index of each non-zero entry.
• data — value of each non-zero entry.

Errors

Returns FerroError::InvalidParameter if the data is structurally invalid (wrong lengths, out-of-bound indices, unsorted inner indices).

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.

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

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

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

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

pub fn from_coo(coo: &CooMatrix<T>) -> Result<Self, FerroError>

where T: Clone + Add<Output = T> + 'static,

Construct a CscMatrix from a CooMatrix by converting to CSC.

Duplicate entries at the same position are summed.

Errors

This conversion is always successful for structurally valid inputs.

pub fn from_csr(csr: &CsrMatrix<T>) -> Result<Self, FerroError>

where T: Clone + Default + 'static,

Construct a CscMatrix from a CsrMatrix.

Errors

This conversion is always successful.

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

where T: Clone + Default + 'static,

Convert to CsrMatrix.

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

Convert to CooMatrix.

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

where T: Clone + Zero + 'static,

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

pub fn from_dense(dense: &ArrayView2<'_, T>, epsilon: T) -> Self

where T: Copy + Zero + PartialOrd + Signed + 'static,

Construct a CscMatrix from a dense Array2<T>, dropping entries whose absolute value is less than or equal to epsilon.

pub fn col_slice( &self, start: usize, end: usize, ) -> Result<CscMatrix<T>, FerroError>

where T: Clone + Default + 'static,

Return a new CSC matrix containing only the columns in start..end.

Errors

Returns FerroError::InvalidParameter if start > end or end > n_cols().

pub fn scale(&mut self, scalar: T)

where for<'r> T: MulAssign<&'r T>,

Scalar multiplication in-place: multiplies every non-zero by scalar.

Requires T: for<'r> MulAssign<&'r T>, which is satisfied by all primitive numeric types.

pub fn mul_scalar(&self, scalar: T) -> CscMatrix<T>

where T: Copy + Mul<Output = T> + Zero + 'static,

Scalar multiplication returning a new matrix.

pub fn add(&self, rhs: &CscMatrix<T>) -> Result<CscMatrix<T>, FerroError>

where T: Zero + Default + Clone + 'static, for<'r> &'r T: Add<&'r T, Output = T>,

Element-wise addition of two CSC matrices with the same shape.

Errors

Returns FerroError::ShapeMismatch if the matrices have different shapes.

pub fn mul_vec(&self, rhs: &Array1<T>) -> Result<Array1<T>, FerroError>

where T: Clone + Zero + 'static + AddAssign, for<'r> &'r T: Mul<Output = T>,

Sparse matrix-dense vector product: computes self * rhs.

Errors

Returns FerroError::ShapeMismatch if rhs.len() != n_cols().

Trait Implementations

impl<T: Clone> Clone for CscMatrix<T>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for CscMatrix<T>

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

Formats the value using the given formatter.