Initializing help system before first use

problem.addMsJobStartCallback

Purpose
Add a user callback to be called every time a new multistart job is created, and the pre-loaded settings are applied
Topic areas
Callback, Multistart
Synopsis
problem.addMsJobStartCallback(msjobstart, data=None, priority=0)
msjobstart(cbprob, cbdata, jobdata, jobdesc, status)
Arguments
msjobstart 
The function to be called when a new multistart job is created
data 
User data passed to the callback function.
priority 
An integer that determines the order in which callbacks of this type will be invoked. The callback added with a higher priority will be called before a callback with a lower priority. Set to 0 if not required.
cbprob 
The problem passed to the callback function.
cbdata 
The user-defined object passed as data to problem.addMsJobStartCallback.
jobdata 
Job specific user-defined object, as specified by the multistart job creating API functions.
jobdesc 
The description of the problem as specified by the multistart job creating API functions.
status 

User return status variable:

0 - normal return, solve the job,

1 - disregard this job and continue,

2 - Stop multistart.
Further information
All mulit-start jobs operate on an independent copy of the original problem, and any modification to the problem is allowed, including structural changes. Please note, however, that any modification will be carried over to the base problem, should a modified problem be declared the winner problem.
Related topics
problem.addMsJobEndCallback, problem.addMsWinnerCallback problem.removeMsJobStartCallback

Parent Topic Methods of the class problem

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