LinearAlgebraPool<T>.RentUpperTriangularMatrix Method

Rents a lower triangular matrix with the specified dimensions from the pool.

Definition

Namespace: Numerics.NET.Collections
Assembly: Numerics.NET (in Numerics.NET.dll) Version: 9.0.7
C#
public TriangularMatrix<T> RentUpperTriangularMatrix(
	int rowCount,
	int columnCount,
	MatrixDiagonal unitDiagonal = MatrixDiagonal.NonUnitDiagonal,
	MatrixElementOrder elementOrder = MatrixElementOrder.ColumnMajor
)

Parameters

rowCount  Int32
The number of rows in the matrix.
columnCount  Int32
The number of columns in the matrix.
unitDiagonal  MatrixDiagonal  (Optional)
Optional. Specifies whether the matrix has a unit diagonal. The default is non-unit-diagonal.
elementOrder  MatrixElementOrder  (Optional)
Optional. A MatrixElementOrder value that indicates whether the elements are stored in column-major or row-major order. The default is column-major order.

Return Value

TriangularMatrix<T>
An upper TriangularMatrix<T> of the specified dimensions.

Exceptions

ArgumentOutOfRangeException

rowCount is less than or equal to zero.

-or-

columnCount is less than or equal to zero.

See Also