Initializing help system before first use

addcbchgbranchobject

Purpose
Declares a callback function that will be called after the selection of a MIP entity to branch on.
Synopsis
addcbchgbranchobject(prob, cb, prio = 0)
Arguments
prob 
The problem pointer to which the callback is added.
cb 
The callback function to add.
prio 
The priority of the callback. If multiple callbacks are registered for the same event then they are invoked according to their priority ordering.
Return value
Always returns 0 (zero).
Further information
Note the general callback conventions:
  • a callback function may return either an integer or a list.
  • if the C callback function has an integer return type then the value returned to the optimizer is the integer value returned or the list's "ret" element (if it exists).
  • if the C callback function has output arguments then these arguments are taken from the list that is returned by the callback function.
  • the R callback function will only receive the input arguments of the C callback
The chgbranchobject callback supports the following input arguments (in this order):
cbprob
The problem passed to the callback function, chgbranchobject.
branch
The candidate branching data selected by the Optimizer. Will be NULL if no candidates exist.
The chgbranchobject callback supports the following output arguments:
ret
An integer that will interrupt the search if non-zero.
newbranch
Optional new branching data to replace the Optimizer's selection.

Parent Topic R interface reference manual

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