Initializing help system before first use

addcbcutround

Purpose
Declares a callback function that is called when the Optimizer could separate cutting planes during the branch and bound search.
Synopsis
addcbcutround(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 cutround callback supports the following input arguments (in this order):
cbprob
The problem passed to the callback function, cutround.
ifxpresscuts
An integer set to 1 if the Optimizer will apply a round of cuts after this callback. 0 otherwise.
action
An integer return value that specifies the action the Optimizer should take:
-1
Continue unchanged. The default action.
0
No further rounds of cuts should be applied on this node.
1
The Optimizer should apply one more round of cutting, regardless of the value of ifxpresscuts
2
The Optimizer should process any changes applied during this callback and fire the callback again, but skip any Optimizer cutting.
The cutround callback supports the following output arguments:
ret
An integer that will interrupt the search if non-zero.
action
An integer return value that specifies the action the Optimizer should take:
-1
Continue unchanged. The default action.
0
No further rounds of cuts should be applied on this node.
1
The Optimizer should apply one more round of cutting, regardless of the value of ifxpresscuts
2
The Optimizer should process any changes applied during this callback and fire the callback again, but skip any Optimizer cutting.

Parent Topic R interface reference manual

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