ILMathchol Method (InArraycomplex, Boolean)

public static RetArray<complex> chol(
	InArray<complex> A,
	bool throwException = true
)

Public Shared Function chol ( 
	A As InArray(Of complex),
	Optional throwException As Boolean = true
) As RetArray(Of complex)

Dim A As InArray(Of complex)
Dim throwException As Boolean
Dim returnValue As RetArray(Of complex)

returnValue = ILMath.chol(A, throwException)

Parameters

A

Type: ILNumericsInArraycomplex
Input matrix. A must be a symmetric/hermitian matrix.

throwException (Optional)

Type: SystemBoolean
Throws an ArgumentException if A is found to be not positive definite.

Return Value

No check is performed on A's symmetry for performance reasons.

If throwException is true and A is found to be not positive definite an ArgumentException is thrown and the operation is canceled.

If throwException is false, check the return value's dimension to determine the success of the operation (unless you are sure, A was positive definite). If A was found not to be positive definite the matrix returned will be of dimension [k x k] and the result of the cholesky factorization of A[0:k-1;0:k-1]. Here k is the first leading minor of A at which A was found to be not positive definite.

The factorization is carried out by use of the LAPACK functions DPOTRF, ZPOTRF, SPOTRF or CPOTRF respectively.

[ILNumerics Computing Engine]

Reference