Matrix.ExtractLowerTriangle Method

Definition

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

Overload List

ExtractLowerTriangle<T>(DenseMatrix<T>) Constructs a TriangularMatrix<T> whose elements are contained in the lower triangular portion of a DenseMatrix<T>.
ExtractLowerTriangle<T>(HermitianMatrix<T>) Constructs a TriangularMatrix<T> whose elements are contained in the lower triangular portion of a HermitianMatrix<T>.
ExtractLowerTriangle<T>(SymmetricMatrix<T>) Constructs a TriangularMatrix<T> whose elements are contained in the lower triangular portion of a SymmetricMatrix<T>.
ExtractLowerTriangle<T>(DenseMatrix<T>, MatrixDiagonal) Constructs a TriangularMatrix<T> whose elements are contained in the lower triangular portion of a DenseMatrix<T>.
ExtractLowerTriangle<T>(HermitianMatrix<T>, MatrixDiagonal) Constructs a TriangularMatrix<T> whose elements are contained in the lower triangular portion of a HermitianMatrix<T>.
ExtractLowerTriangle<T>(SymmetricMatrix<T>, MatrixDiagonal) Constructs a TriangularMatrix<T> whose elements are contained in the lower triangular portion of a SymmetricMatrix<T>.
ExtractLowerTriangle<T>(DenseMatrix<T>, Int32, Int32, MatrixDiagonal) Constructs a TriangularMatrix<T> whose elements are contained in the lower triangular portion of a DenseMatrix<T>.

ExtractLowerTriangle<T>(DenseMatrix<T>)

Constructs a TriangularMatrix<T> whose elements are contained in the lower triangular portion of a DenseMatrix<T>.
C#
public static TriangularMatrix<T> ExtractLowerTriangle<T>(
	DenseMatrix<T> matrix
)

Parameters

matrix  DenseMatrix<T>
A DenseMatrix<T>.

Type Parameters

T

Return Value

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

Exceptions

ArgumentNullExceptionmatrix is null.

ExtractLowerTriangle<T>(HermitianMatrix<T>)

Constructs a TriangularMatrix<T> whose elements are contained in the lower triangular portion of a HermitianMatrix<T>.
C#
public static TriangularMatrix<T> ExtractLowerTriangle<T>(
	HermitianMatrix<T> matrix
)

Parameters

matrix  HermitianMatrix<T>
A HermitianMatrix<T>.

Type Parameters

T

Return Value

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

Exceptions

ArgumentNullExceptionmatrix is null.

ExtractLowerTriangle<T>(SymmetricMatrix<T>)

Constructs a TriangularMatrix<T> whose elements are contained in the lower triangular portion of a SymmetricMatrix<T>.
C#
public static TriangularMatrix<T> ExtractLowerTriangle<T>(
	SymmetricMatrix<T> matrix
)

Parameters

matrix  SymmetricMatrix<T>
A SymmetricMatrix<T>.

Type Parameters

T

Return Value

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

Exceptions

ArgumentNullExceptionmatrix is null.

ExtractLowerTriangle<T>(DenseMatrix<T>, MatrixDiagonal)

Constructs a TriangularMatrix<T> whose elements are contained in the lower triangular portion of a DenseMatrix<T>.
C#
public static TriangularMatrix<T> ExtractLowerTriangle<T>(
	DenseMatrix<T> matrix,
	MatrixDiagonal unitDiagonal
)

Parameters

matrix  DenseMatrix<T>
A DenseMatrix<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

ArgumentNullExceptionmatrix is null.

ExtractLowerTriangle<T>(HermitianMatrix<T>, MatrixDiagonal)

Constructs a TriangularMatrix<T> whose elements are contained in the lower triangular portion of a HermitianMatrix<T>.
C#
public static TriangularMatrix<T> ExtractLowerTriangle<T>(
	HermitianMatrix<T> matrix,
	MatrixDiagonal unitDiagonal
)

Parameters

matrix  HermitianMatrix<T>
A HermitianMatrix<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

ArgumentNullExceptionmatrix is null.

ExtractLowerTriangle<T>(SymmetricMatrix<T>, MatrixDiagonal)

Constructs a TriangularMatrix<T> whose elements are contained in the lower triangular portion of a SymmetricMatrix<T>.
C#
public static TriangularMatrix<T> ExtractLowerTriangle<T>(
	SymmetricMatrix<T> matrix,
	MatrixDiagonal unitDiagonal
)

Parameters

matrix  SymmetricMatrix<T>
A SymmetricMatrix<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

ArgumentNullExceptionmatrix is null.

ExtractLowerTriangle<T>(DenseMatrix<T>, Int32, Int32, MatrixDiagonal)

Constructs a TriangularMatrix<T> whose elements are contained in the lower triangular portion of a DenseMatrix<T>.
C#
public static TriangularMatrix<T> ExtractLowerTriangle<T>(
	DenseMatrix<T> matrix,
	int rowCount,
	int columnCount,
	MatrixDiagonal unitDiagonal
)

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

ArgumentNullExceptionmatrix 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.

See Also