Using callbacks in a discrete model

These routines implement callbacks in a discrete model, such as a mixed integer program (MIP).

CPXXbranchcallbackbranchasCPLEX and CPXbranchcallbackbranchasCPLEX
The routine CPXXbranchcallbackbranchasCPLEX/CPXbranchcallbackbranchasCPLEX accomplishes two tasks.
CPXXbranchcallbackbranchbds and CPXbranchcallbackbranchbds
The routine CPXXbranchcallbackbranchbds/CPXbranchcallbackbranchbds specifies the branches to be taken from the current node.
CPXXbranchcallbackbranchconstraints and CPXbranchcallbackbranchconstraints
The routine CPXXbranchcallbackbranchconstraints/CPXbranchcallbackbranchconstraints specifies the branches to be taken from the current node when the branch is specified by adding one or more constraints to the node problem.
CPXXbranchcallbackbranchgeneral and CPXbranchcallbackbranchgeneral
The routine CPXXbranchcallbackbranchgeneral/CPXbranchcallbackbranchgeneral specifies the branches to be taken from the current node when the branch includes variable bound changes and additional constraints.
CPXXcallbackgetlocallb and CPXcallbackgetlocallb
The routine CPXXcallbackgetlocallb/CPXcallbackgetlocallb retrieves the lower bound values for the subproblem at the current node during MIP optimization from within a user-written callback.
CPXXcallbackgetlocalub and CPXcallbackgetlocalub
The routine CPXXcallbackgetlocalub/CPXcallbackgetlocalub retrieves the upper bound values for the subproblem at the current node during MIP optimization from within a user-written callback.
CPXXcallbackgetgloballb and CPXcallbackgetgloballb
The routine CPXXcallbackgetgloballb/CPXcallbackgetgloballb retrieves the best known globally valid lower bound values during MIP optimization from within a user-written callback.
CPXXcallbackgetglobalub and CPXcallbackgetglobalub
The routine CPXXcallbackgetglobalub/CPXcallbackgetglobalub retrieves the best known globally valid upper bound values during MIP optimization from within a user-written callback.
CPXXcallbacksetnodeuserhandle and CPXcallbacksetnodeuserhandle
The routine CPXXcallbacksetnodeuserhandle/CPXcallbacksetnodeuserhandle sets the user handle for the node specified by nodeindex and optionally returns the old user handle stored at that node.
CPXXcallbacksetuserhandle and CPXcallbacksetuserhandle
The routine CPXXcallbacksetuserhandle/CPXcallbacksetuserhandle sets the user handle at the current node and optionally returns the old user handle stored at the current node.
CPXXcutcallbackadd and CPXcutcallbackadd
The routine CPXXcutcallbackadd/CPXcutcallbackadd adds lazy constraints and globally valid cuts to the current node LP subproblem during MIP branch and cut.
CPXXcutcallbackaddlocal and CPXcutcallbackaddlocal
The routine CPXXcutcallbackaddlocal/CPXcutcallbackaddlocal adds local cuts during MIP branch and cut.
CPXXgetbranchcallbackfunc and CPXgetbranchcallbackfunc
The routine CPXXgetbranchcallbackfunc/CPXgetbranchcallbackfunc accesses the user-written callback routine to be called during MIP optimization after a branch has been selected but before the branch is carried out.
CPXXgetbranchnosolncallbackfunc and CPXgetbranchnosolncallbackfunc
This routine accesses the user-written callback to be called during MIP optimization when branching when no solution is available.
CPXXgetcallbackctype and CPXgetcallbackctype
The routine CPXXgetcallbackctype/CPXgetcallbackctype retrieves the ctypes for the MIP problem from within a user-written callback during MIP optimization.
CPXXgetcallbackgloballb and CPXgetcallbackgloballb
The routine CPXXgetcallbackgloballb/CPXgetcallbackgloballb retrieves the best known global lower bound values during MIP optimization from within a user-written callback.
CPXXgetcallbackglobalub and CPXgetcallbackglobalub
The routine CPXXgetcallbackglobalub/CPXgetcallbackglobalub retrieves the best known global upper bound values during MIP optimization from within a user-written callback.
CPXXgetcallbackincumbent and CPXgetcallbackincumbent
The routine CPXXgetcallbackincumbent/CPXgetcallbackincumbent retrieves the incumbent values during MIP optimization from within a user-written callback.
CPXXgetcallbackindicatorinfo and CPXgetcallbackindicatorinfo
The routine CPXXgetcallbackindicatorinfo/CPXgetcallbackindicatorinfo accesses information about the indicator constraints of the presolved problem during MIP callbacks.
CPXXgetcallbacklp and CPXgetcallbacklp
The routine CPXXgetcallbacklp/CPXgetcallbacklp retrieves the pointer to the MIP problem that is in use when the user-written callback function is called.
CPXXgetcallbacknodeinfo and CPXgetcallbacknodeinfo
The routine CPXXgetcallbacknodeinfo/CPXgetcallbacknodeinfo is called from within user-written callbacks during a MIP optimization and accesses information about nodes.
CPXXgetcallbacknodeintfeas and CPXgetcallbacknodeintfeas
The routine CPXXgetcallbacknodeintfeas/CPXgetcallbacknodeintfeas retrieves information for each variable about whether or not the variable is integer feasible in the subproblem at the current node.
CPXXgetcallbacknodelb and CPXgetcallbacknodelb
The routine CPXXgetcallbacknodelb/CPXgetcallbacknodelb retrieves the lower bound values for the subproblem at the current node during MIP optimization from within a user-written callback.
CPXXgetcallbacknodelp and CPXgetcallbacknodelp
The routine CPXXgetcallbacknodelp/CPXgetcallbacknodelp returns a pointer to the subproblem at the current node from within a user-written callback.
CPXXgetcallbacknodeobjval and CPXgetcallbacknodeobjval
The routine CPXXgetcallbacknodeobjval/CPXgetcallbacknodeobjval retrieves the objective value for the subproblem at the current node during MIP optimization from within a user-written callback.
CPXXgetcallbacknodestat and CPXgetcallbacknodestat
The routine CPXXgetcallbacknodestat/CPXgetcallbacknodestat retrieves the optimization status of the subproblem at the current node from within a user-written callback during MIP optimization.
CPXXgetcallbacknodeub and CPXgetcallbacknodeub
The routine CPXXgetcallbacknodeub/CPXgetcallbacknodeub retrieves the upper bound values for the subproblem at the current node during MIP optimization from within a user-written callback.
CPXXgetcallbacknodex and CPXgetcallbacknodex
The routine CPXXgetcallbacknodex/CPXgetcallbacknodex retrieves the primal variable (x) values for the subproblem at the current node during MIP optimization from within a user-written callback.
CPXXgetcallbackorder and CPXgetcallbackorder
The routine CPXXgetcallbackorder/CPXgetcallbackorder retrieves MIP priority order information during MIP optimization from within a user-written callback.
CPXXgetcallbackpseudocosts and CPXgetcallbackpseudocosts
The routine CPXXgetcallbackpseudocosts/CPXgetcallbackpseudocosts retrieves the pseudo-cost values during MIP optimization from within a user-written callback.
CPXXgetcallbackseqinfo and CPXgetcallbackseqinfo
The routine CPXXgetcallbackseqinfo/CPXgetcallbackseqinfo accesses information about nodes during the MIP optimization from within user-written callbacks.
CPXXgetcallbacksosinfo and CPXgetcallbacksosinfo
The routine CPXXgetcallbacksosinfo/CPXgetcallbacksosinfo accesses information about special ordered sets (SOSs) during MIP optimization from within user-written callbacks.
CPXXgetdeletenodecallbackfunc and CPXgetdeletenodecallbackfunc
The routine CPXXgetdeletenodecallbackfunc/CPXgetdeletenodecallbackfunc accesses the user-written callback to be called during MIP optimization when a node is to be deleted.
CPXXgetheuristiccallbackfunc and CPXgetheuristiccallbackfunc
The routine CPXXgetheuristiccallbackfunc/CPXgetheuristiccallbackfunc accesses the user-written callback to be called by CPLEX during MIP optimization after the subproblem has been solved to optimality.
CPXXgetincumbentcallbackfunc and CPXgetincumbentcallbackfunc
The routine CPXXgetincumbentcallbackfunc/CPXgetincumbentcallbackfunc accesses the user-written callback to be called by CPLEX during MIP optimization after an integer solution has been found but before this solution replaces the incumbent.
CPXXgetinfocallbackfunc and CPXgetinfocallbackfunc
The routine CPXXgetinfocallbackfunc/CPXgetinfocallbackfunc accesses the user-written callback routine to be called regularly during the optimization of a mixed integer program (MIP).
CPXXgetlazyconstraintcallbackfunc and CPXgetlazyconstraintcallbackfunc
The routine CPXXgetlazyconstraintcallbackfunc/CPXgetlazyconstraintcallbackfunc accesses the user-written callback for adding lazy constraints.
CPXXgetmipcallbackfunc and CPXgetmipcallbackfunc
The routine CPXXgetmipcallbackfunc/CPXgetmipcallbackfunc accesses the user-written callback routine to be called in the branch-and-cut tree during the optimization of a mixed integer program.
CPXXgetnodecallbackfunc and CPXgetnodecallbackfunc
The routine CPXXgetnodecallbackfunc/CPXgetnodecallbackfunc accesses the user-written callback to be called during MIP optimization after CPLEX has selected a node to explore, but before this exploration is carried out.
CPXXgetsolvecallbackfunc and CPXgetsolvecallbackfunc
The routine CPXXgetsolvecallbackfunc/CPXgetsolvecallbackfunc accesses the user-written callback to be called during MIP optimization to optimize the subproblem.
CPXXgetusercutcallbackfunc and CPXgetusercutcallbackfunc
The routine CPXXgetusercutcallbackfunc/CPXgetusercutcallbackfunc accesses the user-written callback for adding cuts.
CPXXsetbranchcallbackfunc and CPXsetbranchcallbackfunc
Sets and modifies the user-written legacy callback routine to be called after a branch has been selected but before the branch is carried out during MIP optimization.
CPXXsetbranchnosolncallbackfunc and CPXsetbranchnosolncallbackfunc
The routine CPXXsetbranchnosolncallbackfunc/CPXsetbranchnosolncallbackfunc sets the callback function that will be called instead of the branch callback when there is a failure due to such situations as an iteration limit being reached, unboundedness being detected, numeric difficulties being encountered, while the node LP is being solved.
CPXXsetdeletenodecallbackfunc and CPXsetdeletenodecallbackfunc
The routine CPXXsetdeletenodecallbackfunc/CPXsetdeletenodecallbackfunc sets and modifies the user-written callback to be called during MIP optimization when a node is to be deleted.
CPXXsetheuristiccallbackfunc and CPXsetheuristiccallbackfunc
The routine CPXXsetheuristiccallbackfunc/CPXsetheuristiccallbackfunc sets or modifies the user-written callback to be called by CPLEX during MIP optimization after the subproblem has been solved to optimality.
CPXXsetincumbentcallbackfunc and CPXsetincumbentcallbackfunc
The routine CPXXsetincumbentcallbackfunc/CPXsetincumbentcallbackfunc sets and modifies the user-written callback routine to be called when an integer solution has been found but before this solution replaces the incumbent.
CPXXsetinfocallbackfunc and CPXsetinfocallbackfunc
The routine CPXXsetinfocallbackfunc/CPXsetinfocallbackfunc sets the user-written callback routine that CPLEX calls regularly during the optimization of a mixed integer program and during certain cut generation routines.
CPXXsetlazyconstraintcallbackfunc and CPXsetlazyconstraintcallbackfunc
The routine CPXXsetlazyconstraintcallbackfunc/CPXsetlazyconstraintcallbackfunc sets and modifies the user-written callback for adding lazy constraints.
CPXXsetmipcallbackfunc and CPXsetmipcallbackfunc
The routine CPXXsetmipcallbackfunc/CPXsetmipcallbackfunc sets the user-written callback routine to be called in the branch-and-cut tree, including the root node, during the optimization of a mixed integer program and during some cut generation routines.
CPXXsetnodecallbackfunc and CPXsetnodecallbackfunc
The routine CPXXsetnodecallbackfunc/CPXsetnodecallbackfunc sets and modifies the user-written callback to be called during MIP optimization after CPLEX has selected a node to explore, but before this exploration is carried out.
CPXXsetsolvecallbackfunc and CPXsetsolvecallbackfunc
The routine CPXXsetsolvecallbackfunc/CPXsetsolvecallbackfunc sets and modifies the user-written callback to be called during MIP optimization to optimize subproblems (for example, node and heuristic subproblems).
CPXXsetusercutcallbackfunc and CPXsetusercutcallbackfunc
The routine CPXXsetusercutcallbackfunc/CPXsetusercutcallbackfunc sets and modifies the user-written callback for adding cuts.

Parent topic: Discrete Optimization in the CPLEX Callable Library (C API) Reference Manual