Initializing help system before first use

problem.setcbmsjobstart

problem.setcbmsjobstart


Purpose
Set a user callback to be called every time a new multistart job is created, and the pre-loaded settings are applied
Synopsis

problem.setcbmsjobstart(callback, object)

status = callback(my_prob, my_object, job_object, description)


Arguments
callback 
The function to be called when a new multistart job is created;
my_prob 
The problem passed to the callback function.
my_object 
The user-defined object passed as object to setcbmsjobstart.
job_object 
Job specific user-defined object, as specified in by the multistart job creating API functions.
description 
The description of the problem as specified in 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 operation 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 prob.


Related topics