methods to query search tree related information
Modules | |
Nodes | |
methods for nodes of the search tree of 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.
scip
is in one of the following stages:
scip | SCIP data structure |
Definition at line 40434 of file scip.c.
References checkStage(), FALSE, SCIP_CALL_ABORT, SCIPtreeGetFocusNode(), Scip::tree, and TRUE.
Referenced by SCIPvarUpdatePseudocost().
gets current node in the tree
scip
is in one of the following stages:
scip | SCIP data structure |
Definition at line 40453 of file scip.c.
References checkStage(), FALSE, SCIP_CALL_ABORT, SCIPtreeGetCurrentNode(), Scip::tree, and TRUE.
Referenced by applyDomainChanges(), applyProbing(), applyVbounds(), constructCompression(), createAndSplitProblem(), enforceCardinality(), enforceConstraint(), Exec(), execGenVBounds(), execRelpscost(), findComponents(), generateCut(), generateSecantCut(), generateSecantCutNoCheck(), getBranchingDecisionStrongbranchSOS1(), initProblem(), SCIP_DECL_BRANCHEXECEXT(), SCIP_DECL_BRANCHEXECLP(), SCIP_DECL_BRANCHEXECPS(), SCIP_DECL_CONSPROP(), SCIP_DECL_EVENTEXEC(), SCIP_DECL_HEUREXEC(), SCIP_DECL_PROPEXEC(), SCIP_DECL_SEPAEXECLP(), SCIPanalyzeDeductionsProbing(), SCIPendStrongbranch(), SCIPstartDive(), selectVarMultAggrBranching(), subscipdataCopySubscip(), tightenBounds(), and updateDataStructures().
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
scip | SCIP data structure |
Definition at line 42094 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(), generateCut(), 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(), SCIPaddCut(), SCIPapplyUndercover(), SCIPapplyZeroobj(), SCIPisConflictAnalysisApplicable(), SCIPperformGenericDivingAlgorithm(), SCIPpropagateProbing(), SCIPselectVarPseudoStrongBranching(), SCIPselectVarStrongBranching(), SCIPupdateDivesetStats(), SCIPvarUpdatePseudocost(), selectVarMultAggrBranching(), sepaImplBoundCutsSOS1(), separateCuts(), separateIndicators(), separateSOS1(), setupProbingSCIP(), solveNlp(), tryOneOpt(), and trySolCandidate().
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
scip | SCIP data structure |
Definition at line 42120 of file scip.c.
References checkStage(), FALSE, SCIP_CALL_ABORT, SCIPtreeGetFocusDepth(), Scip::tree, and TRUE.
int SCIPgetPlungeDepth | ( | SCIP * | scip | ) |
gets current plunging depth (successive times, a child was selected as next node)
scip | SCIP data structure |
Definition at line 42209 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().
gets the root node of the tree
scip
is in one of the following stages:
scip | SCIP data structure |
Definition at line 40472 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().
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.
scip
is in one of the following stages:
scip | SCIP data structure |
Definition at line 40489 of file scip.c.
References checkStage(), FALSE, SCIP_CALL_ABORT, SCIPtreeGetEffectiveRootDepth(), Scip::tree, and TRUE.
Referenced by SCIP_DECL_EVENTEXEC().
returns whether the current node is already solved and only propagated again
scip
is in one of the following stages:
scip | SCIP data structure |
Definition at line 40508 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().
SCIP_RETCODE SCIPgetChildren | ( | SCIP * | scip, |
SCIP_NODE *** | children, | ||
int * | nchildren | ||
) |
gets children of focus node along with the number of children
scip
is in one of the following stages:
gets children of focus node along with the number of children
scip
is in one of the following stages:
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 40526 of file scip.c.
References checkStage(), SCIP_Tree::children, FALSE, SCIP_Tree::nchildren, NULL, SCIP_CALL, SCIP_OKAY, Scip::tree, and TRUE.
Referenced by checkLeavesBelowIncumbent(), SCIPsolve(), updateDataStructures(), and writeBounds().
int SCIPgetNChildren | ( | SCIP * | scip | ) |
gets number of children of focus node
scip
is in one of the following stages:
gets number of children of focus node
scip
is in one of the following stages:
scip | SCIP data structure |
Definition at line 40550 of file scip.c.
References checkStage(), FALSE, SCIP_Tree::nchildren, SCIP_CALL_ABORT, Scip::tree, and TRUE.
Referenced by SCIP_DECL_CONSDEACTIVE(), and updateDataStructures().
SCIP_RETCODE SCIPgetSiblings | ( | SCIP * | scip, |
SCIP_NODE *** | siblings, | ||
int * | nsiblings | ||
) |
gets siblings of focus node along with the number of siblings
scip
is in one of the following stages:
gets siblings of focus node along with the number of siblings
scip
is in one of the following stages:
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 40568 of file scip.c.
References checkStage(), FALSE, SCIP_Tree::nsiblings, NULL, SCIP_CALL, SCIP_OKAY, SCIP_Tree::siblings, Scip::tree, and TRUE.
Referenced by checkLeavesBelowIncumbent(), SCIPsolve(), and writeBounds().
int SCIPgetNSiblings | ( | SCIP * | scip | ) |
gets number of siblings of focus node
scip
is in one of the following stages:
gets number of siblings of focus node
scip
is in one of the following stages:
scip | SCIP data structure |
Definition at line 40592 of file scip.c.
References checkStage(), FALSE, SCIP_Tree::nsiblings, SCIP_CALL_ABORT, Scip::tree, and TRUE.
SCIP_RETCODE SCIPgetLeaves | ( | SCIP * | scip, |
SCIP_NODE *** | leaves, | ||
int * | nleaves | ||
) |
gets leaves of the tree along with the number of leaves
scip
is in one of the following stages:
gets leaves of the tree along with the number of leaves
scip
is in one of the following stages:
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 40610 of file scip.c.
References checkStage(), FALSE, SCIP_Tree::leaves, NULL, SCIP_CALL, SCIP_OKAY, SCIPnodepqLen(), SCIPnodepqNodes(), Scip::tree, and TRUE.
Referenced by checkLeavesBelowIncumbent(), SCIPsolve(), and writeBounds().
int SCIPgetNLeaves | ( | SCIP * | scip | ) |
gets number of leaves in the tree
scip
is in one of the following stages:
gets number of leaves in the tree
scip
is in one of the following stages:
scip | SCIP data structure |
Definition at line 40634 of file scip.c.
References checkStage(), FALSE, SCIP_Tree::leaves, SCIP_CALL_ABORT, SCIPnodepqLen(), Scip::tree, and TRUE.
int SCIPgetNNodesLeft | ( | SCIP * | scip | ) |
gets number of nodes left in the tree (children + siblings + leaves)
scip | SCIP data structure |
Definition at line 41227 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().
gets the best child of the focus node w.r.t. the node selection priority assigned by the branching rule
scip
is in one of the following stages:
scip | SCIP data structure |
Definition at line 40650 of file scip.c.
References checkStage(), FALSE, SCIP_CALL_ABORT, SCIPtreeGetPrioChild(), Scip::tree, and TRUE.
Referenced by SCIP_DECL_NODESELSELECT().
gets the best sibling of the focus node w.r.t. the node selection priority assigned by the branching rule
scip
is in one of the following stages:
scip | SCIP data structure |
Definition at line 40666 of file scip.c.
References checkStage(), FALSE, SCIP_CALL_ABORT, SCIPtreeGetPrioSibling(), Scip::tree, and TRUE.
Referenced by SCIP_DECL_NODESELSELECT().
gets the best child of the focus node w.r.t. the node selection strategy
scip
is in one of the following stages:
scip | SCIP data structure |
Definition at line 40682 of file scip.c.
References checkStage(), FALSE, SCIP_CALL_ABORT, SCIPtreeGetBestChild(), Scip::set, Scip::tree, and TRUE.
Referenced by SCIP_DECL_NODESELSELECT().
gets the best sibling of the focus node w.r.t. the node selection strategy
scip
is in one of the following stages:
scip | SCIP data structure |
Definition at line 40698 of file scip.c.
References checkStage(), FALSE, SCIP_CALL_ABORT, SCIPtreeGetBestSibling(), Scip::set, Scip::tree, and TRUE.
Referenced by SCIP_DECL_NODESELSELECT().
gets the best leaf from the node queue w.r.t. the node selection strategy
scip
is in one of the following stages:
scip | SCIP data structure |
Definition at line 40714 of file scip.c.
References checkStage(), FALSE, SCIP_CALL_ABORT, SCIPtreeGetBestLeaf(), Scip::tree, and TRUE.
Referenced by SCIP_DECL_NODESELSELECT().
gets the best node from the tree (child, sibling, or leaf) w.r.t. the node selection strategy
scip
is in one of the following stages:
scip | SCIP data structure |
Definition at line 40730 of file scip.c.
References checkStage(), FALSE, SCIP_CALL_ABORT, SCIPtreeGetBestNode(), Scip::set, Scip::tree, and TRUE.
Referenced by SCIP_DECL_NODESELSELECT().
gets the node with smallest lower bound from the tree (child, sibling, or leaf)
scip
is in one of the following stages:
scip | SCIP data structure |
Definition at line 40746 of file scip.c.
References checkStage(), FALSE, SCIP_CALL_ABORT, SCIPtreeGetLowerboundNode(), Scip::set, Scip::tree, and TRUE.
Referenced by SCIP_DECL_NODESELSELECT().
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)
scip
is in one of the following stages:
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 40760 of file scip.c.
References checkStage(), SCIP_Tree::children, FALSE, SCIP_Tree::leaves, NULL, SCIP_CALL, SCIP_OKAY, SCIPnodepqLen(), SCIPnodepqNodes(), SCIPtreeGetNChildren(), SCIPtreeGetNSiblings(), SCIP_Tree::siblings, Scip::tree, and TRUE.
Referenced by recomputeNodeInformation(), and SCIP_DECL_NODESELSELECT().
SCIP_RETCODE SCIPcutoffNode | ( | SCIP * | scip, |
SCIP_NODE * | node | ||
) |
cuts off node and whole sub tree from branch and bound tree
scip
is in one of the following stages:
scip | SCIP data structure |
node | node that should be cut off |
Definition at line 40796 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().
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
scip
is in one of the following stages:
scip | SCIP data structure |
node | node that should be propagated again |
Definition at line 40817 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().
int SCIPgetCutoffdepth | ( | SCIP * | scip | ) |
returns depth of first node in active path that is marked being cutoff
scip
is in one of the following stages:
scip | SCIP data structure |
Definition at line 40836 of file scip.c.
References checkStage(), SCIP_Tree::cutoffdepth, FALSE, SCIP_CALL_ABORT, Scip::tree, and TRUE.
int SCIPgetRepropdepth | ( | SCIP * | scip | ) |
returns depth of first node in active path that has to be propagated again
scip
is in one of the following stages:
scip | SCIP data structure |
Definition at line 40852 of file scip.c.
References checkStage(), FALSE, SCIP_Tree::repropdepth, SCIP_CALL_ABORT, Scip::tree, and TRUE.
SCIP_RETCODE SCIPprintNodeRootPath | ( | SCIP * | scip, |
SCIP_NODE * | node, | ||
FILE * | file | ||
) |
prints all branching decisions on variables from the root to the given node
scip
is in one of the following stages:
scip | SCIP data structure |
node | node data |
file | output file (or NULL for standard output) |
Definition at line 40869 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().
sets whether the LP should be solved at the focus node
scip
is in one of the following stages:
scip | SCIP data structure |
solvelp | should the LP be solved? |
Definition at line 40965 of file scip.c.
References checkStage(), FALSE, SCIP_CALL_ABORT, SCIPtreeSetFocusNodeLP(), Scip::tree, and TRUE.