Package ai.rapids.cudf

Enum OutOfBoundsPolicy

java.lang.Object

java.lang.Enum<OutOfBoundsPolicy>

ai.rapids.cudf.OutOfBoundsPolicy

All Implemented Interfaces:

Serializable, Comparable<OutOfBoundsPolicy>, java.lang.constant.Constable

public enum OutOfBoundsPolicy
extends Enum<OutOfBoundsPolicy>

Policy to account for possible out-of-bounds indices `NULLIFY` means to nullify output values corresponding to out-of-bounds gather map values. `DONT_CHECK` means do not check whether the indices are out-of-bounds, for better performance. Use `DONT_CHECK` carefully, as it can result in a CUDA exception if the gather map values are actually out of range.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
DONT_CHECK
NULLIFY

Method Summary

Modifier and Type	Method	Description
static OutOfBoundsPolicy	valueOf(String name)	Returns the enum constant of this type with the specified name.
static OutOfBoundsPolicy[]	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, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

NULLIFY

public static final OutOfBoundsPolicy NULLIFY

DONT_CHECK

public static final OutOfBoundsPolicy DONT_CHECK

Method Details

values

public static OutOfBoundsPolicy[] values()

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

Returns:

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

valueOf

public static OutOfBoundsPolicy valueOf(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:

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

NullPointerException - if the argument is null