Package ffx.numerics.optimization

Enum Class LineSearch.LineSearchResult

java.lang.Object

java.lang.Enum<LineSearch.LineSearchResult>

ffx.numerics.optimization.LineSearch.LineSearchResult

All Implemented Interfaces:

Serializable, Comparable<LineSearch.LineSearchResult>, Constable

Enclosing class:

LineSearch

public static enum LineSearch.LineSearchResult
extends Enum<LineSearch.LineSearchResult>

The six possible line search results:

Success, WideAngle, ScaleStep, IntplnErr, ReSearch, BadIntpln

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
BadIntpln	Bad interpolation.
IntplnErr	Interpolation error.
ReSearch	Restart the search.
ScaleStep	Scale the step size.
Success	Successful line search.
WideAngle	Angle between gradient and search direction is too wide.

Method Summary

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

Success

public static final LineSearch.LineSearchResult Success

Successful line search.

WideAngle

public static final LineSearch.LineSearchResult WideAngle

Angle between gradient and search direction is too wide.

ScaleStep

public static final LineSearch.LineSearchResult ScaleStep

Scale the step size.

IntplnErr

public static final LineSearch.LineSearchResult IntplnErr

Interpolation error.

ReSearch

public static final LineSearch.LineSearchResult ReSearch

Restart the search.

BadIntpln

public static final LineSearch.LineSearchResult BadIntpln

Bad interpolation.

Method Details

values

public static LineSearch.LineSearchResult[] 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 LineSearch.LineSearchResult 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