IMIP (Java Optimization 1.3.0 API)

All Superinterfaces:

Serializable

All Known Implementing Classes:

MIP, MIPWrapper
```
public interface IMIP
extends Serializable
```
Interface specifying a Mixed Integer Program

Since:

Apr 12, 2004

Version:

$Revision: 1.2 $ on $Date: 2017/11/08 12:55:46 $

Author:

Benjamin Lubin; Last modified by $Author: blubin $

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`add(Constraint constraint)` Adds a new constraint
`String`	`add(Variable var)` Adds a variable to the MIP formulation.
`void`	`addObjectiveTerm(double coefficient, Variable var)` Adds a Term to the objective function.
`void`	`addObjectiveTerm(double coefficient, Variable varA, Variable varB)` Adds a Term to the objective function.
`void`	`addObjectiveTerm(LinearTerm term)` Adds a Term to the objective function.
`void`	`addObjectiveTerm(QuadraticTerm term)` Adds a Term to the objective function.
`boolean`	`clearObjective()` Removes the objective
`void`	`clearProposedValues()` Clears proposed value for this variable
`void`	`clearSolveParams()`
`boolean`	`getBooleanSolveParam(SolveParam param)`
`boolean`	`getBooleanSolveParam(SolveParam param, boolean defaultValue)`
`boolean`	`getBooleanSolveParam(SolveParam param, Boolean defaultValue)`
`List<Constraint>`	`getConstraints()`
`double`	`getDoubleSolveParam(SolveParam param)`
`double`	`getDoubleSolveParam(SolveParam param, double defaultValue)`
`double`	`getDoubleSolveParam(SolveParam param, Double defaultValue)`
`int`	`getIntSolveParam(SolveParam param)`
`int`	`getIntSolveParam(SolveParam param, int defaultValue)`
`int`	`getIntSolveParam(SolveParam param, Integer defaultValue)`
`Collection<LinearTerm>`	`getLinearObjectiveTerms()`
`int`	`getNumConstraints()`
`int`	`getNumVars()`
`Collection<Term>`	`getObjectiveTerms()`
`boolean`	`getProposedBooleanValue(Variable var)` returns the currently proposed value for Boolean variable var
`double`	`getProposedDoubleValue(Variable var)` returns the currently proposed value for Double variable var
`int`	`getProposedIntValue(Variable var)` returns the currently proposed value for Integer variable var
`Map<Variable,Object>`	`getProposedValuesMap()` useful for copying proposed var/vals to a new MIP
`Collection<QuadraticTerm>`	`getQuadraticObjectiveTerms()`
`Object`	`getSolveParam(SolveParam param)` These functions control how JOpt operates, and how the backend solver operates.
`Collection<LinearTerm>`	`getSortedLinearObjectiveTerms()` Get the terms sorted lexicographically
`Collection<QuadraticTerm>`	`getSortedQuadraticObjectiveTerms()` Get the terms sorted lexicographically
`Set<SolveParam>`	`getSpecifiedSolveParams()`
`String`	`getStringSolveParam(SolveParam param)`
`String`	`getStringSolveParam(SolveParam param, String defaultValue)`
`Variable`	`getVar(String name)`
`Map<String,Variable>`	`getVars()`
`Set<Variable>`	`getVarsWithProposedValues()` useful for copying proposed var/vals to a new MIP
`boolean`	`isObjectiveMax()`
`boolean`	`isObjectiveMin()`
`boolean`	`isSolveParamSpecified(SolveParam param)`
`void`	`proposeValue(Variable var, boolean value)` Sets proposed value for this variable
`void`	`proposeValue(Variable var, double value)` Sets proposed value for this variable
`void`	`proposeValue(Variable var, int value)` Sets proposed value for this variable
`boolean`	`remove(Constraint constraint)` removes a constraint from the formulation.
`void`	`remove(Variable var)` Removes a variable from the MIP formulation.
`void`	`removeObjectiveTerm(LinearTerm term)` removes a Term from the objective function.
`void`	`removeObjectiveTerm(QuadraticTerm term)` removes a Term from the objective function.
`void`	`removeProposedValue(Variable var)` Removes proposed value for this variable
`void`	`resetDefaultSolveParams()` reset behavior is solver specific; see implementing class
`void`	`setObjectiveMax(boolean isMax)` Set the objective to be MAX (true) or MIN (false)
`void`	`setProposedValues(Map<Variable,Object> proposedValues)` useful for copying proposed var/vals to a new MIP
`void`	`setSolveParam(SolveParam param, Object value)`
`IMIP`	`typedClone()`

- Method Detail
  - getVars
```
Map<String,Variable> getVars()
```
    Returns:
    
    a Map from Strings to Variables.
  - getVar
```
Variable getVar(String name)
```
    Returns:
    
    the Variable corresponding to the String name.
  - add
```
String add(Variable var)
```
    Adds a variable to the MIP formulation. Depending on the implementation you may find that this variable doesn't show up in the solver. (For instance if there is no reference to the variable in any constraint
    
    Returns:
    
    the string representation of the variable
  - remove
```
void remove(Variable var)
```
    Removes a variable from the MIP formulation. Depending on the implementation this may not actually communicate with the solver, if this variable is unused by the solver.
  - getNumVars
```
int getNumVars()
```
    Returns:
    
    the number of variables in the MIP formulation.
  - proposeValue
```
void proposeValue(Variable var,
                  double value)
```
    Sets proposed value for this variable
  - proposeValue
```
void proposeValue(Variable var,
                  int value)
```
    Sets proposed value for this variable
  - proposeValue
```
void proposeValue(Variable var,
                  boolean value)
```
    Sets proposed value for this variable
  - removeProposedValue
```
void removeProposedValue(Variable var)
```
    Removes proposed value for this variable
  - clearProposedValues
```
void clearProposedValues()
```
    Clears proposed value for this variable
  - getVarsWithProposedValues
```
Set<Variable> getVarsWithProposedValues()
```
    useful for copying proposed var/vals to a new MIP
  - getProposedValuesMap
```
Map<Variable,Object> getProposedValuesMap()
```
    useful for copying proposed var/vals to a new MIP
  - setProposedValues
```
void setProposedValues(Map<Variable,Object> proposedValues)
```
    useful for copying proposed var/vals to a new MIP
  - getProposedIntValue
```
int getProposedIntValue(Variable var)
```
    returns the currently proposed value for Integer variable var
  - getProposedDoubleValue
```
double getProposedDoubleValue(Variable var)
```
    returns the currently proposed value for Double variable var
  - getProposedBooleanValue
```
boolean getProposedBooleanValue(Variable var)
```
    returns the currently proposed value for Boolean variable var
  - getLinearObjectiveTerms
```
Collection<LinearTerm> getLinearObjectiveTerms()
```
    Returns:
    
    an iterator on the Linear objective Term objects
  - getSortedLinearObjectiveTerms
```
Collection<LinearTerm> getSortedLinearObjectiveTerms()
```
    Get the terms sorted lexicographically
  - addObjectiveTerm
```
void addObjectiveTerm(LinearTerm term)
```
    Adds a Term to the objective function.
    
    Parameters:
    
    term -
  - addObjectiveTerm
```
void addObjectiveTerm(double coefficient,
                      Variable var)
```
    Adds a Term to the objective function.
    
    Parameters:
    
    term -
  - removeObjectiveTerm
```
void removeObjectiveTerm(LinearTerm term)
```
    removes a Term from the objective function.
    
    Parameters:
    
    term -
  - getQuadraticObjectiveTerms
```
Collection<QuadraticTerm> getQuadraticObjectiveTerms()
```
    Returns:
    
    an iterator on the objective Quadratic Term objects
  - getSortedQuadraticObjectiveTerms
```
Collection<QuadraticTerm> getSortedQuadraticObjectiveTerms()
```
    Get the terms sorted lexicographically
  - addObjectiveTerm
```
void addObjectiveTerm(QuadraticTerm term)
```
    Adds a Term to the objective function.
    
    Parameters:
    
    term -
  - addObjectiveTerm
```
void addObjectiveTerm(double coefficient,
                      Variable varA,
                      Variable varB)
```
    Adds a Term to the objective function.
    
    Parameters:
    
    term -
  - removeObjectiveTerm
```
void removeObjectiveTerm(QuadraticTerm term)
```
    removes a Term from the objective function.
    
    Parameters:
    
    term -
  - clearObjective
```
boolean clearObjective()
```
    Removes the objective
    
    Returns:
    
    whether a previous objective was set
  - getObjectiveTerms
```
Collection<Term> getObjectiveTerms()
```
    Returns:
    
    All the Term objects
  - isObjectiveMax
```
boolean isObjectiveMax()
```
    Returns:
    
    true if objective is a max
  - isObjectiveMin
```
boolean isObjectiveMin()
```
    Returns:
    
    true if objective is a min
  - setObjectiveMax
```
void setObjectiveMax(boolean isMax)
```
    Set the objective to be MAX (true) or MIN (false)
    
    Parameters:
    
    isMax -
  - getConstraints
```
List<Constraint> getConstraints()
```
    Returns:
    
    An iterator over the constraints
  - getNumConstraints
```
int getNumConstraints()
```
    Returns:
    
    the number of constraints in the system
  - add
```
void add(Constraint constraint)
```
    Adds a new constraint
    
    Parameters:
    
    constraint - the constraint to add
  - remove
```
boolean remove(Constraint constraint)
```
    removes a constraint from the formulation.
    
    Parameters:
    
    constraint -
    
    Returns:
  - getSolveParam
```
Object getSolveParam(SolveParam param)
```
    These functions control how JOpt operates, and how the backend solver operates. You can control a number of parameters. Not all of these will be supported by your chosen backend solver, unfortunently. But we try to map these settings into relevant solver settings. See each setting to see if they are applicable to CPLEX, LPSOLVE, or ALLSOLVERS
  - getIntSolveParam
```
int getIntSolveParam(SolveParam param,
                     int defaultValue)
```
    See Also:
    
    getSolveParam(SolveParam)
  - getDoubleSolveParam
```
double getDoubleSolveParam(SolveParam param,
                           double defaultValue)
```
    See Also:
    
    getSolveParam(SolveParam)
  - getBooleanSolveParam
```
boolean getBooleanSolveParam(SolveParam param,
                             boolean defaultValue)
```
    See Also:
    
    getSolveParam(SolveParam)
  - getIntSolveParam
```
int getIntSolveParam(SolveParam param,
                     Integer defaultValue)
```
    See Also:
    
    getSolveParam(SolveParam)
  - getDoubleSolveParam
```
double getDoubleSolveParam(SolveParam param,
                           Double defaultValue)
```
    See Also:
    
    getSolveParam(SolveParam)
  - getBooleanSolveParam
```
boolean getBooleanSolveParam(SolveParam param,
                             Boolean defaultValue)
```
    See Also:
    
    getSolveParam(SolveParam)
  - getStringSolveParam
```
String getStringSolveParam(SolveParam param,
                           String defaultValue)
```
    See Also:
    
    getSolveParam(SolveParam)
  - getIntSolveParam
```
int getIntSolveParam(SolveParam param)
```
    See Also:
    
    getSolveParam(SolveParam)
  - getDoubleSolveParam
```
double getDoubleSolveParam(SolveParam param)
```
    See Also:
    
    getSolveParam(SolveParam)
  - getBooleanSolveParam
```
boolean getBooleanSolveParam(SolveParam param)
```
    See Also:
    
    getSolveParam(SolveParam)
  - getStringSolveParam
```
String getStringSolveParam(SolveParam param)
```
    See Also:
    
    getSolveParam(SolveParam)
  - setSolveParam
```
void setSolveParam(SolveParam param,
                   Object value)
```
    See Also:
    
    getSolveParam(SolveParam)
  - getSpecifiedSolveParams
```
Set<SolveParam> getSpecifiedSolveParams()
```
    See Also:
    
    getSolveParam(SolveParam)
  - isSolveParamSpecified
```
boolean isSolveParamSpecified(SolveParam param)
```
  - clearSolveParams
```
void clearSolveParams()
```
    See Also:
    
    getSolveParam(SolveParam)
  - resetDefaultSolveParams
```
void resetDefaultSolveParams()
```
    reset behavior is solver specific; see implementing class
  - typedClone
```
IMIP typedClone()
```

Interface IMIP

Method Summary

Method Detail

getVars

getVar

add

remove

getNumVars

proposeValue

proposeValue

proposeValue

removeProposedValue

clearProposedValues

getVarsWithProposedValues

getProposedValuesMap

setProposedValues

getProposedIntValue

getProposedDoubleValue

getProposedBooleanValue

getLinearObjectiveTerms

getSortedLinearObjectiveTerms

addObjectiveTerm

addObjectiveTerm

removeObjectiveTerm

getQuadraticObjectiveTerms

getSortedQuadraticObjectiveTerms

addObjectiveTerm

addObjectiveTerm

removeObjectiveTerm

clearObjective

getObjectiveTerms

isObjectiveMax

isObjectiveMin

setObjectiveMax

getConstraints

getNumConstraints

add

remove

getSolveParam

getIntSolveParam

getDoubleSolveParam

getBooleanSolveParam

getIntSolveParam

getDoubleSolveParam

getBooleanSolveParam

getStringSolveParam

getIntSolveParam

getDoubleSolveParam

getBooleanSolveParam

getStringSolveParam

setSolveParam

getSpecifiedSolveParams

isSolveParamSpecified

clearSolveParams

resetDefaultSolveParams

typedClone