org.ddogleg.optimization

Enum RegionStepType

java.lang.Object

java.lang.Enum<RegionStepType>

org.ddogleg.optimization.RegionStepType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<RegionStepType>

public enum RegionStepType
extends java.lang.Enum<RegionStepType>

Enumerated type for specifying different types of steps for use in TrustRegionLeastSquares.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CAUCHY Performs the optimal step along the gradient line.
DOG_LEG_F Dogleg that decomposes square of the Jacobian directly.
DOG_LEG_FTF Dogleg that decomposes square of the Jacobian, F(x)TF(x).

Method Summary

Modifier and Type	Method and Description
static RegionStepType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static RegionStepType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

CAUCHY

public static final RegionStepType CAUCHY

Performs the optimal step along the gradient line. While fast to compute this has very slow convergence due to it being a pure gradient descent optimization.

See Also:

CauchyStep

DOG_LEG_FTF

public static final RegionStepType DOG_LEG_FTF

Dogleg that decomposes square of the Jacobian, F(x)^TF(x). If the number of functions is much larger than the number of parameters this technique can be a lot faster. However, because of the Jacobian is squared some numerical precision is lost.

See Also:

DoglegStepFtF

DOG_LEG_F

public static final RegionStepType DOG_LEG_F

Dogleg that decomposes square of the Jacobian directly. Has slightly higher precision than the FTF method and is faster when the number of parameters and functions are about equal.

See Also:

DoglegStepF

Method Detail

values

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

Returns:

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

valueOf

public static RegionStepType 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