problem.addGapNotifyCallback
Purpose
Declares a gap notification callback, to be called when a MIP solve reaches a predefined target, set using the
MIPRELGAPNOTIFY,
MIPABSGAPNOTIFY,
MIPABSGAPNOTIFYOBJ and/or
MIPABSGAPNOTIFYBOUND controls.
Topic areas
Callback, Limits
Synopsis
problem.addGapNotifyCallback(gapnotify, data=None, priority=0)
relgapnotifytarget, absgapnotifytarget, absgapnotifyobjtarget, absgapnotifyboundtarget = gapnotify(cbprob, cbdata)
Arguments
|
gapnotify
|
The callback function.
|
|
data
|
A user-defined data to be passed to the callback function,
gapnotify.
|
|
priority
|
An integer that determines the order in which multiple estimate callbacks will be invoked. The callback added with a higher priority will be called before a callback with a lower priority. Set to 0 if not required. |
|
cbprob
|
The current problem.
|
|
cbdata
|
The user-defined data passed as
data when setting up the callback.
|
Return value
|
relgapnotifytarget
|
The value the
MIPRELGAPNOTIFY control will be set to after this callback. May be modified within the callback in order to set a new notification target. |
|
absgapnotifytarget
|
The value the
MIPABSGAPNOTIFY control will be set to after this callback. May be modified within the callback in order to set a new notification target. |
|
absgapnotifyobjtarget
|
The value the
MIPABSGAPNOTIFYOBJ control will be set to after this callback. May be modified within the callback in order to set a new notification target. |
|
absgapnotifyboundtarget
|
The value the
MIPABSGAPNOTIFYBOUND control will be set to after this callback. May be modified within the callback in order to set a new notification target. |
Further information
The target values that caused the callback to be triggered will automatically be reset to prevent the same callback from being fired again.
Related topics
MIPRELGAPNOTIFY,
MIPABSGAPNOTIFY,
MIPABSGAPNOTIFYOBJ,
MIPABSGAPNOTIFYBOUND,
problem.removeGapNotifyCallback.
© 2001-2026 Fair Isaac Corporation. All rights reserved. This documentation is the property of Fair Isaac Corporation ("FICO"). Receipt or possession of this documentation does not convey rights to disclose, reproduce, make derivative works, use, or allow others to use it except solely for internal evaluation purposes to determine whether to purchase a license to the software described in this documentation, or as otherwise set forth in a written software license agreement between you and FICO (or a FICO affiliate). Use of this documentation and the software described in it must conform strictly to the foregoing permitted uses, and no other use is permitted.