Package org.hipparchus.optim.univariate
Class UnivariateOptimizer
- java.lang.Object
-
- org.hipparchus.optim.BaseOptimizer<UnivariatePointValuePair>
-
- org.hipparchus.optim.univariate.UnivariateOptimizer
-
- Direct Known Subclasses:
BrentOptimizer
,MultiStartUnivariateOptimizer
public abstract class UnivariateOptimizer extends BaseOptimizer<UnivariatePointValuePair>
Base class for a univariate scalar function optimizer.
-
-
Field Summary
-
Fields inherited from class org.hipparchus.optim.BaseOptimizer
evaluations, iterations
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
UnivariateOptimizer(ConvergenceChecker<UnivariatePointValuePair> checker)
Simple constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected double
computeObjectiveValue(double x)
Computes the objective function value.GoalType
getGoalType()
Get optimization type.double
getMax()
Get upper bounds.double
getMin()
Get lower bounds.double
getStartValue()
Get initial guess.UnivariatePointValuePair
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 Detail
-
UnivariateOptimizer
protected UnivariateOptimizer(ConvergenceChecker<UnivariatePointValuePair> checker)
Simple constructor.- Parameters:
checker
- Convergence checker.
-
-
Method Detail
-
optimize
public UnivariatePointValuePair optimize(OptimizationData... optData) throws MathIllegalStateException
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<UnivariatePointValuePair>
- 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.
- Throws:
MathIllegalStateException
- if the maximal number of evaluations is exceeded.
-
getGoalType
public GoalType getGoalType()
Get optimization type.- Returns:
- the optimization type
-
parseOptimizationData
protected void parseOptimizationData(OptimizationData... optData)
Scans the list of (required and optional) optimization data that characterize the problem.- Overrides:
parseOptimizationData
in classBaseOptimizer<UnivariatePointValuePair>
- Parameters:
optData
- Optimization data. The following data will be looked for:
-
getStartValue
public double getStartValue()
Get initial guess.- Returns:
- the initial guess
-
getMin
public double getMin()
Get lower bounds.- Returns:
- the lower bounds
-
getMax
public double getMax()
Get upper bounds.- Returns:
- the upper bounds
-
computeObjectiveValue
protected double computeObjectiveValue(double x)
Computes the objective function value. This method must be called by subclasses to enforce the evaluation counter limit.- Parameters:
x
- Point at which the objective function must be evaluated.- Returns:
- the objective function value at the specified point.
- Throws:
MathIllegalStateException
- if the maximal number of evaluations is exceeded.
-
-