[−][src]Struct na::Cholesky
The Cholesky decomposition of a symmetric-definite-positive matrix.
Methods
impl<N, D> Cholesky<N, D> where
D: DimSub<Dynamic>,
N: ComplexField,
DefaultAllocator: Allocator<N, D, D>,
[src]
D: DimSub<Dynamic>,
N: ComplexField,
DefaultAllocator: Allocator<N, D, D>,
pub fn new(
matrix: Matrix<N, D, D, <DefaultAllocator as Allocator<N, D, D>>::Buffer>
) -> Option<Cholesky<N, D>>
[src]
matrix: Matrix<N, D, D, <DefaultAllocator as Allocator<N, D, D>>::Buffer>
) -> Option<Cholesky<N, D>>
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
) -> Matrix<N, D, D, <DefaultAllocator as Allocator<N, D, D>>::Buffer>
[src]
self
) -> Matrix<N, D, D, <DefaultAllocator as Allocator<N, D, D>>::Buffer>
Retrieves the lower-triangular factor of the Cholesky decomposition with its strictly upper-triangular part filled with zeros.
pub fn unpack_dirty(
self
) -> Matrix<N, D, D, <DefaultAllocator as Allocator<N, D, D>>::Buffer>
[src]
self
) -> Matrix<N, D, D, <DefaultAllocator as Allocator<N, D, D>>::Buffer>
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
) -> Matrix<N, D, D, <DefaultAllocator as Allocator<N, D, D>>::Buffer>
[src]
&self
) -> Matrix<N, D, D, <DefaultAllocator as Allocator<N, D, D>>::Buffer>
Retrieves the lower-triangular factor of the Cholesky decomposition with its strictly uppen-triangular part filled with zeros.
pub fn l_dirty(
&self
) -> &Matrix<N, D, D, <DefaultAllocator as Allocator<N, D, D>>::Buffer>
[src]
&self
) -> &Matrix<N, D, D, <DefaultAllocator as Allocator<N, D, D>>::Buffer>
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, C2, S2>(&self, b: &mut Matrix<N, R2, C2, S2>) where
C2: Dim,
R2: Dim,
S2: StorageMut<N, R2, C2>,
ShapeConstraint: SameNumberOfRows<R2, D>,
[src]
C2: Dim,
R2: Dim,
S2: StorageMut<N, 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
.
pub fn solve<R2, C2, S2>(
&self,
b: &Matrix<N, R2, C2, S2>
) -> Matrix<N, R2, C2, <DefaultAllocator as Allocator<N, R2, C2>>::Buffer> where
C2: Dim,
R2: Dim,
S2: StorageMut<N, R2, C2>,
DefaultAllocator: Allocator<N, R2, C2>,
ShapeConstraint: SameNumberOfRows<R2, D>,
[src]
&self,
b: &Matrix<N, R2, C2, S2>
) -> Matrix<N, R2, C2, <DefaultAllocator as Allocator<N, R2, C2>>::Buffer> where
C2: Dim,
R2: Dim,
S2: StorageMut<N, R2, C2>,
DefaultAllocator: Allocator<N, 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.
pub fn inverse(
&self
) -> Matrix<N, D, D, <DefaultAllocator as Allocator<N, D, D>>::Buffer>
[src]
&self
) -> Matrix<N, D, D, <DefaultAllocator as Allocator<N, D, D>>::Buffer>
Computes the inverse of the decomposed matrix.
Trait Implementations
impl<N, D> Clone for Cholesky<N, D> where
D: Dim + Clone,
N: Clone + ComplexField,
DefaultAllocator: Allocator<N, D, D>,
[src]
D: Dim + Clone,
N: Clone + ComplexField,
DefaultAllocator: Allocator<N, D, D>,
impl<N, D> Copy for Cholesky<N, D> where
D: Dim,
N: ComplexField,
DefaultAllocator: Allocator<N, D, D>,
Matrix<N, D, D, <DefaultAllocator as Allocator<N, D, D>>::Buffer>: Copy,
[src]
D: Dim,
N: ComplexField,
DefaultAllocator: Allocator<N, D, D>,
Matrix<N, D, D, <DefaultAllocator as Allocator<N, D, D>>::Buffer>: Copy,
impl<N, D> Debug for Cholesky<N, D> where
D: Dim + Debug,
N: Debug + ComplexField,
DefaultAllocator: Allocator<N, D, D>,
[src]
D: Dim + Debug,
N: Debug + ComplexField,
DefaultAllocator: Allocator<N, D, D>,
Auto Trait Implementations
impl<N, D> !RefUnwindSafe for Cholesky<N, D>
impl<N, D> !Send for Cholesky<N, D>
impl<N, D> !Sync for Cholesky<N, D>
impl<N, D> !Unpin for Cholesky<N, D>
impl<N, D> !UnwindSafe for Cholesky<N, D>
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<V> IntoPnt<V> for V
[src]
impl<V> IntoVec<V> for V
[src]
impl<T> Same<T> for T
type Output = T
Should always be Self
impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,
[src]
SS: SubsetOf<SP>,
fn to_subset(&self) -> Option<SS>
[src]
fn is_in_subset(&self) -> bool
[src]
unsafe fn to_subset_unchecked(&self) -> SS
[src]
fn from_subset(element: &SS) -> SP
[src]
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
fn to_owned(&self) -> T
[src]
fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
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]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
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]
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
V: MultiLane<T>,