org.nd4j.linalg.dataset.api.iterator.enums

Enum InequalityHandling

java.lang.Object

java.lang.Enum<InequalityHandling>

org.nd4j.linalg.dataset.api.iterator.enums.InequalityHandling

All Implemented Interfaces:

Serializable, Comparable<InequalityHandling>

public enum InequalityHandling
extends Enum<InequalityHandling>

This enum describes different handling options for situations once one of producer runs out of data

Author:

[email protected]

Enum Constant Summary

Enum Constants

Enum Constant and Description
PASS_NULL Parallel iterator will keep returning true on hasNext(), but next() will return null instead of DataSet
RELOCATE Parallel iterator will ignore this producer, and will use other producers.
RESET Parallel iterator will silently reset underlying producer
STOP_EVERYONE Parallel iterator will stop everything once one of producers runs out of data

Method Summary

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

STOP_EVERYONE

public static final InequalityHandling STOP_EVERYONE

Parallel iterator will stop everything once one of producers runs out of data

PASS_NULL

public static final InequalityHandling PASS_NULL

Parallel iterator will keep returning true on hasNext(), but next() will return null instead of DataSet

RESET

public static final InequalityHandling RESET

Parallel iterator will silently reset underlying producer

RELOCATE

public static final InequalityHandling RELOCATE

Parallel iterator will ignore this producer, and will use other producers. PLEASE NOTE: This option will invoke cross-device relocation in multi-device systems.

Method Detail

values

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

Returns:

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

valueOf

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