Modifier and Type	Class and Description
private static class	BaseOptimizer.MaxEvalCallback Defines the action to perform when reaching the maximum number of evaluations.
private static class	BaseOptimizer.MaxIterCallback Defines the action to perform when reaching the maximum number of evaluations.

Modifier and Type	Field and Description
private final ConvergenceChecker<PAIR>	checker Convergence checker.
protected final Incrementor	evaluations Deprecated as a consequence of `Incrementor` being deprecated. Evaluations counter.
protected final Incrementor	iterations Deprecated as a consequence of `Incrementor` being deprecated. Iterations counter.

Access	Constructor and Description
protected	BaseOptimizer(ConvergenceChecker<PAIR> Convergence checker. checker)
protected	BaseOptimizer(ConvergenceChecker<PAIR> Convergence checker. checker, int Maximum number of objective function evaluations. maxEval, int Maximum number of algorithm iterations. maxIter)

Method Summary

Modifier and Type	Method and Description
protected abstract PAIR	Returns: the point/value pair giving the optimal value of the objective function. doOptimize() Performs the bulk of the optimization algorithm.
public ConvergenceChecker<PAIR>	Returns: the object used to check for convergence. getConvergenceChecker() Gets the convergence checker.
public int	Returns: the number of evaluations of the objective function. getEvaluations() Gets the number of evaluations of the objective function.
public int	Returns: the number of evaluations of the objective function. getIterations() Gets the number of iterations performed by the algorithm.
public int	Returns: the maximal number of function evaluations. getMaxEvaluations() Gets the maximal number of function evaluations.
public int	Returns: the maximal number of iterations. getMaxIterations() Gets the maximal number of iterations.
protected void	incrementEvaluationCount() Increment the evaluation count.
protected void	incrementIterationCount() Increment the iteration count.
public PAIR	Returns: a point/value pair that satisfies the convergence criteria. optimize(OptimizationData... Optimization data. This method will register the following data: `MaxEval` `MaxIter` optData) Stores data and performs the optimization.
public PAIR	Returns: a point/value pair that satisfies the convergence criteria. optimize() Performs the optimization.
protected void	parseOptimizationData(OptimizationData... Optimization data. The following data will be looked for: `MaxEval` `MaxIter` optData) Scans the list of (required and optional) optimization data that characterize the problem.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

checker	back to summary
private final ConvergenceChecker<PAIR> checker Convergence checker.

evaluations	back to summary
protected final Incrementor evaluations Deprecated as a consequence of `Incrementor` being deprecated. See corresponding docs for further information. Evaluations counter.

iterations	back to summary
protected final Incrementor iterations Deprecated as a consequence of `Incrementor` being deprecated. See corresponding docs for further information. Iterations counter.

Constructor Detail

BaseOptimizer	back to summary
protected BaseOptimizer(ConvergenceChecker<PAIR> checker) Parameters checker:ConvergenceChecker<PAIR> Convergence checker.

BaseOptimizer	back to summary
protected BaseOptimizer(ConvergenceChecker<PAIR> checker, int maxEval, int maxIter) Parameters checker:ConvergenceChecker<PAIR> Convergence checker. maxEval:int Maximum number of objective function evaluations. maxIter:int Maximum number of algorithm iterations.

Method Detail

doOptimize	back to summary
protected abstract PAIR doOptimize() Performs the bulk of the optimization algorithm. Returns:PAIR the point/value pair giving the optimal value of the objective function.

doOptimize

back to summary

protected abstract PAIR doOptimize()

Performs the bulk of the optimization algorithm.

Returns:PAIR: the point/value pair giving the optimal value of the objective function.

getConvergenceChecker	back to summary
public ConvergenceChecker<PAIR> getConvergenceChecker() Gets the convergence checker. Returns:ConvergenceChecker<PAIR> the object used to check for convergence.

getConvergenceChecker

back to summary

public ConvergenceChecker<PAIR> getConvergenceChecker()

Gets the convergence checker.

Returns:ConvergenceChecker<PAIR>: the object used to check for convergence.

getEvaluations back to summary

getEvaluations	back to summary
public int getEvaluations() Gets the number of evaluations of the objective function. The number of evaluations corresponds to the last call to the `optimize` method. It is 0 if the method has not been called yet. Returns:int the number of evaluations of the objective function.

public int getEvaluations()

Gets the number of evaluations of the objective function. The number of evaluations corresponds to the last call to the optimize method. It is 0 if the method has not been called yet.

Returns:int: the number of evaluations of the objective function.

getIterations back to summary

getIterations	back to summary
public int getIterations() Gets the number of iterations performed by the algorithm. The number iterations corresponds to the last call to the `optimize` method. It is 0 if the method has not been called yet. Returns:int the number of evaluations of the objective function.

public int getIterations()

Gets the number of iterations performed by the algorithm. The number iterations corresponds to the last call to the optimize method. It is 0 if the method has not been called yet.

Returns:int: the number of evaluations of the objective function.

getMaxEvaluations	back to summary
public int getMaxEvaluations() Gets the maximal number of function evaluations. Returns:int the maximal number of function evaluations.

getMaxEvaluations

back to summary

public int getMaxEvaluations()

Gets the maximal number of function evaluations.

Returns:int: the maximal number of function evaluations.

getMaxIterations	back to summary
public int getMaxIterations() Gets the maximal number of iterations. Returns:int the maximal number of iterations.

getMaxIterations

back to summary

public int getMaxIterations()

Gets the maximal number of iterations.

Returns:int: the maximal number of iterations.

incrementEvaluationCount	back to summary
protected void incrementEvaluationCount() throws TooManyEvaluationsException Increment the evaluation count. Exceptions TooManyEvaluationsException: if the allowed evaluations have been exhausted.

incrementEvaluationCount

back to summary

protected void incrementEvaluationCount() throws TooManyEvaluationsException

Increment the evaluation count.

Exceptions

TooManyEvaluationsException:: if the allowed evaluations have been exhausted.

incrementIterationCount	back to summary
protected void incrementIterationCount() throws TooManyIterationsException Increment the iteration count. Exceptions TooManyIterationsException: if the allowed iterations have been exhausted.

incrementIterationCount

back to summary

protected void incrementIterationCount() throws TooManyIterationsException

Increment the iteration count.

Exceptions

TooManyIterationsException:: if the allowed iterations have been exhausted.

optimize back to summary

optimize	back to summary
public PAIR optimize(OptimizationData... optData) throws TooManyEvaluationsException, TooManyIterationsException 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 `parseOptimizationData(OptimizationData[])` if they need to register their own options; but then, they must also call `super.parseOptimizationData(optData)` within that method. Parameters optData:OptimizationData[] Optimization data. This method will register the following data: `MaxEval` `MaxIter` Returns:PAIR a point/value pair that satisfies the convergence criteria. Exceptions TooManyEvaluationsException: if the maximal number of evaluations is exceeded. TooManyIterationsException: if the maximal number of iterations is exceeded.

public PAIR optimize(OptimizationData... optData) throws TooManyEvaluationsException, TooManyIterationsException

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 parseOptimizationData(OptimizationData[]) if they need to register their own options; but then, they must also call super.parseOptimizationData(optData) within that method.

Parameters

optData:OptimizationData[]

Optimization data. This method will register the following data:

Returns:PAIR

a point/value pair that satisfies the convergence criteria.

Exceptions

TooManyEvaluationsException:: if the maximal number of evaluations is exceeded.
TooManyIterationsException:: if the maximal number of iterations is exceeded.

optimize	back to summary
public PAIR optimize() throws TooManyEvaluationsException, TooManyIterationsException Performs the optimization. Returns:PAIR a point/value pair that satisfies the convergence criteria. Exceptions TooManyEvaluationsException: if the maximal number of evaluations is exceeded. TooManyIterationsException: if the maximal number of iterations is exceeded.

optimize

back to summary

public PAIR optimize() throws TooManyEvaluationsException, TooManyIterationsException

Performs the optimization.

Returns:PAIR

a point/value pair that satisfies the convergence criteria.

Exceptions

TooManyEvaluationsException:: if the maximal number of evaluations is exceeded.
TooManyIterationsException:: if the maximal number of iterations is exceeded.

parseOptimizationData back to summary

parseOptimizationData	back to summary
protected void parseOptimizationData(OptimizationData... optData) Scans the list of (required and optional) optimization data that characterize the problem. Parameters optData:OptimizationData[] Optimization data. The following data will be looked for: `MaxEval` `MaxIter`

protected void parseOptimizationData(OptimizationData... optData)

Scans the list of (required and optional) optimization data that characterize the problem.

Parameters

optData:OptimizationData[]

Optimization data. The following data will be looked for:

org.apache.commons.math3.optim back to summary

private Class BaseOptimizer.MaxEvalCallback

Class Inheritance

extends Object
implements MaxCountExceededCallback

java.lang.Object
org.apache.commons.math3.optim.BaseOptimizer.MaxEvalCallback

All Implemented Interfaces

org.apache.commons.math3.util.Incrementor.MaxCountExceededCallback

Defines the action to perform when reaching the maximum number of evaluations.

Constructor Summary

Access	Constructor and Description
private	MaxEvalCallback()

Method Summary

Modifier and Type	Method and Description
public void	trigger(int Maximal count. max) Implements org.apache.commons.math3.util.Incrementor.MaxCountExceededCallback.trigger. Function called when the maximal count has been reached.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Detail

MaxEvalCallback	back to summary
private MaxEvalCallback()

Method Detail

trigger	back to summary
public void trigger(int max) Implements org.apache.commons.math3.util.Incrementor.MaxCountExceededCallback.trigger. Doc from org.apache.commons.math3.util.Incrementor.MaxCountExceededCallback.trigger. Function called when the maximal count has been reached. Parameters max:int Maximal count.

trigger

back to summary

public void trigger(int max)

Implements org.apache.commons.math3.util.Incrementor.MaxCountExceededCallback.trigger.

Doc from org.apache.commons.math3.util.Incrementor.MaxCountExceededCallback.trigger.

Function called when the maximal count has been reached.

Parameters

max:int: Maximal count.

org.apache.commons.math3.optim back to summary

private Class BaseOptimizer.MaxIterCallback

Class Inheritance

extends Object
implements MaxCountExceededCallback

java.lang.Object
org.apache.commons.math3.optim.BaseOptimizer.MaxIterCallback

All Implemented Interfaces

org.apache.commons.math3.util.Incrementor.MaxCountExceededCallback

Defines the action to perform when reaching the maximum number of evaluations.

Constructor Summary

Access	Constructor and Description
private	MaxIterCallback()

Method Summary

Modifier and Type	Method and Description
public void	trigger(int Maximal count. max) Implements org.apache.commons.math3.util.Incrementor.MaxCountExceededCallback.trigger. Function called when the maximal count has been reached.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Detail

MaxIterCallback	back to summary
private MaxIterCallback()

Method Detail

trigger	back to summary
public void trigger(int max) Implements org.apache.commons.math3.util.Incrementor.MaxCountExceededCallback.trigger. Doc from org.apache.commons.math3.util.Incrementor.MaxCountExceededCallback.trigger. Function called when the maximal count has been reached. Parameters max:int Maximal count.

trigger

back to summary

public void trigger(int max)

Implements org.apache.commons.math3.util.Incrementor.MaxCountExceededCallback.trigger.

Doc from org.apache.commons.math3.util.Incrementor.MaxCountExceededCallback.trigger.

Function called when the maximal count has been reached.

Parameters

max:int: Maximal count.

public abstract Class BaseOptimizer<PAIR>

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class BaseOptimizer.MaxEvalCallback

Constructor Summary

Method Summary

Constructor Detail

Method Detail

private Class BaseOptimizer.MaxIterCallback

Constructor Summary

Method Summary

Constructor Detail

Method Detail