Enum Class ConjugateGradientFormula
java.lang.Object
java.lang.Enum<ConjugateGradientFormula>
org.apache.commons.math.optimization.general.ConjugateGradientFormula
- All Implemented Interfaces:
Serializable
,Comparable<ConjugateGradientFormula>
,Constable
Available choices of update formulas for the β parameter
in
NonLinearConjugateGradientOptimizer
.
The β parameter is used to compute the successive conjugate search directions. For non-linear conjugate gradients, there are two formulas to compute β:
- Fletcher-Reeves formula
- Polak-Ribière formula
- Since:
- 2.0
- Version:
- $Revision: 758059 $ $Date: 2009-03-24 23:16:21 +0100 (mar. 24 mars 2009) $
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionFletcher-Reeves formula.Polak-Ribière formula. -
Method Summary
Modifier and TypeMethodDescriptionstatic ConjugateGradientFormula
Returns the enum constant of this class with the specified name.static ConjugateGradientFormula[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
FLETCHER_REEVES
Fletcher-Reeves formula. -
POLAK_RIBIERE
Polak-Ribière formula.
-
-
Method Details
-
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
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 nameNullPointerException
- if the argument is null
-