org.apache.commons.math3.optim

Class BaseOptimizer<PAIR>

java.lang.Object

org.apache.commons.math3.optim.BaseOptimizer<PAIR>

Type Parameters:

PAIR - Type of the point/value pair returned by the optimization algorithm.

Direct Known Subclasses:

BaseMultivariateOptimizer, UnivariateOptimizer

public abstract class BaseOptimizer<PAIR>
extends Object

Base class for implementing optimizers. It contains the boiler-plate code for counting the number of evaluations of the objective function and the number of iterations of the algorithm, and storing the convergence checker. It is not a "user" class.

Since:

3.1

Method Summary

Modifier and Type	Method and Description
ConvergenceChecker<PAIR>	getConvergenceChecker() Gets the convergence checker.
int	getEvaluations() Gets the number of evaluations of the objective function.
int	getIterations() Gets the number of iterations performed by the algorithm.
int	getMaxEvaluations() Gets the maximal number of function evaluations.
int	getMaxIterations() Gets the maximal number of iterations.
PAIR	optimize() Performs the optimization.
PAIR	optimize(OptimizationData... optData) Stores data and performs the optimization.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getMaxEvaluations

public int getMaxEvaluations()

Gets the maximal number of function evaluations.

Returns:

the maximal number of function evaluations.

getEvaluations

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:

the number of evaluations of the objective function.

getMaxIterations

public int getMaxIterations()

Gets the maximal number of iterations.

Returns:

the maximal number of iterations.

getIterations

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:

the number of evaluations of the objective function.

getConvergenceChecker

public ConvergenceChecker<PAIR> getConvergenceChecker()

Gets the convergence checker.

Returns:

the object used to check for convergence.

optimize

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 - Optimization data. This method will register the following data:

• MaxEval
• MaxIter

Returns:

a point/value pair that satisfies the convergence criteria.

Throws:

TooManyEvaluationsException - if the maximal number of evaluations is exceeded.

TooManyIterationsException - if the maximal number of iterations is exceeded.

optimize

public PAIR optimize()
              throws TooManyEvaluationsException,
                     TooManyIterationsException

Performs the optimization.

Returns:

a point/value pair that satisfies the convergence criteria.

Throws:

TooManyEvaluationsException - if the maximal number of evaluations is exceeded.

TooManyIterationsException - if the maximal number of iterations is exceeded.