Struct CscMatrix 

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

Sparse matrix in CSC (Compressed Sparse Column) format.

Examples

let csc = CscMatrix::from_triplets(
    2, 2,
    vec![0, 1], vec![0, 1], vec![1.0, 2.0],
).unwrap();
assert_eq!(csc.nnz(), 2);

Implementations

impl<T: Scalar> CscMatrix<T>

pub fn new(nrows: usize, ncols: usize) -> Self

Create an empty CSC matrix.

Examples

let csc = CscMatrix::<f64>::new(3, 3);
assert_eq!(csc.nnz(), 0);

pub fn from_triplets( nrows: usize, ncols: usize, rows: Vec<usize>, cols: Vec<usize>, values: Vec<T>, ) -> Result<Self>

Build CSC from triplet data.

Examples

let csc = CscMatrix::from_triplets(
    2, 2,
    vec![0, 1], vec![0, 1], vec![1.0, 2.0],
).unwrap();
assert_eq!(csc.nnz(), 2);

pub fn nrows(&self) -> usize

Number of rows.

pub fn ncols(&self) -> usize

Number of columns.

pub fn nnz(&self) -> usize

Number of stored non-zero entries.

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

Shape as (nrows, ncols).

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

Convert to a dense 2-D tensor.

Examples

let csc = CscMatrix::from_triplets(
    2, 2, vec![0, 1], vec![0, 1], vec![1.0, 2.0],
).unwrap();
let dense = csc.to_dense();
assert_eq!(dense.as_slice(), &[1.0, 0.0, 0.0, 2.0]);

pub fn matvec(&self, x: &Tensor<T>) -> Result<Tensor<T>>

Sparse matrix × dense vector multiplication.

x must be a 1-D tensor of length ncols.

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

Transpose, returning a CSR matrix.

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

Convert to COO format.

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

Convert to CSR format.

Trait Implementations

impl<T: Clone + Scalar> 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 + Scalar> Debug for CscMatrix<T>

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

Formats the value using the given formatter.