Initializing help system before first use

problem.setcbiterend

Purpose
Set a user callback to be called at the end of each SLP iteration
Synopsis

problem.setcbiterend(callback, data)

retval = callback(my_prob, my_object)
Arguments
callback 
The function to be called at the end of each SLP iteration. callback 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 data to setcbiterend.
data 
User-defined object, which can be used for any purpose by the function. data is passed to callback 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 Obj 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
problem.setcbiterstart, problem.setcbitervar

Parent Topic Xpress problem methods

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