# Struct extendr_api::prelude::sparse::linalg::cholesky::LdltRef

pub struct LdltRef<'a, I, E>where
I: Index,
E: Entity,{
symbolic: &'a SymbolicCholesky<I>,
values: SliceGroup<'a, E>,
}
Expand description

Sparse LDLT factorization wrapper.

## Fields§

§symbolic: &'a SymbolicCholesky<I>§values: SliceGroup<'a, E>

## Implementations§

§

### impl<'a, I, E> LdltRef<'a, I, E>where I: Index, E: Entity,

#### pub fn new( symbolic: &'a SymbolicCholesky<I>, values: <<E as Entity>::Group as ForType>::FaerOf<&'a [<E as Entity>::Unit]>, ) -> LdltRef<'a, I, E>

Creates new Cholesky LDLT factors from the symbolic part and numerical values.

##### §Panics
• Panics if values.len() != symbolic.len_values().

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

Returns the symbolic part of the Cholesky factor.

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

Solves the equation $\text{Op}(A) x = \text{rhs}$ and stores the result in rhs, where $\text{Op}$ is either the identity or the conjugate, depending on the value of conj.

##### §Panics

Panics if rhs.nrows() != self.symbolic().nrows().

## 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) -> Option<PermRef<'_, I>>

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>( &self, parallelism: Parallelism<'_>, ) -> Result<StackReq, SizeOverflow>where E: Entity,

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

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

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

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

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

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

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>( &'out self, L_values: <<E as Entity>::Group as ForType>::FaerOf<&'out mut [<E as Entity>::Unit]>, A: SparseColMatRef<'_, I, E>, side: Side, regularization: LdltRegularization<'_, E>, parallelism: Parallelism<'_>, stack: PodStack<'_>, ) -> LdltRef<'out, I, E>where E: ComplexField,

Computes a numerical LDLT factorization of A.

#### pub fn factorize_numeric_intranode_bunch_kaufman<'out, E>( &'out self, L_values: <<E as Entity>::Group as ForType>::FaerOf<&'out mut [<E as Entity>::Unit]>, subdiag: <<E as Entity>::Group as ForType>::FaerOf<&'out mut [<E as Entity>::Unit]>, perm_forward: &'out mut [I], perm_inverse: &'out mut [I], A: SparseColMatRef<'_, I, E>, side: Side, regularization: BunchKaufmanRegularization<'_, E>, parallelism: Parallelism<'_>, stack: PodStack<'_>, ) -> IntranodeBunchKaufmanRef<'out, I, E>where E: ComplexField,

Computes a numerical intranodal Bunch-Kaufman factorization of A.

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

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, E> Clone for LdltRef<'a, I, E>where I: Index, E: Entity,

§

#### fn clone(&self) -> LdltRef<'a, I, E>

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
§

### impl<'a, I, E> Debug for LdltRef<'a, I, E>where I: Debug + Index, E: Debug + Entity,

§

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

Formats the value using the given formatter. Read more
§

### impl<'a, I, E> Deref for LdltRef<'a, I, E>where I: Index, E: Entity,

§

#### type Target = SymbolicCholesky<I>

The resulting type after dereferencing.
§

#### fn deref(&self) -> &<LdltRef<'a, I, E> as Deref>::Target

Dereferences the value.
§

§

§

§

§

§

§

## Blanket Implementations§

source§

### impl<T> Any for Twhere T: 'static + ?Sized,

source§

#### fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

### impl<T> Borrow<T> for Twhere T: ?Sized,

source§

#### fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

### impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

#### fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

### impl<T> CloneToUninit for Twhere T: Clone,

source§

#### default unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

### impl<T> CloneToUninit for Twhere T: Copy,

source§

#### unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

### impl<T> From<T> for T

source§

#### fn from(t: T) -> T

Returns the argument unchanged.

source§

### impl<T, U> Into<U> for Twhere U: From<T>,

source§

#### fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

### impl<T> IntoEither for T

source§

#### fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts 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 more
source§

#### fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘwhere F: FnOnce(&Self) -> bool,

Converts 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
§

### impl<T> Pointable for T

§

#### const ALIGN: usize = _

The alignment of pointer.
§

#### type Init = T

The type for initializers.
§

#### unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

#### unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

#### unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

#### unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

### impl<T> ToOwned for Twhere T: Clone,

§

#### type Owned = T

The resulting type after obtaining ownership.
source§

#### fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

#### fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

### impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

#### type Error = Infallible

The type returned in the event of a conversion error.
source§

#### fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

### impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

#### type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

#### fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.