Apache Commons Math 3.6.1 · org.apache.commons.math3.optimization.linear.AbstractLinearOptimizer

Field Summary

Modifier and Type	Field and Description
public static final int	DEFAULT_MAX_ITERATIONS Default maximal number of iterations allowed.
private LinearObjectiveFunction	function Deprecated as a consequence of `LinearObjectiveFunction` being deprecated. Linear objective function.
private GoalType	goal Deprecated as a consequence of `GoalType` being deprecated. Type of optimization goal: either `GoalType#MAXIMIZE` or `GoalType#MINIMIZE`.
private int	iterations Number of iterations already performed.
private Collection<LinearConstraint>	linearConstraints Linear constraints.
private int	maxIterations Maximal number of iterations allowed.
private boolean	nonNegative Whether to restrict the variables to non-negative values.

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
protected abstract PointValuePair	Returns: the point/value pair giving the optimal value for objective function doOptimize() Deprecated as a consequence of `PointValuePair` being deprecated. Perform the bulk of optimization algorithm.
protected Collection<LinearConstraint>	Returns: the optimization type. getConstraints()
protected LinearObjectiveFunction	Returns: the optimization type. getFunction() Deprecated as a consequence of `LinearObjectiveFunction` being deprecated.
protected GoalType	Returns: the optimization type. getGoalType() Deprecated as a consequence of `GoalType` being deprecated.
public int	getIterations() Implements org.apache.commons.math3.optimization.linear.LinearOptimizer.getIterations. Get the number of iterations realized by the algorithm.
public int	getMaxIterations() Implements org.apache.commons.math3.optimization.linear.LinearOptimizer.getMaxIterations. Get the maximal number of iterations of the algorithm.
protected void	incrementIterationsCounter() Increment the iterations counter by 1.
public PointValuePair	optimize(final LinearObjectiveFunction linear objective function f, final Collection<LinearConstraint> linear constraints constraints, final GoalType type of optimization goal: either `GoalType#MAXIMIZE` or `GoalType#MINIMIZE` goalType, final boolean whether to restrict the variables to non-negative values restrictToNonNegative) Implements org.apache.commons.math3.optimization.linear.LinearOptimizer.optimize. Deprecated as a consequence of `LinearObjectiveFunction`, `GoalType` and `PointValuePair` being deprecated. Optimizes an objective function.
protected boolean	Returns: `true` if the variables are restricted to non-negative values. restrictToNonNegative()
public void	setMaxIterations(int maximal number of function calls maxIterations) Implements org.apache.commons.math3.optimization.linear.LinearOptimizer.setMaxIterations. Set the maximal number of iterations of the algorithm.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

DEFAULT_MAX_ITERATIONS	back to summary
public static final int DEFAULT_MAX_ITERATIONS Default maximal number of iterations allowed.

function back to summary

function	back to summary
private LinearObjectiveFunction function Deprecated as a consequence of `LinearObjectiveFunction` being deprecated. See corresponding docs for further information. Linear objective function. Since 2.1

private LinearObjectiveFunction function

Deprecated

as a consequence of LinearObjectiveFunction being deprecated. See corresponding docs for further information.

Linear objective function.

Since: 2.1

goal back to summary

goal	back to summary
private GoalType goal Deprecated as a consequence of `GoalType` being deprecated. See corresponding docs for further information. Type of optimization goal: either `GoalType#MAXIMIZE` or `GoalType#MINIMIZE`. Since 2.1

private GoalType goal

Deprecated

as a consequence of GoalType being deprecated. See corresponding docs for further information.

Type of optimization goal: either GoalType#MAXIMIZE or GoalType#MINIMIZE.

Since: 2.1

iterations	back to summary
private int iterations Number of iterations already performed.

linearConstraints	back to summary
private Collection<LinearConstraint> linearConstraints Linear constraints. Since 2.1

linearConstraints

back to summary

private Collection<LinearConstraint> linearConstraints

Linear constraints.

Since: 2.1

maxIterations	back to summary
private int maxIterations Maximal number of iterations allowed.

nonNegative	back to summary
private boolean nonNegative Whether to restrict the variables to non-negative values. Since 2.1

nonNegative

back to summary

private boolean nonNegative

Whether to restrict the variables to non-negative values.

Since: 2.1

Constructor Detail

AbstractLinearOptimizer	back to summary
protected AbstractLinearOptimizer() Simple constructor with default settings. The maximal number of evaluation is set to its default value.

AbstractLinearOptimizer

back to summary

protected AbstractLinearOptimizer()

Simple constructor with default settings.

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

Method Detail

doOptimize back to summary

doOptimize	back to summary
protected abstract PointValuePair doOptimize() throws MathIllegalStateException Deprecated as a consequence of `PointValuePair` being deprecated. See corresponding docs for further information. Perform the bulk of optimization algorithm. Returns:PointValuePair the point/value pair giving the optimal value for objective function Exceptions MathIllegalStateException: if no solution fulfilling the constraints can be found in the allowed number of iterations

protected abstract PointValuePair doOptimize() throws MathIllegalStateException

Deprecated

as a consequence of PointValuePair being deprecated. See corresponding docs for further information.

Perform the bulk of optimization algorithm.

Returns:PointValuePair

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

Exceptions

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

getConstraints	back to summary
protected Collection<LinearConstraint> getConstraints() Returns:Collection<LinearConstraint> the optimization type.

getFunction	back to summary
protected LinearObjectiveFunction getFunction() Deprecated as a consequence of `LinearObjectiveFunction` being deprecated. See corresponding docs for further information. Returns:LinearObjectiveFunction the optimization type.

getGoalType	back to summary
protected GoalType getGoalType() Deprecated as a consequence of `GoalType` being deprecated. See corresponding docs for further information. Returns:GoalType the optimization type.

getIterations back to summary

getIterations	back to summary
public int getIterations() Implements org.apache.commons.math3.optimization.linear.LinearOptimizer.getIterations. Doc from org.apache.commons.math3.optimization.linear.LinearOptimizer.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. Returns:int number of iterations

public int getIterations()

Implements org.apache.commons.math3.optimization.linear.LinearOptimizer.getIterations.

Doc from org.apache.commons.math3.optimization.linear.LinearOptimizer.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.

Returns:int: number of iterations

getMaxIterations	back to summary
public int getMaxIterations() Implements org.apache.commons.math3.optimization.linear.LinearOptimizer.getMaxIterations. Doc from org.apache.commons.math3.optimization.linear.LinearOptimizer.getMaxIterations. Get the maximal number of iterations of the algorithm. Returns:int maximal number of iterations

getMaxIterations

back to summary

public int getMaxIterations()

Implements org.apache.commons.math3.optimization.linear.LinearOptimizer.getMaxIterations.

Doc from org.apache.commons.math3.optimization.linear.LinearOptimizer.getMaxIterations.

Get the maximal number of iterations of the algorithm.

Returns:int: maximal number of iterations

incrementIterationsCounter	back to summary
protected void incrementIterationsCounter() throws MaxCountExceededException Increment the iterations counter by 1. Exceptions MaxCountExceededException: if the maximal number of iterations is exceeded

incrementIterationsCounter

back to summary

protected void incrementIterationsCounter() throws MaxCountExceededException

Increment the iterations counter by 1.

Exceptions

MaxCountExceededException:: if the maximal number of iterations is exceeded

optimize back to summary

optimize	back to summary
public PointValuePair optimize(final LinearObjectiveFunction f, final Collection<LinearConstraint> constraints, final GoalType goalType, final boolean restrictToNonNegative) throws MathIllegalStateException Implements org.apache.commons.math3.optimization.linear.LinearOptimizer.optimize. Doc from org.apache.commons.math3.optimization.linear.LinearOptimizer.optimize. Deprecated as a consequence of `LinearObjectiveFunction`, `GoalType` and `PointValuePair` being deprecated. See corresponding docs for further information. Optimizes an objective function. Parameters f:LinearObjectiveFunction linear objective function constraints:Collection<LinearConstraint> linear constraints goalType:GoalType type of optimization goal: either `GoalType#MAXIMIZE` or `GoalType#MINIMIZE` restrictToNonNegative:boolean whether to restrict the variables to non-negative values Returns:PointValuePair point/value pair giving the optimal value for objective function Exceptions MathIllegalStateException: if no solution fulfilling the constraints can be found in the allowed number of iterations

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

Implements org.apache.commons.math3.optimization.linear.LinearOptimizer.optimize.

Doc from org.apache.commons.math3.optimization.linear.LinearOptimizer.optimize.

Deprecated

as a consequence of LinearObjectiveFunction, GoalType and PointValuePair being deprecated. See corresponding docs for further information.

Optimizes an objective function.

Parameters

f:LinearObjectiveFunction: linear objective function
constraints:Collection<LinearConstraint>: linear constraints
goalType:GoalType: type of optimization goal: either GoalType#MAXIMIZE or GoalType#MINIMIZE
restrictToNonNegative:boolean: whether to restrict the variables to non-negative values

Returns:PointValuePair

point/value pair giving the optimal value for objective function

Exceptions

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

restrictToNonNegative	back to summary
protected boolean restrictToNonNegative() Returns:boolean `true` if the variables are restricted to non-negative values.

setMaxIterations	back to summary
public void setMaxIterations(int maxIterations) Implements org.apache.commons.math3.optimization.linear.LinearOptimizer.setMaxIterations. Doc from org.apache.commons.math3.optimization.linear.LinearOptimizer.setMaxIterations. Set the maximal number of iterations of the algorithm. Parameters maxIterations:int maximal number of function calls

setMaxIterations

back to summary

public void setMaxIterations(int maxIterations)

Implements org.apache.commons.math3.optimization.linear.LinearOptimizer.setMaxIterations.

Doc from org.apache.commons.math3.optimization.linear.LinearOptimizer.setMaxIterations.

Set the maximal number of iterations of the algorithm.

Parameters