|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IMIP
Interface specifying a Mixed Integer Program
Method Summary | |
---|---|
int |
add(Constraint constraint,
int constraintId)
Adds a new constraint |
java.lang.String |
add(Variable var)
Adds a variable to the MIP formulation. |
void |
addObjectiveTerm(Term term)
Adds a Term to the objective function. |
void |
addObjectiveTerm(Variable var,
double coefficient)
Creates and then adds a Term to the objective function. |
void |
clearProposedValues()
Clears proposed value for this variable |
void |
clearSolveParams()
|
boolean |
getBooleanSolveParam(SolveParam param)
|
boolean |
getBooleanSolveParam(SolveParam param,
java.lang.Boolean defaultValue)
|
Constraint |
getConstraint(int constraintId)
|
java.util.Iterator |
getConstraints()
|
double |
getDoubleSolveParam(SolveParam param)
|
double |
getDoubleSolveParam(SolveParam param,
java.lang.Double defaultValue)
|
int |
getIntSolveParam(SolveParam param)
|
int |
getIntSolveParam(SolveParam param,
java.lang.Integer defaultValue)
|
int |
getNumConstraints()
|
int |
getNumVars()
|
java.util.Iterator |
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 |
java.lang.Object |
getSolveParam(SolveParam param)
These functions control how JOpt operates, and how the backend solver operates. |
java.util.Set |
getSpecefiedSolveParams()
|
java.lang.String |
getStringSolveParam(SolveParam param)
|
java.lang.String |
getStringSolveParam(SolveParam param,
java.lang.String defaultValue)
|
Variable |
getVar(java.lang.String name)
|
java.util.Map |
getVars()
|
java.util.Set |
getVarsWithProposedValues()
useful for copying proposed var/vals to a new MIP |
boolean |
isObjectiveMax()
|
boolean |
isObjectiveMin()
|
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 |
void |
remove(int constraintId)
removes a constraint from the formulation. |
void |
remove(Variable var)
Removes a variable from the MIP formulation. |
void |
removeObjectiveTerm(Term 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 |
setSolveParam(SolveParam param,
boolean value)
|
void |
setSolveParam(SolveParam param,
double value)
|
void |
setSolveParam(SolveParam param,
int value)
|
void |
setSolveParam(SolveParam param,
java.lang.String value)
|
IMIP |
typedClone()
|
Method Detail |
---|
java.util.Map getVars()
Variable getVar(java.lang.String name)
java.lang.String add(Variable var)
void remove(Variable var)
void proposeValue(Variable var, double value)
void proposeValue(Variable var, int value)
void proposeValue(Variable var, boolean value)
void removeProposedValue(Variable var)
void clearProposedValues()
java.util.Set getVarsWithProposedValues()
int getProposedIntValue(Variable var)
double getProposedDoubleValue(Variable var)
boolean getProposedBooleanValue(Variable var)
int getNumVars()
java.util.Iterator getConstraints()
Constraint getConstraint(int constraintId)
constraintId
- the id passed in during constraint creation
int add(Constraint constraint, int constraintId)
constraint
- the constraint to addconstraintId
- should be a UNIQUE number; useful for getting the dual of this constraint
void remove(int constraintId)
constraintId
- int getNumConstraints()
java.util.Iterator getObjectiveTerms()
void addObjectiveTerm(Term term)
term
- void addObjectiveTerm(Variable var, double coefficient)
var
- coefficient
- void removeObjectiveTerm(Term term)
term
- boolean isObjectiveMax()
boolean isObjectiveMin()
void setObjectiveMax(boolean isMax)
isMax
- IMIP typedClone()
java.lang.Object getSolveParam(SolveParam param)
int getIntSolveParam(SolveParam param, java.lang.Integer defaultValue)
getSolveParam(SolveParam)
double getDoubleSolveParam(SolveParam param, java.lang.Double defaultValue)
getSolveParam(SolveParam)
boolean getBooleanSolveParam(SolveParam param, java.lang.Boolean defaultValue)
getSolveParam(SolveParam)
java.lang.String getStringSolveParam(SolveParam param, java.lang.String defaultValue)
getSolveParam(SolveParam)
int getIntSolveParam(SolveParam param)
getSolveParam(SolveParam)
double getDoubleSolveParam(SolveParam param)
getSolveParam(SolveParam)
boolean getBooleanSolveParam(SolveParam param)
getSolveParam(SolveParam)
java.lang.String getStringSolveParam(SolveParam param)
getSolveParam(SolveParam)
void setSolveParam(SolveParam param, int value)
getSolveParam(SolveParam)
void setSolveParam(SolveParam param, double value)
getSolveParam(SolveParam)
void setSolveParam(SolveParam param, boolean value)
getSolveParam(SolveParam)
void setSolveParam(SolveParam param, java.lang.String value)
getSolveParam(SolveParam)
java.util.Set getSpecefiedSolveParams()
getSolveParam(SolveParam)
void clearSolveParams()
getSolveParam(SolveParam)
void resetDefaultSolveParams()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |