problem.setcbcascadevarfail
problem.setcbcascadevarfail |
Purpose
Set a user callback to be called after cascading a column was not successful
Synopsis
problem.setcbcascadevarfail(callback, data)
retval = callback(my_prob, my_object, colindex)
Arguments
|
callback
|
The function to be called after cascading a column was not successful.
callback returns an integer value. If the return value is nonzero, the cascading process will be omitted for the remaining variables during the current SLP iteration, but the optimization will continue.
|
|
my_prob
|
The problem passed to the callback function.
|
|
my_object
|
The user-defined object passed as
data to
setcbcascadevarfail.
|
|
colindex
|
The number of the column which has been cascaded.
|
|
data
|
Address of a user-defined object, which can be used for any purpose by the function.
data is passed to
callback as
my_object.
|
Further information
This callback can be used to provide user defined updates for SLP variables having a determining row that were not successfully cascaded due to the determining row being close to singular around the current values. This callback will always be called in place of the cascadevar callback in such cases, and in no situation will both the cascadevar and the cascadevarfail callback be called in the same iteration for the same variable.
Related topics