LinearAlgebraPool<T>.Return Method

Definition

Namespace: Numerics.NET.Collections
Assembly: Numerics.NET (in Numerics.NET.dll) Version: 9.0.7

Overload List

Return(Matrix<T>, Boolean) Returns a rented matrix to the pool.
Return(Vector<T>, Boolean) Returns a rented vector to the pool.

Return(Matrix<T>, Boolean)

Returns a rented matrix to the pool.
C#
public void Return(
	Matrix<T> matrix,
	bool clearStorage = false
)

Parameters

matrix  Matrix<T>
The matrix to return.
clearStorage  Boolean  (Optional)
Optional. Specifies whether the storage array is cleared before being returned to the pool. The default is false.

Exceptions

ArgumentNullExceptionThrown when matrix is null.

Return(Vector<T>, Boolean)

Returns a rented vector to the pool.
C#
public void Return(
	Vector<T> vector,
	bool clearStorage = false
)

Parameters

vector  Vector<T>
The vector to return.
clearStorage  Boolean  (Optional)
Optional. Specifies whether the storage array is cleared before being returned to the pool. The default is false.

Exceptions

ArgumentNullExceptionThrown when vector is null.

See Also