# [−][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: Clone + ComplexField, D: Clone + Dim> Clone for Cholesky<N, D> where
DefaultAllocator: Allocator<N, D, D>,` [src]

#### `fn clone(&self) -> Cholesky<N, D>`[src]

Returns a copy of the value. Read more

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

Performs copy-assignment from `source`. Read more

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

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

#### `fn fmt(&self, f: &mut Formatter) -> Result`[src]

Formats the value using the given formatter. Read more

## Auto Trait Implementations

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

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

### `impl<N, D> !Sync 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.

#### `fn to_owned(&self) -> T`[src]

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

#### `fn clone_into(&self, target: &mut T)`[src]

🔬 This is a nightly-only experimental API. (`toowned_clone_into`)

recently added

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

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

#### `fn into(self) -> U`[src]

Performs the conversion.

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

#### `fn from(t: T) -> T`[src]

Performs the conversion.

### `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.

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

Performs the conversion.

### `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.

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

Performs the conversion.

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

#### `fn borrow_mut(&mut self) -> &mut T`[src]

Mutably borrows from an owned value. Read more

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

#### `fn borrow(&self) -> &T`[src]

Immutably borrows from an owned value. Read more

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

#### `fn type_id(&self) -> TypeId`[src]

Gets the `TypeId` of `self`. Read more

### `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]

#### `fn to_subset(&self) -> Option<SS>`[src]

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

#### `fn is_in_subset(&self) -> bool`[src]

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

#### `unsafe fn to_subset_unchecked(&self) -> SS`[src]

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

#### `fn from_subset(element: &SS) -> SP`[src]

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

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g., `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g., `vec -> usize` or `* -> vec`)

Search multiple things at once by splitting your query with comma (e.g., `str,u8` or `String,struct:Vec,test`)