Home > Extreme Optimization Mathematics Library for .NET > Reference > Extreme.Mathematics.LinearAlgebra Namespace > TriangularMatrix Class > Methods > TriangularMatrix.ExtractLowerTriangle Method

Extreme Optimization Mathematics Library for .NET

TriangularMatrix.ExtractLowerTriangle Method (GeneralMatrix, Int32, Int32, MatrixDiagonalMode)

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

[Visual Basic]
Overloads Public Shared Function ExtractLowerTriangle( _
   ByVal matrix As GeneralMatrix, _
   ByVal rowCount As Integer, _
   ByVal columnCount As Integer, _
   ByVal unitDiagonal As MatrixDiagonalMode _
) As TriangularMatrix
[C#]
public static TriangularMatrix ExtractLowerTriangle(
   GeneralMatrix matrix,
   int rowCount,
   int columnCount,
   MatrixDiagonalMode unitDiagonal
);

Parameters

matrix
A GeneralMatrix.
rowCount
The number of rows in the TriangularMatrix.
columnCount
The number of columns in the TriangularMatrix.
unitDiagonal
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

Exception TypeCondition
ArgumentNullExceptionmatrix is a null reference (Nothing in Visual Basic).
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.

See Also

TriangularMatrix Class | Extreme.Mathematics.LinearAlgebra Namespace | TriangularMatrix.ExtractLowerTriangle Overload List