Constructs a TriangularMatrix whose elements are contained in the lower triangular portion of a GeneralMatrix.

Namespace: Extreme.Mathematics.LinearAlgebra
Assembly: Extreme.Numerics (Extreme.Numerics)

Syntax

Visual Basic (Declaration)
Public Shared Function ExtractLowerTriangle ( _
	matrix As GeneralMatrix, _
	rowCount As Integer, _
	columnCount As Integer, _
	unitDiagonal As MatrixDiagonalMode _
) As TriangularMatrix
C#
public static TriangularMatrix ExtractLowerTriangle (
	GeneralMatrix matrix,
	int rowCount,
	int columnCount,
	MatrixDiagonalMode unitDiagonal
)
C++
public:
static TriangularMatrix^ ExtractLowerTriangle (
	GeneralMatrix^ matrix, 
	int rowCount, 
	int columnCount, 
	MatrixDiagonalMode unitDiagonal
)

Parameters

matrix (Extreme.Mathematics.LinearAlgebra.GeneralMatrix)
A GeneralMatrix.
rowCount (System.Int32)
The number of rows in the TriangularMatrix.
columnCount (System.Int32)
The number of columns in the TriangularMatrix.
unitDiagonal (Extreme.Mathematics.LinearAlgebra.MatrixDiagonalMode)
If true, the matrix is unit triangular. Only the elements below the diagonal in matrix are considered. If false, the diagonal elements of matrix are taken as the diagonal elements of the triangular matrix.

Return Value

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

Exceptions

ExceptionCondition
ArgumentNullExceptionmatrix is nullNothingnullptr.
ArgumentOutOfRangeException

rowCount is less than zero or greater than or equal to the number of rows in matrix.

-or-

columnCount is less than zero or greater than or equal to the number of columns in matrix.