Struct CscMatrix 

pub struct CscMatrix { /* private fields */ }

A sparse matrix in compressed sparse column format.

Implementations

impl CscMatrix

pub fn ldl_symbolic(&self) -> Result<CscLdl, SparseError>

Builds the LDLᵀ factorization pattern symbolically for the fill-reducing ordering, requiring a structurally full diagonal; the values must be symmetric and are all zero until a refactorization supplies them.

impl CscMatrix

pub fn lu(&self) -> Result<CscLu, SparseError>

Factors PA = LU using the Gilbert-Peierls method with partial pivoting.

pub fn lu_amd(&self) -> Result<CscLu, SparseError>

Factors PAQ = LU using the Gilbert-Peierls method with partial pivoting, with a fill-reducing approximate minimum degree column ordering.

pub fn lu_symbolic(&self) -> Result<CscLu, SparseError>

Builds the factorization pattern symbolically for the fill-reducing ordering assuming pivots from a maximum transversal (the diagonal when it is structurally full), which is the exact fill pattern for a symmetric pattern and a superset otherwise; all values are zero until a refactorization supplies them.

impl CscMatrix

pub fn amd(&self) -> Vec<usize>

Fill-reducing ordering from approximate minimum degree on the pattern of A + Aᵀ.

impl CscMatrix

pub fn from_pattern( height: usize, width: usize, pattern: Vec<(usize, usize)>, ) -> Self

Builds the sparsity structure from a list of nonzero (row, column) positions, with all values initialized to zero.

pub fn fill(&mut self, source: impl FnMut(usize, usize) -> Scalar)

Fills the values from a source, summing duplicate positions in the pattern.

pub fn column(&self, j: usize) -> impl Iterator<Item = (usize, &Scalar)>

Iterates over the nonzero entries of a column as (row, value).

pub fn height(&self) -> usize

pub fn iter(&self) -> impl Iterator<Item = (usize, usize, &Scalar)>

Iterates over the nonzero entries as (row, column, value), in column-major order.

pub fn nonzeros(&self) -> usize

pub fn pattern(&self) -> &[(usize, usize)]

The nonzero (row, column) positions this structure was built from.

pub fn transpose(&self) -> Self

pub fn width(&self) -> usize

Trait Implementations

impl Clone for CscMatrix

fn clone(&self) -> CscMatrix

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CscMatrix

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

Formats the value using the given formatter.

impl Mul<&Vector> for &CscMatrix

type Output = Vector

The resulting type after applying the * operator.

fn mul(self, vector: &Vector) -> Self::Output

Performs the * operation.

impl PartialEq for CscMatrix

fn eq(&self, other: &CscMatrix) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CscMatrix