Package org.hipparchus.optim
Class BaseMultivariateOptimizer<P>
java.lang.Object
org.hipparchus.optim.BaseOptimizer<P>
org.hipparchus.optim.BaseMultivariateOptimizer<P>
- Type Parameters:
P
- Type of the point/value pair returned by the optimization algorithm.
- Direct Known Subclasses:
BaseMultiStartMultivariateOptimizer
,ConstraintOptimizer
,MultivariateOptimizer
Base class for implementing optimizers for multivariate functions.
It contains the boiler-plate code for initial guess and bounds
specifications.
It is not a "user" class.
-
Field Summary
Fields inherited from class org.hipparchus.optim.BaseOptimizer
evaluations, iterations
-
Constructor Summary
ModifierConstructorDescriptionprotected
BaseMultivariateOptimizer
(ConvergenceChecker<P> checker) Simple constructor. -
Method Summary
Modifier and TypeMethodDescriptiondouble[]
Get lower bounds.double[]
Gets the initial guess.double[]
Get upper bounds.optimize
(OptimizationData... optData) Stores data and performs the optimization.protected void
parseOptimizationData
(OptimizationData... optData) Scans the list of (required and optional) optimization data that characterize the problem.Methods inherited from class org.hipparchus.optim.BaseOptimizer
doOptimize, getConvergenceChecker, getEvaluations, getIterations, getMaxEvaluations, getMaxIterations, incrementEvaluationCount, incrementIterationCount, optimize
-
Constructor Details
-
BaseMultivariateOptimizer
Simple constructor.- Parameters:
checker
- Convergence checker.
-
-
Method Details
-
optimize
Stores data and performs the optimization.The list of parameters is open-ended so that sub-classes can extend it with arguments specific to their concrete implementations.
When the method is called multiple times, instance data is overwritten only when actually present in the list of arguments: when not specified, data set in a previous call is retained (and thus is optional in subsequent calls).
Important note: Subclasses must override
BaseOptimizer.parseOptimizationData(OptimizationData[])
if they need to register their own options; but then, they must also callsuper.parseOptimizationData(optData)
within that method.- Overrides:
optimize
in classBaseOptimizer<P>
- Parameters:
optData
- Optimization data. In addition to those documented inBaseOptimizer
, this method will register the following data:- Returns:
- a point/value pair that satisfies the convergence criteria.
-
parseOptimizationData
Scans the list of (required and optional) optimization data that characterize the problem.- Overrides:
parseOptimizationData
in classBaseOptimizer<P>
- Parameters:
optData
- Optimization data. The following data will be looked for:
-
getStartPoint
public double[] getStartPoint()Gets the initial guess.- Returns:
- the initial guess, or
null
if not set.
-
getLowerBound
public double[] getLowerBound()Get lower bounds.- Returns:
- the lower bounds, or
null
if not set.
-
getUpperBound
public double[] getUpperBound()Get upper bounds.- Returns:
- the upper bounds, or
null
if not set.
-