Struct sprs_ldl::LdlNumeric

pub struct LdlNumeric<N, I> { /* fields omitted */ }

Structure to hold a numeric LDLT decomposition

Implementations

impl<N, I: SpIndex> LdlNumeric<N, I>

pub fn new(mat: CsMatViewI<N, I>) -> Result<Self, SprsError> where
    N: Copy + Num + PartialOrd, 

Compute the numeric LDLT decomposition of the given matrix.

Panics

• if mat is not symmetric

pub fn new_perm(
    mat: CsMatViewI<N, I>,
    perm: PermOwnedI<I>,
    check_symmetry: SymmetryCheck
) -> Result<Self, SprsError> where
    N: Copy + Num + PartialOrd, 

Compute the numeric decomposition L D L^T = P^T A P 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

pub fn update(&mut self, mat: CsMatViewI<N, I>) -> Result<(), SprsError> where
    N: Copy + Num + PartialOrd, 

Update the decomposition with the given matrix. The matrix must have the same non-zero pattern as the original matrix, otherwise the result is unspecified.

pub fn solve<'a, V>(&self, rhs: &V) -> Vec<N> where
    N: 'a + Copy + Num,
    V: Deref<Target = [N]>, 

Solve the system A x = rhs

pub fn d(&self) -> &[N]

The diagonal factor D of the LDL^T decomposition

pub fn l(&self) -> CsMatViewI<N, I>

The L factor of the LDL^T decomposition

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

Trait Implementations

impl<N: Clone, I: Clone> Clone for LdlNumeric<N, I>

fn clone(&self) -> LdlNumeric<N, I>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<N: Debug, I: Debug> Debug for LdlNumeric<N, I>

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

Formats the value using the given formatter.