Initializing help system before first use

problem.setcbslpstart

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

problem.setcbslpstart(callback, data)

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 data to setcbslpstart.
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 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
problem.setcbslpend

Parent Topic Xpress problem methods

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