Cuda (cudfjni 25.04.0 API)

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

```
public class Cuda
extends Object
```

嵌套类摘要

嵌套类
修饰符和类型类和描述

static class Cuda.Event

static class Cuda.Stream
表示 CUDA stream 的类

嵌套类
修饰符和类型	类和描述
`static class`	`Cuda.Event`
`static class`	`Cuda.Stream` 表示 CUDA stream 的类

字段摘要

字段
修饰符和类型字段和描述

static Cuda.Stream DEFAULT_STREAM

字段
修饰符和类型	字段和描述
`static Cuda.Stream`	`DEFAULT_STREAM`

构造方法摘要

构造方法
构造方法和描述

Cuda()

构造方法
构造方法和描述
`Cuda()`

方法摘要

所有方法静态方法具体方法
修饰符和类型	方法和描述
`static void`	`asyncMemset(long dst, byte value, long count)` 将从 dst 指向的内存区域开始的 count 字节设置为 value。
`static void`	`autoSetDevice()` 将此线程的设备设置为适当的设备。
`static void`	`deviceSynchronize()` 使用 cudaDeviceSynchronize 同步整个设备。
`static void`	`freeZero()` 调用 cudaFree(0)。
`static int`	`getComputeCapabilityMajor()` 获取当前设备的 CUDA 主要计算能力。
`static int`	`getComputeCapabilityMinor()` 获取当前设备的 CUDA 次要计算能力。
`static CudaComputeMode`	`getComputeMode()` 获取当前设备的 CUDA 计算模式。
`static int`	`getDevice()` 获取当前设备的 ID。
`static int`	`getDeviceCount()` 获取设备数量。
`static int`	`getDriverVersion()` 获取 CUDA 驱动程序版本，这是驱动程序支持的最新 CUDA 版本。
`static int`	`getRuntimeVersion()` 获取当前 CUDA Runtime 实例的 CUDA Runtime 版本。
`static boolean`	`isEnvCompatibleForTesting()` 这仅应在测试中使用，用于在当前环境与此库版本不兼容时启用或禁用测试。
`static boolean`	`isPtdsEnabled()` 是否启用每线程默认 stream。
`static CudaMemInfo`	`memGetInfo()` 映射：cudaMemGetInfo(size_t free, size_t total)
`static void`	`memset(long dst, byte value, long count)` 将从 dst 指向的内存区域开始的 count 字节设置为 value。
`static void`	`multiBufferCopyAsync(long[] destAddrs, long[] srcAddrs, long[] copySizes, Cuda.Stream stream)` 将数据从多个设备缓冲区源复制到多个设备缓冲区目标。
`static void`	`profilerStart()` 如果当前已附加性能分析器，则开始一个 Nsight 性能分析会话。
`static void`	`profilerStop()` 停止活动的 Nsight 性能分析会话。
`static void`	`setDevice(int device)` 设置当前设备的 ID。

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

- 字段详细信息
  - DEFAULT_STREAM
```
public static final Cuda.Stream DEFAULT_STREAM
```
- 构造方法详细信息
  - Cuda
```
public Cuda()
```
- 方法详细信息
  - getComputeMode
```
public static CudaComputeMode getComputeMode()
```
    获取当前设备的 CUDA 计算模式。
    
    返回
    
    CudaComputeMode 的枚举值
  - memGetInfo
```
public static CudaMemInfo memGetInfo()
                              throws CudaException
```
    映射：cudaMemGetInfo(size_t *free, size_t *total)
    
    抛出
    
    CudaException
  - memset
```
public static void memset(long dst,
                          byte value,
                          long count)
                   throws CudaException
```
    将从 dst 指向的内存区域开始的 count 字节设置为 value。当此方法返回时，操作已完成，但可能与在其他 stream 上发生的操作重叠。
    
    参数
    
    dst - - 目标内存地址
    
    value - - 用于设置 dst 的字节值
    
    count - - 要设置的字节大小
    
    抛出
    
    CudaException
  - asyncMemset
```
public static void asyncMemset(long dst,
                               byte value,
                               long count)
                        throws CudaException
```
    将从 dst 指向的内存区域开始的 count 字节设置为 value。当此方法返回时，操作不一定已完成，但可能与在其他 stream 上发生的操作重叠。
    
    参数
    
    dst - - 目标内存地址
    
    value - - 用于设置 dst 的字节值
    
    count - - 要设置的字节大小
    
    抛出
    
    CudaException
  - getDevice
```
public static int getDevice()
                     throws CudaException
```
    获取当前设备的 ID。
    
    返回
    
    当前设备的 ID
    
    抛出
    
    CudaException - 发生任何错误时
  - getDeviceCount
```
public static int getDeviceCount()
                          throws CudaException
```
    获取设备数量。
    
    返回
    
    返回具有计算能力的设备数量
    
    抛出
    
    CudaException - 发生任何错误时
  - setDevice
```
public static void setDevice(int device)
                      throws CudaException,
                             CudfException
```
    设置当前设备的 ID。
    请注意，这相对于 CUDA_SET_VISIBLE_DEVICES 设置，例如，如果 CUDA_SET_VISIBLE_DEVICES=1,0，并且您调用 setDevice(0)，您将获得设备 1。
    请注意，如果 RMM 已初始化且请求的设备 ID 与用于初始化 RMM 的设备不匹配，则会抛出错误。
    
    抛出
    
    CudaException - 发生任何错误时
    
    CudfException
  - autoSetDevice
```
public static void autoSetDevice()
                          throws CudaException
```
    将此线程的设备设置为适当的设备。Java 喜欢使用线程，但 CUDA 要求每个线程都显式设置设备，否则会回退到 CUDA_VISIBLE_DEVICES。大多数通过 cudf API 进行的 JNI 调用都会为您处理这一点，但如果您正在编写自己的扩展 cudf 的 JNI 调用，您可能需要在调用您的 JNI API 之前调用此方法以确保设备设置正确。
    
    抛出
    
    CudaException - 发生任何错误时
  - getDriverVersion
```
public static int getDriverVersion()
                            throws CudaException
```
    获取 CUDA 驱动程序版本，这是驱动程序支持的最新 CUDA 版本。版本以 (1000 * 主要版本 + 10 * 次要版本) 的形式返回。例如，CUDA 9.2 将表示为 9020。如果未安装驱动程序，则驱动程序版本返回 0。
    
    返回
    
    CUDA 驱动程序版本
    
    抛出
    
    CudaException - 发生任何错误时
  - getRuntimeVersion
```
public static int getRuntimeVersion()
                             throws CudaException
```
    获取当前 CUDA Runtime 实例的 CUDA Runtime 版本。版本以 (1000 * 主要版本 + 10 * 次要版本) 的形式返回。例如，CUDA 9.2 将表示为 9020。
    
    返回
    
    CUDA Runtime 版本
    
    抛出
    
    CudaException - 发生任何错误时
  - getComputeCapabilityMajor
```
public static int getComputeCapabilityMajor()
                                     throws CudaException
```
    获取当前设备的 CUDA 主要计算能力。参考：https://developer.nvidia.com/cuda-gpus 硬件代次计算能力 Ampere 8.x Turing 7.5 Volta 7.0, 7.2 Pascal 6.x Maxwell 5.x Kepler 3.x Fermi 2.x
    
    返回
    
    当前 CUDA 设备的主要计算能力版本号
    
    抛出
    
    CudaException - 发生任何错误时
  - getComputeCapabilityMinor
```
public static int getComputeCapabilityMinor()
                                     throws CudaException
```
    获取当前设备的 CUDA 次要计算能力。参考：https://developer.nvidia.com/cuda-gpus 硬件代次计算能力 Ampere 8.x Turing 7.5 Volta 7.0, 7.2 Pascal 6.x Maxwell 5.x Kepler 3.x Fermi 2.x
    
    返回
    
    当前 CUDA 设备的次要计算能力版本号
    
    抛出
    
    CudaException - 发生任何错误时
  - freeZero
```
public static void freeZero()
                     throws CudaException
```
    调用 cudaFree(0)。这可以在 setDevice() 后用于初始化 GPU。
    
    抛出
    
    CudaException - 发生任何错误时
  - isEnvCompatibleForTesting
```
public static boolean isEnvCompatibleForTesting()
```
    这仅应在测试中使用，用于在当前环境与此库版本不兼容时启用或禁用测试。目前它只执行一些非常基础的检查，但将来可能会根据需要扩展这些检查。
    
    返回
    
    如果兼容则为 true，否则为 false。
  - isPtdsEnabled
```
public static boolean isPtdsEnabled()
```
    是否启用每线程默认 stream。
  - multiBufferCopyAsync
```
public static void multiBufferCopyAsync(long[] destAddrs,
                                        long[] srcAddrs,
                                        long[] copySizes,
                                        Cuda.Stream stream)
```
    将数据从多个设备缓冲区源复制到多个设备缓冲区目标。对于每个要复制的缓冲区，在目标地址、源地址和复制大小向量中都有相应的条目。
    
    参数
    
    destAddrs - - 设备目标地址向量
    
    srcAddrs - - 设备源地址向量
    
    copySizes - - 复制大小向量
    
    stream - - 用于复制的 CUDA stream
  - profilerStart
```
public static void profilerStart()
```
    如果当前已附加性能分析器，则开始一个 Nsight 性能分析会话。
  - profilerStop
```
public static void profilerStop()
```
    停止活动的 Nsight 性能分析会话。
  - deviceSynchronize
```
public static void deviceSynchronize()
```
    使用 cudaDeviceSynchronize 同步整个设备。

类 Cuda

嵌套类摘要

字段摘要

构造方法摘要

方法摘要

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

字段详细信息

DEFAULT_STREAM

构造方法详细信息

Cuda

方法详细信息

getComputeMode

memGetInfo

memset

asyncMemset

getDevice

getDeviceCount

setDevice

autoSetDevice

getDriverVersion

getRuntimeVersion

getComputeCapabilityMajor

getComputeCapabilityMinor

freeZero

isEnvCompatibleForTesting

isPtdsEnabled

multiBufferCopyAsync

profilerStart

profilerStop

deviceSynchronize