Package ffx.algorithms.optimize.anneal

Enum Class SimulatedAnnealing.Schedules

java.lang.Object

java.lang.Enum<SimulatedAnnealing.Schedules>

ffx.algorithms.optimize.anneal.SimulatedAnnealing.Schedules

All Implemented Interfaces:

Serializable, Comparable<SimulatedAnnealing.Schedules>, Constable

Enclosing class:

SimulatedAnnealing

public static enum SimulatedAnnealing.Schedules
extends Enum<SimulatedAnnealing.Schedules>

Represents non-composite AnnealingSchedules known (i.e. not FlatEndAnnealSchedule).

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
LINEAR

Method Summary

Modifier and Type	Method	Description
AnnealingSchedule	generate(int nWindows, double tLow, double tHigh)	Creates an AnnealingSchedule corresponding to this enum and provided values.
static SimulatedAnnealing.Schedules	parse(String name)	Attempt to parse a String to a Schedules in a case-insensitive, alias-recognizing fashion.
static SimulatedAnnealing.Schedules	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SimulatedAnnealing.Schedules[]	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

EXP

public static final SimulatedAnnealing.Schedules EXP

LINEAR

public static final SimulatedAnnealing.Schedules LINEAR

Method Details

values

public static SimulatedAnnealing.Schedules[] 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 SimulatedAnnealing.Schedules 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

parse

public static SimulatedAnnealing.Schedules parse(String name)

Attempt to parse a String to a Schedules in a case-insensitive, alias-recognizing fashion.

Parameters:

name - Name of a schedule.

Returns:

A Schedules enum.

generate

public AnnealingSchedule generate(int nWindows,
 double tLow,
 double tHigh)

Creates an AnnealingSchedule corresponding to this enum and provided values.

Parameters:

nWindows - Number of annealing windows.

tLow - Final temperature.

tHigh - Starting temperature.

Returns:

An AnnealingSchedule.