problem.addcbbarlog
problem.addcbbarlog |
Purpose
Declares a barrier log callback function, called at each iteration during the interior point algorithm. This callback function will be called in addition to any barrier log callbacks already added by addcbbarlog.
Synopsis
problem.addcbbarlog(callback, data, priority)
ret = callback(my_prob, my_object)
Arguments
|
callback
|
The callback function itself. This 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 at every barrier iteration.
|
|
my_prob
|
The problem passed to the callback function,
callback.
|
|
my_object
|
The user-defined object passed as
object when setting up the callback with
addcbbarlog.
|
|
data
|
A user-defined object to be passed to the callback function,
callback.
|
|
priority
|
An integer that determines the order in which multiple barrier 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
This simple example prints a line to the screen for each iteration of the algorithm.
prob.addcbbarlog(barLog, None, 0)
prob.lpoptimize('b')
The callback function might resemble:
def barLog(prob, object):
print('Next barrier iteration')
Further information
If the callback function returns a nonzero value, the Optimizer run will be interrupted.
Related topics