Initializing help system before first use

XPRSaddcbchgbranch

Purpose
This subroutine is deprecated and will be removed in a future release. Please use XPRSaddcbchgbranchobject instead.
Declares a branching variable callback function, called every time a new branching variable is set or selected during the branch and bound search. This callback function will be called in addition to any change branch callbacks already added by XPRSaddcbchgbranch.
Topic areas
Callback, Branching
Synopsis
int XPRS_CC XPRSaddcbchgbranch(XPRSprob prob, void (XPRS_CC *chgbranch)(XPRSprob cbprob, void *cbdata, int *p_entity, int *p_up, double *p_estdeg), void *data, int priority);
Arguments
prob 
The current problem.
chgbranch 
The callback function, which takes five arguments, cbprob, cbdata, p_entity, p_up and p_estdeg, and has no return value. This function is called every time a new branching variable or set is selected.
cbprob 
The problem passed to the callback function, chgbranch.
cbdata 
The user-defined data passed as data when setting up the callback with XPRSaddcbchgbranch.
p_entity 
A pointer to the variable or set on which to branch. Integer variables are identified by their column index, i.e. 0, 1,...( COLS - 1) and sets by their set index, i.e. 0, 1,...,( SETS - 1).
p_up 
If p_entity is a variable, this is 1 if the upward branch is to be made first, or 0 otherwise. If p_entity is a set, this is 3 if the upward branch is to be made first, or 2 otherwise.
p_estdeg 
This value is obsolete. It will be set to zero and any returned value is ignored.
data 
A user-defined data to be passed to the callback function, chgbranch.
priority 
An integer that determines the order in which multiple branching variable callbacks 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
The arguments initially contain the default values of the branching variable, branching variable, branching direction and estimated degradation. If they are changed then the Optimizer will use the new values, if they are not changed then the default values will be used.
Related topics
XPRSremovecbchgbranch, XPRSaddcbchgnode, XPRSaddcboptnode, XPRSaddcbinfnode, XPRSaddcbintsol, XPRSaddcbnodecutoff, XPRSaddcbprenode.

Parent Topic Console and Library Functions

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