CholeskyDecomposition<T> Constructor

Constructs a new CholeskyDecomposition<T> object.

Definition

Namespace: Numerics.NET.LinearAlgebra
Assembly: Numerics.NET (in Numerics.NET.dll) Version: 9.0.3
C#
protected CholeskyDecomposition(
	Matrix<T> matrix,
	bool overwrite
)

Parameters

matrix  Matrix<T>
The SymmetricMatrix<T> that is to be factorized. This matrix must be positive-definite, or the decomposition will fail.
overwrite  Boolean
If false, the matrix is preserved. (This is the default.) If true, matrix is destroyed by the decomposition.

Remarks

By default, the matrix matrix is preserved. It may be more efficient to overwrite the components of matrix with the result of the decomposition. To do this, set the Overwrite property to false immediately after creating the CholeskyDecomposition<T>.

The decomposition isn't performed until it is needed. You can force the calculation to take place by calling the Decompose() method.

Exceptions

ArgumentNullException

matrix is null.

See Also