org.apache.commons.math.optimization
Interface BaseOptimizer<PAIR>

Type Parameters:

PAIR - Type of the point/objective pair.

All Known Subinterfaces:

BaseMultivariateRealOptimizer<FUNC>, BaseMultivariateVectorialOptimizer<FUNC>, BaseUnivariateRealOptimizer<FUNC>, DifferentiableMultivariateRealOptimizer, DifferentiableMultivariateVectorialOptimizer, MultivariateRealOptimizer, UnivariateRealOptimizer

All Known Implementing Classes:

AbstractLeastSquaresOptimizer, AbstractScalarDifferentiableOptimizer, AbstractUnivariateRealOptimizer, BaseAbstractScalarOptimizer, BaseAbstractVectorialOptimizer, BaseMultiStartMultivariateRealOptimizer, BaseMultiStartMultivariateVectorialOptimizer, BOBYQAOptimizer, BrentOptimizer, CMAESOptimizer, GaussNewtonOptimizer, LevenbergMarquardtOptimizer, MultiStartDifferentiableMultivariateRealOptimizer, MultiStartDifferentiableMultivariateVectorialOptimizer, MultiStartMultivariateRealOptimizer, MultiStartUnivariateRealOptimizer, NonLinearConjugateGradientOptimizer, PowellOptimizer, SimplexOptimizer

public interface BaseOptimizer<PAIR>

This interface is mainly intended to enforce the internal coherence of Commons-Math. Users of the API are advised to base their code on the following interfaces:

• MultivariateRealOptimizer
• DifferentiableMultivariateRealOptimizer
• DifferentiableMultivariateVectorialOptimizer
• UnivariateRealOptimizer

Since:

3.0

Version:

$Id$

Method Summary

ConvergenceChecker<PAIR>	getConvergenceChecker() Get the convergence checker.
int	getEvaluations() Get the number of evaluations of the objective function.
int	getMaxEvaluations() Get the maximal number of function evaluations.
void	setConvergenceChecker(ConvergenceChecker<PAIR> checker) Set the convergence checker.

Method Detail

getMaxEvaluations

int getMaxEvaluations()

Get the maximal number of function evaluations.

Returns:

the maximal number of function evaluations.

getEvaluations

int getEvaluations()

Get 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.

setConvergenceChecker

void setConvergenceChecker(ConvergenceChecker<PAIR> checker)

Set the convergence checker.

Parameters:

checker - Object to use to check for convergence.

getConvergenceChecker

ConvergenceChecker<PAIR> getConvergenceChecker()

Get the convergence checker.

Returns:

the object used to check for convergence.