Enum GradientMode
- All Implemented Interfaces:
Serializable,Comparable<GradientMode>,java.lang.constant.Constable
Enumerate for gradient mode.
- Since:
- 4.1
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>> -
Enum Constant Summary
Enum Constants -
Method Summary
Modifier and TypeMethodDescriptionstatic GradientModeReturns the enum constant of this type with the specified name.static GradientMode[]values()Returns an array containing the constants of this enum type, in the order they are declared.
-
Enum Constant Details
-
EXTERNAL
Compute gradients from the objective and constraints functions themselves. -
FORWARD
Compute gradients using forward difference. -
CENTRAL
Compute gradients using central differences.
-
-
Method Details
-
values
Returns an array containing the constants of this enum type, in the order they are declared.- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
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
-