com.gams.api.GAMSOptions.EFDOpt Enum Reference
Options for finite differences. More...
Public Member Functions | |
| int | value () |
| Get the int value of this enumerated FDOpt. | |
Static Public Member Functions | |
| static EFDOpt | lookup (int val) |
| Lookup all fDOpts. | |
Public Attributes | |
| GHAnalyticHNumericGradScale =(0) | |
| All derivatives analytically, for numerical Hessian use gradient values, scale delta. | |
| GHAnalyticHNumericFuncScale =(1) | |
| All derivatives analytically, for numerical Hessian use function values, scale delta. | |
| GAnalyticFHNumericGradScale =(2) | |
| Gradient analytically, force Hessian numerically using gradient values, scale delta. | |
| GAnalyticFHNumericFuncScale =(3) | |
| Gradient analytically, force Hessian numerically using function values, scale delta. | |
| FGHNumericScale =(4) | |
| Force gradient and Hessian numerically, scale delta. | |
| GHAnalyticHNumericGradNoScale =(10) | |
| Same as 0, but no scale of delta. | |
| GHAnalyticHNumericFuncNoScale =(11) | |
| Same as 1, but no scale of delta. | |
| GAnalyticFHNumericGradNoScale =(12) | |
| Same as 2, but no scale of delta. | |
| GAnalyticFHNumericFuncNoScale =(13) | |
| Same as 3, but no scale of delta. | |
| FGHNumericNoScale =(14) | |
| Same as 4, but no scale of delta. | |
| UndefinedFDOpt =(15) | |
| Undefined FDOpt. | |
Detailed Description
Options for finite differences.
Member Function Documentation
◆ lookup()
|
static |
Lookup all fDOpts.
- Parameters
-
val an int value to lookup
- Returns
- the enumerated FDOpt that has the specified value, or UndefinedFDOpt if the specified value is not found.
◆ value()
| int com.gams.api.GAMSOptions.EFDOpt.value | ( | ) |
Get the int value of this enumerated FDOpt.
- Returns
- the fDOpt value
Member Data Documentation
◆ FGHNumericNoScale
| com.gams.api.GAMSOptions.EFDOpt.FGHNumericNoScale =(14) |
Same as 4, but no scale of delta.
◆ FGHNumericScale
| com.gams.api.GAMSOptions.EFDOpt.FGHNumericScale =(4) |
Force gradient and Hessian numerically, scale delta.
◆ GAnalyticFHNumericFuncNoScale
| com.gams.api.GAMSOptions.EFDOpt.GAnalyticFHNumericFuncNoScale =(13) |
Same as 3, but no scale of delta.
◆ GAnalyticFHNumericFuncScale
| com.gams.api.GAMSOptions.EFDOpt.GAnalyticFHNumericFuncScale =(3) |
Gradient analytically, force Hessian numerically using function values, scale delta.
◆ GAnalyticFHNumericGradNoScale
| com.gams.api.GAMSOptions.EFDOpt.GAnalyticFHNumericGradNoScale =(12) |
Same as 2, but no scale of delta.
◆ GAnalyticFHNumericGradScale
| com.gams.api.GAMSOptions.EFDOpt.GAnalyticFHNumericGradScale =(2) |
Gradient analytically, force Hessian numerically using gradient values, scale delta.
◆ GHAnalyticHNumericFuncNoScale
| com.gams.api.GAMSOptions.EFDOpt.GHAnalyticHNumericFuncNoScale =(11) |
Same as 1, but no scale of delta.
◆ GHAnalyticHNumericFuncScale
| com.gams.api.GAMSOptions.EFDOpt.GHAnalyticHNumericFuncScale =(1) |
All derivatives analytically, for numerical Hessian use function values, scale delta.
◆ GHAnalyticHNumericGradNoScale
| com.gams.api.GAMSOptions.EFDOpt.GHAnalyticHNumericGradNoScale =(10) |
Same as 0, but no scale of delta.
◆ GHAnalyticHNumericGradScale
| com.gams.api.GAMSOptions.EFDOpt.GHAnalyticHNumericGradScale =(0) |
All derivatives analytically, for numerical Hessian use gradient values, scale delta.
◆ UndefinedFDOpt
| com.gams.api.GAMSOptions.EFDOpt.UndefinedFDOpt =(15) |
Undefined FDOpt.