Struct sparse::DokMat

pub struct DokMat<T> { /* fields omitted */ }

Dictionary Of Keys (DOK) format sparse matrix.

Implementations

impl<T> DokMat<T>

pub fn new(rows: usize, cols: usize) -> Self

Creates a dictionnary of keys format sparse matrix with specified shape (rows, cols).

pub fn rows(&self) -> usize

Returns the number of rows of the matrix.

pub fn cols(&self) -> usize

Returns the number of cols of the matrix.

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

Returns the shape of the matrix.

pub fn insert(&mut self, row: usize, col: usize, val: T) -> Option<T>

Inserts an entry in the matrix.

Returns Some(old_value) if (row, col) indices were present in the matrix, None otherwise.

pub fn remove(&mut self, row: usize, col: usize) -> Option<T>

Removes an entry from the matrix.

Returns Some(value) if (row, col) indices were present in the matrix, None otherwise.

pub fn contains(&self, row: usize, col: usize) -> bool

Returns true if the matrix contains an entry at (row, col) indices.

pub fn clear(&mut self)

Clears the matrix.

pub fn len(&self) -> usize

Returns the number of entries in the matrix.

pub fn is_empty(&self) -> bool

Returns true if the matrix contains no entry.

pub fn entries(&self) -> impl Iterator<Item = (&(usize, usize), &T)>

An iterator visiting all entries of the matrix.

Trait Implementations

impl<T: Clone> Clone for DokMat<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for DokMat<T>

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

Formats the value using the given formatter.