Class MultiStartMultivariateVectorOptimizer
- java.lang.Object
-
- org.apache.commons.math3.optim.BaseOptimizer<PAIR>
-
- org.apache.commons.math3.optim.BaseMultivariateOptimizer<PAIR>
-
- org.apache.commons.math3.optim.BaseMultiStartMultivariateOptimizer<PointVectorValuePair>
-
- org.apache.commons.math3.optim.nonlinear.vector.MultiStartMultivariateVectorOptimizer
-
@Deprecated public class MultiStartMultivariateVectorOptimizer extends BaseMultiStartMultivariateOptimizer<PointVectorValuePair>
Deprecated.Multi-start optimizer for a (vector) model function. This class wraps an optimizer in order to use it several times in turn with different starting points (trying to avoid being trapped in a local extremum when looking for a global one).- Since:
- 3.0
-
-
Field Summary
Fields Modifier and Type Field Description private java.util.List<PointVectorValuePair>
optima
Deprecated.Found optima.private MultivariateVectorOptimizer
optimizer
Deprecated.Underlying optimizer.-
Fields inherited from class org.apache.commons.math3.optim.BaseOptimizer
evaluations, iterations
-
-
Constructor Summary
Constructors Constructor Description MultiStartMultivariateVectorOptimizer(MultivariateVectorOptimizer 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 protected void
clear()
Deprecated.Method that will called in order to clear all stored optima.PointVectorValuePair[]
getOptima()
Deprecated.Gets all the optima found during the last call tooptimize
.private java.util.Comparator<PointVectorValuePair>
getPairComparator()
Deprecated.protected void
store(PointVectorValuePair optimum)
Deprecated.Method that will be called in order to store each found optimum.-
Methods inherited from class org.apache.commons.math3.optim.BaseMultiStartMultivariateOptimizer
doOptimize, getEvaluations, optimize
-
Methods inherited from class org.apache.commons.math3.optim.BaseMultivariateOptimizer
getLowerBound, getStartPoint, getUpperBound, parseOptimizationData
-
Methods inherited from class org.apache.commons.math3.optim.BaseOptimizer
getConvergenceChecker, getIterations, getMaxEvaluations, getMaxIterations, incrementEvaluationCount, incrementIterationCount, optimize
-
-
-
-
Field Detail
-
optimizer
private final MultivariateVectorOptimizer optimizer
Deprecated.Underlying optimizer.
-
optima
private final java.util.List<PointVectorValuePair> optima
Deprecated.Found optima.
-
-
Constructor Detail
-
MultiStartMultivariateVectorOptimizer
public MultiStartMultivariateVectorOptimizer(MultivariateVectorOptimizer optimizer, int starts, RandomVectorGenerator generator) throws NullArgumentException, NotStrictlyPositiveException
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
, the result will be same as ifoptimizer
is called directly.generator
- Random vector generator to use for restarts.- Throws:
NullArgumentException
- ifoptimizer
orgenerator
isnull
.NotStrictlyPositiveException
- ifstarts < 1
.
-
-
Method Detail
-
getOptima
public PointVectorValuePair[] getOptima()
Deprecated.Gets 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 bynull
elements corresponding to the runs that did not converge. This means all elements will benull
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.
The behaviour is undefined if this method is called beforeoptimize
; it will likely throwNullPointerException
.- Specified by:
getOptima
in classBaseMultiStartMultivariateOptimizer<PointVectorValuePair>
- Returns:
- an array containing the optima sorted from best to worst.
-
store
protected void store(PointVectorValuePair optimum)
Deprecated.Method that will be called in order to store each found optimum.- Specified by:
store
in classBaseMultiStartMultivariateOptimizer<PointVectorValuePair>
- Parameters:
optimum
- Result of an optimization run.
-
clear
protected void clear()
Deprecated.Method that will called in order to clear all stored optima.- Specified by:
clear
in classBaseMultiStartMultivariateOptimizer<PointVectorValuePair>
-
getPairComparator
private java.util.Comparator<PointVectorValuePair> getPairComparator()
Deprecated.- Returns:
- a comparator for sorting the optima.
-
-