Detailed Description

methods for branching rule plugins

Functions
SCIP_EXPORT	SCIP_DECL_SORTPTRCOMP (SCIPbranchruleComp)

SCIP_EXPORT	SCIP_DECL_SORTPTRCOMP (SCIPbranchruleCompName)

SCIP_EXPORT SCIP_BRANCHRULEDATA *	SCIPbranchruleGetData (SCIP_BRANCHRULE *branchrule)

SCIP_EXPORT void	SCIPbranchruleSetData (SCIP_BRANCHRULE branchrule, SCIP_BRANCHRULEDATA branchruledata)

SCIP_EXPORT const char *	SCIPbranchruleGetName (SCIP_BRANCHRULE *branchrule)

SCIP_EXPORT const char *	SCIPbranchruleGetDesc (SCIP_BRANCHRULE *branchrule)

SCIP_EXPORT int	SCIPbranchruleGetPriority (SCIP_BRANCHRULE *branchrule)

SCIP_EXPORT int	SCIPbranchruleGetMaxdepth (SCIP_BRANCHRULE *branchrule)

SCIP_EXPORT SCIP_Real	SCIPbranchruleGetMaxbounddist (SCIP_BRANCHRULE *branchrule)

SCIP_EXPORT SCIP_Real	SCIPbranchruleGetSetupTime (SCIP_BRANCHRULE *branchrule)

SCIP_EXPORT SCIP_Real	SCIPbranchruleGetTime (SCIP_BRANCHRULE *branchrule)

SCIP_EXPORT SCIP_Longint	SCIPbranchruleGetNLPCalls (SCIP_BRANCHRULE *branchrule)

SCIP_EXPORT SCIP_Longint	SCIPbranchruleGetNExternCalls (SCIP_BRANCHRULE *branchrule)

SCIP_EXPORT SCIP_Longint	SCIPbranchruleGetNPseudoCalls (SCIP_BRANCHRULE *branchrule)

SCIP_EXPORT SCIP_Longint	SCIPbranchruleGetNCutoffs (SCIP_BRANCHRULE *branchrule)

SCIP_EXPORT SCIP_Longint	SCIPbranchruleGetNCutsFound (SCIP_BRANCHRULE *branchrule)

SCIP_EXPORT SCIP_Longint	SCIPbranchruleGetNConssFound (SCIP_BRANCHRULE *branchrule)

SCIP_EXPORT SCIP_Longint	SCIPbranchruleGetNDomredsFound (SCIP_BRANCHRULE *branchrule)

SCIP_EXPORT SCIP_Longint	SCIPbranchruleGetNChildren (SCIP_BRANCHRULE *branchrule)

SCIP_EXPORT SCIP_Bool	SCIPbranchruleIsInitialized (SCIP_BRANCHRULE *branchrule)

SCIP_EXPORT 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_EXPORT 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_EXPORT SCIP_RETCODE	SCIPsetBranchruleCopy (SCIP scip, SCIP_BRANCHRULE branchrule, SCIP_DECL_BRANCHCOPY((*branchcopy)))

SCIP_EXPORT SCIP_RETCODE	SCIPsetBranchruleFree (SCIP scip, SCIP_BRANCHRULE branchrule, SCIP_DECL_BRANCHFREE((*branchfree)))

SCIP_EXPORT SCIP_RETCODE	SCIPsetBranchruleInit (SCIP scip, SCIP_BRANCHRULE branchrule, SCIP_DECL_BRANCHINIT((*branchinit)))

SCIP_EXPORT SCIP_RETCODE	SCIPsetBranchruleExit (SCIP scip, SCIP_BRANCHRULE branchrule, SCIP_DECL_BRANCHEXIT((*branchexit)))

SCIP_EXPORT SCIP_RETCODE	SCIPsetBranchruleInitsol (SCIP scip, SCIP_BRANCHRULE branchrule, SCIP_DECL_BRANCHINITSOL((*branchinitsol)))

SCIP_EXPORT SCIP_RETCODE	SCIPsetBranchruleExitsol (SCIP scip, SCIP_BRANCHRULE branchrule, SCIP_DECL_BRANCHEXITSOL((*branchexitsol)))

SCIP_EXPORT SCIP_RETCODE	SCIPsetBranchruleExecLp (SCIP scip, SCIP_BRANCHRULE branchrule, SCIP_DECL_BRANCHEXECLP((*branchexeclp)))

SCIP_EXPORT SCIP_RETCODE	SCIPsetBranchruleExecExt (SCIP scip, SCIP_BRANCHRULE branchrule, SCIP_DECL_BRANCHEXECEXT((*branchexecext)))

SCIP_EXPORT SCIP_RETCODE	SCIPsetBranchruleExecPs (SCIP scip, SCIP_BRANCHRULE branchrule, SCIP_DECL_BRANCHEXECPS((*branchexecps)))

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

SCIP_EXPORT SCIP_BRANCHRULE **	SCIPgetBranchrules (SCIP *scip)

SCIP_EXPORT int	SCIPgetNBranchrules (SCIP *scip)

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

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

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

Function Documentation

◆ SCIP_DECL_SORTPTRCOMP() [1/2]

SCIP_EXPORT SCIP_DECL_SORTPTRCOMP ( SCIPbranchruleComp )

compares two branching rules w. r. to their priority

Definition at line 1220 of file branch.c.

◆ SCIP_DECL_SORTPTRCOMP() [2/2]

SCIP_EXPORT SCIP_DECL_SORTPTRCOMP ( SCIPbranchruleCompName )

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

Definition at line 1226 of file branch.c.

References SCIPbranchruleGetName().

◆ SCIPbranchruleGetData()

SCIP_EXPORT SCIP_BRANCHRULEDATA* SCIPbranchruleGetData ( SCIP_BRANCHRULE * branchrule )

gets user data of branching rule

Parameters

branchrule branching rule

Definition at line 1849 of file branch.c.

References SCIP_Branchrule::branchruledata, and NULL.

Referenced by applyBdchgs(), branch(), execRelpscost(), 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(), SCIPfindObjBranchrule(), SCIPgetObjBranchrule(), SCIPgetVanillafullstrongData(), SCIPselectVarPseudoStrongBranching(), SCIPselectVarStrongBranching(), selectBranchVar(), and selectVarMultAggrBranching().

◆ SCIPbranchruleSetData()

SCIP_EXPORT void SCIPbranchruleSetData	(	SCIP_BRANCHRULE *	branchrule,
		SCIP_BRANCHRULEDATA *	branchruledata
	)

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

Parameters

branchrule	branching rule
branchruledata	new branching rule user data

Definition at line 1859 of file branch.c.

References SCIP_Branchrule::branchruledata, and NULL.

Referenced by SCIP_DECL_BRANCHFREE().

◆ SCIPbranchruleGetName()

SCIP_EXPORT const char* SCIPbranchruleGetName ( SCIP_BRANCHRULE * branchrule )

gets name of branching rule

Parameters

branchrule branching rule

Definition at line 1971 of file branch.c.

References SCIP_Branchrule::name, and NULL.

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

◆ SCIPbranchruleGetDesc()

SCIP_EXPORT const char* SCIPbranchruleGetDesc ( SCIP_BRANCHRULE * branchrule )

gets description of branching rule

Parameters

branchrule branching rule

Definition at line 1981 of file branch.c.

References SCIP_Branchrule::desc, and NULL.

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

◆ SCIPbranchruleGetPriority()

SCIP_EXPORT int SCIPbranchruleGetPriority ( SCIP_BRANCHRULE * branchrule )

gets priority of branching rule

Parameters

branchrule branching rule

Definition at line 1991 of file branch.c.

References NULL, and SCIP_Branchrule::priority.

Referenced by SCIP_DECL_DIALOGEXEC().

◆ SCIPbranchruleGetMaxdepth()

SCIP_EXPORT int SCIPbranchruleGetMaxdepth ( SCIP_BRANCHRULE * branchrule )

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

Parameters

branchrule branching rule

Definition at line 2015 of file branch.c.

References SCIP_Branchrule::maxdepth, and NULL.

Referenced by SCIP_DECL_DIALOGEXEC().

◆ SCIPbranchruleGetMaxbounddist()

SCIP_EXPORT SCIP_Real SCIPbranchruleGetMaxbounddist ( SCIP_BRANCHRULE * branchrule )

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

Parameters

branchrule branching rule

Definition at line 2037 of file branch.c.

References SCIP_Branchrule::maxbounddist, and NULL.

Referenced by SCIP_DECL_DIALOGEXEC().

◆ SCIPbranchruleGetSetupTime()

SCIP_EXPORT SCIP_Real SCIPbranchruleGetSetupTime ( SCIP_BRANCHRULE * branchrule )

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

Parameters

branchrule branching rule

Definition at line 2071 of file branch.c.

References NULL, SCIPclockGetTime(), and SCIP_Branchrule::setuptime.

Referenced by SCIPprintBranchruleStatistics().

◆ SCIPbranchruleGetTime()

SCIP_EXPORT SCIP_Real SCIPbranchruleGetTime ( SCIP_BRANCHRULE * branchrule )

gets time in seconds used in this branching rule

Parameters

branchrule branching rule

Definition at line 2081 of file branch.c.

References SCIP_Branchrule::branchclock, NULL, and SCIPclockGetTime().

Referenced by SCIPprintBranchruleStatistics().

◆ SCIPbranchruleGetNLPCalls()

SCIP_EXPORT SCIP_Longint SCIPbranchruleGetNLPCalls ( SCIP_BRANCHRULE * branchrule )

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

Parameters

branchrule branching rule

Definition at line 2091 of file branch.c.

References SCIP_Branchrule::nlpcalls, and NULL.

Referenced by SCIPprintBranchruleStatistics().

◆ SCIPbranchruleGetNExternCalls()

SCIP_EXPORT 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

branchrule branching rule

Definition at line 2101 of file branch.c.

References SCIP_Branchrule::nexterncalls, and NULL.

Referenced by SCIPprintBranchruleStatistics().

◆ SCIPbranchruleGetNPseudoCalls()

SCIP_EXPORT SCIP_Longint SCIPbranchruleGetNPseudoCalls ( SCIP_BRANCHRULE * branchrule )

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

Parameters

branchrule branching rule

Definition at line 2111 of file branch.c.

References SCIP_Branchrule::npseudocalls, and NULL.

Referenced by SCIPprintBranchruleStatistics().

◆ SCIPbranchruleGetNCutoffs()

SCIP_EXPORT SCIP_Longint SCIPbranchruleGetNCutoffs ( SCIP_BRANCHRULE * branchrule )

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

Parameters

branchrule branching rule

Definition at line 2121 of file branch.c.

References SCIP_Branchrule::ncutoffs, and NULL.

Referenced by SCIPprintBranchruleStatistics().

◆ SCIPbranchruleGetNCutsFound()

SCIP_EXPORT SCIP_Longint SCIPbranchruleGetNCutsFound ( SCIP_BRANCHRULE * branchrule )

gets the total number of cuts, the branching rule separated

Parameters

branchrule branching rule

Definition at line 2131 of file branch.c.

References SCIP_Branchrule::ncutsfound, and NULL.

Referenced by SCIPprintBranchruleStatistics().

◆ SCIPbranchruleGetNConssFound()

SCIP_EXPORT 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

branchrule branching rule

Definition at line 2143 of file branch.c.

References SCIP_Branchrule::nconssfound, and NULL.

Referenced by SCIPprintBranchruleStatistics().

◆ SCIPbranchruleGetNDomredsFound()

SCIP_EXPORT SCIP_Longint SCIPbranchruleGetNDomredsFound ( SCIP_BRANCHRULE * branchrule )

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

Parameters

branchrule branching rule

Definition at line 2153 of file branch.c.

References SCIP_Branchrule::ndomredsfound, and NULL.

Referenced by SCIPprintBranchruleStatistics().

◆ SCIPbranchruleGetNChildren()

SCIP_EXPORT SCIP_Longint SCIPbranchruleGetNChildren ( SCIP_BRANCHRULE * branchrule )

gets the total number of children, the branching rule created

Parameters

branchrule branching rule

Definition at line 2163 of file branch.c.

References SCIP_Branchrule::nchildren, and NULL.

Referenced by displayRelevantStats(), and SCIPprintBranchruleStatistics().

◆ SCIPbranchruleIsInitialized()

SCIP_EXPORT SCIP_Bool SCIPbranchruleIsInitialized ( SCIP_BRANCHRULE * branchrule )

is branching rule initialized?

Parameters

branchrule branching rule

Definition at line 2173 of file branch.c.

References SCIP_Branchrule::initialized, and NULL.

Referenced by SCIPsetIncludeNodesel().

◆ SCIPincludeBranchrule()

SCIP_EXPORT 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

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

scip	SCIP data structure
name	name of branching rule
desc	description of branching rule
priority	priority of the branching rule
maxdepth	maximal depth level, up to which this branching rule should be used (or -1)
maxbounddist	maximal 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)
branchruledata	branching rule data

Definition at line 59 of file scip_branch.c.

References FALSE, Scip::mem, Scip::messagehdlr, NULL, SCIP_CALL, SCIP_INVALIDDATA, SCIP_OKAY, SCIPbranchruleCreate(), SCIPcheckStage(), SCIPerrorMessage, SCIPfindBranchrule(), SCIPsetIncludeBranchrule(), Scip::set, SCIP_Mem::setmem, and TRUE.

Referenced by SCIPincludeObjBranchrule().

◆ SCIPincludeBranchruleBasic()

SCIP_EXPORT 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().

Note: if you want to set all callbacks with a single method call, consider using SCIPincludeBranchrule() instead

Parameters

scip	SCIP data structure
branchruleptr	pointer to branching rule, or NULL
name	name of branching rule
desc	description of branching rule
priority	priority of the branching rule
maxdepth	maximal depth level, up to which this branching rule should be used (or -1)
maxbounddist	maximal 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)
branchruledata	branching rule data

Definition at line 107 of file scip_branch.c.

References FALSE, Scip::mem, Scip::messagehdlr, NULL, SCIP_CALL, SCIP_INVALIDDATA, SCIP_OKAY, SCIPbranchruleCreate(), SCIPcheckStage(), SCIPerrorMessage, SCIPfindBranchrule(), SCIPsetIncludeBranchrule(), Scip::set, SCIP_Mem::setmem, and TRUE.

◆ SCIPsetBranchruleCopy()

SCIP_EXPORT SCIP_RETCODE SCIPsetBranchruleCopy	(	SCIP *	scip,
		SCIP_BRANCHRULE *	branchrule,
		SCIP_DECL_BRANCHCOPY((*branchcopy))
	)

sets copy method of branching rule

Parameters

scip	SCIP data structure
branchrule	branching rule

Definition at line 144 of file scip_branch.c.

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

Referenced by SCIPincludeBranchruleAllfullstrong(), SCIPincludeBranchruleColoring(), SCIPincludeBranchruleDistribution(), SCIPincludeBranchruleFullstrong(), SCIPincludeBranchruleInference(), SCIPincludeBranchruleLeastinf(), SCIPincludeBranchruleMostinf(), SCIPincludeBranchruleMultAggr(), SCIPincludeBranchruleNodereopt(), SCIPincludeBranchrulePscost(), SCIPincludeBranchruleRandom(), SCIPincludeBranchruleStp(), SCIPincludeBranchruleStrongcoloring(), and SCIPincludeBranchruleVanillafullstrong().

◆ SCIPsetBranchruleFree()

SCIP_EXPORT SCIP_RETCODE SCIPsetBranchruleFree	(	SCIP *	scip,
		SCIP_BRANCHRULE *	branchrule,
		SCIP_DECL_BRANCHFREE((*branchfree))
	)

sets destructor method of branching rule

Parameters

scip	SCIP data structure
branchrule	branching rule

Definition at line 160 of file scip_branch.c.

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

Referenced by SCIPincludeBranchruleAllfullstrong(), SCIPincludeBranchruleCloud(), SCIPincludeBranchruleDistribution(), SCIPincludeBranchruleFullstrong(), SCIPincludeBranchruleInference(), SCIPincludeBranchruleMultAggr(), SCIPincludeBranchrulePscost(), SCIPincludeBranchruleRandom(), SCIPincludeBranchruleStp(), SCIPincludeBranchruleStrongcoloring(), and SCIPincludeBranchruleVanillafullstrong().

◆ SCIPsetBranchruleInit()

SCIP_EXPORT SCIP_RETCODE SCIPsetBranchruleInit	(	SCIP *	scip,
		SCIP_BRANCHRULE *	branchrule,
		SCIP_DECL_BRANCHINIT((*branchinit))
	)

sets initialization method of branching rule

Parameters

scip	SCIP data structure
branchrule	branching rule

Definition at line 176 of file scip_branch.c.

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

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

◆ SCIPsetBranchruleExit()

SCIP_EXPORT SCIP_RETCODE SCIPsetBranchruleExit	(	SCIP *	scip,
		SCIP_BRANCHRULE *	branchrule,
		SCIP_DECL_BRANCHEXIT((*branchexit))
	)

sets deinitialization method of branching rule

Parameters

scip	SCIP data structure
branchrule	branching rule

Definition at line 192 of file scip_branch.c.

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

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

◆ SCIPsetBranchruleInitsol()

SCIP_EXPORT SCIP_RETCODE SCIPsetBranchruleInitsol	(	SCIP *	scip,
		SCIP_BRANCHRULE *	branchrule,
		SCIP_DECL_BRANCHINITSOL((*branchinitsol))
	)

sets solving process initialization method of branching rule

Parameters

scip	SCIP data structure
branchrule	branching rule

Definition at line 208 of file scip_branch.c.

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

◆ SCIPsetBranchruleExitsol()

SCIP_EXPORT SCIP_RETCODE SCIPsetBranchruleExitsol	(	SCIP *	scip,
		SCIP_BRANCHRULE *	branchrule,
		SCIP_DECL_BRANCHEXITSOL((*branchexitsol))
	)

sets solving process deinitialization method of branching rule

Parameters

scip	SCIP data structure
branchrule	branching rule

Definition at line 224 of file scip_branch.c.

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

Referenced by SCIPincludeBranchruleDistribution().

◆ SCIPsetBranchruleExecLp()

SCIP_EXPORT SCIP_RETCODE SCIPsetBranchruleExecLp	(	SCIP *	scip,
		SCIP_BRANCHRULE *	branchrule,
		SCIP_DECL_BRANCHEXECLP((*branchexeclp))
	)

sets branching execution method for fractional LP solutions

Parameters

scip	SCIP data structure
branchrule	branching rule

Definition at line 240 of file scip_branch.c.

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

◆ SCIPsetBranchruleExecExt()

SCIP_EXPORT SCIP_RETCODE SCIPsetBranchruleExecExt	(	SCIP *	scip,
		SCIP_BRANCHRULE *	branchrule,
		SCIP_DECL_BRANCHEXECEXT((*branchexecext))
	)

sets branching execution method for external candidates

Parameters

scip	SCIP data structure
branchrule	branching rule

Definition at line 256 of file scip_branch.c.

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

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

◆ SCIPsetBranchruleExecPs()

SCIP_EXPORT SCIP_RETCODE SCIPsetBranchruleExecPs	(	SCIP *	scip,
		SCIP_BRANCHRULE *	branchrule,
		SCIP_DECL_BRANCHEXECPS((*branchexecps))
	)

sets branching execution method for not completely fixed pseudo solutions

Parameters

scip	SCIP data structure
branchrule	branching rule

Definition at line 272 of file scip_branch.c.

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

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

◆ SCIPfindBranchrule()

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

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

Parameters

scip	SCIP data structure
name	name of branching rule

Definition at line 288 of file scip_branch.c.

References NULL, SCIPsetFindBranchrule(), SCIPsetSortBranchrules(), and Scip::set.

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

◆ SCIPgetBranchrules()

SCIP_EXPORT SCIP_BRANCHRULE** SCIPgetBranchrules ( SCIP * scip )

returns the array of currently available branching rules

Parameters

scip	SCIP data structure

Definition at line 303 of file scip_branch.c.

References SCIP_Set::branchrules, NULL, and Scip::set.

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

◆ SCIPgetNBranchrules()

SCIP_EXPORT int SCIPgetNBranchrules ( SCIP * scip )

returns the number of currently available branching rules

Parameters

scip	SCIP data structure

Definition at line 314 of file scip_branch.c.

References SCIP_Set::nbranchrules, NULL, and Scip::set.

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

◆ SCIPsetBranchrulePriority()

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

sets the priority of a branching rule

Parameters

scip	SCIP data structure
branchrule	branching rule
priority	new priority of the branching rule

Definition at line 325 of file scip_branch.c.

References NULL, SCIP_OKAY, SCIPbranchruleSetPriority(), and Scip::set.

Referenced by SCIP_DECL_PARAMCHGD().

◆ SCIPsetBranchruleMaxdepth()

SCIP_EXPORT 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

scip	SCIP data structure
branchrule	branching rule
maxdepth	new maxdepth of the branching rule

Definition at line 340 of file scip_branch.c.

References NULL, SCIP_OKAY, SCIPbranchruleSetMaxdepth(), and Scip::set.

◆ SCIPsetBranchruleMaxbounddist()

SCIP_EXPORT 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

scip	SCIP data structure
branchrule	branching rule
maxbounddist	new maxbounddist of the branching rule

Definition at line 355 of file scip_branch.c.

References NULL, SCIP_OKAY, SCIPbranchruleSetMaxbounddist(), and Scip::set.

SCIP

Detailed Description

Functions

Function Documentation

◆ SCIP_DECL_SORTPTRCOMP() [1/2]

◆ SCIP_DECL_SORTPTRCOMP() [2/2]

◆ SCIPbranchruleGetData()

◆ SCIPbranchruleSetData()

◆ SCIPbranchruleGetName()

◆ SCIPbranchruleGetDesc()

◆ SCIPbranchruleGetPriority()

◆ SCIPbranchruleGetMaxdepth()

◆ SCIPbranchruleGetMaxbounddist()

◆ SCIPbranchruleGetSetupTime()

◆ SCIPbranchruleGetTime()

◆ SCIPbranchruleGetNLPCalls()

◆ SCIPbranchruleGetNExternCalls()

◆ SCIPbranchruleGetNPseudoCalls()

◆ SCIPbranchruleGetNCutoffs()

◆ SCIPbranchruleGetNCutsFound()

◆ SCIPbranchruleGetNConssFound()

◆ SCIPbranchruleGetNDomredsFound()

◆ SCIPbranchruleGetNChildren()

◆ SCIPbranchruleIsInitialized()

◆ SCIPincludeBranchrule()

◆ SCIPincludeBranchruleBasic()

◆ SCIPsetBranchruleCopy()

◆ SCIPsetBranchruleFree()

◆ SCIPsetBranchruleInit()

◆ SCIPsetBranchruleExit()

◆ SCIPsetBranchruleInitsol()

◆ SCIPsetBranchruleExitsol()

◆ SCIPsetBranchruleExecLp()

◆ SCIPsetBranchruleExecExt()

◆ SCIPsetBranchruleExecPs()

◆ SCIPfindBranchrule()

◆ SCIPgetBranchrules()

◆ SCIPgetNBranchrules()

◆ SCIPsetBranchrulePriority()

◆ SCIPsetBranchruleMaxdepth()

◆ SCIPsetBranchruleMaxbounddist()