org.apache.commons.math3.optimization.linear

Class AbstractLinearOptimizer

java.lang.Object

org.apache.commons.math3.optimization.linear.AbstractLinearOptimizer

All Implemented Interfaces:

LinearOptimizer

Direct Known Subclasses:

SimplexSolver

public abstract class AbstractLinearOptimizer
extends Object
implements LinearOptimizer

Base class for implementing linear optimizers.

This base class handles the boilerplate methods associated to thresholds settings and iterations counters.

Since:

2.0

Version:

$Id: AbstractLinearOptimizer.java 1296553 2012-03-03 01:52:06Z erans $

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_MAX_ITERATIONS Default maximal number of iterations allowed.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractLinearOptimizer() Simple constructor with default settings.

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract PointValuePair	doOptimize() Perform the bulk of optimization algorithm.
protected Collection<LinearConstraint>	getConstraints()
protected LinearObjectiveFunction	getFunction()
protected GoalType	getGoalType()
int	getIterations() Get the number of iterations realized by the algorithm.
int	getMaxIterations() Get the maximal number of iterations of the algorithm.
protected void	incrementIterationsCounter() Increment the iterations counter by 1.
PointValuePair	optimize(LinearObjectiveFunction f, Collection<LinearConstraint> constraints, GoalType goalType, boolean restrictToNonNegative) Optimizes an objective function.
protected boolean	restrictToNonNegative()
void	setMaxIterations(int maxIterations) Set the maximal number of iterations of the algorithm.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_MAX_ITERATIONS

public static final int DEFAULT_MAX_ITERATIONS

Default maximal number of iterations allowed.

See Also:

Constant Field Values

Constructor Detail

AbstractLinearOptimizer

protected AbstractLinearOptimizer()

Simple constructor with default settings.

The maximal number of evaluation is set to its default value.

Method Detail

restrictToNonNegative

protected boolean restrictToNonNegative()

Returns:

true if the variables are restricted to non-negative values.

getGoalType

protected GoalType getGoalType()

Returns:

the optimization type.

getFunction

protected LinearObjectiveFunction getFunction()

Returns:

the optimization type.

getConstraints

protected Collection<LinearConstraint> getConstraints()

Returns:

the optimization type.

setMaxIterations

public void setMaxIterations(int maxIterations)

Set the maximal number of iterations of the algorithm.

Specified by:

setMaxIterations in interface LinearOptimizer

Parameters:

maxIterations - maximal number of function calls

getMaxIterations

public int getMaxIterations()

Get the maximal number of iterations of the algorithm.

Specified by:

getMaxIterations in interface LinearOptimizer

Returns:

maximal number of iterations

getIterations

public int getIterations()

Get the number of iterations realized by the algorithm.

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:

getIterations in interface LinearOptimizer

Returns:

number of iterations

incrementIterationsCounter

protected void incrementIterationsCounter()
                                   throws MaxCountExceededException

Increment the iterations counter by 1.

Throws:

MaxCountExceededException - if the maximal number of iterations is exceeded

optimize

public PointValuePair optimize(LinearObjectiveFunction f,
                      Collection<LinearConstraint> constraints,
                      GoalType goalType,
                      boolean restrictToNonNegative)
                        throws MathIllegalStateException

Optimizes an objective function.

Specified by:

optimize in interface LinearOptimizer

Parameters:

f - linear objective function

constraints - linear constraints

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

restrictToNonNegative - whether to restrict the variables to non-negative values

Returns:

point/value pair giving the optimal value for objective function

Throws:

MathIllegalStateException - if no solution fulfilling the constraints can be found in the allowed number of iterations

doOptimize

protected abstract PointValuePair doOptimize()
                                      throws MathIllegalStateException

Perform the bulk of optimization algorithm.

Returns:

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

Throws:

MathIllegalStateException - if no solution fulfilling the constraints can be found in the allowed number of iterations