Struct sprs_suitesparse_ldl::LdlSymbolic

pub struct LdlSymbolic { /* private fields */ }

Structure holding the symbolic ldlt decomposition computed by suitesparse’s ldl

Implementations

impl LdlSymbolic

pub fn new<N, I>(mat: CsMatViewI<'_, N, I>) -> LdlSymbolic where
    N: Clone + Into<f64>,
    I: SpIndex, 

Compute the symbolic LDLT decomposition of the given matrix.

Panics

• if the matrix is not symmetric

pub fn new_perm<N, I>(
    mat: CsMatViewI<'_, N, I>,
    perm: PermOwnedI<I>,
    check_perm: PermutationCheck
) -> LdlSymbolic where
    N: Clone + Into<f64>,
    I: SpIndex, 

Compute the symbolic decomposition L D L^T = P A P^T where P is a permutation matrix.

Using a good permutation matrix can reduce the non-zero count in L, thus making the decomposition and the solves faster.

Panics

• if mat is not symmetric
• if perm does not represent a valid permutation

pub fn problem_size(&self) -> usize

The size of the linear system associated with this decomposition

pub fn nnz(&self) -> usize

The number of non-zero entries in L

pub fn factor<N, I>(
    self,
    mat: CsMatViewI<'_, N, I>
) -> Result<LdlNumeric, LinalgError> where
    N: Clone + Into<f64>,
    I: SpIndex, 

Factor a matrix, assuming it shares the same nonzero pattern as the matrix this factorization was built from.

Panics

If the matrix is not symmetric.

Trait Implementations

impl Clone for LdlSymbolic

fn clone(&self) -> LdlSymbolic

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for LdlSymbolic

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

Formats the value using the given formatter.