Matrix.ExtractLowerTriangle<T>(DenseMatrix<T>, Int32, Int32, MatrixDiagonal) Method

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

Definition

Namespace: Extreme.Mathematics
Assembly: Extreme.Numerics (in Extreme.Numerics.dll) Version: 8.1.23

public static TriangularMatrix<T> ExtractLowerTriangle<T>(
	DenseMatrix<T> matrix,
	int rowCount,
	int columnCount,
	MatrixDiagonal unitDiagonal
)

Visual Basic

Public Shared Function ExtractLowerTriangle(Of T) ( 
	matrix As DenseMatrix(Of T),
	rowCount As Integer,
	columnCount As Integer,
	unitDiagonal As MatrixDiagonal
) As TriangularMatrix(Of T)

C++/CLI

public:
generic<typename T>
static TriangularMatrix<T>^ ExtractLowerTriangle(
	DenseMatrix<T>^ matrix, 
	int rowCount, 
	int columnCount, 
	MatrixDiagonal unitDiagonal
)

static member ExtractLowerTriangle : 
        matrix : DenseMatrix<'T> * 
        rowCount : int * 
        columnCount : int * 
        unitDiagonal : MatrixDiagonal -> TriangularMatrix<'T>

Parameters

matrix DenseMatrix<T>: A DenseMatrix<T>.
rowCount Int32: The number of rows in the TriangularMatrix<T>.
columnCount Int32: The number of columns in the TriangularMatrix<T>.
unitDiagonal MatrixDiagonal: 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.

Type Parameters

T

Return Value

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

Exceptions

ArgumentNullException

matrix is null.

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.