org.apache.commons.math.optimization.univariate
Interface BaseUnivariateRealOptimizer<FUNC extends UnivariateRealFunction>

Type Parameters:

FUNC - Type of the objective function to be optimized.

All Superinterfaces:

BaseOptimizer<UnivariateRealPointValuePair>

All Known Subinterfaces:

UnivariateRealOptimizer

All Known Implementing Classes:

AbstractUnivariateRealOptimizer, BrentOptimizer, MultiStartUnivariateRealOptimizer

public interface BaseUnivariateRealOptimizer<FUNC extends UnivariateRealFunction>
extends BaseOptimizer<UnivariateRealPointValuePair>

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:

• UnivariateRealOptimizer

Since:

3.0

Version:

$Id$

Method Summary

UnivariateRealPointValuePair	optimize(int maxEval, FUNC f, GoalType goalType, double min, double max) Find an optimum in the given interval.
UnivariateRealPointValuePair	optimize(int maxEval, FUNC f, GoalType goalType, double min, double max, double startValue) Find an optimum in the given interval, start at startValue.

Methods inherited from interface org.apache.commons.math.optimization.BaseOptimizer

getConvergenceChecker, getEvaluations, getMaxEvaluations, setConvergenceChecker

Method Detail

optimize

UnivariateRealPointValuePair optimize(int maxEval,
                                      FUNC f,
                                      GoalType goalType,
                                      double min,
                                      double max)

Find an optimum in the given interval. An optimizer may require that the interval brackets a single optimum.

Parameters:

f - Function to optimize.

goalType - Type of optimization goal: either GoalType.MAXIMIZE or GoalType.MINIMIZE.

min - Lower bound for the interval.

max - Upper bound for the interval.

maxEval - Maximum number of function evaluations.

Returns:

a (point, value) pair where the function is optimum.

Throws:

TooManyEvaluationsException - if the maximum evaluation count is exceeded.

ConvergenceException - if the optimizer detects a convergence problem.

java.lang.IllegalArgumentException - if min > max or the endpoints do not satisfy the requirements specified by the optimizer.

optimize

UnivariateRealPointValuePair optimize(int maxEval,
                                      FUNC f,
                                      GoalType goalType,
                                      double min,
                                      double max,
                                      double startValue)

Find an optimum in the given interval, start at startValue. An optimizer may require that the interval brackets a single optimum.

Parameters:

f - Function to optimize.

goalType - Type of optimization goal: either GoalType.MAXIMIZE or GoalType.MINIMIZE.

min - Lower bound for the interval.

max - Upper bound for the interval.

startValue - Start value to use.

maxEval - Maximum number of function evaluations.

Returns:

a (point, value) pair where the function is optimum.

Throws:

TooManyEvaluationsException - if the maximum evaluation count is exceeded.

ConvergenceException - if the optimizer detects a convergence problem.

java.lang.IllegalArgumentException - if min > max or the endpoints do not satisfy the requirements specified by the optimizer.

NullArgumentException - if any argument is null.