[][src]Struct nalgebra::linalg::Cholesky

pub struct Cholesky<N: ComplexField, D: Dim> where
    DefaultAllocator: Allocator<N, D, D>, 
{ /* fields omitted */ }

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

Methods

impl<N: ComplexField, D: DimSub<Dynamic>> Cholesky<N, D> where
    DefaultAllocator: Allocator<N, D, D>, 
[src]

pub fn new(matrix: MatrixN<N, D>) -> Option<Self>[src]

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.

pub fn unpack(self) -> MatrixN<N, D>[src]

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

pub fn unpack_dirty(self) -> MatrixN<N, D>[src]

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.

pub fn l(&self) -> MatrixN<N, D>[src]

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

pub fn l_dirty(&self) -> &MatrixN<N, D>[src]

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.

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

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

The result is stored on b.

pub fn solve<R2: Dim, C2: Dim, S2>(
    &self,
    b: &Matrix<N, R2, C2, S2>
) -> MatrixMN<N, R2, C2> where
    S2: StorageMut<N, R2, C2>,
    DefaultAllocator: Allocator<N, R2, C2>,
    ShapeConstraint: SameNumberOfRows<R2, D>, 
[src]

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

pub fn inverse(&self) -> MatrixN<N, D>[src]

Computes the inverse of the decomposed matrix.

Trait Implementations

impl<N: ComplexField, D: Dim> Copy for Cholesky<N, D> where
    DefaultAllocator: Allocator<N, D, D>,
    MatrixN<N, D>: Copy
[src]

impl<N: Clone + ComplexField, D: Clone + Dim> Clone for Cholesky<N, D> where
    DefaultAllocator: Allocator<N, D, D>, 
[src]

fn clone_from(&mut self, source: &Self)1.0.0[src]

Performs copy-assignment from source. Read more

impl<N: Debug + ComplexField, D: Debug + Dim> Debug for Cholesky<N, D> where
    DefaultAllocator: Allocator<N, D, D>, 
[src]

impl<N: ComplexField, D: Dim> Serialize for Cholesky<N, D> where
    DefaultAllocator: Allocator<N, D, D>,
    DefaultAllocator: Allocator<N, D>,
    MatrixN<N, D>: Serialize
[src]

impl<'de, N: ComplexField, D: Dim> Deserialize<'de> for Cholesky<N, D> where
    DefaultAllocator: Allocator<N, D, D>,
    DefaultAllocator: Allocator<N, D>,
    MatrixN<N, D>: Deserialize<'de>, 
[src]

Auto Trait Implementations

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

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

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

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

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

Blanket Implementations

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

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

The type returned in the event of a conversion error.

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Same<T> for T[src]

type Output = T

Should always be Self

impl<SS, SP> SupersetOf<SS> for SP where
    SS: SubsetOf<SP>, 
[src]