problem.setcbiterend
problem.setcbiterend |
Purpose
Set a user callback to be called at the end of each SLP iteration
Synopsis
problem.setcbiterend (userfunc, object)
retval = userfunc (my_prob, my_object)
Arguments
|
userfunc
|
The function to be called at the end of each SLP iteration.
userfunc returns an integer value. If the return value is nonzero, the SLP iterations will stop.
|
|
my_prob
|
The problem passed to the callback function.
|
|
my_object
|
The user-defined object passed as
object to
setcbiterend.
|
|
object
|
Address of a user-defined object, which can be used for any purpose by the function.
object is passed to
userfunc as
my_object.
|
Example
The following example sets up a callback to be executed at the end of each SLP iteration. It records the number of LP iterations in the latest optimization and stops if there were fewer than 10:
p.setcbiterend (CBIterEnd, None)
A suitable callback function might resemble this:
def CBIterEnd (MyProb, Obj): niter = MyProb.attributes.simplexiter return (niter < 10)
The
object argument is not used here, and so is passed as
None.
Further information
This callback can be used at the end of each SLP iteration to carry out any further processing and/or stop any further SLP iterations.
Related topics