Class BaseMultivariateMultiStartOptimizer<FUNC extends MultivariateFunction>
- java.lang.Object
-
- org.apache.commons.math3.optimization.BaseMultivariateMultiStartOptimizer<FUNC>
-
- Type Parameters:
FUNC
- Type of the objective function to be optimized.
- All Implemented Interfaces:
BaseMultivariateOptimizer<FUNC>
,BaseOptimizer<PointValuePair>
- Direct Known Subclasses:
DifferentiableMultivariateMultiStartOptimizer
,MultivariateDifferentiableMultiStartOptimizer
,MultivariateMultiStartOptimizer
@Deprecated public class BaseMultivariateMultiStartOptimizer<FUNC extends MultivariateFunction> extends java.lang.Object implements BaseMultivariateOptimizer<FUNC>
Deprecated.As of 3.1 (to be removed in 4.0).Base class for all implementations of a multi-start optimizer. This interface is mainly intended to enforce the internal coherence of Commons-Math. Users of the API are advised to base their code onMultivariateMultiStartOptimizer
or onDifferentiableMultivariateMultiStartOptimizer
.- Since:
- 3.0
-
-
Field Summary
Fields Modifier and Type Field Description private RandomVectorGenerator
generator
Deprecated.Random generator for multi-start.private int
maxEvaluations
Deprecated.Maximal number of evaluations allowed.private PointValuePair[]
optima
Deprecated.Found optima.private BaseMultivariateOptimizer<FUNC>
optimizer
Deprecated.Underlying classical optimizer.private int
starts
Deprecated.Number of starts to go.private int
totalEvaluations
Deprecated.Number of evaluations already performed for all starts.
-
Constructor Summary
Constructors Modifier Constructor Description protected
BaseMultivariateMultiStartOptimizer(BaseMultivariateOptimizer<FUNC> optimizer, int starts, RandomVectorGenerator generator)
Deprecated.Create a multi-start optimizer from a single-start optimizer.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description ConvergenceChecker<PointValuePair>
getConvergenceChecker()
Deprecated.Get the convergence checker.int
getEvaluations()
Deprecated.Get the number of evaluations of the objective function.int
getMaxEvaluations()
Deprecated.Get the maximal number of function evaluations.PointValuePair[]
getOptima()
Deprecated.Get all the optima found during the last call tooptimize
.PointValuePair
optimize(int maxEval, FUNC f, GoalType goal, double[] startPoint)
Deprecated.Optimize an objective function.private void
sortPairs(GoalType goal)
Deprecated.Sort the optima from best to worst, followed bynull
elements.
-
-
-
Field Detail
-
optimizer
private final BaseMultivariateOptimizer<FUNC extends MultivariateFunction> optimizer
Deprecated.Underlying classical optimizer.
-
maxEvaluations
private int maxEvaluations
Deprecated.Maximal number of evaluations allowed.
-
totalEvaluations
private int totalEvaluations
Deprecated.Number of evaluations already performed for all starts.
-
starts
private int starts
Deprecated.Number of starts to go.
-
generator
private RandomVectorGenerator generator
Deprecated.Random generator for multi-start.
-
optima
private PointValuePair[] optima
Deprecated.Found optima.
-
-
Constructor Detail
-
BaseMultivariateMultiStartOptimizer
protected BaseMultivariateMultiStartOptimizer(BaseMultivariateOptimizer<FUNC> optimizer, int starts, RandomVectorGenerator generator)
Deprecated.Create a multi-start optimizer from a single-start optimizer.- Parameters:
optimizer
- Single-start optimizer to wrap.starts
- Number of starts to perform. Ifstarts == 1
, theoptimize
will return the same solution asoptimizer
would.generator
- Random vector generator to use for restarts.- Throws:
NullArgumentException
- ifoptimizer
orgenerator
isnull
.NotStrictlyPositiveException
- ifstarts < 1
.
-
-
Method Detail
-
getOptima
public PointValuePair[] getOptima()
Deprecated.Get all the optima found during the last call tooptimize
. The optimizer stores all the optima found during a set of restarts. Theoptimize
method returns the best point only. This method returns all the points found at the end of each starts, including the best one already returned by theoptimize
method.
The returned array as one element for each start as specified in the constructor. It is ordered with the results from the runs that did converge first, sorted from best to worst objective value (i.e in ascending order if minimizing and in descending order if maximizing), followed by and null elements corresponding to the runs that did not converge. This means all elements will be null if theoptimize
method did throw an exception. This also means that if the first element is notnull
, it is the best point found across all starts.- Returns:
- an array containing the optima.
- Throws:
MathIllegalStateException
- ifoptimize
has not been called.
-
getMaxEvaluations
public int getMaxEvaluations()
Deprecated.Get the maximal number of function evaluations.- Specified by:
getMaxEvaluations
in interfaceBaseOptimizer<FUNC extends MultivariateFunction>
- Returns:
- the maximal number of function evaluations.
-
getEvaluations
public int getEvaluations()
Deprecated.Get the number of evaluations of the objective function. The number of evaluations corresponds to the last call to theoptimize
method. It is 0 if the method has not been called yet.- Specified by:
getEvaluations
in interfaceBaseOptimizer<FUNC extends MultivariateFunction>
- Returns:
- the number of evaluations of the objective function.
-
getConvergenceChecker
public ConvergenceChecker<PointValuePair> getConvergenceChecker()
Deprecated.Get the convergence checker.- Specified by:
getConvergenceChecker
in interfaceBaseOptimizer<FUNC extends MultivariateFunction>
- Returns:
- the object used to check for convergence.
-
optimize
public PointValuePair optimize(int maxEval, FUNC f, GoalType goal, double[] startPoint)
Deprecated.Optimize an objective function.- Specified by:
optimize
in interfaceBaseMultivariateOptimizer<FUNC extends MultivariateFunction>
- Parameters:
maxEval
- Maximum number of function evaluations.f
- Objective function.goal
- Type of optimization goal: eitherGoalType.MAXIMIZE
orGoalType.MINIMIZE
.startPoint
- Start point for optimization.- Returns:
- the point/value pair giving the optimal value for objective function.
-
sortPairs
private void sortPairs(GoalType goal)
Deprecated.Sort the optima from best to worst, followed bynull
elements.- Parameters:
goal
- Goal type.
-
-