Constructs a TriangularMatrix whose
elements are contained in the lower triangular portion
of a SymmetricMatrix.
Namespace: Extreme.Mathematics.LinearAlgebra
Assembly: Extreme.Numerics (Extreme.Numerics)
Syntax
| Visual Basic (Declaration) |
|---|
Public Shared Function ExtractLowerTriangle ( _ matrix As SymmetricMatrix, _ unitDiagonal As MatrixDiagonalMode _ ) As TriangularMatrix |
| C# |
|---|
public static TriangularMatrix ExtractLowerTriangle ( SymmetricMatrix matrix, MatrixDiagonalMode unitDiagonal ) |
| C++ |
|---|
public: static TriangularMatrix^ ExtractLowerTriangle ( SymmetricMatrix^ matrix, MatrixDiagonalMode unitDiagonal ) |
Parameters
- 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
| Exception | Condition |
|---|---|
| ArgumentNullException | variable is nullNothingnullptr. |