主机内存缓冲区 (cudfjni 25.04.0 API)

java.lang.Object
- ai.rapids.cudf.MemoryBuffer
- - ai.rapids.cudf.HostMemoryBuffer

所有已实现的接口

AutoCloseable
```
public class HostMemoryBuffer
extends MemoryBuffer
```
此类在主机/CPU 内存中维护一个堆外缓冲区。请注意，必须显式关闭实例，否则会发生本地内存泄漏！默认情况下，此类内部会尝试使用 PinnedMemoryPool 来分配和释放其使用的内存。要默认避免使用固定内存池进行分配，请将 Java 系统属性 ai.rapids.cudf.prefer-pinned 设置为 false。请注意，Java 设置的堆外内存限制不适用于这些缓冲区。

嵌套类摘要
- 从类 ai.rapids.cudf.MemoryBuffer 继承的嵌套类/接口
  MemoryBuffer.EventHandler, MemoryBuffer.MemoryBufferCleaner

字段摘要
- 从类 ai.rapids.cudf.MemoryBuffer 继承的字段
  address, cleaner, closed, id, length, refCount

方法摘要

所有方法静态方法实例方法具体方法
修饰符和类型	方法和描述
`static HostMemoryBuffer`	`allocate(long bytes)` 分配内存，但请务必关闭返回的缓冲区以避免内存泄漏。
`static HostMemoryBuffer`	`allocate(long bytes, boolean preferPinned)` 分配内存，但请务必关闭返回的缓冲区以避免内存泄漏。
`static HostMemoryBuffer`	`allocateRaw(long bytes)` 分配主机内存，绕过默认分配器。
`ByteBuffer`	`asByteBuffer()` 返回一个提供访问底层内存的 ByteBuffer。
`ByteBuffer`	`asByteBuffer(long offset, int length)` 返回一个提供访问底层内存的 ByteBuffer。
`void`	`copyFromDeviceBuffer(BaseDeviceMemoryBuffer deviceMemoryBuffer)` 同步从 DeviceMemoryBuffer 复制到 HostMemoryBuffer
`void`	`copyFromDeviceBuffer(BaseDeviceMemoryBuffer deviceMemoryBuffer, Cuda.Stream stream)` 使用指定的流从 DeviceMemoryBuffer 复制到 HostMemoryBuffer。
`void`	`copyFromDeviceBufferAsync(BaseDeviceMemoryBuffer deviceMemoryBuffer, Cuda.Stream stream)` 使用指定的流从 DeviceMemoryBuffer 复制到 HostMemoryBuffer。
`void`	`copyFromHostBuffer(long destOffset, HostMemoryBuffer srcData, long srcOffset, long length)` 将给定缓冲区的内容复制到此缓冲区。
`void`	`copyFromStream(long destOffset, InputStream in, long byteLength)` 从 in 复制 len 字节到此缓冲区。
`boolean`	`getBoolean(long offset)` 返回该偏移量处的布尔值。
`byte`	`getByte(long offset)` 返回该偏移量处的字节值。
`void`	`getBytes(byte[] dst, long dstOffset, long srcOffset, long len)` 从缓冲区中从偏移量开始复制一组字节到数组。
`double`	`getDouble(long offset)` 返回该偏移量处的双精度浮点值。
`float`	`getFloat(long offset)` 返回该偏移量处的单精度浮点值。
`int`	`getInt(long offset)` 返回该偏移量处的整数值。
`void`	`getInts(int[] dst, long dstIndex, long srcOffset, int count)` 从缓冲区中从偏移量开始复制一组整数到数组。
`long`	`getLong(long offset)` 返回该偏移量处的长整数值。
`void`	`getLongs(long[] dst, long dstIndex, long srcOffset, int count)` 从缓冲区中从偏移量开始复制一组长整数到数组。
`short`	`getShort(long offset)` 返回该偏移量处的短整数值。
`static HostMemoryBuffer`	`mapFile(File path, FileChannel.MapMode mode, long offset, long length)` 创建一个内存映射到文件的主机缓冲区。
`void`	`printBuffer()` 警告：仅用于调试的打印缓冲区方法。
`void`	`printBuffer(int wordsPerRow)` 警告：仅用于调试的打印缓冲区方法。
`void`	`setBoolean(long offset, boolean value)` 设置该偏移量处的布尔值。
`void`	`setByte(long offset, byte value)` 设置该偏移量处的字节值。
`void`	`setBytes(long offset, byte[] data, long srcOffset, long len)` 从数组复制一组字节到缓冲区中从偏移量开始的位置。
`void`	`setDouble(long offset, double value)` 设置该偏移量处的双精度浮点值。
`void`	`setDoubles(long offset, double[] data, long srcOffset, long len)` 从数组复制一组双精度浮点值到缓冲区中从偏移量开始的位置。
`void`	`setFloat(long offset, float value)` 设置该偏移量处的单精度浮点值。
`void`	`setFloats(long offset, float[] data, long srcOffset, long len)` 从数组复制一组单精度浮点值到缓冲区中从偏移量开始的位置。
`void`	`setInt(long offset, int value)` 设置该偏移量处的整数值。
`void`	`setInts(long offset, int[] data, long srcOffset, long len)` 从数组复制一组整数到缓冲区中从偏移量开始的位置。
`void`	`setLong(long offset, long value)` 设置该偏移量处的长整数值。
`void`	`setLongs(long offset, long[] data, long srcOffset, long len)` 从数组复制一组长整数到缓冲区中从偏移量开始的位置。
`void`	`setMemory(long offset, long length, byte value)` 在此缓冲区中重复设置值。
`void`	`setShort(long offset, short value)` 设置该偏移量处的短整数值。
`void`	`setShorts(long offset, short[] data, long srcOffset, long len)` 从数组复制一组短整数到缓冲区中从偏移量开始的位置。
`HostMemoryBuffer`	`slice(long offset, long len)` 切割主机缓冲区的一部分。
`HostMemoryBuffer`	`sliceWithCopy(long offset, long len)` 切割主机缓冲区的一部分，并实际复制数据。

从类 ai.rapids.cudf.MemoryBuffer 继承的方法
addressOutOfBoundsCheck, close, copyFromMemoryBuffer, copyFromMemoryBufferAsync, getAddress, getEventHandler, getLength, getRefCount, incRefCount, noWarnLeakExpected, setEventHandler, toString

从类 java.lang.Object 继承的方法
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- 方法详细信息
  - allocate
```
public static HostMemoryBuffer allocate(long bytes,
                                        boolean preferPinned)
```
    分配内存，但请务必关闭返回的缓冲区以避免内存泄漏。
    
    参数
    
    bytes - 要分配的字节大小
    
    preferPinned - 如果设置为 true，将尽可能使用固定内存池，并回退到堆外内存。如果设置为 false，分配将始终来自堆外内存。
    
    返回
    
    新创建的缓冲区
  - allocate
```
public static HostMemoryBuffer allocate(long bytes)
```
    分配内存，但请务必关闭返回的缓冲区以避免内存泄漏。如果 Java 系统属性 ai.rapids.cudf.prefer-pinned 设置为 true，则分配内存时将优先使用固定内存。
    
    参数
    
    bytes - 要分配的字节大小
    
    返回
    
    新创建的缓冲区
  - allocateRaw
```
public static HostMemoryBuffer allocateRaw(long bytes)
```
    分配主机内存，绕过默认分配器。这仅供其他分配器使用。固定内存不会用于这些分配。
    
    参数
    
    bytes - 要分配的字节大小
    
    返回
    
    新创建的缓冲区
  - mapFile
```
public static HostMemoryBuffer mapFile(File path,
                                       FileChannel.MapMode mode,
                                       long offset,
                                       long length)
                                throws IOException
```
    创建一个内存映射到文件的主机缓冲区。
    
    参数
    
    path - 要映射到主机内存的文件路径
    
    mode - 映射类型
    
    offset - 映射开始的文件偏移量
    
    length - 要映射的字节数
    
    返回
    
    文件映射的缓冲区
    
    抛出
    
    IOException
  - asByteBuffer
```
public final ByteBuffer asByteBuffer()
```
    返回一个提供访问底层内存的 ByteBuffer。请注意：如果缓冲区大于 ByteBuffer 可处理的大小 (2GB)，将抛出异常。另请注意，ByteBuffer 将采用原生字节序，这与默认大端字节序的常规 ByteBuffers 不同。
  - asByteBuffer
```
public final ByteBuffer asByteBuffer(long offset,
                                     int length)
```
    返回一个提供访问底层内存的 ByteBuffer。请注意，ByteBuffer 将采用原生字节序，这与默认大端字节序的常规 ByteBuffers 不同。
    
    参数
    
    offset - 起始偏移量
    
    length - 包含的字节数。
  - copyFromHostBuffer
```
public final void copyFromHostBuffer(long destOffset,
                                     HostMemoryBuffer srcData,
                                     long srcOffset,
                                     long length)
```
    将给定缓冲区的内容复制到此缓冲区。
    
    参数
    
    destOffset - 在此缓冲区中开始复制的目标字节偏移量
    
    srcData - 要从中复制的缓冲区
    
    srcOffset - 在 srcData 中开始复制的源字节偏移量
    
    length - 要复制的字节数
  - copyFromStream
```
public final void copyFromStream(long destOffset,
                                 InputStream in,
                                 long byteLength)
                          throws IOException
```
    从 in 复制 len 字节到此缓冲区。
    
    参数
    
    destOffset - 在此缓冲区中开始复制的目标字节偏移量
    
    in - 要从中复制字节的输入流
    
    byteLength - 要复制的字节数
    
    抛出
    
    EOFException - 如果流中没有足够的字节可供复制。
    
    IOException - 如果从流中读取时发生错误。
  - getByte
```
public final byte getByte(long offset)
```
    返回该偏移量处的字节值。
    
    参数
    
    offset - - 相对于地址的偏移量
    
    返回
    
    - 值
  - setByte
```
public final void setByte(long offset,
                          byte value)
```
    设置该偏移量处的字节值。
    
    参数
    
    offset - - 相对于地址的偏移量
    
    value - - 要设置的值
  - getBytes
```
public final void getBytes(byte[] dst,
                           long dstOffset,
                           long srcOffset,
                           long len)
```
    从缓冲区中从偏移量开始复制一组字节到数组。
    
    参数
    
    dst - 目标字节数组
    
    dstOffset - 目标数组内的起始偏移量
    
    srcOffset - 此缓冲区内的起始偏移量
    
    len - 要复制的字节数
  - setBytes
```
public final void setBytes(long offset,
                           byte[] data,
                           long srcOffset,
                           long len)
```
    从数组复制一组字节到缓冲区中从偏移量开始的位置。
    
    参数
    
    offset - 相对于地址开始复制到的偏移量
    
    data - 要复制的数据。
  - getShort
```
public final short getShort(long offset)
```
    返回该偏移量处的短整数值。
    
    参数
    
    offset - - 相对于地址的偏移量
    
    返回
    
    - 值
  - setShort
```
public final void setShort(long offset,
                           short value)
```
    设置该偏移量处的短整数值。
    
    参数
    
    offset - - 相对于地址的偏移量
    
    value - - 要设置的值
  - setShorts
```
public final void setShorts(long offset,
                            short[] data,
                            long srcOffset,
                            long len)
```
    从数组复制一组短整数到缓冲区中从偏移量开始的位置。
    
    参数
    
    offset - 相对于地址开始复制到的偏移量
    
    data - 要复制的数据。
    
    srcOffset - 数据中开始的索引。
  - getInt
```
public final int getInt(long offset)
```
    返回该偏移量处的整数值。
    
    参数
    
    offset - - 相对于地址的偏移量
    
    返回
    
    - 值
  - getInts
```
public final void getInts(int[] dst,
                          long dstIndex,
                          long srcOffset,
                          int count)
```
    从缓冲区中从偏移量开始复制一组整数到数组。
    
    参数
    
    dst - 目标整数数组
    
    dstIndex - 目标数组内的起始索引
    
    srcOffset - 此缓冲区内的起始偏移量
    
    count - 要复制的整数个数
  - setInt
```
public final void setInt(long offset,
                         int value)
```
    设置该偏移量处的整数值。
    
    参数
    
    offset - - 相对于地址的偏移量
    
    value - - 要设置的值
  - setInts
```
public final void setInts(long offset,
                          int[] data,
                          long srcOffset,
                          long len)
```
    从数组复制一组整数到缓冲区中从偏移量开始的位置。
    
    参数
    
    offset - 相对于地址开始复制到的偏移量
    
    data - 要复制的数据。
    
    srcOffset - 数据中开始的索引
  - getLong
```
public final long getLong(long offset)
```
    返回该偏移量处的长整数值。
    
    参数
    
    offset - - 相对于地址的偏移量
    
    返回
    
    - 值
  - setLong
```
public final void setLong(long offset,
                          long value)
```
    设置该偏移量处的长整数值。
    
    参数
    
    offset - - 相对于地址的偏移量
    
    value - - 要设置的值
  - getLongs
```
public final void getLongs(long[] dst,
                           long dstIndex,
                           long srcOffset,
                           int count)
```
    从缓冲区中从偏移量开始复制一组长整数到数组。
    
    参数
    
    dst - 目标长整数数组
    
    dstIndex - 目标数组内的起始索引
    
    srcOffset - 此缓冲区内的起始偏移量
    
    count - 要复制的长整数个数
  - setLongs
```
public final void setLongs(long offset,
                           long[] data,
                           long srcOffset,
                           long len)
```
    从数组复制一组长整数到缓冲区中从偏移量开始的位置。
    
    参数
    
    offset - 相对于地址开始复制到的偏移量
    
    data - 要复制的数据。
    
    srcOffset - 数据中开始的索引。
  - getFloat
```
public final float getFloat(long offset)
```
    返回该偏移量处的单精度浮点值。
    
    参数
    
    offset - - 相对于地址的偏移量
    
    返回
    
    - 值
  - setFloat
```
public final void setFloat(long offset,
                           float value)
```
    设置该偏移量处的单精度浮点值。
    
    参数
    
    offset - - 相对于地址的偏移量
    
    value - - 要设置的值
  - setFloats
```
public final void setFloats(long offset,
                            float[] data,
                            long srcOffset,
                            long len)
```
    从数组复制一组单精度浮点值到缓冲区中从偏移量开始的位置。
    
    参数
    
    offset - 相对于地址开始复制到的偏移量
    
    data - 要复制的数据。
    
    srcOffset - 数据中开始的索引
  - getDouble
```
public final double getDouble(long offset)
```
    返回该偏移量处的双精度浮点值。
    
    参数
    
    offset - - 相对于地址的偏移量
    
    返回
    
    - 值
  - setDouble
```
public final void setDouble(long offset,
                            double value)
```
    设置该偏移量处的双精度浮点值。
    
    参数
    
    offset - - 相对于地址的偏移量
    
    value - - 要设置的值
  - setDoubles
```
public final void setDoubles(long offset,
                             double[] data,
                             long srcOffset,
                             long len)
```
    从数组复制一组双精度浮点值到缓冲区中从偏移量开始的位置。
    
    参数
    
    offset - 相对于地址开始复制到的偏移量
    
    data - 要复制的数据。
    
    srcOffset - 数据中开始的索引
  - getBoolean
```
public final boolean getBoolean(long offset)
```
    返回该偏移量处的布尔值。
    
    参数
    
    offset - - 相对于地址的偏移量
    
    返回
    
    - 值
  - setBoolean
```
public final void setBoolean(long offset,
                             boolean value)
```
    设置该偏移量处的布尔值。
    
    参数
    
    offset - - 相对于地址的偏移量
    
    value - - 要设置的值
  - setMemory
```
public final void setMemory(long offset,
                            long length,
                            byte value)
```
    在此缓冲区中重复设置值。
    
    参数
    
    offset - - 相对于地址的偏移量
    
    length - - 要设置的字节数
    
    value - - 要设置的值
  - copyFromDeviceBuffer
```
public final void copyFromDeviceBuffer(BaseDeviceMemoryBuffer deviceMemoryBuffer)
```
    同步从 DeviceMemoryBuffer 复制到 HostMemoryBuffer
    
    参数
    
    deviceMemoryBuffer - 要从中复制数据的缓冲区
  - copyFromDeviceBuffer
```
public final void copyFromDeviceBuffer(BaseDeviceMemoryBuffer deviceMemoryBuffer,
                                       Cuda.Stream stream)
```
    使用指定的流从 DeviceMemoryBuffer 复制到 HostMemoryBuffer。此方法返回时，复制已完成，但内存复制可能与在其他流上发生的操作重叠。
    
    参数
    
    deviceMemoryBuffer - 要从中复制数据的缓冲区
    
    stream - 要使用的 CUDA 流
  - copyFromDeviceBufferAsync
```
public final void copyFromDeviceBufferAsync(BaseDeviceMemoryBuffer deviceMemoryBuffer,
                                            Cuda.Stream stream)
```
    使用指定的流从 DeviceMemoryBuffer 复制到 HostMemoryBuffer。复制是异步的，在此方法返回时可能尚未完成。
    
    参数
    
    deviceMemoryBuffer - 要从中复制数据的缓冲区
    
    stream - 要使用的 CUDA 流
  - slice
```
public final HostMemoryBuffer slice(long offset,
                                    long len)
```
    切割主机缓冲区的一部分。
    
    指定者
    
    类 MemoryBuffer 中的 slice
    
    参数
    
    offset - 切割的起始位置。
    
    len - 要切割的字节数
    
    返回
    
    一个主机缓冲区，需要独立于此缓冲区关闭。
  - sliceWithCopy
```
public final HostMemoryBuffer sliceWithCopy(long offset,
                                            long len)
```
    切割主机缓冲区的一部分，并实际复制数据。
    
    参数
    
    offset - 切割的起始位置。
    
    len - 要切割的字节数
    
    返回
    
    一个主机缓冲区，需要独立于此缓冲区关闭。
  - printBuffer
```
public void printBuffer()
```
    警告：仅用于调试的打印缓冲区方法。对大于 2GB 的缓冲区不起作用。
  - printBuffer
```
public void printBuffer(int wordsPerRow)
```
    警告：仅用于调试的打印缓冲区方法。对大于 2GB 的缓冲区不起作用。
    
    参数
    
    wordsPerRow - 每行要打印的 32 位字数。

类 HostMemoryBuffer

嵌套类摘要

从类 ai.rapids.cudf.MemoryBuffer 继承的嵌套类/接口

字段摘要

从类 ai.rapids.cudf.MemoryBuffer 继承的字段

方法摘要

从类 ai.rapids.cudf.MemoryBuffer 继承的方法

从类 java.lang.Object 继承的方法

方法详细信息

allocate

allocate

allocateRaw

mapFile

asByteBuffer

asByteBuffer

copyFromHostBuffer

copyFromStream

getByte

setByte

getBytes

setBytes

getShort

setShort

setShorts

getInt

getInts

setInt

setInts

getLong

setLong

getLongs

setLongs

getFloat

setFloat

setFloats

getDouble

setDouble

setDoubles

getBoolean

setBoolean

setMemory

copyFromDeviceBuffer

copyFromDeviceBuffer

copyFromDeviceBufferAsync

slice

sliceWithCopy

printBuffer

printBuffer