ilog.opl

Class IloCplex.ProbingInfoCallback

java.lang.Object

ilog.opl.IloCplex.Callback

ilog.opl.IloCplex.MIPInfoCallback

ilog.opl.IloCplex.ProbingInfoCallback

All Implemented Interfaces:

java.lang.Cloneable

Enclosing class:

IloCplex

public abstract static class IloCplex.ProbingInfoCallback
extends IloCplex.MIPInfoCallback

Monitors probing progress for user-written callbacks in a mixed integer program (MIP).

User-written callbacks of this class are compatible with dynamic search.

The constructor and methods of this class are protected to make sure that they are used only to derive a user-written callback class or to implement the main method in it.

The user-written callback of this class is called by only one thread, even in the case of parallel execution. Consequently, it is not necessary for the user-written callback to manage synchronization.

See Also:

IloCplex.MIPInfoCallback

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	IloCplex.ProbingInfoCallback() Constructor for user-written probing callbacks.

Method Summary

Methods

Modifier and Type	Method and Description
protected int	getPhase() Returns the current phase of probing.
protected double	getProgress() Returns the fraction of completion of the current probing phase.

Methods inherited from class ilog.opl.IloCplex.MIPInfoCallback

getBestObjValue, getCutoff, getDirection, getIncumbentObjValue, getIncumbentValue, getIncumbentValue, getIncumbentValues, getIncumbentValues, getMIPRelativeGap, getMyThreadNum, getNiterations, getNnodes, getNremainingNodes, getPriority, hasIncumbent

Methods inherited from class ilog.opl.IloCplex.Callback

abort, getCplexTime, getDetTime, getEndDetTime, getEndTime, getEnvImpl, getModel, getNcols, getNQCs, getNrows, getStartDetTime, getStartTime, main

Methods inherited from class java.lang.Object

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

Constructor Detail

IloCplex.ProbingInfoCallback

protected IloCplex.ProbingInfoCallback()

Constructor for user-written probing callbacks.

This constructor can be called only to construct objects of derived user-written callback classes, but not to construct ProbingInfoCallback objects directly.

Method Detail

getPhase

protected int getPhase()
                throws IloException

Returns the current phase of probing.

Throws:

IloException

Returns:

The current probing phase.

getProgress

protected double getProgress()
                      throws IloException

Returns the fraction of completion of the current probing phase.

This value is between 0.0 and 1.0.

Throws:

IloException

Returns:

The fraction of the completion of the current probing phase.