: Class IloCplex.CutCallback

Overview

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

ilog.cplex
Class IloCplex.CutCallback

java.lang.Object
  |
  +--ilog.cplex.IloCplex.Callback
        |
        +--ilog.cplex.IloCplex.MIPCallback
              |
              +--ilog.cplex.IloCplex.ControlCallback
                    |
                    +--ilog.cplex.IloCplex.CutCallback

public abstract static class IloCplex.CutCallback
extends IloCplex.ControlCallback

This class represents a user-written callback in an application that uses an instance of IloCplex to solve a mixed integer programming problem (a MIP). It offers a method to add a cut from a user-written callback. More than one cut can be added in this callback by calling add multiple times.

Since cuts are not removed when backtracking in the search tree, user cuts that are added must be generated in such a way that they are valid for the global problem, and not only in the subtree where they have been generated.

The constructor and methods of this class are protected for use in deriving a user-written callback class, and in implementing the main method in it. If an attempt is made to access information not available to an instance of this class, an exception is thrown.

See Also:: IloCplex.ControlCallback

Constructor Summary
`protected`	`IloCplex.CutCallback()` This constructor creates a callback for use in an application with a user-defined cut.

Method Summary
`protected IloRange`	`add(IloRange cut)` Adds a cut `cut`from a user-written callback.

Methods inherited from class ilog.cplex.IloCplex.ControlCallback

getDownPseudoCost, 
getFeasibilities, 
getFeasibilities, 
getFeasibility, 
getLB, 
getLBs, 
getLBs, 
getObjCoef, 
getObjCoefs, 
getObjCoefs, 
getObjValue, 
getSlack, 
getSlacks, 
getSlacks, 
getSOSFeasibility, 
getSOSFeasibility, 
getUB, 
getUBs, 
getUBs, 
getUpPseudoCost, 
getValue, 
getValue, 
getValues, 
getValues

Methods inherited from class ilog.cplex.IloCplex.MIPCallback

getBestObjValue, 
getCutoff, 
getDirection, 
getIncumbentObjValue, 
getIncumbentValue, 
getIncumbentValues, 
getIncumbentValues, 
getNcliques, 
getNcovers, 
getNdisjunctiveCuts, 
getNflowCovers, 
getNflowPaths, 
getNfractionalCuts, 
getNGUBcovers, 
getNimpliedBounds, 
getNiterations, 
getNMIRs, 
getNnodes, 
getNremainingNodes, 
getPriority, 
isIntegerFeasible

Methods inherited from class ilog.cplex.IloCplex.Callback

abort, 
main

Methods inherited from class java.lang.Object

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

Constructor Detail

IloCplex.CutCallback

protected IloCplex.CutCallback()

This constructor creates a callback for use in an application with a user-defined cut.

Method Detail

add

protected IloRange add(IloRange cut)
                throws IloException

Adds a cut cutfrom a user-written callback. This cut must be globally valid, it will not be removed by backtracking or any other means during the search.

Parameters:: cut - The cut constraint to be added.
Returns:: The cut that has been added.