SymmetricMatrix<T>.ExtractLowerTriangle Method

Constructs a TriangularMatrix<T> whose elements are contained in the lower triangular portion of a SymmetricMatrix<T>.

Definition

Namespace: Numerics.NET.LinearAlgebra
Assembly: Numerics.NET (in Numerics.NET.dll) Version: 9.0.2
C#
public abstract TriangularMatrix<T> ExtractLowerTriangle(
	MatrixDiagonal unitDiagonal = MatrixDiagonal.NonUnitDiagonal
)

Parameters

unitDiagonal  MatrixDiagonal  (Optional)
If true, the matrix is unit triangular. Only the elements below the diagonal in the matrix are considered. If false, the diagonal elements of the matrix are taken as the diagonal elements of the triangular matrix.

Return Value

TriangularMatrix<T>
A TriangularMatrix<T> whose elements are contained in the lower triangular portion of the matrix.

Exceptions

ArgumentNullException

the matrix is null.

See Also