The Cplex..::..UserCutCallback type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | Cplex..::..UserCutCallback |
This is the constructor for user-written user cut callbacks.
|
Methods
| Name | Description | |
|---|---|---|
| Abort |
Instructs CPLEX to stop the current optimization after the
user-written callback finishes.
(Inherited from Cplex..::..Callback.) |
| AbortCutLoop |
Exit the cut loop and move on to branching.
|
| Add |
Adds cut as a global user cut to the problem being solved.
|
| AddLocal |
Adds its argument as a local cut to the problem being solved.
|
 | Equals | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetBestObjValue |
This method returns a bound on the optimal solution value
of the active problem at the moment the callback is called.
(Inherited from Cplex..::..MIPInfoCallback.) |
| GetCplexTime |
Returns a time stamp.
(Inherited from Cplex..::..Callback.) |
| GetCurrentNodeDepth |
Returns the depth of the current node in the search tree.
(Inherited from Cplex..::..MIPCallback.) |
| GetCutoff |
Returns the cutoff for the objective value when
nodes are being solved during
branch-and-cut search.
(Inherited from Cplex..::..MIPInfoCallback.) |
| GetDetTime |
This method returns a deterministic time stamp in ticks.
(Inherited from Cplex..::..Callback.) |
| GetDirection |
Returns the branch direction for a variable.
(Inherited from Cplex..::..MIPInfoCallback.) |
| GetDownPseudoCost |
Returns the pseudo cost for branching down on variable var.
(Inherited from Cplex..::..ControlCallback.) |
| GetEndDetTime |
This method returns a deterministic time stamp specifying
when the solving process terminates.
(Inherited from Cplex..::..Callback.) |
| GetEndTime |
This method returns a time stamp specifying when
solving process terminates.
(Inherited from Cplex..::..Callback.) |
| GetFeasibilities(array<INumVar>[]()[][]) |
States whether the variables in the specified array
are integer feasible, integer infeasible, or implied
integer feasible in the current node solution.
(Inherited from Cplex..::..ControlCallback.) |
| GetFeasibilities(array<INumVar>[]()[][], Int32, Int32) |
Queries whether the variables specified in the array
are integer feasible, integer infeasible, or implied
integer feasible in the current node solution.
(Inherited from Cplex..::..ControlCallback.) |
| GetFeasibility |
States whether the variable var is integer feasible,
integer infeasible, or implied integer feasible in the current node
solution.
(Inherited from Cplex..::..ControlCallback.) |
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetIncumbentObjValue | Returns the objective value of the current best integer solution at the moment the callback is called. This method returns the objective value for the current incumbent solution (that is, the best integer solution found so far). If there is no incumbent, this method returns a very large positive number for a minimization or a very small negative number for a maximization. |
| GetIncumbentValue(INumExpr) |
Returns the value expr takes for the current
incumbent solution.
(Inherited from Cplex..::..MIPInfoCallback.) |
| GetIncumbentValue(INumVar) | Returns the value of the specified variable for the current best integer solution. This method returns the value of the variable in the current incumbent solution (that is, the best integer solution found so far). |
| GetIncumbentValues(array<INumVar>[]()[][]) |
Returns incumbent solution values for an array of variables.
(Inherited from Cplex..::..MIPInfoCallback.) |
| GetIncumbentValues(array<INumVar>[]()[][], Int32, Int32) |
Returns the incumbent solution values for a set of variables.
(Inherited from Cplex..::..MIPInfoCallback.) |
| GetLB |
Returns the current lower bound for the variable var.
(Inherited from Cplex..::..ControlCallback.) |
| GetLBs(array<INumVar>[]()[][]) |
Returns the current lower bounds for an array of variables.
(Inherited from Cplex..::..ControlCallback.) |
| GetLBs(array<INumVar>[]()[][], Int32, Int32) |
Returns the current lower bounds for a set of variables.
(Inherited from Cplex..::..ControlCallback.) |
| GetMIPRelativeGap |
This method returns the relative objective gap
of the active problem at the moment the callback is called.
(Inherited from Cplex..::..MIPInfoCallback.) |
| GetModel |
Returns the model being solved when the invoking callback is called,
that is, the active model.
(Inherited from Cplex..::..OptimizationCallback.) |
| GetNcuts |
Returns the number of cuts of the specified type
that have been added to the node
relaxation at the moment the callback is called.
(Inherited from Cplex..::..MIPInfoCallback.) |
| GetNiterations | Returns the total number of iterations for solving node relaxations during the current optimization. |
| GetNiterations64 | Returns the total number of iterations for solving node relaxations during the current optimization. |
| GetNnodes | Returns the number of nodes processed so far in the active branch-and-cut search. |
| GetNnodes64 | Returns the number of nodes processed so far in the active branch-and-cut search. |
| GetNodeData |
Returns the user object attached to the current node.
(Inherited from Cplex..::..ControlCallback.) |
| GetNodeDoubleInfo | (Inherited from Cplex..::..MIPCallback.) |
| GetNodeId | Returns the node identifier of the current node. |
| GetNodeIntInfo | (Inherited from Cplex..::..MIPCallback.) |
| GetNodeLongInfo | (Inherited from Cplex..::..MIPCallback.) |
| GetNremainingNodes | Returns the number of nodes remaining to be processed, or, equivalently, the number of active nodes in the tree. |
| GetNremainingNodes64 | Returns the number of nodes remaining to be processed, or, equivalently, the number of active nodes in the tree. |
| GetObjCoef |
Returns the linear objective function coefficient for the variable
var in the model being solved.
(Inherited from Cplex..::..MIPCallback.) |
| GetObjCoefs(array<INumVar>[]()[][]) |
Returns the linear objective function coefficients for an array of
variables in the model being solved.
(Inherited from Cplex..::..MIPCallback.) |
| GetObjCoefs(array<INumVar>[]()[][], Int32, Int32) |
Returns the linear objective function coefficients for a set of
variables in the model being solved.
(Inherited from Cplex..::..MIPCallback.) |
| GetObjValue |
Returns the objective function value of the solution at
the current node.
(Inherited from Cplex..::..ControlCallback.) |
| GetPriority | Returns the branch priority for the specified variable. |
| GetQuality |
Returns an instance of Cplex.Quality that contains
the requested quality measure.
(Inherited from Cplex..::..MIPInfoCallback.) |
| GetSlack |
Returns the slack value of a constraint for the solution of the
continuous relaxation of the current node.
(Inherited from Cplex..::..ControlCallback.) |
| GetSlacks(array<IRange>[]()[][]) |
Returns the slack values of an array of constraints for the solution
of the current node.
(Inherited from Cplex..::..ControlCallback.) |
| GetSlacks(array<IRange>[]()[][], Int32, Int32) |
Returns the slack values of a set of constraints for the solution
of the current node.
(Inherited from Cplex..::..ControlCallback.) |
| GetSOSFeasibility(ISOS1) |
States whether the special ordered set of type 1 is integer feasible,
integer infeasible, or implied integer feasible in the current node
solution.
(Inherited from Cplex..::..ControlCallback.) |
| GetSOSFeasibility(ISOS2) |
States whether the special ordered set of type 2 is integer feasible,
integer infeasible, or implied integer feasible in the current node
solution.
(Inherited from Cplex..::..ControlCallback.) |
| GetStartDetTime |
This method returns a deterministic time stamp specifying when
the solving process started.
(Inherited from Cplex..::..Callback.) |
| GetStartTime |
This method returns a time stamp specifying when
the solving process started.
(Inherited from Cplex..::..Callback.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| GetUB |
Returns the current upper bound for the variable var.
(Inherited from Cplex..::..ControlCallback.) |
| GetUBs(array<INumVar>[]()[][]) |
Returns the current upper bounds for an array of variables.
(Inherited from Cplex..::..ControlCallback.) |
| GetUBs(array<INumVar>[]()[][], Int32, Int32) |
Returns the current upper bounds for a set of variables.
(Inherited from Cplex..::..ControlCallback.) |
| GetUpPseudoCost |
Returns the pseudo cost for branching up on variable var.
(Inherited from Cplex..::..ControlCallback.) |
| GetValue(INumExpr) |
Returns the value expr takes for the solution of the
continuous relaxation of the current node.
(Inherited from Cplex..::..ControlCallback.) |
| GetValue(INumVar) |
Returns the solution value of a variable at the current node.
(Inherited from Cplex..::..ControlCallback.) |
| GetValues(array<INumVar>[]()[][]) |
Returns the solution values for an array of variables at the
current node.
(Inherited from Cplex..::..ControlCallback.) |
| GetValues(array<INumVar>[]()[][], Int32, Int32) |
Returns the solution values for a set of variables at the
current node.
(Inherited from Cplex..::..ControlCallback.) |
| HasIncumbent | Returns true if an incumbent solution has been found when the callback is called. |
| IsAfterCutLoop |
This method indicates whether or not the callback was invoked after
CPLEX stopped generating cuts and called the callback a final time.
|
| Main |
The method to be implemented by user callback classes.
(Inherited from Cplex..::..Callback.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| SetNodeData |
Sets the user object attached to the current node.
(Inherited from Cplex..::..ControlCallback.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
Properties
| Name | Description | |
|---|---|---|
 | MIPRelativeGap |
Accesses the relative objective gap for a MIP optimization.
(Inherited from Cplex..::..MIPInfoCallback.) |
| MyThreadNum | (Inherited from Cplex..::..MIPInfoCallback.) |
| Ncols |
Gets the number of columns of the matrix representation of the
active model being solved when the invoking callback is called.
(Inherited from Cplex..::..OptimizationCallback.) |
| Nrows |
Gets the number of rows of the matrix representation of the active
model being solved when the invoking callback is called.
(Inherited from Cplex..::..OptimizationCallback.) |
| UserThreads | (Inherited from Cplex..::..MIPCallback.) |
