chol

Perform a Cholesky factorization.

Note

The input matrix must be symmetric positive-definite

template<typename OpA>
__MATX_INLINE__ auto matx::chol(const OpA &a, SolverFillMode uplo = SolverFillMode::UPPER)

Performs a Cholesky factorization, saving the result in either the upper or lower triangle of the output.

If rank > 2, operations are batched.

Template Parameters:

OpA – Data type of input a tensor or operator

Parameters:

• a – Input tensor or operator of shape ... x n x n

• uplo – Part of matrix to fill

Returns:

Operator that produces the factorization output of shape ... x n x n.

Enums

The following enums are used for configuring the behavior of Cholesky operations.

enum class matx::SolverFillMode

Indicates which part (lower or upper) of the dense matrix was filled and should be used by the function.

Values:

enumerator UPPER

Use the upper part of the matrix

enumerator LOWER

Use the lower part of the matrix

Examples

(Bv = chol(Bv, SolverFillMode::LOWER)).run(this->exec);