PinnedMemoryPool (cudfjni 23.02.0 API)

java.lang.Object
- ai.rapids.cudf.PinnedMemoryPool

All Implemented Interfaces:

AutoCloseable
```
public final class PinnedMemoryPool
extends Object
implements AutoCloseable
```
This provides a pool of pinned memory similar to what RMM does for device memory.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static HostMemoryBuffer`	`allocate(long bytes)` Factory method to create a host buffer but preferably pointing to pinned memory.
`void`	`close()`
`static long`	`getAvailableBytes()` Get the number of bytes free in the pinned memory pool.
`static void`	`initialize(long poolSize)` Initialize the pool.
`static void`	`initialize(long poolSize, int gpuId)` Initialize the pool.
`static boolean`	`isInitialized()` Check if the pool has been initialized or not.
`static void`	`shutdown()` Shut down the pool of memory.
`static HostMemoryBuffer`	`tryAllocate(long bytes)` Factory method to create a pinned host memory buffer.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - initialize
```
public static void initialize(long poolSize)
```
    Initialize the pool.
    
    Parameters:
    
    poolSize - size of the pool to initialize.
  - initialize
```
public static void initialize(long poolSize,
                              int gpuId)
```
    Initialize the pool.
    
    Parameters:
    
    poolSize - size of the pool to initialize.
    
    gpuId - gpu id to set to get memory pool from, -1 means to use default
  - isInitialized
```
public static boolean isInitialized()
```
    Check if the pool has been initialized or not.
  - shutdown
```
public static void shutdown()
```
    Shut down the pool of memory. If there are outstanding allocations this may fail.
  - tryAllocate
```
public static HostMemoryBuffer tryAllocate(long bytes)
```
    Factory method to create a pinned host memory buffer.
    
    Parameters:
    
    bytes - size in bytes to allocate
    
    Returns:
    
    newly created buffer or null if insufficient pinned memory
  - allocate
```
public static HostMemoryBuffer allocate(long bytes)
```
    Factory method to create a host buffer but preferably pointing to pinned memory. It is not guaranteed that the returned buffer will be pointer to pinned memory.
    
    Parameters:
    
    bytes - size in bytes to allocate
    
    Returns:
    
    newly created buffer
  - getAvailableBytes
```
public static long getAvailableBytes()
```
    Get the number of bytes free in the pinned memory pool.
    
    Returns:
    
    amount of free memory in bytes or 0 if the pool is not initialized
  - close
```
public void close()
```
    Specified by:
    
    close in interface AutoCloseable

Class PinnedMemoryPool

Method Summary

Methods inherited from class java.lang.Object

Method Detail

initialize

initialize

isInitialized

shutdown

tryAllocate

allocate

getAvailableBytes

close