SymmetricMatrix<T, TSlice, TStorage2D>.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.4

public override TriangularMatrix<T> ExtractLowerTriangle(
	MatrixDiagonal unitDiagonal = MatrixDiagonal.NonUnitDiagonal
)

Visual Basic

Public Overrides Function ExtractLowerTriangle ( 
	Optional unitDiagonal As MatrixDiagonal = MatrixDiagonal.NonUnitDiagonal
) As TriangularMatrix(Of T)

C++/CLI

public:
virtual TriangularMatrix<T>^ ExtractLowerTriangle(
	MatrixDiagonal unitDiagonal = MatrixDiagonal::NonUnitDiagonal
) override

abstract ExtractLowerTriangle : 
        ?unitDiagonal : MatrixDiagonal 
(* Defaults:
        let _unitDiagonal = defaultArg unitDiagonal MatrixDiagonal.NonUnitDiagonal
*)
-> TriangularMatrix<'T> 
override ExtractLowerTriangle : 
        ?unitDiagonal : MatrixDiagonal 
(* Defaults:
        let _unitDiagonal = defaultArg unitDiagonal MatrixDiagonal.NonUnitDiagonal
*)
-> TriangularMatrix<'T>

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.

SymmetricMatrix<T, TSlice, TStorage2D>.ExtractLowerTriangle Method

Definition

Parameters

Return Value

Exceptions

See Also

Reference