Struct SparseMatrix 

pub struct SparseMatrix {
    pub dimension: usize,
    /* private fields */
}

Wrapper around a BTreeMap to store square-symmetric matrices in a sparse data structure

Fields

dimension: usize

Size of the square matrix

Implementations

impl SparseMatrix

pub fn new(dimension: usize) -> Self

pub fn num_entries(&self) -> usize

pub fn insert(&mut self, [row_idx, col_idx]: [usize; 2], value: f64)

Insert a value into the matrix. Assumes symmetry: row/col order does not matter.

pub fn insert_group(&mut self, entry_group: Vec<([usize; 2], f64)>)

Insert a group of entries

pub fn consume_matrix(&mut self, other: &mut Self)

Consume the entries from another sparse matrix leaving it empty.

pub fn iter_upper_tri(&self) -> impl Iterator<Item = ([usize; 2], f64)> + '_

Iterate over the upper triangle of the matrix.

pub fn write_to_petsc_binary_format(&self, path: impl AsRef<str>) -> Result<()>

Trait Implementations

impl Clone for SparseMatrix

fn clone(&self) -> SparseMatrix

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl From<SparseMatrix> for DMatrix<f64>

fn from(sm: SparseMatrix) -> Self

Converts to this type from the input type.

impl From<SparseMatrix> for AIJMatrixBinary

fn from(sm: SparseMatrix) -> Self

Converts to this type from the input type.