LinearAlgebraPool<T>.RentBandMatrix Method

Rents a band matrix with the specified dimensions from the pool.

Definition

Namespace: Numerics.NET.Collections
Assembly: Numerics.NET (in Numerics.NET.dll) Version: 9.1.0
C# 
public BandMatrix<T> RentBandMatrix(
	int rowCount,
	int columnCount,
	int lowerBandwidth,
	int upperBandwidth
)

Parameters

rowCount  Int32
The number of rows in the matrix.
columnCount  Int32
The number of columns in the matrix.
lowerBandwidth  Int32
The lower bandwidth of the matrix.
upperBandwidth  Int32
The upper bandwidth of the matrix.

Return Value

BandMatrix<T>
A BandMatrix<T> of the specified dimensions.

Exceptions

ArgumentOutOfRangeException

rowCount is less than or equal to zero.

-or-

columnCount is less than or equal to zero.

-or-

lowerBandwidth is less than zero.

-or-

upperBandwidth is less than zero.

See Also