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, _
	intent As Intent _
) As BandMatrix
C#
public static BandMatrix Extract (
	TriangularMatrix matrix,
	MatrixTriangleMode triangleMode,
	int bandwidth,
	MatrixDiagonalMode unitDiagonal,
	Intent intent
)
C++
public:
static BandMatrix^ Extract (
	TriangularMatrix^ matrix, 
	MatrixTriangleMode triangleMode, 
	int bandwidth, 
	MatrixDiagonalMode unitDiagonal, 
	Intent intent
)

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.
intent (Extreme.Mathematics.Intent)
A Intent value that specifies the intended use of the extracted BandMatrix.

Return Value

A BandMatrix with the same components as matrix with lower bandwidth lowerBandwidth and upper bandwidth upperBandwidth.