Struct nalgebra::linalg::Cholesky

source ·
pub struct Cholesky<T: SimdComplexField, D: Dim>{ /* private fields */ }
Expand description

The Cholesky decomposition of a symmetric-definite-positive matrix.

Implementations§

source§

impl<T: SimdComplexField, D: Dim> Cholesky<T, D>

source

pub fn new_unchecked(matrix: OMatrix<T, D, D>) -> Self

Computes the Cholesky decomposition of matrix without checking that the matrix is definite-positive.

If the input matrix is not definite-positive, the decomposition may contain trash values (Inf, NaN, etc.)

source

pub fn pack_dirty(matrix: OMatrix<T, D, D>) -> Self

Uses the given matrix as-is without any checks or modifications as the Cholesky decomposition.

It is up to the user to ensure all invariants hold.

source

pub fn unpack(self) -> OMatrix<T, D, D>

Retrieves the lower-triangular factor of the Cholesky decomposition with its strictly upper-triangular part filled with zeros.

source

pub fn unpack_dirty(self) -> OMatrix<T, D, D>

Retrieves the lower-triangular factor of the Cholesky decomposition, without zeroing-out its strict upper-triangular part.

The values of the strict upper-triangular part are garbage and should be ignored by further computations.

source

pub fn l(&self) -> OMatrix<T, D, D>

Retrieves the lower-triangular factor of the Cholesky decomposition with its strictly uppen-triangular part filled with zeros.

source

pub fn l_dirty(&self) -> &OMatrix<T, D, D>

Retrieves the lower-triangular factor of the Cholesky decomposition, without zeroing-out its strict upper-triangular part.

This is an allocation-less version of self.l(). The values of the strict upper-triangular part are garbage and should be ignored by further computations.

source

pub fn solve_mut<R2: Dim, C2: Dim, S2>(&self, b: &mut Matrix<T, R2, C2, S2>)
where S2: StorageMut<T, R2, C2>, ShapeConstraint: SameNumberOfRows<R2, D>,

Solves the system self * x = b where self is the decomposed matrix and x the unknown.

The result is stored on b.

source

pub fn solve<R2: Dim, C2: Dim, S2>( &self, b: &Matrix<T, R2, C2, S2> ) -> OMatrix<T, R2, C2>
where S2: Storage<T, R2, C2>, DefaultAllocator: Allocator<R2, C2>, ShapeConstraint: SameNumberOfRows<R2, D>,

Returns the solution of the system self * x = b where self is the decomposed matrix and x the unknown.

source

pub fn inverse(&self) -> OMatrix<T, D, D>

Computes the inverse of the decomposed matrix.

source

pub fn determinant(&self) -> T::SimdRealField

Computes the determinant of the decomposed matrix.

source

pub fn ln_determinant(&self) -> T::SimdRealField

Computes the natural logarithm of determinant of the decomposed matrix.

This method is more robust than .determinant() to very small or very large determinants since it returns the natural logarithm of the determinant rather than the determinant itself.

source§

impl<T: ComplexField, D: Dim> Cholesky<T, D>

source

pub fn new(matrix: OMatrix<T, D, D>) -> Option<Self>

Attempts to compute the Cholesky decomposition of matrix.

Returns None if the input matrix is not definite-positive. The input matrix is assumed to be symmetric and only the lower-triangular part is read.

source

pub fn new_with_substitute( matrix: OMatrix<T, D, D>, substitute: T ) -> Option<Self>

Attempts to approximate the Cholesky decomposition of matrix by replacing non-positive values on the diagonals during the decomposition with the given substitute.

try_sqrt will be applied to the substitute when it has to be used.

If your input matrix results only in positive values on the diagonals during the decomposition, substitute is unused and the result is just the same as if you used new.

This method allows to compensate for matrices with very small or even negative values due to numerical errors but necessarily results in only an approximation: it is basically a hack. If you don’t specifically need Cholesky, it may be better to consider alternatives like the LU decomposition/factorization.

source

pub fn rank_one_update<R2: Dim, S2>( &mut self, x: &Vector<T, R2, S2>, sigma: T::RealField )

Given the Cholesky decomposition of a matrix M, a scalar sigma and a vector v, performs a rank one update such that we end up with the decomposition of M + sigma * (v * v.adjoint()).

source

pub fn insert_column<R2, S2>( &self, j: usize, col: Vector<T, R2, S2> ) -> Cholesky<T, DimSum<D, U1>>
where D: DimAdd<U1>, R2: Dim, S2: Storage<T, R2, U1>, DefaultAllocator: Allocator<DimSum<D, U1>, DimSum<D, U1>> + Allocator<R2>, ShapeConstraint: SameNumberOfRows<R2, DimSum<D, U1>>,

Updates the decomposition such that we get the decomposition of a matrix with the given column col in the jth position. Since the matrix is square, an identical row will be added in the jth row.

source

pub fn remove_column(&self, j: usize) -> Cholesky<T, DimDiff<D, U1>>

Updates the decomposition such that we get the decomposition of the factored matrix with its jth column removed. Since the matrix is square, the jth row will also be removed.

Trait Implementations§

source§

impl<T: Clone + SimdComplexField, D: Clone + Dim> Clone for Cholesky<T, D>

source§

fn clone(&self) -> Cholesky<T, D>

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

impl<T: Debug + SimdComplexField, D: Debug + Dim> Debug for Cholesky<T, D>

source§

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

Formats the value using the given formatter. Read more
source§

impl<T: SimdComplexField, D: Dim> Copy for Cholesky<T, D>
where DefaultAllocator: Allocator<D, D>, OMatrix<T, D, D>: Copy,

Auto Trait Implementations§

§

impl<T, D> !Freeze for Cholesky<T, D>

§

impl<T, D> !RefUnwindSafe for Cholesky<T, D>

§

impl<T, D> !Send for Cholesky<T, D>

§

impl<T, D> !Sync for Cholesky<T, D>

§

impl<T, D> !Unpin for Cholesky<T, D>

§

impl<T, D> !UnwindSafe for Cholesky<T, D>

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

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

Mutably borrows from an owned value. 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 T
where 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> Same for T

§

type Output = T

Should always be Self
source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
source§

impl<T> ToOwned for T
where 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 T
where 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 T
where 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.