ilog.concert

Interface IloObjective

All Superinterfaces:

IloAddable

public interface IloObjective
extends IloAddable

This interface defines the API for objectives. An objective function is defined by an objective expression and an optimization sense. The objective sense is represented by IloObjectiveSense objects and can be IloObjectiveSense.Minimize or IloObjectiveSense.Maximize.

Both the objective sense and expression can be queried and reset. In addition to this, the CPLEX® class IloMPModeler provides methods for manipulating linear objective expressions through its methods setLinearCoef() and setLinearCoefs(). IloMPModeler is available to users of CPLEX.

See Also:

IloModeler.minimize(IloNumExpr), IloModeler.maximize(IloNumExpr), IloModeler.objective(IloObjectiveSense, IloNumExpr), IloModeler.addMinimize(IloNumExpr), IloModeler.addMaximize(IloNumExpr), IloModeler.addObjective(IloObjectiveSense, IloNumExpr), IloObjectiveSense

Method Summary

Methods

Modifier and Type	Method and Description
void	clearExpr() Sets the optimization expression to 0.
double	getConstant() Queries the constant term from the invoking IloObjective.
IloNumExpr	getExpr() Queries the expression of the invoking IloObjective object.
IloObjectiveSense	getSense() Queries the optimization sense of the invoking IloObjective object.
void	setConstant(double val) Sets the constant term from the invoking IloObjective to val.
void	setExpr(IloNumExpr expr) Sets the expression of the invoking IloObjective object.
void	setSense(IloObjectiveSense sense) Sets the optimization sense of the invoking IloObjective object.

Methods inherited from interface ilog.concert.IloAddable

getName, setName

Method Detail

getSense

IloObjectiveSense getSense()
                           throws IloException

Queries the optimization sense of the invoking IloObjective object.

Throws:

IloException

Returns:

The optimization sense.

setSense

void setSense(IloObjectiveSense sense)
              throws IloException

Sets the optimization sense of the invoking IloObjective object.

Throws:

IloException

Parameters:

sense - The new optimization sense.

getExpr

IloNumExpr getExpr()
                   throws IloException

Queries the expression of the invoking IloObjective object.

Throws:

IloException

Returns:

A deep copy of the expression to optimize. The deep copy contains all fields and copies dynamically allocated memory pointed to by those fields.

setExpr

void setExpr(IloNumExpr expr)
             throws IloException

Sets the expression of the invoking IloObjective object.

Throws:

IloException

Parameters:

expr - The new expression to optimize.

clearExpr

void clearExpr()
               throws IloException

Sets the optimization expression to 0.

Throws:

IloException

getConstant

double getConstant()
                   throws IloException

Queries the constant term from the invoking IloObjective.

Throws:

IloException

Returns:

The constant term.

setConstant

void setConstant(double val)
                 throws IloException

Sets the constant term from the invoking IloObjective to val.

Throws:

IloException

Parameters:

val - The new constant term.