Scippy

SCIP

Solving Constraint Integer Programs

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_NODESCIPgetFocusNode (SCIP *scip)
 
SCIP_NODESCIPgetCurrentNode (SCIP *scip)
 
int SCIPgetDepth (SCIP *scip)
 
int SCIPgetFocusDepth (SCIP *scip)
 
int SCIPgetPlungeDepth (SCIP *scip)
 
SCIP_NODESCIPgetRootNode (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_NODESCIPgetPrioChild (SCIP *scip)
 
SCIP_NODESCIPgetPrioSibling (SCIP *scip)
 
SCIP_NODESCIPgetBestChild (SCIP *scip)
 
SCIP_NODESCIPgetBestSibling (SCIP *scip)
 
SCIP_NODESCIPgetBestLeaf (SCIP *scip)
 
SCIP_NODESCIPgetBestNode (SCIP *scip)
 
SCIP_NODESCIPgetBestboundNode (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 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)
 

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
scipSCIP data structure

Definition at line 41379 of file scip.c.

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

Referenced by applyCliqueFixings(), and SCIPvarUpdatePseudocost().

◆ SCIPgetCurrentNode()

◆ 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
scipSCIP data structure

Definition at line 43039 of file scip.c.

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

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

◆ 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
scipSCIP data structure

Definition at line 43065 of file scip.c.

References checkStage(), FALSE, SCIP_CALL_ABORT, SCIPtreeGetFocusDepth(), Scip::tree, 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
scipSCIP data structure

Definition at line 43154 of file scip.c.

References checkStage(), FALSE, SCIP_Stat::plungedepth, SCIP_CALL_ABORT, Scip::stat, 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
scipSCIP data structure

Definition at line 41417 of file scip.c.

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

Referenced by Exec(), propagateCons(), SCIP_DECL_BRANCHEXECLP(), SCIPcopyConcurrentSolvingStats(), SCIPreoptimizeNode(), SCIPshrinkDisjunctiveVarSet(), 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:
Parameters
scipSCIP data structure

Definition at line 41434 of file scip.c.

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

Referenced by SCIP_DECL_EVENTEXEC().

◆ 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
scipSCIP data structure

Definition at line 41453 of file scip.c.

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

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

◆ 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:

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
scipSCIP data structure
childrenpointer to store children array, or NULL if not needed
nchildrenpointer to store number of children, or NULL if not needed

Definition at line 41471 of file scip.c.

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

Referenced by checkLeavesBelowIncumbent(), SCIPsolve(), 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:

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
scipSCIP data structure

Definition at line 41495 of file scip.c.

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

Referenced by SCIP_DECL_CONSDEACTIVE(), 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:

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
scipSCIP data structure
siblingspointer to store siblings array, or NULL if not needed
nsiblingspointer to store number of siblings, or NULL if not needed

Definition at line 41513 of file scip.c.

References checkStage(), FALSE, SCIP_Tree::nsiblings, SCIP_CALL, SCIP_OKAY, SCIP_Tree::siblings, Scip::tree, 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:

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
scipSCIP data structure

Definition at line 41537 of file scip.c.

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

◆ 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:

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
scipSCIP data structure
leavespointer to store leaves array, or NULL if not needed
nleavespointer to store number of leaves, or NULL if not needed

Definition at line 41555 of file scip.c.

References checkStage(), FALSE, SCIP_Tree::leaves, SCIP_CALL, SCIP_OKAY, SCIPnodepqLen(), SCIPnodepqNodes(), Scip::tree, 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:

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
scipSCIP data structure

Definition at line 41579 of file scip.c.

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

◆ 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
scipSCIP data structure

Definition at line 42172 of file scip.c.

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

Referenced by applyDomainChanges(), 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:
Parameters
scipSCIP data structure

Definition at line 41595 of file scip.c.

References checkStage(), FALSE, SCIP_CALL_ABORT, SCIPtreeGetPrioChild(), Scip::tree, 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:
Parameters
scipSCIP data structure

Definition at line 41611 of file scip.c.

References checkStage(), FALSE, SCIP_CALL_ABORT, SCIPtreeGetPrioSibling(), Scip::tree, 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:
Parameters
scipSCIP data structure

Definition at line 41627 of file scip.c.

References checkStage(), FALSE, SCIP_CALL_ABORT, SCIPtreeGetBestChild(), Scip::set, Scip::tree, 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:
Parameters
scipSCIP data structure

Definition at line 41643 of file scip.c.

References checkStage(), FALSE, SCIP_CALL_ABORT, SCIPtreeGetBestSibling(), Scip::set, Scip::tree, 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:
Parameters
scipSCIP data structure

Definition at line 41659 of file scip.c.

References checkStage(), FALSE, SCIP_CALL_ABORT, SCIPtreeGetBestLeaf(), Scip::tree, 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:
Parameters
scipSCIP data structure

Definition at line 41675 of file scip.c.

References checkStage(), FALSE, SCIP_CALL_ABORT, SCIPtreeGetBestNode(), Scip::set, Scip::tree, 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:
Parameters
scipSCIP data structure

Definition at line 41691 of file scip.c.

References checkStage(), FALSE, SCIP_CALL_ABORT, SCIPtreeGetLowerboundNode(), Scip::set, Scip::tree, 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:
Parameters
scipSCIP data structure
leavespointer to store the leaves, or NULL if not needed
childrenpointer to store the children, or NULL if not needed
siblingspointer to store the siblings, or NULL if not needed
nleavespointer to store the number of leaves, or NULL
nchildrenpointer to store the number of children, or NULL
nsiblingspointer to store the number of siblings, or NULL

Definition at line 41705 of file scip.c.

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

Referenced by recomputeNodeInformation(), and SCIP_DECL_NODESELSELECT().

◆ SCIPcutoffNode()

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:
Parameters
scipSCIP data structure
nodenode that should be cut off

Definition at line 41741 of file scip.c.

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

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

◆ 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:
Parameters
scipSCIP data structure
nodenode that should be propagated again

Definition at line 41762 of file scip.c.

References checkStage(), FALSE, SCIP_CALL, SCIP_OKAY, SCIPnodePropagateAgain(), Scip::set, Scip::stat, Scip::tree, 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:
Parameters
scipSCIP data structure

Definition at line 41781 of file scip.c.

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

◆ 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:
Parameters
scipSCIP data structure

Definition at line 41797 of file scip.c.

References checkStage(), FALSE, SCIP_Tree::repropdepth, SCIP_CALL_ABORT, Scip::tree, 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:
Parameters
scipSCIP data structure
nodenode data
fileoutput file (or NULL for standard output)

Definition at line 41814 of file scip.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()

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:
Parameters
scipSCIP data structure
solvelpshould the LP be solved?

Definition at line 41910 of file scip.c.

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