Initializing help system before first use

problem.setcbmsjobend

problem.setcbmsjobend


Purpose
Set a user callback to be called every time a new multistart job finishes. Can be used to overwrite the default solution ranking function
Synopsis

problem.setcbmsjobend(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 setcbmsjobend.
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 - use the default evaluation of the finished job

1 - disregard the result and continue

2 - stop the multistart search

Further information

The multistart pool is dynamic, and this callback can be used to load new multistart jobs using the normal API functions.


Related topics