ai.rapids.cudf

Enum NaNEquality

java.lang.Object

java.lang.Enum<NaNEquality>

ai.rapids.cudf.NaNEquality

All Implemented Interfaces:

Serializable, Comparable<NaNEquality>

public enum NaNEquality
extends Enum<NaNEquality>

How should NaNs be compared in an operation. In floating point there are multiple different binary representations for NaN.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALL_EQUAL All representations of NaN are considered to be equal.
UNEQUAL No NaN representation is considered equal to any NaN representation, even for the exact same representation.

Method Summary

Modifier and Type	Method and Description
static NaNEquality	valueOf(String name) Returns the enum constant of this type with the specified name.
static NaNEquality[]	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

UNEQUAL

public static final NaNEquality UNEQUAL

No NaN representation is considered equal to any NaN representation, even for the exact same representation.

ALL_EQUAL

public static final NaNEquality ALL_EQUAL

All representations of NaN are considered to be equal.

Method Detail

values

public static NaNEquality[] 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 (NaNEquality c : NaNEquality.values())
    System.out.println(c);

Returns:

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

valueOf

public static NaNEquality 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