BandMatrix<T>.Extract Method

Definition

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

Overload List

Extract(Matrix<T>, Int32, Int32) Returns a band matrix view or copy of another matrix.
Extract(Matrix<T>, Int32, Int32, Intent) Returns a band matrix view or copy of another matrix.
Extract(TriangularMatrix<T>, MatrixTriangle, Int32, MatrixDiagonal) Returns an upper or lower band matrix view or copy of a triangular matrix.
Extract(Matrix<T>, MatrixTriangle, Int32, MatrixDiagonal, Intent) Returns an upper or lower band matrix view or copy of a triangular matrix.

Extract(Matrix<T>, Int32, Int32)

Returns a band matrix view or copy of another matrix.
C# 
public static BandMatrix<T> Extract(
	Matrix<T> matrix,
	int lowerBandwidth,
	int upperBandwidth
)

Parameters

matrix  Matrix<T>
The matrix that supplies the components.
lowerBandwidth  Int32
The lower bandwidth of the BandMatrix<T>.
upperBandwidth  Int32
The upper bandwidth of the BandMatrix<T>.

Return Value

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

Extract(Matrix<T>, Int32, Int32, Intent)

Returns a band matrix view or copy of another matrix.
C# 
public static BandMatrix<T> Extract(
	Matrix<T> matrix,
	int lowerBandwidth,
	int upperBandwidth,
	Intent intent
)

Parameters

matrix  Matrix<T>
The matrix that supplies the components.
lowerBandwidth  Int32
The lower bandwidth of the BandMatrix<T>.
upperBandwidth  Int32
The upper bandwidth of the BandMatrix<T>.
intent  Intent
An Intent value that specifies the intended use of the returned BandMatrix<T>.

Return Value

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

Extract(TriangularMatrix<T>, MatrixTriangle, Int32, MatrixDiagonal)

Returns an upper or lower band matrix view or copy of a triangular matrix.
C# 
public static BandMatrix<T> Extract(
	TriangularMatrix<T> matrix,
	MatrixTriangle storedTriangle,
	int bandwidth,
	MatrixDiagonal unitDiagonal
)

Parameters

matrix  TriangularMatrix<T>
The matrix that supplies the components.
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 matrix are considered. If false, the diagonal elements of matrix are taken as the diagonal elements of the triangular matrix.

Return Value

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

Extract(Matrix<T>, MatrixTriangle, Int32, MatrixDiagonal, Intent)

Returns an upper or lower band matrix view or copy of a triangular matrix.
C# 
public static BandMatrix<T> Extract(
	Matrix<T> matrix,
	MatrixTriangle storedTriangle,
	int bandwidth,
	MatrixDiagonal unitDiagonal,
	Intent intent
)

Parameters

matrix  Matrix<T>
The matrix that supplies the components.
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 matrix are considered. If false, the diagonal elements of matrix are taken as the diagonal elements of the triangular matrix.
intent  Intent
An Intent value that specifies the intended use of the returned BandMatrix<T>.

Return Value

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

See Also