org.apache.commons.math3.optimization.direct

Class BaseAbstractMultivariateOptimizer<FUNC extends MultivariateFunction>

java.lang.Object

org.apache.commons.math3.optimization.direct.BaseAbstractMultivariateOptimizer<FUNC>

Type Parameters:

FUNC - Type of the objective function to be optimized.

All Implemented Interfaces:

BaseMultivariateOptimizer<FUNC>, BaseOptimizer<PointValuePair>

Direct Known Subclasses:

AbstractDifferentiableOptimizer, AbstractScalarDifferentiableOptimizer, BaseAbstractMultivariateSimpleBoundsOptimizer, PowellOptimizer, SimplexOptimizer

Deprecated.

As of 3.1 (to be removed in 4.0).

@Deprecated
public abstract class BaseAbstractMultivariateOptimizer<FUNC extends MultivariateFunction>
extends Object
implements BaseMultivariateOptimizer<FUNC>

Base class for implementing optimizers for multivariate scalar functions. This base class handles the boiler-plate methods associated to thresholds, evaluations counting, initial guess and simple bounds settings.

Since:

2.2

Method Summary

Modifier and Type	Method and Description
ConvergenceChecker<PointValuePair>	getConvergenceChecker() Deprecated. Get the convergence checker.
int	getEvaluations() Deprecated. Get the number of evaluations of the objective function.
GoalType	getGoalType() Deprecated.
double[]	getLowerBound() Deprecated.
int	getMaxEvaluations() Deprecated. Get the maximal number of function evaluations.
double[]	getStartPoint() Deprecated.
double[]	getUpperBound() Deprecated.
PointValuePair	optimize(int maxEval, FUNC f, GoalType goalType, double[] startPoint) Deprecated. As of 3.1. Please use optimize(int,MultivariateFunction,GoalType,OptimizationData[]) instead.
PointValuePair	optimize(int maxEval, FUNC f, GoalType goalType, OptimizationData... optData) Deprecated. Optimize an objective function.

Methods inherited from class java.lang.Object

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

Method Detail

getMaxEvaluations

public int getMaxEvaluations()

Deprecated.

Get the maximal number of function evaluations.

Specified by:

getMaxEvaluations in interface BaseOptimizer<PointValuePair>

Returns:

the maximal number of function evaluations.

getEvaluations

public int getEvaluations()

Deprecated.

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.

Specified by:

getEvaluations in interface BaseOptimizer<PointValuePair>

Returns:

the number of evaluations of the objective function.

getConvergenceChecker

public ConvergenceChecker<PointValuePair> getConvergenceChecker()

Deprecated.

Get the convergence checker.

Specified by:

getConvergenceChecker in interface BaseOptimizer<PointValuePair>

Returns:

the object used to check for convergence.

optimize

@Deprecated
public PointValuePair optimize(int maxEval,
                                           FUNC f,
                                           GoalType goalType,
                                           double[] startPoint)

Deprecated. As of 3.1. Please use optimize(int,MultivariateFunction,GoalType,OptimizationData[]) instead.

Optimize an objective function.

Specified by:

optimize in interface BaseMultivariateOptimizer<FUNC extends MultivariateFunction>

Parameters:

maxEval - Maximum number of function evaluations.

f - Objective function.

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

startPoint - Start point for optimization.

Returns:

the point/value pair giving the optimal value for objective function.

optimize

public PointValuePair optimize(int maxEval,
                               FUNC f,
                               GoalType goalType,
                               OptimizationData... optData)

Deprecated.

Optimize an objective function.

Parameters:

maxEval - Allowed number of evaluations of the objective function.

f - Objective function.

goalType - Optimization type.

optData - Optimization data. The following data will be looked for:

• InitialGuess
• SimpleBounds

Returns:

the point/value pair giving the optimal value of the objective function.

Since:

3.1

getGoalType

public GoalType getGoalType()

Deprecated.

Returns:

the optimization type.

getStartPoint

public double[] getStartPoint()

Deprecated.

Returns:

the initial guess.

getLowerBound

public double[] getLowerBound()

Deprecated.

Returns:

the lower bounds.

Since:

3.1

getUpperBound

public double[] getUpperBound()

Deprecated.

Returns:

the upper bounds.

Since:

3.1