Package ai.djl.training.tracker

Enum Class CyclicalTracker.CyclicalMode

java.lang.Object

java.lang.Enum<CyclicalTracker.CyclicalMode>

ai.djl.training.tracker.CyclicalTracker.CyclicalMode

All Implemented Interfaces:

Serializable, Comparable<CyclicalTracker.CyclicalMode>, Constable

Enclosing class:

CyclicalTracker

public static enum CyclicalTracker.CyclicalMode
extends Enum<CyclicalTracker.CyclicalMode>

CyclicalTracker provides three predefined cyclical modes and can be selected by this enum.

• TRIANGULAR: A basic triangular cycle without amplitude scaling.
• TRIANGULAR2: A basic triangular cycle that scales initial amplitude by half each cycle.
• EXP_RANGE: A cycle that scales initial amplitude by (gamma^{cycleIterations}) at each cycle iteration.

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
EXP_RANGE
TRIANGULAR
TRIANGULAR2

Method Summary

Modifier and Type	Method	Description
static CyclicalTracker.CyclicalMode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static CyclicalTracker.CyclicalMode[]	values()	Returns an array containing the constants of this enum class, 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

TRIANGULAR

public static final CyclicalTracker.CyclicalMode TRIANGULAR

TRIANGULAR2

public static final CyclicalTracker.CyclicalMode TRIANGULAR2

EXP_RANGE

public static final CyclicalTracker.CyclicalMode EXP_RANGE

Method Details

values

public static CyclicalTracker.CyclicalMode[] values()

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

Returns:

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

valueOf

public static CyclicalTracker.CyclicalMode valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null