Instances of this class define the context in which the CPLEX generic callback can be invoked.

This method stops optimization. A call of this method instructs CPLEX to halt optimization as soon as possible after the callback returns.

This method adds a user-defined cut. The method creates a deep copy of all IloRange instances passed to it, so you can invoke the method end on the ranges after the method returns.

This method asks CPLEX to stop cutting plane separation at the current node.

This method can be invoked only from the context IloCplex::Callback::Context::Id::Relaxation; it throws an exception when invoked from another context.

This method accesses the objective of the current candidate solution. This method can be invoked only from the context IloCplex::Callback::Context::Id::Candidate; it throws an exception when invoked from another context.

This method is a convenience wrapper for the method IloCplex::Callback::getCandidatePoint(IloIntVarArray const&, IloNumArray &). (See the documentation of that method for more detail.) This method retrieves the candidate solution value for a single variable.

This method is a convenience wrapper for the method IloCplex::Callback::getCandidatePoint(IloNumVarArray const&, IloNumArray & />. (See the documentation of that method for more detail.) This method retrieves the candidate solution value for a single variable.

This method accesses a candidate solution. It retrieves the values for vars[start], . . . , vars[start+length-1] in the current candidate and returns them. This method can be invoked only from the context IloCplex::Callback::Context::Id::Candidate and if IloCplex::Callback::Context:isCandidatePoint() returns true; it throws an exception when invoked from another context.

This method accesses the candidate solution. It retrieves the values for vars[start], . . . , vars[start+length-1] in the current candidate and returns them. This method can be invoked only from the context IloCplex::Callback::Context::Id::Candidate and if IloCplex::Callback::Context::isCandidatePoint() returns true; it throws an exception when invoked from another context.

This method evaluates expr with respect to the current candidate solution. This method can be invoked only in the context IloCplex::Callback::Context::Id::Candidate and if IloCplex::Callback::Context::isCandidatePoint() returns true.

This method accesses double-precision valued information. See the documentation of the Info struct for details about what information can be queried.

This method accesses an instance of IloEnv that is valid for use during a callback. Use the environment object returned by this method (instead of the global instance of IloEnv) for everything that your application does in a callback.

This method is a convenience wrapper for the method IloCplex::Callback::Context::getGlobalLB(IloIntVarArray const&, IloIntArray &). (See the documentation of that method for more detail.) This method retrieves the global lower bound for a single variable.

This method is a convenience wrapper for the method IloCplex::Callback::Context::getGlobalLB(IloNumVarArray const&, IloNumArray &). (See the documentation of that method for more detail.) This method retrieves the global lower bound for a single variable.

This method accesses the global lower bounds for variables. This methods queries the best known globally valid bounds.

This method cannot be invoked from the context IloCplex::Callback::Context::Id::ThreadUp or IloCplex::Callback::Context::Id::ThreadDown.

This method accesses the global lower bounds for variables. This methods queries the best known globally valid bounds.

This method cannot be invoked from the context IloCplex::Callback::Context::Id::ThreadUp or IloCplex::Callback::Context::Id::ThreadDown.

This method is a convenience wrapper for the method IloCplex::Callback::Context::getGlobalUB(IloIntVarArray const&, IloNumArray &). (See the documentation of that method for more detail.) This method retrieves the global upper bound for a single variable.

This method is a convenience wrapper for the method IloCplex::Callback::Context::getGlobalUB(IloNumVarArray const&, IloNumArray &)' />. (See the documentation of that method for more detail.) This method retrieves the global upper bound for a single variable.

This method accesses the global upper bounds for variables. This method queries the best known globally valid bounds.

This method cannot be invoked from the context IloCplex::Callback::Context::Id::ThreadUp or IloCplex::Callback::Context::Id::ThreadDown.

This method accesses the global upper bounds for variables. This method queries the best known globally valid bounds.

This method cannot be invoked from the context IloCplex::Callback::Context::Id::ThreadUp or IloCplex::Callback::Context::Id::ThreadDown.

This method accesses the context in which the corresponding callback was invoked.

This method is a convenience wrapper for the method IloCplex::Callback::getIncumbent(IloIntVarArray const&, IloNumArray &). (See the documentation of that method for more detail.) This method retrieves the incumbent solution value for a single variable.

This method is a convenience wrapper for the method IloCplex::Callback::getIncumbent(IloNumVarArray const&, IloNumArray &). (See the documentation of that method for more detail.) This method retrieves the incumbent solution value for a single variable.

This method accesses the current incumbent solution. It retrieves the values for vars[start], . . . , vars[start+length-1] in the current incumbent solution and returns them. The method raises an exception if there is no incumbent solution available. Use the method IloCplex::Callback::getIntInfo with the value Info::Feasible to check whether an incumbent is available.

This method accesses the current incumbent solution. It retrieves the values for vars[start], . . . , vars[start+length-1] in the current incumbent solution and returns them. The method raises an exception if there is no incumbent solution available. Use the method IloCplex::Callback::getIntInfo with the value Info::Feasible to check whether an incumbent is available.

This method access the objective value for the current incumbent.

This method evaluates expr with respect to the current incumbent solution.

This method accesses 32-bit, signed, integer-valued information. See the documentation of the Info struct for details about what information can be queried.

This method is a convenience wrapper for the method IloCplex::Callback::Context::getLocalLB(IloIntVarArray const&, IloIntArray &). (See the documentation of that method for more detail.) This method retrieves the local lower bound for a single variable.

This method is a convenience wrapper for the method IloCplex::Callback::Context::getLocalLB(IloNumVarArray const&, IloNumArray &). (See the documentation of that method for more detail.) This method retrieves the local lower bound for a single variable.

This method accesses the local lower bounds for variables. This methods queries the local bounds that were in place when the current relaxation was computed. These bounds can be tighter than global bounds due to presolve, branching, and other activity.

This method can be invoked only from the context IloCplex::Callback::Context::Id::Relaxation; it throws an exception when invoked from another context.

This method accesses the local lower bounds for variables. This methods queries the local bounds that were in place when the current relaxation was computed. These bounds can be tighter than global bounds due to presolve, branching, and other activity.

This method can be invoked only from the context IloCplex::Callback::Context::Id::Relaxation; it throws an exception when invoked from another context.

This method is a convenience wrapper for the method IloCplex::Callback::Context::getLocalUB(IloIntVarArray const&, IloNumArray &). (See the documentation of that method for more detail.) This method retrieves the local upper bound for a single variable.

This method is a convenience wrapper for the method IloCplex::Callback::Context::getLocalUB(IloNumVarArray const&, IloNumArray &)' />. (See the documentation of that method for more detail.) This method retrieves the local upper bound for a single variable.

This method accesses the local upper bounds for variables. This method queries the local bounds that were in place when the current relaxation was computed. These bounds may be tighter than global bounds due to presolve, branching, and other activity.

This method can be invoked only from the context IloCplex::Callback::Context::Id::Relaxation; it throws an exception when invoked from another context.

This method accesses the local upper bounds for variables. This method queries the local bounds that were in place when the current relaxation was computed. These bounds may be tighter than global bounds due to presolve, branching, and other activity.

This method can be invoked only from the context IloCplex::Callback::Context::Id::Relaxation; it throws an exception when invoked from another context.

This method accesses 64-bit, signed, integer-valued information. See the documentation of the Info struct for details about what information can be queried.

This method accesses the objective of the current relaxation.

This method can be invoked only from the context IloCplex::Callback::Context::Id::Relaxation or IloCplex::Callback::Context::Id::Branching; it throws an exception when invoked from another context.

This method is a convenience wrapper for the method IloCplex::Callback::getRelaxationPoint(IloIntVarArray const&, IloNumArray &). (See the documentation of that method for more detail.) This method retrieves the relaxation solution value for a single variable.

This method is a convenience wrapper for the method IloCplex::Callback::getRelaxationPoint(IloNumVarArray const&, IloNumArray &). (See the documentation of that method for more detail.) This method retrieves the relaxation solution value for a single variable.

This method accesses the current relaxation. It retrieves the values for vars[start], . . . , vars[start+length-1] in the current relaxation and returns them. This method can be invoked only from the context IloCplex::Callback::Context::Id::Relaxation or IloCplex::Callback::Context::Id::Branching; it throws an exception when invoked from another context.

This method accesses the current relaxation. It retrieves the values for vars[start], . . . , vars[start+length-1] in the current relaxation and returns them. This method can be invoked only from the context IloCplex::Callback::Context::Id::Relaxation or IloCplex::Callback::Context::Id::Branching; it throws an exception when invoked from another context.

This method accesses the solution status of the current continous solution. See the documentation of CPXXcallbackgetrelaxationstatus in the callable library reference manual for further details.

This method can be invoked only from the context IloCplex::Callback::Context::Id::Relaxation or IloCplex::Callback::Context::Id::Branching; it throws an exception when invoked from another context.

This method evaluates expr with respect to the current relaxation. This method can be invoked only in the context IloCplex::Callback::Context::Id::Relaxation or IloCplex::Callback::Context::Id::Branching.

This method tests whether the callback was invoked in the context IloCplex::Callback::Context::Id::Branching.

It is a shortcut for getId() == IloCplex::Callback::Context::Id::Branching

This method tests whether the callback was invoked in the context IloCplex::Callback::Context::Id::Candidate.

It is a shortcut for getId() == IloCplex::Callback::Context::Id::Candidate

This method tests whether the callback was invoked in the context IloCplex::Callback::Context::Id::GlobalProgress.

It is a shortcut for getId() == IloCplex::Callback::Context::Id::GlobalProgress

This method tests whether the callback was invoked in the context IloCplex::Callback::Context::Id::LocalProgres.

It is a shortcut for getId() == IloCplex::Callback::Context::Id::LocalProgress

This method tests whether the callback was invoked in the context IloCplex::Callback::Context::Id::Relaxation.

It is a shortcut for getId() == IloCplex::Callback::Context::Id::Relaxation

This method tests whether the callback was invoked in the context IloCplex::Callback::Context::Id::ThreadDown.

It is a shortcut for getId() == IloCplex::Callback::Context::Id::ThreadDown

This method tests whether the callback was invoked in the context IloCplex::Callback::Context::Id::ThreadUp.

It is a shortcut for getId() == IloCplex::Callback::Context::Id::ThreadUp

This method tests whether the callback was invoked in context IloCplex::Callback::Context::Id::Candidate with a candidate feasible point.

If the function returns true, then you can call IloCplex::Callback::Context::getCandidatePoint(), IloCplex::Callback::Context::getCandidateValue(), and IloCplex::Callback::Context::getCandidateObjective() to query the potentially feasible point.

This method tests whether the callback was invoked in context IloCplex::Callback::Context::Id::Candidate with an unbounded ray.

If the function returns true, then you can call IloCplex::Callback::Context::getCandidateRay() to query the unbounded ray.

Convenience wrapper for makeBranch(IloIntVarArray const &, IloNumArray const &, IloCplex::BranchDirectionArray const &, IloRangeArray const &, IloNum).

The function creates a branch that is defined only by a set of constraints.

Convenience wrapper for makeBranch(IloIntVarArray const &, IloNumArray const &, IloCplex::BranchDirectionArray const &, IloRangeArray const &, IloNum).

The function creates a branch that is defined by only branching on a single variable.

Convenience wrapper for makeBranch(IloNumVarArray const &, IloNumArray const &, IloCplex::BranchDirectionArray const &, IloRangeArray const &, IloNum).

The function creates a branch that is defined by only branching on a single variable.

Convenience wrapper for makeBranch(IloIntVarArray const &, IloNumArray const &, IloCplex::BranchDirectionArray const &, IloRangeArray const &, IloNum).

The function creates a branch that is defined only by bound changes.

Convenience wrapper for makeBranch(IloNumVarArray const &, IloNumArray const &, IloCplex::BranchDirectionArray const &, IloRangeArray const &, IloNum).

The function creates a branch that is defined only by bound changes.

This method creates a custom branch at the current node.

The method creates the branch as specified by the arguments. It is fine to branch only on variables (in which case constraints can be empty) or only on constraints (in which case vars, bounds, dirs can be empty).

This method can be invoked only from the context IloCplex::Callback::Context::Id::Branching; it throws an exception when invoked from another context.

At most two branches can be created at a node.

This method creates a custom branch at the current node.

The method creates the branch as specified by the arguments. It is fine to branch only on variables (in which case constraints can be empty) or only on constraints (in which case vars, bounds, dirs can be empty).

This method can be invoked only from the context IloCplex::Callback::Context::Id::Branching; it throws an exception when invoked from another context.

At most two branches can be created at a node.

This method posts a (heuristic) solution to CPLEX. Specifically, the method posts a solution vector to CPLEX. The vector is queued internally. Before CPLEX invokes a heuristic, CPLEX looks at the queue and attempts to create a feasible solution from each vector. This activity can result in new incumbent solutions.

This method posts a (heuristic) solution to CPLEX. Specifically, the method posts a solution vector to CPLEX. The vector is queued internally. Before CPLEX invokes a heuristic, CPLEX looks at the queue and attempts to create a feasible solution from each vector. This activity can result in new incumbent solutions.

This method prunes the current search tree node.

The node for which the callback was invoked is pruned, no further children are created from it. Subsequent calls to makeBranch for this node are ignored.

This method can be invoked only from the context IloCplex::Callback::Context::Id::Relaxation or IloCplex::Callback::Context::Id::Branching; it throws an exception when invoked from another context.

This method rejects the current candidate solution. This method is a convenience wrapper for the method IloCplex::Callback::rejectCandidate(IloRangeArray). (See the documentation of that method for more detail.)

The method creates a deep copy of the IloRange instance passed to it, so you can invoke the end method after this method returns.

This method rejects the current candidate solution. This method can be invoked only from the context IloCplex::Callback::Context::Id::Candidate; it throws an exception when invoked from another context.

The function creates a deep copy of all IloRange instances passed to it, so it is ok to invoke the method end on those ranges after the function returns.

This method rejects the current candidate solution. This method is a convenience wrapper for the method IloCplex::Callback::rejectCandidateLocal(IloRangeArray). (See the documentation of that method for more detail.)

The method creates a deep copy of the IloRange instance passed to it, so you can invoke the end method after this method returns.

This method rejects the current candidate solution. This method can be invoked only from the context IloCplex::Callback::Context::Id::Candidate and only if the callback was invoked for an integral node (see CandidateSource); it throws an exception when invoked from another context.

The function creates a deep copy of all IloRange instances passed to it, so it is ok to invoke the method end on those ranges after the function returns.

The passed constraints are not required to be globally valid. CPLEX only assumes them to be valid in the subtree in which the callback was invoked.

The parameter violated is a potentially empty set of constraints that cut off the candidate solution. This argument may also be null. If not null and not empty, then CPLEX may use these constraints to cut off further candidate solutions that it finds. (There is no guarantee that it does so, though.) These constraints are essentially lazy constraints. None of the elements in this array is allowed to be an empty handle (use an empty array to reject without constraints). The constraints are not required to be globally valid. CPLEX only assumes them to be valid in the subtree in which the callback was invoked.

This struct designates places in which a CPLEX generic callback can be invoked. The values defined here specify in which contexts CPLEX can invoke a callback. They are used in two different ways:

• They are used as arguments to the method IloCplex::Callback::Function::invoke to specify in which context the callback has just been invoked.
• A bit-wise OR of these values passes as an argument to the method IloCplex::use(Callback::Function, long) to specify in which places CPLEX should invoke the registered callback.

For details about the various context values, see the reference manual of the Callable Library (C API).

Important notes about the ThreadDown context:

• If a callback invoked in the ThreadUp context throws an exception, then ThreadDown will not be invoked on this thread.
• The callback function is not allowed to throw exceptions if invoked in the context ThreadDown. Any exception thrown in this context will be ignored.

Think of ThreadUp and ThreadDown as "constructor" and "destructor": the destructor is invoked only if the object was fully constructed and is not allowed to throw an exception.

See the documentation of CPX_CALLBACKCONTEXT_BRANCHING in the reference manual of the Callable Library (C API).

See the documentation of CPX_CALLBACKCONTEXT_CANDIDATE in the reference manual of the Callable Library (C API).

See the documentation of CPX_CALLBACKCONTEXT_GLOBAL_PROGRESS in the reference manual of the Callable Library (C API).

See the documentation of CPX_CALLBACKCONTEXT_LOCAL_PROGRESS in the reference manual of the Callable Library (C API).

See the documentation of CPX_CALLBACKCONTEXT_RELAXATION in the reference manual of the Callable Library (C API).

See the documentation of CPX_CALLBACKCONTEXT_THREAD_DOWN in the reference manual of the Callable Library (C API).

See the documentation of CPX_CALLBACKCONTEXT_THREAD_UP in the reference manual of the Callable Library (C API).

This struct provides an enum of identifiers for the kinds of information that you can retrieve from a generic callback by invoking one (or more) of the generic callback informational methods.

This enum identifies the kinds of information that your application can retrieve from a generic callback by means of the methods IloCple::Callback::getIntInfo(Info), IloCplex::Callback::getLongInfo(Info), or IloCplex::Callback::getDoubleInfo(Info). See documentation of the enumeration CPXCALLBACKINFO in the reference manual of the Callable Library (C API) for further details about these values.

This struct defines an enum that provides identifiers for the various completion strategies that can be passed to the method IloCplex::Callback::Context::postHeuristicSolution.

For more detail, see the documentation of the enumeration CPXCALLBACKSOLUTIONSTRATEGY in the reference manual of the Callable Library (C API) of CPLEX.

This enum identifies completion strategies for CPLEX to use with the method IloCplex::Callback::Context::postHeuristicSolution.

If you pass a complete solution to this method, that is, the solution specifies a value for every variable in the model, then CPLEX can check the feasibility of that complete solution.

Possibly the arguments that you passed to that method specify only a partial solution. In such a case, CPLEX can attempt to complete the partial solution by means of bound propagation.

For more detail about these completion strategies, see the documentation of the enumeration CPXCALLBACKSOLUTIONSTRATEGY in the reference manual of the Callable Library (C API) of CPLEX.