Struct SymbolicCholesky 

pub struct SymbolicCholesky<I> { /* private fields */ }

the symbolic structure of a sparse cholesky decomposition

Implementations

impl<I: Index> SymbolicCholesky<I>

pub fn nrows(&self) -> usize

returns the number of rows of the matrix

pub fn ncols(&self) -> usize

returns the number of columns of the matrix

pub fn raw(&self) -> &SymbolicCholeskyRaw<I>

returns the inner type of the factorization, either simplicial or symbolic

pub fn perm(&self) -> Option<PermRef<'_, I>>

returns the permutation that was computed during symbolic analysis

pub fn len_val(&self) -> usize

returns the length of the slice needed to store the numerical values of the cholesky decomposition

pub fn factorize_numeric_llt_scratch<T: ComplexField>( &self, par: Par, params: Spec<LltParams, T>, ) -> StackReq

computes the required workspace size and alignment for a numerical $LL^H$ factorization

pub fn factorize_numeric_ldlt_scratch<T: ComplexField>( &self, par: Par, params: Spec<LdltParams, T>, ) -> StackReq

computes the required workspace size and alignment for a numerical $LDL^H$ factorization

pub fn factorize_numeric_intranode_lblt_scratch<T: ComplexField>( &self, par: Par, params: Spec<LbltParams, T>, ) -> StackReq

computes the required workspace size and alignment for a numerical intranodal $LBL^\top$ factorization

pub fn factorize_numeric_llt<'out, T: ComplexField>( &'out self, L_values: &'out mut [T], A: SparseColMatRef<'_, I, T>, side: Side, regularization: LltRegularization<T::Real>, par: Par, stack: &mut MemStack, params: Spec<LltParams, T>, ) -> Result<LltRef<'out, I, T>, LltError>

computes a numerical llt factorization of a, or returns a LltError if the matrix is not numerically positive definite

pub fn factorize_numeric_ldlt<'out, T: ComplexField>( &'out self, L_values: &'out mut [T], A: SparseColMatRef<'_, I, T>, side: Side, regularization: LdltRegularization<'_, T::Real>, par: Par, stack: &mut MemStack, params: Spec<LdltParams, T>, ) -> Result<LdltRef<'out, I, T>, LdltError>

computes a numerical $LDL^H$ factorization of a

pub fn factorize_numeric_intranode_lblt<'out, T: ComplexField>( &'out self, L_values: &'out mut [T], subdiag: &'out mut [T], perm_forward: &'out mut [I], perm_inverse: &'out mut [I], A: SparseColMatRef<'_, I, T>, side: Side, par: Par, stack: &mut MemStack, params: Spec<LbltParams, T>, ) -> IntranodeLbltRef<'out, I, T>

computes a numerical intranodal $LBL^\top$ factorization of a

pub fn solve_in_place_scratch<T: ComplexField>( &self, rhs_ncols: usize, par: Par, ) -> StackReq

computes the required workspace size and alignment for a dense solve in place using an $LL^H$, $LDL^H$ or intranodal $LBL^\top$ factorization

Trait Implementations

impl<I: Debug> Debug for SymbolicCholesky<I>

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

Formats the value using the given formatter.