Enum NonLinearConjugateGradientOptimizer.Formula
- java.lang.Object
-
- java.lang.Enum<NonLinearConjugateGradientOptimizer.Formula>
-
- org.apache.commons.math4.legacy.optim.nonlinear.scalar.gradient.NonLinearConjugateGradientOptimizer.Formula
-
- All Implemented Interfaces:
Serializable
,Comparable<NonLinearConjugateGradientOptimizer.Formula>
- Enclosing class:
- NonLinearConjugateGradientOptimizer
public static enum NonLinearConjugateGradientOptimizer.Formula extends Enum<NonLinearConjugateGradientOptimizer.Formula>
Available choices of update formulas for the updating the parameter that is used to compute the successive conjugate search directions. For non-linear conjugate gradients, there are two formulas:- Fletcher-Reeves formula
- Polak-Ribière formula
- Since:
- 2.0
-
-
Enum Constant Summary
Enum Constants Enum Constant Description FLETCHER_REEVES
Fletcher-Reeves formula.POLAK_RIBIERE
Polak-Ribière formula.
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static NonLinearConjugateGradientOptimizer.Formula
valueOf(String name)
Returns the enum constant of this type with the specified name.static NonLinearConjugateGradientOptimizer.Formula[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
FLETCHER_REEVES
public static final NonLinearConjugateGradientOptimizer.Formula FLETCHER_REEVES
Fletcher-Reeves formula.
-
POLAK_RIBIERE
public static final NonLinearConjugateGradientOptimizer.Formula POLAK_RIBIERE
Polak-Ribière formula.
-
-
Method Detail
-
values
public static NonLinearConjugateGradientOptimizer.Formula[] 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 (NonLinearConjugateGradientOptimizer.Formula c : NonLinearConjugateGradientOptimizer.Formula.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static NonLinearConjugateGradientOptimizer.Formula valueOf(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:
IllegalArgumentException
- if this enum type has no constant with the specified nameNullPointerException
- if the argument is null
-
-