problem.addcbnewnode
problem.addcbnewnode |
Purpose
Declares a callback function that will be called every time a new node is created during the branch and bound search. This callback function will be called in addition to any callbacks already added by addcbnewnode.
Synopsis
problem.addcbnewnode (callback, data, priority)
callback (my_prob, my_object, parentnode, newnode, branch)
Arguments
|
callback
|
The callback function, which takes five arguments:
myprob,
my_object,
parentnode,
newnode and
branch. This function is called every time a new node is created through branching.
|
|
my_prob
|
The problem passed to the callback function,
callback.
|
|
my_object
|
The user-defined object passed as
object when setting up the callback with
addcbnewnode.
|
|
parentnode
|
Unique identifier for the parent of the new node.
|
|
newnode
|
Unique identifier assigned to the new node.
|
|
branch
|
The sequence number of the new node amongst the child nodes of
parentnode. For regular branches on a global entity this will be either
0 or
1.
|
|
data
|
A user-defined object to be 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.
|
Further information
1. For regular branches on a global entity,
branch will be either zero or one, depending on whether the new node corresponds to branching the global entity up or down.
2. When branching on a
branchobject,
branch refers to the given branch index of the object.
Related topics