Struct ohsl::matrix::Sparse

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

Implementations

impl<T: Clone + Number> Sparse<T>

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

Create a new sparse matrix where all values are zero

pub fn new(
    rows: usize,
    cols: usize,
    mut triplets: &mut Vector<Triplet<T>>
) -> Self

Create a new sparse matrix from a Vector of Triplets

pub fn rows(&self) -> usize

Return the number of rows in the sparse matrix

pub fn cols(&self) -> usize

Return the number of columns in the sparse matrix

pub fn nonzero(&self) -> usize

Return the number of nonzero values

pub fn val(&self) -> Vector<T>

Return the Vector of nonzero values

pub fn row_index(&self) -> Vector<usize>

Return the vector of row indices

pub fn col_start(&self) -> Vector<usize>

Return the vector of pointers to start of columns

pub fn scale(&mut self, scalar: T)

Scale the Sparse matrix by a constant factor

pub fn multiply(&self, x: &Vector<T>) -> Vector<T>

Multiply the Sparse matrix by a Vector to the right

pub fn transpose_multiply(&self, x: &Vector<T>) -> Vector<T>

Multiply the transpose of the Sparse matrix by a Vector to the right

pub fn col_index(&self) -> Vector<usize>

Return a Vector of column indices relating to each value (triplet form)

pub fn insert(&mut self, row: usize, col: usize, value: T)

Insert a nonzero element into the SparseMatrix

impl Sparse<f64>

pub fn solve_bicg(
    &self,
    b: Vec64,
    guess: Vec64,
    max_iter: usize,
    tol: f64
) -> Vec64

Solve the system of equations Ax=b using the biconjugate gradient method

pub fn solve_bicgstab(
    &self,
    b: Vec64,
    guess: Vec64,
    max_iter: usize,
    tol: f64
) -> Vec64

Solve the system of equations Ax=b using the stabilised biconjugate gradient method