Struct CooMatrix

Source

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

Expand description

Sparse matrix in COO (coordinate / triplet) format.

Stores (row, col, value) triplets. Duplicate entries are summed during conversion to CSR/CSC.

§Examples

let mut coo = CooMatrix::<f64>::new(3, 3);
coo.push(0, 0, 1.0).unwrap();
coo.push(1, 1, 2.0).unwrap();
assert_eq!(coo.nnz(), 2);

Implementations§

Source §

impl<T: Scalar> CooMatrix<T>

Source

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

Create an empty COO matrix with the given dimensions.

§Examples

let coo = CooMatrix::<f64>::new(3, 3);
assert_eq!(coo.nnz(), 0);
assert_eq!(coo.shape(), (3, 3));

Source

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

Build a COO matrix from triplet arrays.

§Examples

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

Source

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

Append a single entry.

§Examples

let mut coo = CooMatrix::<f64>::new(2, 2);
coo.push(0, 1, 3.5).unwrap();
assert_eq!(coo.nnz(), 1);

Source

pub fn nrows(&self) -> usize

Number of rows.

Source

pub fn ncols(&self) -> usize

Number of columns.

Source

pub fn nnz(&self) -> usize

Number of stored entries (may include duplicates).

Source

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

Shape as (nrows, ncols).

Source

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

Convert to a dense 2-D tensor. Duplicate entries are summed.

§Examples

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

Source

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

Convert to CSR format. Duplicate entries at the same position are summed.

§Examples

let coo = CooMatrix::from_triplets(
    2, 2,
    vec![0, 1], vec![0, 1], vec![1.0, 2.0],
).unwrap();
let csr = coo.to_csr();
assert_eq!(csr.nnz(), 2);

Source

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

Convert to CSC format. Duplicate entries at the same position are summed.

§Examples

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