Package ai.onnxruntime

Enum OrtHardwareDevice.OrtHardwareDeviceType

java.lang.Object

java.lang.Enum<OrtHardwareDevice.OrtHardwareDeviceType>

ai.onnxruntime.OrtHardwareDevice.OrtHardwareDeviceType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<OrtHardwareDevice.OrtHardwareDeviceType>

Enclosing class:

OrtHardwareDevice

public static enum OrtHardwareDevice.OrtHardwareDeviceType
extends java.lang.Enum<OrtHardwareDevice.OrtHardwareDeviceType>

The hardware device types.

Enum Constant Summary

Enum Constants

Enum Constant	Description
CPU	A CPU device.
GPU	A GPU device.
NPU	A NPU (Neural Processing Unit) device.

Method Summary

Modifier and Type	Method	Description
int	getValue()	Gets the native value associated with this device type.
static OrtHardwareDevice.OrtHardwareDeviceType	mapFromInt(int deviceType)	Maps from the C API's int enum to the Java enum.
static OrtHardwareDevice.OrtHardwareDeviceType	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static OrtHardwareDevice.OrtHardwareDeviceType[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

CPU

public static final OrtHardwareDevice.OrtHardwareDeviceType CPU

A CPU device.

GPU

public static final OrtHardwareDevice.OrtHardwareDeviceType GPU

A GPU device.

NPU

public static final OrtHardwareDevice.OrtHardwareDeviceType NPU

A NPU (Neural Processing Unit) device.

Method Detail

values

public static OrtHardwareDevice.OrtHardwareDeviceType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (OrtHardwareDevice.OrtHardwareDeviceType c : OrtHardwareDevice.OrtHardwareDeviceType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static OrtHardwareDevice.OrtHardwareDeviceType valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getValue

public int getValue()

Gets the native value associated with this device type.

Returns:

The native value.

mapFromInt

public static OrtHardwareDevice.OrtHardwareDeviceType mapFromInt(int deviceType)

Maps from the C API's int enum to the Java enum.

Parameters:

deviceType - The index of the Java enum.

Returns:

The Java enum.