Struct finiteelement::Sparse

pub struct Sparse<F: Float> { /* fields omitted */ }

A data structure to represent sparse matrix.

A sparse matrix is represented as a Vec of rows, where each row is a HashMap whose keys space is the set of columns. If a key does not exist in the HashMap but is smaller that the number of column the corresponding value is 0. Attempt to access an out of bound value result in a panic.

Example

extern crate finiteelement;
use finiteelement::Sparse;
let mut sprs = Sparse::new(3, 3);
sprs[1][2] = 3.;
assert_eq!(sprs[1][2], 3.);
assert_eq!(sprs[2][2], 0.);
let access_out_of_bound = std::panic::catch_unwind(|| sprs[1][3]);
assert!(access_out_of_bound.is_err());

Methods

impl<A: Float + Clone> Sparse<A>

pub fn nb_columns(&self) -> usize

Returns the number of column of self.

pub fn nb_rows(&self) -> usize

Returns the number of rows of self.

pub fn mul_vec0(&self, x: &Vec<A>, y: &mut Vec<A>)

perform y <- y + self*x where * is a matrix/vector product

pub fn mul_vec1(&self, x: &mut Vec<A>, y: &Vec<A>)

perform x <- x + self^T * y where self^T is the transpose of self and * is a matrix/vector prouct

pub fn new(nb_rows: usize, nb_columns: usize) -> Self

Returns a nb_rows x nb_columns Sparse full of zeroes.

pub fn reset(&mut self)

Set self to the null matrix, preserve the dimension.

pub fn pretty_print(&self) -> String

Returns a String representing self.

Trait Implementations

impl<A: Clone + Float> Display for Sparse<A>

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

Formats the value using the given formatter.

impl<A: Float> Index<usize> for Sparse<A>

type Output = SparseVec<A>

The returned type after indexing.

fn index(&self, row: usize) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<A: Float> Index<(usize, usize)> for Sparse<A>

type Output = A

The returned type after indexing.

fn index(&self, (row, col): (usize, usize)) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<A: Float> IndexMut<usize> for Sparse<A>

fn index_mut(&mut self, row: usize) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl<A: Float> IndexMut<(usize, usize)> for Sparse<A>

fn index_mut(&mut self, (row, col): (usize, usize)) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.