Trait linxal::factorization::cholesky::Cholesky
[−]
[src]
pub trait Cholesky: LinxalImplScalar { fn compute_into<D>(
a: ArrayBase<D, Ix2>,
uplo: Symmetric
) -> Result<ArrayBase<D, Ix2>, CholeskyError>
where
D: DataOwned<Elem = Self> + DataMut<Elem = Self>; fn compute<D1: Data>(
a: &ArrayBase<D1, Ix2>,
uplo: Symmetric
) -> Result<Array<Self, Ix2>, CholeskyError>
where
D1: Data<Elem = Self>, { ... } }
Trait defined on scalars to support Cholesky-factorization.
Required Methods
fn compute_into<D>(
a: ArrayBase<D, Ix2>,
uplo: Symmetric
) -> Result<ArrayBase<D, Ix2>, CholeskyError> where
D: DataOwned<Elem = Self> + DataMut<Elem = Self>,
a: ArrayBase<D, Ix2>,
uplo: Symmetric
) -> Result<ArrayBase<D, Ix2>, CholeskyError> where
D: DataOwned<Elem = Self> + DataMut<Elem = Self>,
Return a triangular matrix satisfying the Cholesky factorization, consuming the input.
The layout of the matrix matches the layout of the input. When
the input matrix is specified as Symmetric::Upper
, the
returned Cholesky factor U
is upper triangular, so that
U^H
* U
= A
.
Likewise, when the input is Symmetric::Lower
, L
is
returned so that L
* L^H
= A
.
The elements outside of the triangle are forcibly zero-ed.
Provided Methods
fn compute<D1: Data>(
a: &ArrayBase<D1, Ix2>,
uplo: Symmetric
) -> Result<Array<Self, Ix2>, CholeskyError> where
D1: Data<Elem = Self>,
a: &ArrayBase<D1, Ix2>,
uplo: Symmetric
) -> Result<Array<Self, Ix2>, CholeskyError> where
D1: Data<Elem = Self>,
Return a triangular matrix satisfying the Cholesky
factorization. (see Self::compute_into
).