Package org.nd4j.linalg.api.memory.enums

Enum SpillPolicy

java.lang.Object

java.lang.Enum<SpillPolicy>

org.nd4j.linalg.api.memory.enums.SpillPolicy

All Implemented Interfaces:

Serializable, Comparable<SpillPolicy>

public enum SpillPolicy
extends Enum<SpillPolicy>

Enum Constant Summary

Enum Constants

Enum Constant	Description
EXTERNAL	This policy means - use external allocation for spills.
FAIL	This policy means - no spills will be ever possible, exception will be thrown.
REALLOCATE	This policy means - use external allocation for spills + reallocate at the end of loop.

Method Summary

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

EXTERNAL

public static final SpillPolicy EXTERNAL

This policy means - use external allocation for spills. PLEASE NOTE: external allocations will be released after end of loop is reached.

REALLOCATE

public static final SpillPolicy REALLOCATE

This policy means - use external allocation for spills + reallocate at the end of loop.

FAIL

public static final SpillPolicy FAIL

This policy means - no spills will be ever possible, exception will be thrown. PLEASE NOTE: basically useful for debugging.

Method Detail

values

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

Returns:

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

valueOf

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