SCIP Doxygen Documentation
Loading...
Searching...
No Matches
Branching Rules
Public API of SCIP » Core API » Methods for managing plugins

Detailed Description

functions for branching rule plugins

Functions

 SCIP_DECL_SORTPTRCOMP (SCIPbranchruleComp)
 SCIP_DECL_SORTPTRCOMP (SCIPbranchruleCompName)
SCIP_BRANCHRULEDATA * SCIPbranchruleGetData (SCIP_BRANCHRULE *branchrule)
void SCIPbranchruleSetData (SCIP_BRANCHRULE *branchrule, SCIP_BRANCHRULEDATA *branchruledata)
void SCIPbranchruleMarkExact (SCIP_BRANCHRULE *branchrule)
const char * SCIPbranchruleGetName (SCIP_BRANCHRULE *branchrule)
const char * SCIPbranchruleGetDesc (SCIP_BRANCHRULE *branchrule)
int SCIPbranchruleGetPriority (SCIP_BRANCHRULE *branchrule)
int SCIPbranchruleGetMaxdepth (SCIP_BRANCHRULE *branchrule)
SCIP_Real SCIPbranchruleGetMaxbounddist (SCIP_BRANCHRULE *branchrule)
SCIP_Real SCIPbranchruleGetSetupTime (SCIP_BRANCHRULE *branchrule)
SCIP_Real SCIPbranchruleGetTime (SCIP_BRANCHRULE *branchrule)
SCIP_Longint SCIPbranchruleGetNLPCalls (SCIP_BRANCHRULE *branchrule)
SCIP_Longint SCIPbranchruleGetNExternCalls (SCIP_BRANCHRULE *branchrule)
SCIP_Longint SCIPbranchruleGetNPseudoCalls (SCIP_BRANCHRULE *branchrule)
SCIP_Longint SCIPbranchruleGetNCutoffs (SCIP_BRANCHRULE *branchrule)
SCIP_Longint SCIPbranchruleGetNCutsFound (SCIP_BRANCHRULE *branchrule)
SCIP_Longint SCIPbranchruleGetNConssFound (SCIP_BRANCHRULE *branchrule)
SCIP_Longint SCIPbranchruleGetNDomredsFound (SCIP_BRANCHRULE *branchrule)
SCIP_Longint SCIPbranchruleGetNChildren (SCIP_BRANCHRULE *branchrule)
SCIP_Bool SCIPbranchruleIsInitialized (SCIP_BRANCHRULE *branchrule)
SCIP_RETCODE SCIPincludeBranchrule (SCIP *scip, const char *name, const char *desc, int priority, int maxdepth, SCIP_Real maxbounddist, SCIP_DECL_BRANCHCOPY((*branchcopy)), SCIP_DECL_BRANCHFREE((*branchfree)), SCIP_DECL_BRANCHINIT((*branchinit)), SCIP_DECL_BRANCHEXIT((*branchexit)), SCIP_DECL_BRANCHINITSOL((*branchinitsol)), SCIP_DECL_BRANCHEXITSOL((*branchexitsol)), SCIP_DECL_BRANCHEXECLP((*branchexeclp)), SCIP_DECL_BRANCHEXECEXT((*branchexecext)), SCIP_DECL_BRANCHEXECPS((*branchexecps)), SCIP_BRANCHRULEDATA *branchruledata)
SCIP_RETCODE SCIPincludeBranchruleBasic (SCIP *scip, SCIP_BRANCHRULE **branchruleptr, const char *name, const char *desc, int priority, int maxdepth, SCIP_Real maxbounddist, SCIP_BRANCHRULEDATA *branchruledata)
SCIP_RETCODE SCIPsetBranchruleCopy (SCIP *scip, SCIP_BRANCHRULE *branchrule,)
SCIP_RETCODE SCIPsetBranchruleFree (SCIP *scip, SCIP_BRANCHRULE *branchrule,)
SCIP_RETCODE SCIPsetBranchruleInit (SCIP *scip, SCIP_BRANCHRULE *branchrule,)
SCIP_RETCODE SCIPsetBranchruleExit (SCIP *scip, SCIP_BRANCHRULE *branchrule,)
SCIP_RETCODE SCIPsetBranchruleInitsol (SCIP *scip, SCIP_BRANCHRULE *branchrule,)
SCIP_RETCODE SCIPsetBranchruleExitsol (SCIP *scip, SCIP_BRANCHRULE *branchrule,)
SCIP_RETCODE SCIPsetBranchruleExecLp (SCIP *scip, SCIP_BRANCHRULE *branchrule,)
SCIP_RETCODE SCIPsetBranchruleExecExt (SCIP *scip, SCIP_BRANCHRULE *branchrule,)
SCIP_RETCODE SCIPsetBranchruleExecPs (SCIP *scip, SCIP_BRANCHRULE *branchrule,)
SCIP_BRANCHRULE * SCIPfindBranchrule (SCIP *scip, const char *name)
SCIP_BRANCHRULE ** SCIPgetBranchrules (SCIP *scip)
int SCIPgetNBranchrules (SCIP *scip)
SCIP_RETCODE SCIPsetBranchrulePriority (SCIP *scip, SCIP_BRANCHRULE *branchrule, int priority)
SCIP_RETCODE SCIPsetBranchruleMaxdepth (SCIP *scip, SCIP_BRANCHRULE *branchrule, int maxdepth)
SCIP_RETCODE SCIPsetBranchruleMaxbounddist (SCIP *scip, SCIP_BRANCHRULE *branchrule, SCIP_Real maxbounddist)

Function Documentation

◆ SCIP_DECL_SORTPTRCOMP() [1/2]

SCIP_DECL_SORTPTRCOMP ( SCIPbranchruleComp )

compares two branching rules w. r. to their priority

Definition at line 1253 of file branch.c.

References SCIP_DECL_SORTPTRCOMP.

◆ SCIP_DECL_SORTPTRCOMP() [2/2]

SCIP_DECL_SORTPTRCOMP ( SCIPbranchruleCompName )

comparison method for sorting branching rules w.r.t. to their name

Definition at line 1259 of file branch.c.

References SCIP_DECL_SORTPTRCOMP, and SCIPbranchruleGetName().

◆ SCIPbranchruleGetData()

SCIP_BRANCHRULEDATA * SCIPbranchruleGetData ( SCIP_BRANCHRULE * branchrule)

gets user data of branching rule

Parameters
branchrulebranching rule

Definition at line 1886 of file branch.c.

References assert(), SCIP_Branchrule::branchruledata, NULL, and SCIPbranchruleGetData().

Referenced by applyBdchgs(), branch(), execRelpscost(), needsStrongBranching(), SCIP_DECL_BRANCHCOPY(), SCIP_DECL_BRANCHEXECEXT(), SCIP_DECL_BRANCHEXECEXT(), SCIP_DECL_BRANCHEXECEXT(), SCIP_DECL_BRANCHEXECEXT(), SCIP_DECL_BRANCHEXECLP(), SCIP_DECL_BRANCHEXECLP(), SCIP_DECL_BRANCHEXECLP(), SCIP_DECL_BRANCHEXECLP(), SCIP_DECL_BRANCHEXECLP(), SCIP_DECL_BRANCHEXECLP(), SCIP_DECL_BRANCHEXECLP(), SCIP_DECL_BRANCHEXECLP(), SCIP_DECL_BRANCHEXECLP(), SCIP_DECL_BRANCHEXECLP(), SCIP_DECL_BRANCHEXECLP(), SCIP_DECL_BRANCHEXECLP(), SCIP_DECL_BRANCHEXECLP(), SCIP_DECL_BRANCHEXECLP(), SCIP_DECL_BRANCHEXECPS(), SCIP_DECL_BRANCHEXECPS(), SCIP_DECL_BRANCHEXECPS(), SCIP_DECL_BRANCHEXIT(), SCIP_DECL_BRANCHEXIT(), SCIP_DECL_BRANCHEXIT(), SCIP_DECL_BRANCHEXIT(), SCIP_DECL_BRANCHEXIT(), SCIP_DECL_BRANCHEXIT(), SCIP_DECL_BRANCHEXIT(), SCIP_DECL_BRANCHEXITSOL(), SCIP_DECL_BRANCHEXITSOL(), SCIP_DECL_BRANCHEXITSOL(), SCIP_DECL_BRANCHEXITSOL(), SCIP_DECL_BRANCHFREE(), SCIP_DECL_BRANCHFREE(), SCIP_DECL_BRANCHFREE(), SCIP_DECL_BRANCHFREE(), SCIP_DECL_BRANCHFREE(), SCIP_DECL_BRANCHFREE(), SCIP_DECL_BRANCHFREE(), SCIP_DECL_BRANCHFREE(), SCIP_DECL_BRANCHFREE(), SCIP_DECL_BRANCHFREE(), SCIP_DECL_BRANCHFREE(), SCIP_DECL_BRANCHFREE(), SCIP_DECL_BRANCHFREE(), SCIP_DECL_BRANCHFREE(), SCIP_DECL_BRANCHFREE(), SCIP_DECL_BRANCHINIT(), SCIP_DECL_BRANCHINIT(), SCIP_DECL_BRANCHINIT(), SCIP_DECL_BRANCHINIT(), SCIP_DECL_BRANCHINIT(), SCIP_DECL_BRANCHINIT(), SCIP_DECL_BRANCHINIT(), SCIP_DECL_BRANCHINIT(), SCIP_DECL_BRANCHINIT(), SCIP_DECL_BRANCHINIT(), SCIP_DECL_BRANCHINITSOL(), SCIP_DECL_BRANCHINITSOL(), SCIPbranchruleGetData(), SCIPfindObjBranchrule(), SCIPgetObjBranchrule(), SCIPgetVanillafullstrongData(), SCIPselectVarPseudoStrongBranching(), SCIPselectVarStrongBranching(), selectBranchVar(), selectVarMultAggrBranching(), and updateMinMaxMeanGain().

◆ SCIPbranchruleSetData()

void SCIPbranchruleSetData ( SCIP_BRANCHRULE * branchrule,
SCIP_BRANCHRULEDATA * branchruledata )

sets user data of branching rule; user has to free old data in advance!

Parameters
branchrulebranching rule
branchruledatanew branching rule user data

Definition at line 1896 of file branch.c.

References assert(), SCIP_Branchrule::branchruledata, NULL, and SCIPbranchruleSetData().

Referenced by SCIP_DECL_BRANCHFREE(), SCIP_DECL_BRANCHFREE(), SCIP_DECL_BRANCHFREE(), SCIP_DECL_BRANCHFREE(), SCIP_DECL_BRANCHFREE(), SCIP_DECL_BRANCHFREE(), SCIP_DECL_BRANCHFREE(), SCIP_DECL_BRANCHFREE(), SCIP_DECL_BRANCHFREE(), SCIP_DECL_BRANCHFREE(), SCIP_DECL_BRANCHFREE(), SCIP_DECL_BRANCHFREE(), SCIP_DECL_BRANCHFREE(), and SCIPbranchruleSetData().

◆ SCIPbranchruleMarkExact()

void SCIPbranchruleMarkExact ( SCIP_BRANCHRULE * branchrule)

marks this branching rule as safe to use in exact solving mode

Parameters
branchrulebranching rule

Definition at line 1907 of file branch.c.

References assert(), SCIP_Branchrule::exact, NULL, SCIPbranchruleMarkExact(), and TRUE.

Referenced by SCIPbranchruleMarkExact(), and SCIPincludeBranchruleRelpscost().

◆ SCIPbranchruleGetName()

const char * SCIPbranchruleGetName ( SCIP_BRANCHRULE * branchrule)

gets name of branching rule

Parameters
branchrulebranching rule

Definition at line 2018 of file branch.c.

References assert(), SCIP_Branchrule::name, NULL, and SCIPbranchruleGetName().

Referenced by branch(), SCIP_DECL_BRANCHCOPY(), SCIP_DECL_BRANCHCOPY(), SCIP_DECL_BRANCHCOPY(), SCIP_DECL_BRANCHCOPY(), SCIP_DECL_BRANCHCOPY(), SCIP_DECL_BRANCHCOPY(), SCIP_DECL_BRANCHCOPY(), SCIP_DECL_BRANCHCOPY(), SCIP_DECL_BRANCHCOPY(), SCIP_DECL_BRANCHCOPY(), SCIP_DECL_BRANCHCOPY(), SCIP_DECL_BRANCHCOPY(), SCIP_DECL_BRANCHCOPY(), SCIP_DECL_BRANCHCOPY(), SCIP_DECL_BRANCHCOPY(), SCIP_DECL_BRANCHCOPY(), SCIP_DECL_BRANCHEXECEXT(), SCIP_DECL_BRANCHEXECEXT(), SCIP_DECL_BRANCHEXECEXT(), SCIP_DECL_BRANCHEXECEXT(), SCIP_DECL_BRANCHEXECLP(), SCIP_DECL_BRANCHEXECLP(), SCIP_DECL_BRANCHEXECLP(), SCIP_DECL_BRANCHEXECLP(), SCIP_DECL_BRANCHEXECLP(), SCIP_DECL_BRANCHEXECLP(), SCIP_DECL_BRANCHEXECLP(), SCIP_DECL_BRANCHEXECLP(), SCIP_DECL_BRANCHEXECLP(), SCIP_DECL_BRANCHEXECLP(), SCIP_DECL_BRANCHEXECLP(), SCIP_DECL_BRANCHEXECLP(), SCIP_DECL_BRANCHEXECLP(), SCIP_DECL_BRANCHEXECLP(), SCIP_DECL_BRANCHEXECLP(), SCIP_DECL_BRANCHEXECPS(), SCIP_DECL_BRANCHEXECPS(), SCIP_DECL_BRANCHEXITSOL(), SCIP_DECL_BRANCHFREE(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_SORTPTRCOMP(), SCIPbranchruleCopyInclude(), SCIPbranchruleGetName(), SCIPcollectBranchruleStatistics(), SCIPincludeDialogDefaultFix(), SCIPincludeDialogDefaultSet(), and SCIPprintBranchruleStatistics().

◆ SCIPbranchruleGetDesc()

const char * SCIPbranchruleGetDesc ( SCIP_BRANCHRULE * branchrule)

gets description of branching rule

Parameters
branchrulebranching rule

Definition at line 2028 of file branch.c.

References assert(), SCIP_Branchrule::desc, NULL, and SCIPbranchruleGetDesc().

Referenced by SCIP_DECL_DIALOGEXEC(), SCIPbranchruleGetDesc(), SCIPcollectBranchruleStatistics(), SCIPincludeDialogDefaultFix(), and SCIPincludeDialogDefaultSet().

◆ SCIPbranchruleGetPriority()

int SCIPbranchruleGetPriority ( SCIP_BRANCHRULE * branchrule)

gets priority of branching rule

Parameters
branchrulebranching rule

Definition at line 2038 of file branch.c.

References assert(), NULL, SCIP_Branchrule::priority, and SCIPbranchruleGetPriority().

Referenced by SCIP_DECL_DIALOGEXEC(), and SCIPbranchruleGetPriority().

◆ SCIPbranchruleGetMaxdepth()

int SCIPbranchruleGetMaxdepth ( SCIP_BRANCHRULE * branchrule)

gets maximal depth level, up to which this branching rule should be used (-1 for no limit)

Parameters
branchrulebranching rule

Definition at line 2062 of file branch.c.

References assert(), SCIP_Branchrule::maxdepth, NULL, and SCIPbranchruleGetMaxdepth().

Referenced by SCIP_DECL_DIALOGEXEC(), and SCIPbranchruleGetMaxdepth().

◆ SCIPbranchruleGetMaxbounddist()

SCIP_Real SCIPbranchruleGetMaxbounddist ( SCIP_BRANCHRULE * branchrule)

gets maximal relative distance from current node's dual bound to primal bound for applying branching rule

Parameters
branchrulebranching rule

Definition at line 2084 of file branch.c.

References assert(), SCIP_Branchrule::maxbounddist, NULL, SCIP_Real, and SCIPbranchruleGetMaxbounddist().

Referenced by SCIP_DECL_DIALOGEXEC(), and SCIPbranchruleGetMaxbounddist().

◆ SCIPbranchruleGetSetupTime()

SCIP_Real SCIPbranchruleGetSetupTime ( SCIP_BRANCHRULE * branchrule)

gets time in seconds used in this branching rule for setting up for next stages

Parameters
branchrulebranching rule

Definition at line 2118 of file branch.c.

References assert(), NULL, SCIP_Real, SCIPbranchruleGetSetupTime(), SCIPclockGetTime(), and SCIP_Branchrule::setuptime.

Referenced by SCIPbranchruleGetSetupTime(), SCIPcollectBranchruleStatistics(), and SCIPprintBranchruleStatistics().

◆ SCIPbranchruleGetTime()

SCIP_Real SCIPbranchruleGetTime ( SCIP_BRANCHRULE * branchrule)

gets time in seconds used in this branching rule

Parameters
branchrulebranching rule

Definition at line 2128 of file branch.c.

References assert(), SCIP_Branchrule::branchclock, NULL, SCIP_Real, SCIPbranchruleGetTime(), and SCIPclockGetTime().

Referenced by SCIPbranchruleGetTime(), SCIPcollectBranchruleStatistics(), and SCIPprintBranchruleStatistics().

◆ SCIPbranchruleGetNLPCalls()

SCIP_Longint SCIPbranchruleGetNLPCalls ( SCIP_BRANCHRULE * branchrule)

gets the total number of times, the branching rule was called on an LP solution

Parameters
branchrulebranching rule

Definition at line 2138 of file branch.c.

References assert(), SCIP_Branchrule::nlpcalls, NULL, SCIP_Longint, and SCIPbranchruleGetNLPCalls().

Referenced by SCIPbranchruleGetNLPCalls(), SCIPcollectBranchruleStatistics(), and SCIPprintBranchruleStatistics().

◆ SCIPbranchruleGetNExternCalls()

SCIP_Longint SCIPbranchruleGetNExternCalls ( SCIP_BRANCHRULE * branchrule)

gets the total number of times, the branching rule was called on external candidates

gets the total number of times, the branching rule was called on an external solution

Parameters
branchrulebranching rule

Definition at line 2148 of file branch.c.

References assert(), SCIP_Branchrule::nexterncalls, NULL, SCIP_Longint, and SCIPbranchruleGetNExternCalls().

Referenced by SCIPbranchruleGetNExternCalls(), SCIPcollectBranchruleStatistics(), and SCIPprintBranchruleStatistics().

◆ SCIPbranchruleGetNPseudoCalls()

SCIP_Longint SCIPbranchruleGetNPseudoCalls ( SCIP_BRANCHRULE * branchrule)

gets the total number of times, the branching rule was called on a pseudo solution

Parameters
branchrulebranching rule

Definition at line 2158 of file branch.c.

References assert(), SCIP_Branchrule::npseudocalls, NULL, SCIP_Longint, and SCIPbranchruleGetNPseudoCalls().

Referenced by SCIPbranchruleGetNPseudoCalls(), SCIPcollectBranchruleStatistics(), and SCIPprintBranchruleStatistics().

◆ SCIPbranchruleGetNCutoffs()

SCIP_Longint SCIPbranchruleGetNCutoffs ( SCIP_BRANCHRULE * branchrule)

gets the total number of times, the branching rule detected a cutoff

Parameters
branchrulebranching rule

Definition at line 2168 of file branch.c.

References assert(), SCIP_Branchrule::ncutoffs, NULL, SCIP_Longint, and SCIPbranchruleGetNCutoffs().

Referenced by SCIPbranchruleGetNCutoffs(), SCIPcollectBranchruleStatistics(), and SCIPprintBranchruleStatistics().

◆ SCIPbranchruleGetNCutsFound()

SCIP_Longint SCIPbranchruleGetNCutsFound ( SCIP_BRANCHRULE * branchrule)

gets the total number of cuts, the branching rule separated

Parameters
branchrulebranching rule

Definition at line 2178 of file branch.c.

References assert(), SCIP_Branchrule::ncutsfound, NULL, SCIP_Longint, and SCIPbranchruleGetNCutsFound().

Referenced by SCIPbranchruleGetNCutsFound(), SCIPcollectBranchruleStatistics(), and SCIPprintBranchruleStatistics().

◆ SCIPbranchruleGetNConssFound()

SCIP_Longint SCIPbranchruleGetNConssFound ( SCIP_BRANCHRULE * branchrule)

gets the total number of constraints, the branching rule added to the respective local nodes (not counting constraints that were added to the child nodes as branching decisions)

Parameters
branchrulebranching rule

Definition at line 2190 of file branch.c.

References assert(), SCIP_Branchrule::nconssfound, NULL, SCIP_Longint, and SCIPbranchruleGetNConssFound().

Referenced by SCIPbranchruleGetNConssFound(), SCIPcollectBranchruleStatistics(), and SCIPprintBranchruleStatistics().

◆ SCIPbranchruleGetNDomredsFound()

SCIP_Longint SCIPbranchruleGetNDomredsFound ( SCIP_BRANCHRULE * branchrule)

gets the total number of domain reductions, the branching rule found

Parameters
branchrulebranching rule

Definition at line 2200 of file branch.c.

References assert(), SCIP_Branchrule::ndomredsfound, NULL, SCIP_Longint, and SCIPbranchruleGetNDomredsFound().

Referenced by SCIPbranchruleGetNDomredsFound(), SCIPcollectBranchruleStatistics(), and SCIPprintBranchruleStatistics().

◆ SCIPbranchruleGetNChildren()

SCIP_Longint SCIPbranchruleGetNChildren ( SCIP_BRANCHRULE * branchrule)

gets the total number of children, the branching rule created

Parameters
branchrulebranching rule

Definition at line 2210 of file branch.c.

References assert(), SCIP_Branchrule::nchildren, NULL, SCIP_Longint, and SCIPbranchruleGetNChildren().

Referenced by displayRelevantStats(), SCIPbranchruleGetNChildren(), SCIPcollectBranchruleStatistics(), and SCIPprintBranchruleStatistics().

◆ SCIPbranchruleIsInitialized()

SCIP_Bool SCIPbranchruleIsInitialized ( SCIP_BRANCHRULE * branchrule)

is branching rule initialized?

Parameters
branchrulebranching rule

Definition at line 2220 of file branch.c.

References assert(), SCIP_Branchrule::initialized, NULL, SCIP_Bool, and SCIPbranchruleIsInitialized().

Referenced by SCIPbranchruleIsInitialized().

◆ SCIPincludeBranchrule()

SCIP_RETCODE SCIPincludeBranchrule ( SCIP * scip,
const char * name,
const char * desc,
int priority,
int maxdepth,
SCIP_Real maxbounddist,
SCIP_DECL_BRANCHCOPY((*branchcopy)) ,
SCIP_DECL_BRANCHFREE((*branchfree)) ,
SCIP_DECL_BRANCHINIT((*branchinit)) ,
SCIP_DECL_BRANCHEXIT((*branchexit)) ,
SCIP_DECL_BRANCHINITSOL((*branchinitsol)) ,
SCIP_DECL_BRANCHEXITSOL((*branchexitsol)) ,
SCIP_DECL_BRANCHEXECLP((*branchexeclp)) ,
SCIP_DECL_BRANCHEXECEXT((*branchexecext)) ,
SCIP_DECL_BRANCHEXECPS((*branchexecps)) ,
SCIP_BRANCHRULEDATA * branchruledata )

creates a branching rule and includes it in SCIP

Precondition
This method can be called if SCIP is in one of the following stages:
Note
method has all branching rule callbacks as arguments and is thus changed every time a new callback is added in future releases; consider using SCIPincludeBranchruleBasic() and setter functions if you seek for a method which is less likely to change in future releases
Parameters
scipSCIP data structure
namename of branching rule
descdescription of branching rule
prioritypriority of the branching rule
maxdepthmaximal depth level, up to which this branching rule should be used (or -1)
maxbounddistmaximal relative distance from current node's dual bound to primal bound compared to best node's dual bound for applying branching rule (0.0: only on current best node, 1.0: on all nodes)
-copy method of branching rule or NULL if you don't want to copy your plugin into sub-SCIPs
-destructor of branching rule
-initialize branching rule
-deinitialize branching rule
-solving process initialization method of branching rule
-solving process deinitialization method of branching rule
-branching execution method for fractional LP solutions
-branching execution method for external candidates
-branching execution method for not completely fixed pseudo solutions
branchruledatabranching rule data

Definition at line 71 of file scip_branch.c.

References FALSE, maxdepth, NULL, SCIP_CALL, SCIP_DECL_BRANCHCOPY, SCIP_DECL_BRANCHEXECEXT, SCIP_DECL_BRANCHEXECLP, SCIP_DECL_BRANCHEXECPS, SCIP_DECL_BRANCHEXIT, SCIP_DECL_BRANCHEXITSOL, SCIP_DECL_BRANCHFREE, SCIP_DECL_BRANCHINIT, SCIP_DECL_BRANCHINITSOL, SCIP_INVALIDDATA, SCIP_OKAY, SCIP_Real, SCIPbranchruleCreate(), SCIPcheckStage, SCIPerrorMessage, SCIPfindBranchrule(), SCIPincludeBranchrule(), SCIPsetIncludeBranchrule(), and TRUE.

Referenced by SCIPincludeBranchrule(), and SCIPincludeObjBranchrule().

◆ SCIPincludeBranchruleBasic()

SCIP_RETCODE SCIPincludeBranchruleBasic ( SCIP * scip,
SCIP_BRANCHRULE ** branchruleptr,
const char * name,
const char * desc,
int priority,
int maxdepth,
SCIP_Real maxbounddist,
SCIP_BRANCHRULEDATA * branchruledata )

creates a branching rule and includes it in SCIP. All non-fundamental (or optional) callbacks will be set to NULL. Optional callbacks can be set via specific setter functions, see SCIPsetBranchruleInit(), SCIPsetBranchruleExit(), SCIPsetBranchruleCopy(), SCIPsetBranchruleFree(), SCIPsetBranchruleInitsol(), SCIPsetBranchruleExitsol(), SCIPsetBranchruleExecLp(), SCIPsetBranchruleExecExt(), and SCIPsetBranchruleExecPs().

Precondition
This method can be called if SCIP is in one of the following stages:
Note
if you want to set all callbacks with a single method call, consider using SCIPincludeBranchrule() instead
Parameters
scipSCIP data structure
branchruleptrpointer to branching rule, or NULL
namename of branching rule
descdescription of branching rule
prioritypriority of the branching rule
maxdepthmaximal depth level, up to which this branching rule should be used (or -1)
maxbounddistmaximal relative distance from current node's dual bound to primal bound compared to best node's dual bound for applying branching rule (0.0: only on current best node, 1.0: on all nodes)
branchruledatabranching rule data

Definition at line 123 of file scip_branch.c.

References FALSE, maxdepth, NULL, SCIP_CALL, SCIP_INVALIDDATA, SCIP_OKAY, SCIP_Real, SCIPbranchruleCreate(), SCIPcheckStage, SCIPerrorMessage, SCIPfindBranchrule(), SCIPincludeBranchruleBasic(), SCIPsetIncludeBranchrule(), and TRUE.

Referenced by SCIPincludeBranchruleAllfullstrong(), SCIPincludeBranchruleBasic(), SCIPincludeBranchruleCloud(), SCIPincludeBranchruleColoring(), SCIPincludeBranchruleDistribution(), SCIPincludeBranchruleFullstrong(), SCIPincludeBranchruleGomory(), SCIPincludeBranchruleInference(), SCIPincludeBranchruleLeastinf(), SCIPincludeBranchruleLookahead(), SCIPincludeBranchruleMostinf(), SCIPincludeBranchruleMultAggr(), SCIPincludeBranchruleMultinode(), SCIPincludeBranchruleNodereopt(), SCIPincludeBranchrulePscost(), SCIPincludeBranchruleRandom(), SCIPincludeBranchruleRelpscost(), SCIPincludeBranchruleRyanFoster(), SCIPincludeBranchruleStrongcoloring(), and SCIPincludeBranchruleVanillafullstrong().

◆ SCIPsetBranchruleCopy()

SCIP_RETCODE SCIPsetBranchruleCopy ( SCIP * scip,
SCIP_BRANCHRULE * branchrule )

sets copy method of branching rule

Parameters
scipSCIP data structure
branchrulebranching rule copy method of branching rule or NULL if you don't want to copy your plugin into sub-SCIPs

Definition at line 160 of file scip_branch.c.

References assert(), FALSE, NULL, SCIP_CALL, SCIP_DECL_BRANCHCOPY, SCIP_OKAY, SCIPbranchruleSetCopy(), SCIPcheckStage, SCIPsetBranchruleCopy(), and TRUE.

Referenced by SCIPincludeBranchruleAllfullstrong(), SCIPincludeBranchruleCloud(), SCIPincludeBranchruleColoring(), SCIPincludeBranchruleDistribution(), SCIPincludeBranchruleFullstrong(), SCIPincludeBranchruleGomory(), SCIPincludeBranchruleInference(), SCIPincludeBranchruleLeastinf(), SCIPincludeBranchruleLookahead(), SCIPincludeBranchruleMostinf(), SCIPincludeBranchruleMultAggr(), SCIPincludeBranchruleNodereopt(), SCIPincludeBranchrulePscost(), SCIPincludeBranchruleRandom(), SCIPincludeBranchruleRelpscost(), SCIPincludeBranchruleStrongcoloring(), SCIPincludeBranchruleVanillafullstrong(), and SCIPsetBranchruleCopy().

◆ SCIPsetBranchruleFree()

SCIP_RETCODE SCIPsetBranchruleFree ( SCIP * scip,
SCIP_BRANCHRULE * branchrule )

sets destructor method of branching rule

Parameters
scipSCIP data structure
branchrulebranching rule destructor of branching rule

Definition at line 176 of file scip_branch.c.

References assert(), FALSE, NULL, SCIP_CALL, SCIP_DECL_BRANCHFREE, SCIP_OKAY, SCIPbranchruleSetFree(), SCIPcheckStage, SCIPsetBranchruleFree(), and TRUE.

Referenced by SCIPincludeBranchruleAllfullstrong(), SCIPincludeBranchruleCloud(), SCIPincludeBranchruleColoring(), SCIPincludeBranchruleDistribution(), SCIPincludeBranchruleFullstrong(), SCIPincludeBranchruleGomory(), SCIPincludeBranchruleInference(), SCIPincludeBranchruleLookahead(), SCIPincludeBranchruleMultAggr(), SCIPincludeBranchrulePscost(), SCIPincludeBranchruleRandom(), SCIPincludeBranchruleRelpscost(), SCIPincludeBranchruleStrongcoloring(), SCIPincludeBranchruleVanillafullstrong(), and SCIPsetBranchruleFree().

◆ SCIPsetBranchruleInit()

SCIP_RETCODE SCIPsetBranchruleInit ( SCIP * scip,
SCIP_BRANCHRULE * branchrule )

sets initialization method of branching rule

Parameters
scipSCIP data structure
branchrulebranching rule initialize branching rule

Definition at line 192 of file scip_branch.c.

References assert(), FALSE, NULL, SCIP_CALL, SCIP_DECL_BRANCHINIT, SCIP_OKAY, SCIPbranchruleSetInit(), SCIPcheckStage, SCIPsetBranchruleInit(), and TRUE.

Referenced by SCIPincludeBranchruleAllfullstrong(), SCIPincludeBranchruleCloud(), SCIPincludeBranchruleFullstrong(), SCIPincludeBranchruleLookahead(), SCIPincludeBranchruleMultAggr(), SCIPincludeBranchrulePscost(), SCIPincludeBranchruleRandom(), SCIPincludeBranchruleStrongcoloring(), SCIPincludeBranchruleVanillafullstrong(), and SCIPsetBranchruleInit().

◆ SCIPsetBranchruleExit()

SCIP_RETCODE SCIPsetBranchruleExit ( SCIP * scip,
SCIP_BRANCHRULE * branchrule )

sets deinitialization method of branching rule

Parameters
scipSCIP data structure
branchrulebranching rule deinitialize branching rule

Definition at line 208 of file scip_branch.c.

References assert(), FALSE, NULL, SCIP_CALL, SCIP_DECL_BRANCHEXIT, SCIP_OKAY, SCIPbranchruleSetExit(), SCIPcheckStage, SCIPsetBranchruleExit(), and TRUE.

Referenced by SCIPincludeBranchruleFullstrong(), SCIPincludeBranchruleLookahead(), SCIPincludeBranchruleMultAggr(), SCIPincludeBranchruleRandom(), SCIPincludeBranchruleStrongcoloring(), SCIPincludeBranchruleVanillafullstrong(), and SCIPsetBranchruleExit().

◆ SCIPsetBranchruleInitsol()

SCIP_RETCODE SCIPsetBranchruleInitsol ( SCIP * scip,
SCIP_BRANCHRULE * branchrule )

sets solving process initialization method of branching rule

Parameters
scipSCIP data structure
branchrulebranching rule solving process initialization method of branching rule

Definition at line 224 of file scip_branch.c.

References assert(), FALSE, NULL, SCIP_CALL, SCIP_DECL_BRANCHINITSOL, SCIP_OKAY, SCIPbranchruleSetInitsol(), SCIPcheckStage, SCIPsetBranchruleInitsol(), and TRUE.

Referenced by SCIPincludeBranchruleRelpscost(), and SCIPsetBranchruleInitsol().

◆ SCIPsetBranchruleExitsol()

SCIP_RETCODE SCIPsetBranchruleExitsol ( SCIP * scip,
SCIP_BRANCHRULE * branchrule )

sets solving process deinitialization method of branching rule

Parameters
scipSCIP data structure
branchrulebranching rule solving process deinitialization method of branching rule

Definition at line 240 of file scip_branch.c.

References assert(), FALSE, NULL, SCIP_CALL, SCIP_DECL_BRANCHEXITSOL, SCIP_OKAY, SCIPbranchruleSetExitsol(), SCIPcheckStage, SCIPsetBranchruleExitsol(), and TRUE.

Referenced by SCIPincludeBranchruleDistribution(), SCIPincludeBranchruleLookahead(), SCIPincludeBranchruleRelpscost(), and SCIPsetBranchruleExitsol().

◆ SCIPsetBranchruleExecLp()

SCIP_RETCODE SCIPsetBranchruleExecLp ( SCIP * scip,
SCIP_BRANCHRULE * branchrule )

sets branching execution method for fractional LP solutions

Parameters
scipSCIP data structure
branchrulebranching rule branching execution method for fractional LP solutions

Definition at line 256 of file scip_branch.c.

References assert(), FALSE, NULL, SCIP_CALL, SCIP_DECL_BRANCHEXECLP, SCIP_OKAY, SCIPbranchruleSetExecLp(), SCIPcheckStage, SCIPsetBranchruleExecLp(), and TRUE.

Referenced by SCIPincludeBranchruleAllfullstrong(), SCIPincludeBranchruleCloud(), SCIPincludeBranchruleColoring(), SCIPincludeBranchruleDistribution(), SCIPincludeBranchruleFullstrong(), SCIPincludeBranchruleGomory(), SCIPincludeBranchruleInference(), SCIPincludeBranchruleLeastinf(), SCIPincludeBranchruleLookahead(), SCIPincludeBranchruleMostinf(), SCIPincludeBranchruleMultAggr(), SCIPincludeBranchruleMultinode(), SCIPincludeBranchruleNodereopt(), SCIPincludeBranchrulePscost(), SCIPincludeBranchruleRandom(), SCIPincludeBranchruleRelpscost(), SCIPincludeBranchruleRyanFoster(), SCIPincludeBranchruleStrongcoloring(), SCIPincludeBranchruleVanillafullstrong(), and SCIPsetBranchruleExecLp().

◆ SCIPsetBranchruleExecExt()

SCIP_RETCODE SCIPsetBranchruleExecExt ( SCIP * scip,
SCIP_BRANCHRULE * branchrule )

sets branching execution method for external candidates

Parameters
scipSCIP data structure
branchrulebranching rule branching execution method for external candidates

Definition at line 272 of file scip_branch.c.

References assert(), FALSE, NULL, SCIP_CALL, SCIP_DECL_BRANCHEXECEXT, SCIP_OKAY, SCIPbranchruleSetExecExt(), SCIPcheckStage, SCIPsetBranchruleExecExt(), and TRUE.

Referenced by SCIPincludeBranchruleInference(), SCIPincludeBranchruleLeastinf(), SCIPincludeBranchruleMostinf(), SCIPincludeBranchruleNodereopt(), SCIPincludeBranchrulePscost(), SCIPincludeBranchruleRandom(), and SCIPsetBranchruleExecExt().

◆ SCIPsetBranchruleExecPs()

SCIP_RETCODE SCIPsetBranchruleExecPs ( SCIP * scip,
SCIP_BRANCHRULE * branchrule )

sets branching execution method for not completely fixed pseudo solutions

Parameters
scipSCIP data structure
branchrulebranching rule branching execution method for not completely fixed pseudo solutions

Definition at line 288 of file scip_branch.c.

References assert(), FALSE, NULL, SCIP_CALL, SCIP_DECL_BRANCHEXECPS, SCIP_OKAY, SCIPbranchruleSetExecPs(), SCIPcheckStage, SCIPsetBranchruleExecPs(), and TRUE.

Referenced by SCIPincludeBranchruleAllfullstrong(), SCIPincludeBranchruleColoring(), SCIPincludeBranchruleInference(), SCIPincludeBranchruleNodereopt(), SCIPincludeBranchruleRandom(), and SCIPsetBranchruleExecPs().

◆ SCIPfindBranchrule()

SCIP_BRANCHRULE * SCIPfindBranchrule ( SCIP * scip,
const char * name )

returns the branching rule of the given name, or NULL if not existing

Parameters
scipSCIP data structure
namename of branching rule

Definition at line 304 of file scip_branch.c.

References assert(), NULL, SCIPfindBranchrule(), SCIPsetFindBranchrule(), and SCIPsetSortBranchrules().

Referenced by applyBdchgs(), applyRepair(), displayRelevantStats(), doSolveSubMIP(), SCIP_DECL_EVENTEXEC(), SCIP_DECL_HEUREXEC(), SCIP_DECL_HEUREXEC(), SCIPapplyRedSize(), SCIPexecRelpscostBranching(), SCIPfindBranchrule(), SCIPfindObjBranchrule(), SCIPgetVanillafullstrongData(), SCIPincludeBranchrule(), SCIPincludeBranchruleBasic(), SCIPselectBranchVarPscost(), SCIPselectVarPseudoStrongBranching(), SCIPselectVarStrongBranching(), SCIPsetCommonSubscipParams(), selectVarMultAggrBranching(), setSubscipParameters(), setupAndSolve(), setupAndSolve(), setupAndSolveSubscip(), setupAndSolveSubscip(), setupAndSolveSubscip(), setupAndSolveSubscipCrossover(), setupAndSolveSubscipMutation(), setupSCIPparamsStage3(), setupSubproblem(), setupSubScip(), setupSubScip(), setupSubScip(), solveCoveringProblem(), wrapperDins(), and wrapperRins().

◆ SCIPgetBranchrules()

SCIP_BRANCHRULE ** SCIPgetBranchrules ( SCIP * scip)

returns the array of currently available branching rules

Parameters
scipSCIP data structure

Definition at line 319 of file scip_branch.c.

References assert(), NULL, and SCIPgetBranchrules().

Referenced by SCIP_DECL_DIALOGEXEC(), SCIPgetBranchrules(), SCIPincludeDialogDefaultFix(), and SCIPincludeDialogDefaultSet().

◆ SCIPgetNBranchrules()

int SCIPgetNBranchrules ( SCIP * scip)

returns the number of currently available branching rules

Parameters
scipSCIP data structure

Definition at line 330 of file scip_branch.c.

References assert(), NULL, and SCIPgetNBranchrules().

Referenced by SCIP_DECL_DIALOGEXEC(), SCIPgetNBranchrules(), SCIPincludeDialogDefaultFix(), and SCIPincludeDialogDefaultSet().

◆ SCIPsetBranchrulePriority()

SCIP_RETCODE SCIPsetBranchrulePriority ( SCIP * scip,
SCIP_BRANCHRULE * branchrule,
int priority )

sets the priority of a branching rule

Parameters
scipSCIP data structure
branchrulebranching rule
prioritynew priority of the branching rule

Definition at line 341 of file scip_branch.c.

References assert(), NULL, SCIP_OKAY, SCIPbranchruleSetPriority(), and SCIPsetBranchrulePriority().

Referenced by SCIP_DECL_PARAMCHGD(), and SCIPsetBranchrulePriority().

◆ SCIPsetBranchruleMaxdepth()

SCIP_RETCODE SCIPsetBranchruleMaxdepth ( SCIP * scip,
SCIP_BRANCHRULE * branchrule,
int maxdepth )

sets maximal depth level, up to which this branching rule should be used (-1 for no limit)

Parameters
scipSCIP data structure
branchrulebranching rule
maxdepthnew maxdepth of the branching rule

Definition at line 356 of file scip_branch.c.

References assert(), maxdepth, NULL, SCIP_OKAY, SCIPbranchruleSetMaxdepth(), and SCIPsetBranchruleMaxdepth().

Referenced by SCIPsetBranchruleMaxdepth().

◆ SCIPsetBranchruleMaxbounddist()

SCIP_RETCODE SCIPsetBranchruleMaxbounddist ( SCIP * scip,
SCIP_BRANCHRULE * branchrule,
SCIP_Real maxbounddist )

sets maximal relative distance from current node's dual bound to primal bound for applying branching rule

Parameters
scipSCIP data structure
branchrulebranching rule
maxbounddistnew maxbounddist of the branching rule

Definition at line 371 of file scip_branch.c.

References assert(), NULL, SCIP_OKAY, SCIP_Real, SCIPbranchruleSetMaxbounddist(), and SCIPsetBranchruleMaxbounddist().

Referenced by SCIPsetBranchruleMaxbounddist().