Detailed Description

methods to query search tree related information

See also: Public methods for nodes

Modules
	Nodes
	methods for nodes of the search tree of SCIP

Functions
SCIP_EXPORT SCIP_NODE *	SCIPgetFocusNode (SCIP *scip)

SCIP_EXPORT SCIP_NODE *	SCIPgetCurrentNode (SCIP *scip)

SCIP_EXPORT int	SCIPgetDepth (SCIP *scip)

SCIP_EXPORT int	SCIPgetFocusDepth (SCIP *scip)

SCIP_EXPORT int	SCIPgetPlungeDepth (SCIP *scip)

SCIP_EXPORT SCIP_NODE *	SCIPgetRootNode (SCIP *scip)

SCIP_EXPORT int	SCIPgetEffectiveRootDepth (SCIP *scip)

SCIP_EXPORT SCIP_Bool	SCIPinRepropagation (SCIP *scip)

SCIP_EXPORT SCIP_RETCODE	SCIPgetChildren (SCIP scip, SCIP_NODE *children, int nchildren)

SCIP_EXPORT int	SCIPgetNChildren (SCIP *scip)

SCIP_EXPORT SCIP_RETCODE	SCIPgetSiblings (SCIP scip, SCIP_NODE *siblings, int nsiblings)

SCIP_EXPORT int	SCIPgetNSiblings (SCIP *scip)

SCIP_EXPORT SCIP_RETCODE	SCIPgetLeaves (SCIP scip, SCIP_NODE *leaves, int nleaves)

SCIP_EXPORT int	SCIPgetNLeaves (SCIP *scip)

SCIP_EXPORT int	SCIPgetNNodesLeft (SCIP *scip)

SCIP_EXPORT SCIP_NODE *	SCIPgetPrioChild (SCIP *scip)

SCIP_EXPORT SCIP_NODE *	SCIPgetPrioSibling (SCIP *scip)

SCIP_EXPORT SCIP_NODE *	SCIPgetBestChild (SCIP *scip)

SCIP_EXPORT SCIP_NODE *	SCIPgetBestSibling (SCIP *scip)

SCIP_EXPORT SCIP_NODE *	SCIPgetBestLeaf (SCIP *scip)

SCIP_EXPORT SCIP_NODE *	SCIPgetBestNode (SCIP *scip)

SCIP_EXPORT SCIP_NODE *	SCIPgetBestboundNode (SCIP *scip)

SCIP_EXPORT SCIP_RETCODE	SCIPgetOpenNodesData (SCIP scip, SCIP_NODE leaves, SCIP_NODE children, SCIP_NODE *siblings, int nleaves, int nchildren, int nsiblings)

SCIP_EXPORT SCIP_RETCODE	SCIPcutoffNode (SCIP scip, SCIP_NODE node)

SCIP_EXPORT SCIP_RETCODE	SCIPrepropagateNode (SCIP scip, SCIP_NODE node)

SCIP_EXPORT int	SCIPgetCutoffdepth (SCIP *scip)

SCIP_EXPORT int	SCIPgetRepropdepth (SCIP *scip)

SCIP_EXPORT SCIP_RETCODE	SCIPprintNodeRootPath (SCIP scip, SCIP_NODE node, FILE *file)

SCIP_EXPORT void	SCIPsetFocusnodeLP (SCIP *scip, SCIP_Bool solvelp)

SCIP_EXPORT SCIP_Bool	SCIPwasNodeLastBranchParent (SCIP scip, SCIP_NODE node)

Function Documentation

◆ SCIPgetFocusNode()

SCIP_EXPORT SCIP_NODE* SCIPgetFocusNode ( SCIP * scip )

gets focus node in the tree

if we are in probing/diving mode this method returns the node in the tree where the probing/diving mode was started.

Returns: the current node of the search tree

Precondition

This method can be called if scip is in one of the following stages:

Parameters

scip	SCIP data structure

Definition at line 62 of file scip_tree.c.

References FALSE, SCIP_CALL_ABORT, SCIPcheckStage(), SCIPtreeGetFocusNode(), Scip::tree, and TRUE.

Referenced by applyCliqueFixings(), SCIPvarUpdatePseudocost(), subtreeSumGapInsertChildren(), subtreeSumGapSplit(), and subtreeSumGapUpdate().

◆ SCIPgetCurrentNode()

SCIP_EXPORT SCIP_NODE* SCIPgetCurrentNode ( SCIP * scip )

gets current node in the tree

Returns: the current node of the search tree

Precondition

This method can be called if scip is in one of the following stages:

Parameters

scip	SCIP data structure

Definition at line 81 of file scip_tree.c.

References FALSE, SCIP_CALL_ABORT, SCIPcheckStage(), SCIPtreeGetCurrentNode(), Scip::tree, and TRUE.

Referenced by applyDomainChanges(), applyProbing(), applyVbounds(), branchCons(), checkDivingCandidates(), computeBranchingVariables(), computeDynamicRowOrder(), constructCompression(), createAndSplitProblem(), enforceCardinality(), enforceConstraint(), Exec(), execGenVBounds(), execRelpscost(), executeStrongBranching(), findComponents(), generateCut(), generateSecantCut(), generateSecantCutNoCheck(), getBranchingDecisionStrongbranchSOS1(), initProblem(), performInteriorSolCutStrengthening(), redbasedVarfixing(), SCIP_DECL_BRANCHEXECEXT(), SCIP_DECL_BRANCHEXECLP(), SCIP_DECL_BRANCHEXECPS(), SCIP_DECL_BRANCHEXITSOL(), SCIP_DECL_CONSPROP(), SCIP_DECL_CONSSEPALP(), SCIP_DECL_EVENTEXEC(), SCIP_DECL_HEUREXEC(), SCIP_DECL_PRICERFARKAS(), SCIP_DECL_PRICERREDCOST(), SCIP_DECL_PROPEXEC(), SCIP_DECL_SEPAEXECLP(), SCIPanalyzeDeductionsProbing(), SCIPendStrongbranch(), SCIPstartDive(), SCIPStpBranchruleApplyVertexChgs(), SCIPtreemodelSelectCandidate(), selectBranchingVertexByLp2Flow(), selectBranchingVertexBySol(), selectVarMultAggrBranching(), separateOddCycles(), setupAndSolveSubscipRapidlearning(), subscipdataCopySubscip(), tightenBounds(), and updateDataStructures().

◆ SCIPgetDepth()

SCIP_EXPORT int SCIPgetDepth ( SCIP * scip )

gets depth of current node, or -1 if no current node exists; in probing, the current node is the last probing node, such that the depth includes the probing path

Returns: the depth of current node, or -1 if no current node exists; in probing, the current node is the last probing node, such that the depth includes the probing path

Precondition

This method can be called if SCIP is in one of the following stages:

Parameters

scip	SCIP data structure

Definition at line 638 of file scip_tree.c.

References FALSE, SCIP_CALL_ABORT, SCIPcheckStage(), SCIPtreeGetCurrentDepth(), Scip::tree, and TRUE.

Referenced by applyCliqueFixings(), applyGenVBounds(), applyNlobbt(), applyOptcumulative(), applyVboundsFixings(), computeCut(), createAndSplitProblem(), createRow(), createSubscip(), disableCons(), doSeparation(), dualcostVarfixing(), enforceCardinality(), enforceConflictgraph(), enforceConstraint(), execGenVBounds(), execRelpscost(), filterExistingLP(), findComponents(), generateClusterCuts(), generateCutFactorable(), generateCutNonConvex(), generateDisjCutSOS1(), initImplGraphSOS1(), initProblem(), performFixing(), performImplicationGraphAnalysis(), performRandRounding(), processRealBoundChg(), processWatchedVars(), propagateCons(), propagateCutoffboundBinvar(), propagateCutoffboundGlobally(), propagateRootRedcostBinvar(), propIndicator(), redbasedVarfixing(), removeFixedBinvars(), runVanillaStrongBranching(), SCIP_DECL_BRANCHEXECLP(), SCIP_DECL_CONSPROP(), SCIP_DECL_CONSSEPALP(), SCIP_DECL_CONSSEPASOL(), SCIP_DECL_DISPOUTPUT(), SCIP_DECL_HEUREXEC(), SCIP_DECL_NODESELSELECT(), SCIP_DECL_PRICERREDCOST(), SCIP_DECL_PROPEXEC(), SCIP_DECL_SEPAEXECLP(), SCIPaddRow(), SCIPapplyLockFixings(), SCIPapplyUndercover(), SCIPapplyZeroobj(), SCIPbendersExec(), SCIPbendersSetupSubproblem(), SCIPgetRowprepRowCons(), SCIPgetRowprepRowConshdlr(), SCIPgetRowprepRowSepa(), SCIPisConflictAnalysisApplicable(), SCIPperformGenericDivingAlgorithm(), SCIPpropagateProbing(), SCIPselectVarPseudoStrongBranching(), SCIPselectVarStrongBranching(), SCIPsnprintfProbingStats(), SCIPupdateDivesetStats(), SCIPvarUpdatePseudocost(), selectVarMultAggrBranching(), sep_2cut(), sepaImplBoundCutsSOS1(), separateCuts(), separateIndicators(), separateOddCycles(), separateSOS1(), setupAndSolveSubscipRapidlearning(), setupProbingSCIP(), solveNlp(), storeAllBilinearTerms(), tryOneOpt(), and trySolCandidate().

◆ SCIPgetFocusDepth()

SCIP_EXPORT int SCIPgetFocusDepth ( SCIP * scip )

gets depth of the focus node, or -1 if no focus node exists; the focus node is the currently processed node in the branching tree, excluding the nodes of the probing path

Returns: the depth of the focus node, or -1 if no focus node exists; the focus node is the currently processed node in the branching tree, excluding the nodes of the probing path

Precondition

This method can be called if SCIP is in one of the following stages:

Parameters

scip	SCIP data structure

Definition at line 664 of file scip_tree.c.

References FALSE, SCIP_CALL_ABORT, SCIPcheckStage(), SCIPtreeGetFocusDepth(), Scip::tree, and TRUE.

◆ SCIPgetPlungeDepth()

SCIP_EXPORT int SCIPgetPlungeDepth ( SCIP * scip )

gets current plunging depth (successive times, a child was selected as next node)

Returns: the current plunging depth (successive times, a child was selected as next node)

Precondition

This method can be called if SCIP is in one of the following stages:

Parameters

scip	SCIP data structure

Definition at line 681 of file scip_tree.c.

References FALSE, SCIP_Stat::plungedepth, SCIP_CALL_ABORT, SCIPcheckStage(), Scip::stat, and TRUE.

Referenced by SCIP_DECL_DISPOUTPUT(), and SCIP_DECL_NODESELSELECT().

◆ SCIPgetRootNode()

SCIP_EXPORT SCIP_NODE* SCIPgetRootNode ( SCIP * scip )

gets the root node of the tree

Returns: the root node of the search tree

Precondition

This method can be called if scip is in one of the following stages:

Parameters

scip	SCIP data structure

Definition at line 100 of file scip_tree.c.

References FALSE, SCIP_CALL_ABORT, SCIPcheckStage(), SCIPtreeGetRootNode(), Scip::tree, and TRUE.

Referenced by Exec(), propagateCons(), SCIP_DECL_BRANCHEXECLP(), SCIP_DECL_PRICERFARKAS(), SCIPcopyConcurrentSolvingStats(), SCIPreoptimizeNode(), SCIPshrinkDisjunctiveVarSet(), tightenVarLb(), and tightenVarUb().

◆ SCIPgetEffectiveRootDepth()

SCIP_EXPORT int SCIPgetEffectiveRootDepth ( SCIP * scip )

gets the effective root depth, i.e., the depth of the deepest node which is part of all paths from the root node to the unprocessed nodes.

Returns: effective root depth

Precondition

This method can be called if scip is in one of the following stages:

SCIP_STAGE_SOLVING

Parameters

scip	SCIP data structure

Definition at line 117 of file scip_tree.c.

References FALSE, SCIP_CALL_ABORT, SCIPcheckStage(), SCIPtreeGetEffectiveRootDepth(), Scip::tree, and TRUE.

Referenced by SCIP_DECL_EVENTEXEC(), SCIP_DECL_HEUREXEC(), and setupAndSolveSubscipRapidlearning().

◆ SCIPinRepropagation()

SCIP_EXPORT SCIP_Bool SCIPinRepropagation ( SCIP * scip )

returns whether the current node is already solved and only propagated again

Returns: TRUE is returned if SCIP performance repropagation, otherwise FALSE.

Precondition

This method can be called if scip is in one of the following stages:

Parameters

scip	SCIP data structure

Definition at line 136 of file scip_tree.c.

References FALSE, SCIP_CALL_ABORT, SCIPcheckStage(), SCIPtreeInRepropagation(), Scip::tree, and TRUE.

Referenced by applyProbingVar(), computeEffectiveHorizonCumulativeCondition(), fixIntegerVariable(), fixIntegerVariableLb(), fixIntegerVariableUb(), propagateAllConss(), propagateCons(), propagateVbounds(), propIndicator(), removeFixedBinvars(), SCIP_DECL_CONSPROP(), SCIP_DECL_PROPEXEC(), solveIndependentCons(), and updateSubproblemLowerbound().

◆ SCIPgetChildren()

SCIP_EXPORT SCIP_RETCODE SCIPgetChildren	(	SCIP *	scip,
		SCIP_NODE ***	children,
		int *	nchildren
	)

gets children of focus node along with the number of children

Returns: SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See SCIP_RETCODE for a complete list of error codes.

Precondition

This method can be called if scip is in one of the following stages:

SCIP_STAGE_SOLVING

gets children of focus node along with the number of children

Returns: SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See SCIP_RETCODE for a complete list of error codes.

Precondition

This method can be called if scip is in one of the following stages:

Parameters

scip	SCIP data structure
children	pointer to store children array, or NULL if not needed
nchildren	pointer to store number of children, or NULL if not needed

Definition at line 154 of file scip_tree.c.

References SCIP_Tree::children, FALSE, SCIP_Tree::nchildren, NULL, SCIP_CALL, SCIP_OKAY, SCIPcheckStage(), Scip::tree, and TRUE.

Referenced by checkLeavesBelowIncumbent(), SCIPsolve(), subtreeSumGapInsertChildren(), updateDataStructures(), and writeBounds().

◆ SCIPgetNChildren()

SCIP_EXPORT int SCIPgetNChildren ( SCIP * scip )

gets number of children of focus node

Returns: number of children of the focus node

Precondition

This method can be called if scip is in one of the following stages:

SCIP_STAGE_SOLVING

gets number of children of focus node

Returns: number of children of the focus node

Precondition

This method can be called if scip is in one of the following stages:

Parameters

scip	SCIP data structure

Definition at line 178 of file scip_tree.c.

References FALSE, SCIP_Tree::nchildren, SCIP_CALL_ABORT, SCIPcheckStage(), Scip::tree, and TRUE.

Referenced by SCIP_DECL_CONSDEACTIVE(), subtreeSumGapUpdate(), and updateDataStructures().

◆ SCIPgetSiblings()

SCIP_EXPORT SCIP_RETCODE SCIPgetSiblings	(	SCIP *	scip,
		SCIP_NODE ***	siblings,
		int *	nsiblings
	)

gets siblings of focus node along with the number of siblings

Returns: SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See SCIP_RETCODE for a complete list of error codes.

Precondition

This method can be called if scip is in one of the following stages:

SCIP_STAGE_SOLVING

gets siblings of focus node along with the number of siblings

Returns: SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See SCIP_RETCODE for a complete list of error codes.

Precondition

This method can be called if scip is in one of the following stages:

Parameters

scip	SCIP data structure
siblings	pointer to store siblings array, or NULL if not needed
nsiblings	pointer to store number of siblings, or NULL if not needed

Definition at line 196 of file scip_tree.c.

References FALSE, SCIP_Tree::nsiblings, NULL, SCIP_CALL, SCIP_OKAY, SCIPcheckStage(), SCIP_Tree::siblings, Scip::tree, and TRUE.

Referenced by checkLeavesBelowIncumbent(), SCIPsolve(), and writeBounds().

◆ SCIPgetNSiblings()

SCIP_EXPORT int SCIPgetNSiblings ( SCIP * scip )

gets number of siblings of focus node

Returns: the number of siblings of focus node

Precondition

This method can be called if scip is in one of the following stages:

SCIP_STAGE_SOLVING

gets number of siblings of focus node

Returns: the number of siblings of focus node

Precondition

This method can be called if scip is in one of the following stages:

Parameters

scip	SCIP data structure

Definition at line 220 of file scip_tree.c.

References FALSE, SCIP_Tree::nsiblings, SCIP_CALL_ABORT, SCIPcheckStage(), Scip::tree, and TRUE.

Referenced by subtreeSumGapUpdate().

◆ SCIPgetLeaves()

SCIP_EXPORT SCIP_RETCODE SCIPgetLeaves	(	SCIP *	scip,
		SCIP_NODE ***	leaves,
		int *	nleaves
	)

gets leaves of the tree along with the number of leaves

Returns: SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See SCIP_RETCODE for a complete list of error codes.

Precondition

This method can be called if scip is in one of the following stages:

SCIP_STAGE_SOLVING

gets leaves of the tree along with the number of leaves

Returns: SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See SCIP_RETCODE for a complete list of error codes.

Precondition

This method can be called if scip is in one of the following stages:

Parameters

scip	SCIP data structure
leaves	pointer to store leaves array, or NULL if not needed
nleaves	pointer to store number of leaves, or NULL if not needed

Definition at line 238 of file scip_tree.c.

References FALSE, SCIP_Tree::leaves, NULL, SCIP_CALL, SCIP_OKAY, SCIPcheckStage(), SCIPnodepqLen(), SCIPnodepqNodes(), Scip::tree, and TRUE.

Referenced by checkLeavesBelowIncumbent(), SCIPsolve(), and writeBounds().

◆ SCIPgetNLeaves()

SCIP_EXPORT int SCIPgetNLeaves ( SCIP * scip )

gets number of leaves in the tree

Returns: the number of leaves in the tree

Precondition

This method can be called if scip is in one of the following stages:

SCIP_STAGE_SOLVING

gets number of leaves in the tree

Returns: the number of leaves in the tree

Precondition

This method can be called if scip is in one of the following stages:

Parameters

scip	SCIP data structure

Definition at line 262 of file scip_tree.c.

References FALSE, SCIP_Tree::leaves, SCIP_CALL_ABORT, SCIPcheckStage(), SCIPnodepqLen(), Scip::tree, and TRUE.

Referenced by subtreeSumGapUpdate().

◆ SCIPgetNNodesLeft()

SCIP_EXPORT int SCIPgetNNodesLeft ( SCIP * scip )

gets number of nodes left in the tree (children + siblings + leaves)

Returns: the number of nodes left in the tree (children + siblings + leaves)

Precondition

This method can be called if SCIP is in one of the following stages:

Parameters

scip	SCIP data structure

Definition at line 612 of file scip_tree.c.

References FALSE, SCIP_CALL_ABORT, SCIPcheckStage(), SCIPtreeGetNNodes(), Scip::tree, and TRUE.

Referenced by applyDomainChanges(), checkLeavesBelowIncumbent(), releaseNodeInformation(), SCIP_DECL_DISPOUTPUT(), SCIP_DECL_NODESELSELECT(), SCIPsolve(), updateDataStructures(), and writeBounds().

◆ SCIPgetPrioChild()

SCIP_EXPORT SCIP_NODE* SCIPgetPrioChild ( SCIP * scip )

gets the best child of the focus node w.r.t. the node selection priority assigned by the branching rule

Returns: the best child of the focus node w.r.t. the node selection priority assigned by the branching rule

Precondition

This method can be called if scip is in one of the following stages:

SCIP_STAGE_SOLVING

Parameters

scip	SCIP data structure

Definition at line 278 of file scip_tree.c.

References FALSE, SCIP_CALL_ABORT, SCIPcheckStage(), SCIPtreeGetPrioChild(), Scip::tree, and TRUE.

Referenced by SCIP_DECL_NODESELSELECT().

◆ SCIPgetPrioSibling()

SCIP_EXPORT SCIP_NODE* SCIPgetPrioSibling ( SCIP * scip )

gets the best sibling of the focus node w.r.t. the node selection priority assigned by the branching rule

Returns: the best sibling of the focus node w.r.t. the node selection priority assigned by the branching rule

Precondition

This method can be called if scip is in one of the following stages:

SCIP_STAGE_SOLVING

Parameters

scip	SCIP data structure

Definition at line 294 of file scip_tree.c.

References FALSE, SCIP_CALL_ABORT, SCIPcheckStage(), SCIPtreeGetPrioSibling(), Scip::tree, and TRUE.

Referenced by SCIP_DECL_NODESELSELECT().

◆ SCIPgetBestChild()

SCIP_EXPORT SCIP_NODE* SCIPgetBestChild ( SCIP * scip )

gets the best child of the focus node w.r.t. the node selection strategy

Returns: the best child of the focus node w.r.t. the node selection strategy

Precondition

This method can be called if scip is in one of the following stages:

SCIP_STAGE_SOLVING

Parameters

scip	SCIP data structure

Definition at line 310 of file scip_tree.c.

References FALSE, SCIP_CALL_ABORT, SCIPcheckStage(), SCIPtreeGetBestChild(), Scip::set, Scip::tree, and TRUE.

Referenced by SCIP_DECL_NODESELSELECT().

◆ SCIPgetBestSibling()

SCIP_EXPORT SCIP_NODE* SCIPgetBestSibling ( SCIP * scip )

gets the best sibling of the focus node w.r.t. the node selection strategy

Returns: the best sibling of the focus node w.r.t. the node selection strategy

Precondition

This method can be called if scip is in one of the following stages:

SCIP_STAGE_SOLVING

Parameters

scip	SCIP data structure

Definition at line 326 of file scip_tree.c.

References FALSE, SCIP_CALL_ABORT, SCIPcheckStage(), SCIPtreeGetBestSibling(), Scip::set, Scip::tree, and TRUE.

Referenced by SCIP_DECL_NODESELSELECT().

◆ SCIPgetBestLeaf()

SCIP_EXPORT SCIP_NODE* SCIPgetBestLeaf ( SCIP * scip )

gets the best leaf from the node queue w.r.t. the node selection strategy

Returns: the best leaf from the node queue w.r.t. the node selection strategy

Precondition

This method can be called if scip is in one of the following stages:

SCIP_STAGE_SOLVING

Parameters

scip	SCIP data structure

Definition at line 342 of file scip_tree.c.

References FALSE, SCIP_CALL_ABORT, SCIPcheckStage(), SCIPtreeGetBestLeaf(), Scip::tree, and TRUE.

Referenced by SCIP_DECL_NODESELSELECT().

◆ SCIPgetBestNode()

SCIP_EXPORT SCIP_NODE* SCIPgetBestNode ( SCIP * scip )

gets the best node from the tree (child, sibling, or leaf) w.r.t. the node selection strategy

Returns: the best node from the tree (child, sibling, or leaf) w.r.t. the node selection strategy

Precondition

This method can be called if scip is in one of the following stages:

SCIP_STAGE_SOLVING

Parameters

scip	SCIP data structure

Definition at line 358 of file scip_tree.c.

References FALSE, SCIP_CALL_ABORT, SCIPcheckStage(), SCIPtreeGetBestNode(), Scip::set, Scip::tree, and TRUE.

Referenced by SCIP_DECL_NODESELSELECT().

◆ SCIPgetBestboundNode()

SCIP_EXPORT SCIP_NODE* SCIPgetBestboundNode ( SCIP * scip )

gets the node with smallest lower bound from the tree (child, sibling, or leaf)

Returns: the node with smallest lower bound from the tree (child, sibling, or leaf)

Precondition

This method can be called if scip is in one of the following stages:

SCIP_STAGE_SOLVING

Parameters

scip	SCIP data structure

Definition at line 374 of file scip_tree.c.

References FALSE, SCIP_CALL_ABORT, SCIPcheckStage(), SCIPtreeGetLowerboundNode(), Scip::set, Scip::tree, and TRUE.

Referenced by SCIP_DECL_NODESELSELECT().

◆ SCIPgetOpenNodesData()

SCIP_EXPORT SCIP_RETCODE SCIPgetOpenNodesData	(	SCIP *	scip,
		SCIP_NODE ***	leaves,
		SCIP_NODE ***	children,
		SCIP_NODE ***	siblings,
		int *	nleaves,
		int *	nchildren,
		int *	nsiblings
	)

access to all data of open nodes (leaves, children, and siblings)

Precondition

This method can be called if scip is in one of the following stages:

SCIP_STAGE_SOLVING

Parameters

scip	SCIP data structure
leaves	pointer to store the leaves, or NULL if not needed
children	pointer to store the children, or NULL if not needed
siblings	pointer to store the siblings, or NULL if not needed
nleaves	pointer to store the number of leaves, or NULL
nchildren	pointer to store the number of children, or NULL
nsiblings	pointer to store the number of siblings, or NULL

Definition at line 388 of file scip_tree.c.

References SCIP_Tree::children, FALSE, SCIP_Tree::leaves, NULL, SCIP_CALL, SCIP_OKAY, SCIPcheckStage(), SCIPnodepqLen(), SCIPnodepqNodes(), SCIPtreeGetNChildren(), SCIPtreeGetNSiblings(), SCIP_Tree::siblings, Scip::tree, and TRUE.

Referenced by recomputeNodeInformation(), SCIP_DECL_NODESELSELECT(), subtreeSumGapInsertChildren(), and subtreeSumGapSplit().

◆ SCIPcutoffNode()

SCIP_EXPORT SCIP_RETCODE SCIPcutoffNode	(	SCIP *	scip,
		SCIP_NODE *	node
	)

cuts off node and whole sub tree from branch and bound tree

Returns: SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See SCIP_RETCODE for a complete list of error codes.

Precondition

This method can be called if scip is in one of the following stages:

SCIP_STAGE_SOLVING

Parameters

scip	SCIP data structure
node	node that should be cut off

Definition at line 424 of file scip_tree.c.

References FALSE, Scip::lp, Scip::mem, Scip::origprob, SCIP_Mem::probmem, Scip::reopt, SCIP_CALL, SCIP_OKAY, SCIPcheckStage(), SCIPnodeCutoff(), Scip::set, Scip::stat, Scip::transprob, Scip::tree, and TRUE.

Referenced by applyVbounds(), propagateCons(), SCIP_DECL_HEUREXEC(), SCIPshrinkDisjunctiveVarSet(), tightenVarLb(), and tightenVarUb().

◆ SCIPrepropagateNode()

SCIP_EXPORT SCIP_RETCODE SCIPrepropagateNode	(	SCIP *	scip,
		SCIP_NODE *	node
	)

marks the given node to be propagated again the next time a node of its subtree is processed

Returns: SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See SCIP_RETCODE for a complete list of error codes.

Precondition

This method can be called if scip is in one of the following stages:

SCIP_STAGE_SOLVING

Parameters

scip	SCIP data structure
node	node that should be propagated again

Definition at line 445 of file scip_tree.c.

References FALSE, SCIP_CALL, SCIP_OKAY, SCIPcheckStage(), SCIPnodePropagateAgain(), Scip::set, Scip::stat, Scip::tree, and TRUE.

Referenced by SCIP_DECL_CONSACTIVE().

◆ SCIPgetCutoffdepth()

SCIP_EXPORT int SCIPgetCutoffdepth ( SCIP * scip )

returns depth of first node in active path that is marked being cutoff

Returns: depth of first node in active path that is marked being cutoff

Precondition

This method can be called if scip is in one of the following stages:

SCIP_STAGE_SOLVING

Parameters

scip	SCIP data structure

Definition at line 464 of file scip_tree.c.

References SCIP_Tree::cutoffdepth, FALSE, SCIP_CALL_ABORT, SCIPcheckStage(), Scip::tree, and TRUE.

◆ SCIPgetRepropdepth()

SCIP_EXPORT int SCIPgetRepropdepth ( SCIP * scip )

returns depth of first node in active path that has to be propagated again

Returns: depth of first node in active path that has to be propagated again

Precondition

This method can be called if scip is in one of the following stages:

SCIP_STAGE_SOLVING

Parameters

scip	SCIP data structure

Definition at line 480 of file scip_tree.c.

References FALSE, SCIP_Tree::repropdepth, SCIP_CALL_ABORT, SCIPcheckStage(), Scip::tree, and TRUE.

◆ SCIPprintNodeRootPath()

SCIP_EXPORT SCIP_RETCODE SCIPprintNodeRootPath	(	SCIP *	scip,
		SCIP_NODE *	node,
		FILE *	file
	)

prints all branching decisions on variables from the root to the given node

Returns: SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See SCIP_RETCODE for a complete list of error codes.

Precondition

This method can be called if scip is in one of the following stages:

SCIP_STAGE_SOLVING

Parameters

scip	SCIP data structure
node	node data
file	output file (or NULL for standard output)

Definition at line 497 of file scip_tree.c.

References Scip::messagehdlr, nnodes, SCIP_BOUNDTYPE_LOWER, SCIP_CALL, SCIP_OKAY, SCIP_Real, SCIPallocBufferArray, SCIPfreeBufferArray, SCIPmessageFPrintInfo(), SCIPnodeGetAncestorBranchingPath(), SCIPnodeGetDepth(), SCIPreallocBufferArray, and SCIPvarGetName().

Referenced by computeBranchingVariables().

◆ SCIPsetFocusnodeLP()

SCIP_EXPORT void SCIPsetFocusnodeLP	(	SCIP *	scip,
		SCIP_Bool	solvelp
	)

sets whether the LP should be solved at the focus node

Note: In order to have an effect, this method needs to be called after a node is focused but before the LP is solved.

Precondition

This method can be called if scip is in one of the following stages:

SCIP_STAGE_SOLVING

Parameters

scip	SCIP data structure
solvelp	should the LP be solved?

Definition at line 593 of file scip_tree.c.

References FALSE, SCIP_CALL_ABORT, SCIPcheckStage(), SCIPtreeSetFocusNodeLP(), Scip::tree, and TRUE.

◆ SCIPwasNodeLastBranchParent()

SCIP_EXPORT SCIP_Bool SCIPwasNodeLastBranchParent	(	SCIP *	scip,
		SCIP_NODE *	node
	)

query if node was the last parent of a branching of the tree

Returns: TRUE if node was the last parent of a branching of the tree

Precondition

This method can be called if SCIP is in one of the following stages:

Parameters

scip	SCIP data structure
node	tree node, or NULL to check focus node

Definition at line 699 of file scip_tree.c.

References FALSE, SCIP_CALL_ABORT, SCIPcheckStage(), SCIPtreeWasNodeLastBranchParent(), Scip::tree, and TRUE.

Referenced by subtreeSumGapUpdate().

SCIP

Detailed Description

Modules

Functions

Function Documentation

◆ SCIPgetFocusNode()

◆ SCIPgetCurrentNode()

◆ SCIPgetDepth()

◆ SCIPgetFocusDepth()

◆ SCIPgetPlungeDepth()

◆ SCIPgetRootNode()

◆ SCIPgetEffectiveRootDepth()

◆ SCIPinRepropagation()

◆ SCIPgetChildren()

◆ SCIPgetNChildren()

◆ SCIPgetSiblings()

◆ SCIPgetNSiblings()

◆ SCIPgetLeaves()

◆ SCIPgetNLeaves()

◆ SCIPgetNNodesLeft()

◆ SCIPgetPrioChild()

◆ SCIPgetPrioSibling()

◆ SCIPgetBestChild()

◆ SCIPgetBestSibling()

◆ SCIPgetBestLeaf()

◆ SCIPgetBestNode()

◆ SCIPgetBestboundNode()

◆ SCIPgetOpenNodesData()

◆ SCIPcutoffNode()

◆ SCIPrepropagateNode()

◆ SCIPgetCutoffdepth()

◆ SCIPgetRepropdepth()

◆ SCIPprintNodeRootPath()

◆ SCIPsetFocusnodeLP()

◆ SCIPwasNodeLastBranchParent()