Initializing help system before first use

problem.setcbiterstart

problem.setcbiterstart

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

problem.setcbiterstart(callback, object)

retval = callback(my_prob, my_object)
Arguments
callback 
The function to be called at the start 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 object to setcbiterstart.
object 
Address of a 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 optimization to save to save the values of the variables from the previous iteration: 
p.setcbiterstart(CBIterStart, cSol)
A suitable callback function might resemble this: 
def CBIterStart(MyProb, Obj):
  niter = MyProb.attributes.xslp_iter
  if nIter == 0:
    return 0 # no previous solution
  Obj = []
  MyProb.getsol(Obj, None, None, None)
  return 0
The object argument is used here to hold the address of the array cSol which we populate with the solution values.
Further information
This callback can be used at the start of each SLP iteration before the optimization begins.
Related topics
problem.setcbiterend, problem.setcbitervar

Parent Topic Reference Manual

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