pub struct SymbolicCholesky<I> { /* private fields */ }Expand description
The symbolic structure of a sparse Cholesky decomposition.
Implementations§
Source§impl<I: Index> SymbolicCholesky<I>
impl<I: Index> SymbolicCholesky<I>
Sourcepub fn raw(&self) -> &SymbolicCholeskyRaw<I>
pub fn raw(&self) -> &SymbolicCholeskyRaw<I>
Returns the inner type of the factorization, either simplicial or symbolic.
Sourcepub fn perm(&self) -> PermutationRef<'_, I, Symbolic>
pub fn perm(&self) -> PermutationRef<'_, I, Symbolic>
Returns the permutation that was computed during symbolic analysis.
Sourcepub fn len_values(&self) -> usize
pub fn len_values(&self) -> usize
Returns the length of the slice needed to store the numerical values of the Cholesky decomposition.
Sourcepub fn factorize_numeric_llt_req<E: Entity>(
&self,
parallelism: Parallelism,
) -> Result<StackReq, SizeOverflow>
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.
Sourcepub fn factorize_numeric_ldlt_req<E: Entity>(
&self,
with_regularization_signs: bool,
parallelism: Parallelism,
) -> Result<StackReq, SizeOverflow>
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.
Sourcepub fn factorize_numeric_intranode_bunch_kaufman_req<E: Entity>(
&self,
with_regularization_signs: bool,
parallelism: Parallelism,
) -> Result<StackReq, SizeOverflow>
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.
Sourcepub 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>
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.
Sourcepub 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>
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.
Sourcepub 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>
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.
Sourcepub fn solve_in_place_req<E: Entity>(
&self,
rhs_ncols: usize,
) -> Result<StackReq, SizeOverflow>
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§
Auto Trait Implementations§
impl<I> Freeze for SymbolicCholesky<I>
impl<I> RefUnwindSafe for SymbolicCholesky<I>where
I: RefUnwindSafe,
impl<I> Send for SymbolicCholesky<I>where
I: Send,
impl<I> Sync for SymbolicCholesky<I>where
I: Sync,
impl<I> Unpin for SymbolicCholesky<I>where
I: Unpin,
impl<I> UnwindSafe for SymbolicCholesky<I>where
I: UnwindSafe,
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more