Initializing help system before first use

# problem.addcbmiplog

Purpose
This subroutine is deprecated and will be removed in a future release. Use problem.addMiplogCallback instead.
Declares a MIP log callback function, called each time the MIP log is printed. This callback function will be called in addition to any callbacks already added by addcbmiplog.
Synopsis
`

problem.addcbmiplog(callback, data, priority)

ret = callback(my_prob, my_object)

`
Arguments

callback | The callback function which takes two arguments, my_prob and my_object, and has an integer return value. If the value returned by callback is nonzero, the solution process will be interrupted. This function is called whenever the MIP log is printed as determined by the MIPLOG control.
my_prob | The problem passed to the callback function, callback.
my_object | The user-defined object passed as data when setting up the callback with addcbmiplog.
data | A user-defined object to be passed to the callback function, callback.
priority | An integer that determines the order in which multiple MIP log 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.

Example
The following example prints at each node of the tree search the node number and its depth:

    prob.controls.miplog = 3
    prob.addcbmiplog(mipLog, None, 0)
    prob.mipoptimize('')

The callback function may resemble:

    def mipLog(prob, object):

        nodedepth = prob.attributes.nodedepth
        node      = prob.attributes.currentnode

        print('Node {0} with depth {1} has been processed'.format
              (node, nodedepth))

        return 0

Further information
If the callback function returns a nonzero value, the tree search will be interrupted.
Related topics
problem.removeMiplogCallback, problem.addBarlogCallback, problem.addLplogCallback, problem.addMessageCallback, problem.addMiplogCallback.
Parent Topic Deprecated functionality

© 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.