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_NODE *	SCIPgetFocusNode (SCIP *scip)

SCIP_NODE *	SCIPgetCurrentNode (SCIP *scip)

int	SCIPgetDepth (SCIP *scip)

int	SCIPgetFocusDepth (SCIP *scip)

int	SCIPgetPlungeDepth (SCIP *scip)

SCIP_NODE *	SCIPgetRootNode (SCIP *scip)

int	SCIPgetEffectiveRootDepth (SCIP *scip)

SCIP_Bool	SCIPinRepropagation (SCIP *scip)

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

int	SCIPgetNChildren (SCIP *scip)

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

int	SCIPgetNSiblings (SCIP *scip)

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

int	SCIPgetNLeaves (SCIP *scip)

int	SCIPgetNNodesLeft (SCIP *scip)

SCIP_NODE *	SCIPgetPrioChild (SCIP *scip)

SCIP_NODE *	SCIPgetPrioSibling (SCIP *scip)

SCIP_NODE *	SCIPgetBestChild (SCIP *scip)

SCIP_NODE *	SCIPgetBestSibling (SCIP *scip)

SCIP_NODE *	SCIPgetBestLeaf (SCIP *scip)

SCIP_NODE *	SCIPgetBestNode (SCIP *scip)

SCIP_NODE *	SCIPgetBestboundNode (SCIP *scip)

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

SCIP_RETCODE	SCIPcutoffNode (SCIP scip, SCIP_NODE node)

SCIP_RETCODE	SCIPpruneTree (SCIP *scip)

SCIP_RETCODE	SCIPrepropagateNode (SCIP scip, SCIP_NODE node)

int	SCIPgetCutoffdepth (SCIP *scip)

int	SCIPgetRepropdepth (SCIP *scip)

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

void	SCIPsetFocusnodeLP (SCIP *scip, SCIP_Bool solvelp)

SCIP_Bool	SCIPwasNodeLastBranchParent (SCIP scip, SCIP_NODE node)

Function Documentation

◆ SCIPgetFocusNode()

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 72 of file scip_tree.c.

References FALSE, SCIP_CALL_ABORT, SCIPcheckStage(), SCIPtreeGetFocusNode(), and TRUE.

Referenced by applyCliqueFixings(), applyOrbitalBranchingPropagations(), applyOrbitalReductionPropagations(), propagateOrbitope(), SCIP_DECL_EVENTEXEC(), SCIP_DECL_HEUREXEC(), SCIPlexicographicReductionPropagate(), SCIPvarUpdatePseudocost(), subtreeSumGapInsertChildren(), subtreeSumGapSplit(), and subtreeSumGapUpdate().

◆ SCIPgetCurrentNode()

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 91 of file scip_tree.c.

References FALSE, SCIP_CALL_ABORT, SCIPcheckStage(), SCIPtreeGetCurrentNode(), and TRUE.

Referenced by applyObbt(), applyOrbitalBranchingPropagations(), applyOrbitalReductionPropagations(), applyProbing(), applyVbounds(), branchCons(), checkDivingCandidates(), computeDynamicRowOrder(), consEnfo(), consSepa(), constructCompression(), createAndSplitProblem(), enforceCardinality(), Exec(), execGenVBounds(), execRelpscost(), executeStrongBranching(), findComponents(), getBranchingDecisionStrongbranchSOS1(), initProblem(), performInteriorSolCutStrengthening(), propagateOrbitope(), SCIP_DECL_BRANCHEXECEXT(), SCIP_DECL_BRANCHEXECLP(), SCIP_DECL_BRANCHEXECPS(), SCIP_DECL_CONSENFOLP(), SCIP_DECL_CONSPROP(), SCIP_DECL_EVENTEXEC(), SCIP_DECL_HEUREXEC(), SCIP_DECL_NLHDLRENFO(), SCIP_DECL_NLHDLRESTIMATE(), SCIP_DECL_PRICERFARKAS(), SCIP_DECL_PRICERREDCOST(), SCIP_DECL_PROPEXEC(), SCIP_DECL_SEPAEXECLP(), SCIPanalyzeDeductionsProbing(), SCIPendStrongbranch(), SCIPstartDive(), SCIPtreemodelSelectCandidate(), selectVarMultAggrBranching(), selectVarStart(), separateOddCycles(), setupAndSolveSubscipRapidlearning(), subscipdataCopySubscip(), and updateDataStructures().

◆ SCIPgetDepth()

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 670 of file scip_tree.c.

References FALSE, SCIP_CALL_ABORT, SCIPcheckStage(), SCIPtreeGetCurrentDepth(), and TRUE.

Referenced by applyCliqueFixings(), applyGenVBounds(), applyNlobbt(), applyObbtBilinear(), applyOptcumulative(), applySeparation(), applyVboundsFixings(), branchAuxNonlinear(), computeCut(), computeRltCut(), createAndSplitProblem(), createAuxVar(), createCons(), createGenVBound(), createRow(), createSubscip(), detectNlhdlrs(), disableCons(), enforceCardinality(), enforceConflictgraph(), enforceConstraint(), execGenVBounds(), execRelpscost(), filterExistingLP(), filterRound(), findComponents(), findNewBounds(), initImplGraphSOS1(), initProblem(), isCurrentNodeCutoff(), performFixing(), performImplicationGraphAnalysis(), performRandRounding(), processRealBoundChg(), processWatchedVars(), propagateCons(), propagateCutoffbound(), propagateCutoffboundBinvar(), propagateCutoffboundGlobally(), propagateRootRedcostBinvar(), propdataInit(), rangedRowPropagation(), removeFixedBinvars(), runVanillaStrongBranching(), SCIP_DECL_BRANCHEXECLP(), SCIP_DECL_CONSENFOLP(), SCIP_DECL_CONSENFOPS(), SCIP_DECL_CONSENFORELAX(), SCIP_DECL_CONSPROP(), SCIP_DECL_CONSSEPALP(), SCIP_DECL_CONSSEPASOL(), SCIP_DECL_CUTSELSELECT(), SCIP_DECL_DISPOUTPUT(), SCIP_DECL_EVENTEXEC(), SCIP_DECL_HEUREXEC(), SCIP_DECL_NLHDLRENFO(), SCIP_DECL_NLHDLRESTIMATE(), SCIP_DECL_NLHDLRINITSEPA(), 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(), selectVarStart(), sepaImplBoundCutsSOS1(), separateIndicators(), separateSOS1(), setupAndSolveSubscipRapidlearning(), setupProbingSCIP(), solveNlp(), startProbing(), tightenBounds(), tryOneOpt(), trySolCandidate(), and varIsInteresting().

◆ SCIPgetFocusDepth()

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 696 of file scip_tree.c.

References FALSE, SCIP_CALL_ABORT, SCIPcheckStage(), SCIPtreeGetFocusDepth(), and TRUE.

◆ SCIPgetPlungeDepth()

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 713 of file scip_tree.c.

References FALSE, SCIP_CALL_ABORT, SCIPcheckStage(), and TRUE.

Referenced by SCIP_DECL_DISPOUTPUT(), and SCIP_DECL_NODESELSELECT().

◆ SCIPgetRootNode()

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 110 of file scip_tree.c.

References FALSE, SCIP_CALL_ABORT, SCIPcheckStage(), SCIPtreeGetRootNode(), and TRUE.

Referenced by Exec(), propagateCons(), propagateCutoffbound(), propagateLowerbound(), SCIP_DECL_BRANCHEXECLP(), SCIP_DECL_HEUREXEC(), SCIP_DECL_PRICERFARKAS(), SCIP_DECL_PROPEXEC(), SCIPcopyConcurrentSolvingStats(), SCIPreoptimizeNode(), tightenVarLb(), and tightenVarUb().

◆ SCIPgetEffectiveRootDepth()

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 127 of file scip_tree.c.

References FALSE, SCIP_CALL_ABORT, SCIPcheckStage(), SCIPtreeGetEffectiveRootDepth(), and TRUE.

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

◆ SCIPinRepropagation()

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 146 of file scip_tree.c.

References FALSE, SCIP_CALL_ABORT, SCIPcheckStage(), SCIPtreeInRepropagation(), and TRUE.

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

◆ SCIPgetChildren()

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 164 of file scip_tree.c.

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

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

◆ SCIPgetNChildren()

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 188 of file scip_tree.c.

References FALSE, SCIP_CALL_ABORT, SCIPcheckStage(), and TRUE.

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

◆ SCIPgetSiblings()

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 206 of file scip_tree.c.

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

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

◆ SCIPgetNSiblings()

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 230 of file scip_tree.c.

References FALSE, SCIP_CALL_ABORT, SCIPcheckStage(), and TRUE.

Referenced by subtreeSumGapUpdate().

◆ SCIPgetLeaves()

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 248 of file scip_tree.c.

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

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

◆ SCIPgetNLeaves()

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 272 of file scip_tree.c.

References FALSE, SCIP_CALL_ABORT, SCIPcheckStage(), SCIPnodepqLen(), and TRUE.

Referenced by subtreeSumGapUpdate().

◆ SCIPgetNNodesLeft()

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 644 of file scip_tree.c.

References FALSE, SCIP_CALL_ABORT, SCIPcheckStage(), SCIPtreeGetNNodes(), and TRUE.

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

◆ SCIPgetPrioChild()

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 288 of file scip_tree.c.

References FALSE, SCIP_CALL_ABORT, SCIPcheckStage(), SCIPtreeGetPrioChild(), and TRUE.

Referenced by SCIP_DECL_NODESELSELECT().

◆ SCIPgetPrioSibling()

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 304 of file scip_tree.c.

References FALSE, SCIP_CALL_ABORT, SCIPcheckStage(), SCIPtreeGetPrioSibling(), and TRUE.

Referenced by SCIP_DECL_NODESELSELECT().

◆ SCIPgetBestChild()

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 320 of file scip_tree.c.

References FALSE, SCIP_CALL_ABORT, SCIPcheckStage(), SCIPtreeGetBestChild(), and TRUE.

Referenced by SCIP_DECL_NODESELSELECT().

◆ SCIPgetBestSibling()

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 336 of file scip_tree.c.

References FALSE, SCIP_CALL_ABORT, SCIPcheckStage(), SCIPtreeGetBestSibling(), and TRUE.

Referenced by SCIP_DECL_NODESELSELECT().

◆ SCIPgetBestLeaf()

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 352 of file scip_tree.c.

References FALSE, SCIP_CALL_ABORT, SCIPcheckStage(), SCIPtreeGetBestLeaf(), and TRUE.

Referenced by SCIP_DECL_NODESELSELECT().

◆ SCIPgetBestNode()

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 368 of file scip_tree.c.

References FALSE, SCIP_CALL_ABORT, SCIPcheckStage(), SCIPtreeGetBestNode(), and TRUE.

Referenced by SCIP_DECL_NODESELSELECT().

◆ SCIPgetBestboundNode()

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 384 of file scip_tree.c.

References FALSE, SCIP_CALL_ABORT, SCIPcheckStage(), SCIPtreeGetLowerboundNode(), and TRUE.

Referenced by SCIP_DECL_NODESELSELECT().

◆ SCIPgetOpenNodesData()

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 398 of file scip_tree.c.

References FALSE, NULL, SCIP_CALL, SCIP_OKAY, SCIPcheckStage(), SCIPnodepqLen(), SCIPnodepqNodes(), SCIPtreeGetNChildren(), SCIPtreeGetNSiblings(), and TRUE.

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

◆ SCIPcutoffNode()

SCIP_RETCODE SCIPcutoffNode	(	SCIP *	scip,
		SCIP_NODE *	node
	)

marks node and whole sub tree to be cut off 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

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 434 of file scip_tree.c.

References FALSE, SCIP_CALL, SCIP_OKAY, SCIPcheckStage(), SCIPnodeCutoff(), and TRUE.

Referenced by applyVbounds(), propagateCons(), propagateCutoffbound(), propagateLowerbound(), SCIP_DECL_HEUREXEC(), SCIP_DECL_PROPEXEC(), tightenVarLb(), and tightenVarUb().

◆ SCIPpruneTree()

SCIP_RETCODE SCIPpruneTree ( SCIP * scip )

removes all nodes from branch and bound tree that were marked to be cut off via SCIPcutoffNode()

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

Note: In diving mode, the removal of nodes is delayed until diving ends.

Parameters

scip	SCIP data structure

Definition at line 457 of file scip_tree.c.

References FALSE, SCIP_CALL, SCIP_OKAY, SCIPcheckStage(), SCIPinfinity(), SCIPtreeCutoff(), and TRUE.

◆ SCIPrepropagateNode()

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 477 of file scip_tree.c.

References FALSE, SCIP_CALL, SCIP_OKAY, SCIPcheckStage(), SCIPnodePropagateAgain(), and TRUE.

Referenced by SCIP_DECL_CONSACTIVE().

◆ SCIPgetCutoffdepth()

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 496 of file scip_tree.c.

References FALSE, SCIP_CALL_ABORT, SCIPcheckStage(), and TRUE.

Referenced by isCurrentNodeCutoff(), and propagateCutoffbound().

◆ SCIPgetRepropdepth()

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 512 of file scip_tree.c.

References FALSE, SCIP_CALL_ABORT, SCIPcheckStage(), and TRUE.

◆ SCIPprintNodeRootPath()

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 529 of file scip_tree.c.

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

◆ SCIPsetFocusnodeLP()

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 625 of file scip_tree.c.

References FALSE, SCIP_CALL_ABORT, SCIPcheckStage(), SCIPtreeSetFocusNodeLP(), and TRUE.

◆ SCIPwasNodeLastBranchParent()

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 731 of file scip_tree.c.

References FALSE, SCIP_CALL_ABORT, SCIPcheckStage(), SCIPtreeWasNodeLastBranchParent(), and TRUE.

Referenced by SCIP_DECL_EVENTEXEC(), and 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()

◆ SCIPpruneTree()

◆ SCIPrepropagateNode()

◆ SCIPgetCutoffdepth()

◆ SCIPgetRepropdepth()

◆ SCIPprintNodeRootPath()

◆ SCIPsetFocusnodeLP()

◆ SCIPwasNodeLastBranchParent()