Constructs a new upper or lower BandMatrix from the components of a triangular matrix.
Namespace: Extreme.Mathematics.LinearAlgebra
Assembly: Extreme.Numerics (Extreme.Numerics)
Syntax
| Visual Basic (Declaration) |
|---|
Public Shared Function Extract ( _ matrix As TriangularMatrix, _ triangleMode As MatrixTriangleMode, _ bandwidth As Integer, _ unitDiagonal As MatrixDiagonalMode _ ) As BandMatrix |
| C# |
|---|
public static BandMatrix Extract ( TriangularMatrix matrix, MatrixTriangleMode triangleMode, int bandwidth, MatrixDiagonalMode unitDiagonal ) |
| C++ |
|---|
public: static BandMatrix^ Extract ( TriangularMatrix^ matrix, MatrixTriangleMode triangleMode, int bandwidth, MatrixDiagonalMode unitDiagonal ) |
Parameters
- matrix (Extreme.Mathematics.LinearAlgebra.TriangularMatrix)
- The Matrix that supplies the components.
- triangleMode (Extreme.Mathematics.LinearAlgebra.MatrixTriangleMode)
- A MatrixTriangleMode value that specifies whether to construct an upper or a lower triangular matrix.
- bandwidth (System.Int32)
- The bandwidth of the BandMatrix.
- 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.