Optimizers

Enum ConjugateGradient.Update

java.lang.Object

java.lang.Enum<ConjugateGradient.Update>

Optimizers.ConjugateGradient.Update

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ConjugateGradient.Update>

Enclosing class:

ConjugateGradient

public static enum ConjugateGradient.Update
extends java.lang.Enum<ConjugateGradient.Update>

Enumeration of the different update methods

Enum Constant Summary

Enum Constants

Enum Constant and Description
BEALE_SORENSON_HESTENES_STIEFEL Use the Beale-Sorenson-Hestenes-Stiefel method
FLETCHER_REEVES Use the Fletcher-Reevs method
POLAK_RIBIERE Use the Polak-Ribiere method

Method Summary

Methods

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

FLETCHER_REEVES

public static final ConjugateGradient.Update FLETCHER_REEVES

Use the Fletcher-Reevs method

POLAK_RIBIERE

public static final ConjugateGradient.Update POLAK_RIBIERE

Use the Polak-Ribiere method

BEALE_SORENSON_HESTENES_STIEFEL

public static final ConjugateGradient.Update BEALE_SORENSON_HESTENES_STIEFEL

Use the Beale-Sorenson-Hestenes-Stiefel method

Method Detail

values

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

Returns:

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

valueOf

public static ConjugateGradient.Update valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null