MemoryPoolHandleTNew Method (UInt64, Boolean)

public HandleT New(
	ulong length,
	bool init = false
)

Public Function New ( 
	length As ULong,
	Optional init As Boolean = false
) As HandleT

Dim instance As MemoryPool
Dim length As ULong
Dim init As Boolean
Dim returnValue As HandleT

returnValue = instance.New(length, init)

Parameters

length

Type: SystemUInt64
Minimal length requested in bytes.

init (Optional)

Type: SystemBoolean
[Optional] True: returned cleared memory (zeros, 0 values); False (default): do not clear the memory.

Return Value

The memory will be taken from the pool if a matching chunk is available in the pool. Otherwise, a new chunk of memory is allocated from the Device's memory allocator.

'Matching' chunks are those chunks of memory stored in the pool which have the exact length requested or a higher length, within a certain interval. The Length property informs about the actual allocated length of the allocated memory chunk the returned pointer refers to.

During the retrieval / allocation of the requested memory chunk this function blocks other threads from modifying the pools state (lockfree, though).

[ILNumerics Core Module]

Reference