Class PoolMemoryResource

Hierarchy (View Summary)

addon.MemoryResource
- PoolMemoryResource

Index

Constructors

Properties

memoryResource supportsGetMemInfo supportsStreams

Methods

getMemInfo isEqual

Constructors

constructor

new PoolMemoryResource(
    upstreamMemoryResource: MemoryResource,
    initialPoolSize?: number,
    maximumPoolSize?: number,
): PoolMemoryResource
Parameters
- upstreamMemoryResource: MemoryResource
  The MemoryResource from which to allocate blocks for the pool.
- OptionalinitialPoolSize: number
  Initial pool size in bytes. By default, an implementation-defined pool size is used.
- OptionalmaximumPoolSize: number
  Maximum size in bytes, that the pool can grow to.
Returns PoolMemoryResource
Inherited from MemoryResource.constructor
- Defined in memory_resource.ts:63

Properties

`Readonly`memoryResource

memoryResource: MemoryResource

`Readonly`supportsGetMemInfo

supportsGetMemInfo: boolean

`Readonly`supportsStreams

supportsStreams: boolean

Methods

getMemInfo

getMemInfo(stream?: number): [number, number]
Queries the amount of free and total memory for the resource.
Parameters
- Optionalstream: number
  the stream whose memory manager we want to retrieve
Returns [number, number]
a tuple which contains [free memory, total memory] (in bytes)
Inherited from MemoryResource.getMemInfo
- Defined in node_rmm.ts:166

isEqual

isEqual(other: MemoryResource): boolean
Parameters
- other: MemoryResource
  The other resource to compare to
Returns boolean
true if the two resources are equal, else false

Remarks
Two CudaMemoryResource instances always compare equal, because they can each deallocate memory allocated by the other.
Inherited from MemoryResource.isEqual
- Defined in node_rmm.ts:178