problem.setcbslpstart
problem.setcbslpstart |
Purpose
Set a user callback to be called at the start of the SLP optimization
Synopsis
problem.setcbslpstart(callback, object)
retval = callback(my_prob, my_object)
Arguments
|
callback
|
The function to be called at the start of the SLP optimization.
callback returns an integer value. If the return value is nonzero, the optimization will not be carried out.
|
|
my_prob
|
The problem passed to the callback function.
|
|
my_object
|
The user-defined object passed as
object to
setcbslpstart.
|
|
object
|
User-defined object, which can be used for any purpose by the function.
object is passed to
callback as
my_object.
|
Example
The following example sets up a callback to be executed at the start of the SLP optimization:
Objdata = [] p.setcbslpstart(CBSlpStart, Objdata)
A suitable callback function might resemble this:
def CBSlpStart(object): object.append(1) return 0
Further information
This callback can be used at the start of the SLP optimization to carry out any housekeeping before the optimization actually starts. Note that a nonzero return code from the callback will terminate the optimization immediately.
Related topics