Package org.tribuo.math.optimisers

Enum Class SGD.Momentum

java.lang.Object

java.lang.Enum<SGD.Momentum>

org.tribuo.math.optimisers.SGD.Momentum

All Implemented Interfaces:

Serializable, Comparable<SGD.Momentum>, Constable

Enclosing class:

SGD

public static enum SGD.Momentum
extends Enum<SGD.Momentum>

Momentum types.

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
NESTEROV	Nesterov momentum.
NONE	No momentum.
STANDARD	Standard momentum.

Method Summary

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

NONE

public static final SGD.Momentum NONE

No momentum.

STANDARD

public static final SGD.Momentum STANDARD

Standard momentum.

NESTEROV

public static final SGD.Momentum NESTEROV

Nesterov momentum.

Method Details

values

public static SGD.Momentum[] 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 SGD.Momentum 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