Struct faer_sparse::cholesky::LltRef

pub struct LltRef<'a, I: Index, E: Entity> { /* private fields */ }

Sparse LLT factorization wrapper.

Implementations

impl<'a, I: Index, E: Entity> LltRef<'a, I, E>

pub fn new( symbolic: &'a SymbolicCholesky<I>, values: GroupFor<E, &'a [E::Unit]> ) -> Self

pub fn symbolic(self) -> &'a SymbolicCholesky<I>

pub fn solve_in_place_with_conj( &self, conj: Conj, rhs: MatMut<'_, E>, parallelism: Parallelism, stack: PodStack<'_> )

where E: ComplexField,

Methods from Deref<Target = 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) -> PermutationRef<'_, I, Symbolic>

Returns the permutation that was computed during symbolic analysis.

pub fn len_values(&self) -> usize

Returns the length of the slice needed to store the numerical values of the Cholesky decomposition.

pub fn factorize_numeric_llt_req<E: Entity>( &self, parallelism: Parallelism ) -> Result<StackReq, SizeOverflow>

Computes the required workspace size and alignment for a numerical LLT factorization.

pub fn factorize_numeric_ldlt_req<E: Entity>( &self, with_regularization_signs: bool, parallelism: Parallelism ) -> Result<StackReq, SizeOverflow>

Computes the required workspace size and alignment for a numerical LDLT factorization.

pub fn factorize_numeric_intranode_bunch_kaufman_req<E: Entity>( &self, with_regularization_signs: bool, parallelism: Parallelism ) -> Result<StackReq, SizeOverflow>

Computes the required workspace size and alignment for a numerical intranodal Bunch-Kaufman factorization.

pub fn factorize_numeric_llt<'out, E: ComplexField>( &'out self, L_values: GroupFor<E, &'out mut [E::Unit]>, A: SparseColMatRef<'_, I, E>, side: Side, regularization: LltRegularization<E>, parallelism: Parallelism, stack: PodStack<'_> ) -> Result<LltRef<'out, I, E>, CholeskyError>

Computes a numerical LLT factorization of A, or returns a CholeskyError if the matrix is not numerically positive definite.

pub fn factorize_numeric_ldlt<'out, E: ComplexField>( &'out self, L_values: GroupFor<E, &'out mut [E::Unit]>, A: SparseColMatRef<'_, I, E>, side: Side, regularization: LdltRegularization<'_, E>, parallelism: Parallelism, stack: PodStack<'_> ) -> LdltRef<'out, I, E>

Computes a numerical LDLT factorization of A.

pub fn factorize_numeric_intranode_bunch_kaufman<'out, E: ComplexField>( &'out self, L_values: GroupFor<E, &'out mut [E::Unit]>, subdiag: GroupFor<E, &'out mut [E::Unit]>, perm_forward: &'out mut [I], perm_inverse: &'out mut [I], A: SparseColMatRef<'_, I, E>, side: Side, regularization: LdltRegularization<'_, E>, parallelism: Parallelism, stack: PodStack<'_> ) -> IntranodeBunchKaufmanRef<'out, I, E>

Computes a numerical intranodal Bunch-Kaufman factorization of A.

pub fn solve_in_place_req<E: Entity>( &self, rhs_ncols: usize ) -> Result<StackReq, SizeOverflow>

Computes the required workspace size and alignment for a dense solve in place using an LLT, LDLT or intranodal Bunch-Kaufman factorization.

Trait Implementations

impl<'a, I: Index, E: Entity> Clone for LltRef<'a, I, E>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, I: Debug + Index, E: Debug + Entity> Debug for LltRef<'a, I, E>

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

Formats the value using the given formatter.

impl<'a, I: Index, E: Entity> Deref for LltRef<'a, I, E>

type Target = SymbolicCholesky<I>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'a, I: Index, E: Entity> Copy for LltRef<'a, I, E>