TriangularMatrix<T>.ExtractBanded Method

Definition

Namespace: Numerics.NET.LinearAlgebra
Assembly: Numerics.NET (in Numerics.NET.dll) Version: 9.0.0

Overload List

ExtractBanded(MatrixTriangle, Int32, MatrixDiagonal) Constructs a new upper or lower band matrix from the components of a triangular matrix.
ExtractBanded(MatrixTriangle, Int32, MatrixDiagonal, Intent) Constructs a new upper or lower band matrix from the components of a triangular matrix.

ExtractBanded(MatrixTriangle, Int32, MatrixDiagonal)

Constructs a new upper or lower band matrix from the components of a triangular matrix.
C# 
public BandMatrix<T> ExtractBanded(
	MatrixTriangle storedTriangle,
	int bandwidth,
	MatrixDiagonal unitDiagonal
)

Parameters

storedTriangle  MatrixTriangle
A MatrixTriangle value that specifies whether to construct an upper or a lower triangular matrix.
bandwidth  Int32
The bandwidth of the BandMatrix<T>.
unitDiagonal  MatrixDiagonal
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

BandMatrix<T>
A BandMatrix<T> with the same components as the matrix with lower and upper bandwidth equal to bandwidth.

ExtractBanded(MatrixTriangle, Int32, MatrixDiagonal, Intent)

Constructs a new upper or lower band matrix from the components of a triangular matrix.
C# 
public abstract BandMatrix<T> ExtractBanded(
	MatrixTriangle storedTriangle,
	int bandwidth,
	MatrixDiagonal unitDiagonal,
	Intent intent
)

Parameters

storedTriangle  MatrixTriangle
A MatrixTriangle value that specifies whether to construct an upper or a lower triangular matrix.
bandwidth  Int32
The bandwidth of the BandMatrix<T>.
unitDiagonal  MatrixDiagonal
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.
intent  Intent
An Intent value that specifies the intended use of the extracted BandMatrix<T>.

Return Value

BandMatrix<T>
A BandMatrix<T> with the same components as the matrix with upper and lower bandwidth equal to bandwidth.

See Also