SCIP
Solving Constraint Integer Programs
Local Subproblem
Detailed Description
methods to query information about or strengthen the problem at the current local search node
Function Documentation
◆ SCIPaddConflict()
| SCIP_RETCODE SCIPaddConflict | ( | SCIP * | scip, |
| SCIP_NODE * | node, | ||
| SCIP_CONS * | cons, | ||
| SCIP_NODE * | validnode, | ||
| SCIP_CONFTYPE | conftype, | ||
| SCIP_Bool | iscutoffinvolved | ||
| ) |
adds a conflict to a given node or globally to the problem if node == NULL.
- 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 in one of the following stages of the SCIP solving process:
- Note
- this method will release the constraint
- Parameters
-
scip SCIP data structure node node to add conflict (or NULL if global) cons constraint representing the conflict validnode node at whichaddConf the constraint is valid (or NULL) conftype type of the conflict iscutoffinvolved is a cutoff bound involved in this conflict
Definition at line 3228 of file scip_prob.c.
References FALSE, NULL, SCIP_CALL, SCIP_CONFTYPE_BNDEXCEEDING, SCIP_NODETYPE_PROBINGNODE, SCIP_OKAY, SCIP_Real, SCIPaddCons(), SCIPaddConsNode(), SCIPcheckStage(), SCIPconflictstoreAddConflict(), SCIPconsMarkConflict(), SCIPgetCutoffbound(), SCIPinfinity(), SCIPnodeGetType(), SCIPreleaseCons(), and TRUE.
Referenced by applyCliqueFixings(), SCIP_DECL_CONFLICTEXEC(), SCIP_DECL_HEUREXEC(), and setupAndSolveSubscipRapidlearning().
◆ SCIPclearConflictStore()
| SCIP_RETCODE SCIPclearConflictStore | ( | SCIP * | scip, |
| SCIP_EVENT * | event | ||
| ) |
removes all conflicts depending on an old cutoff bound if the improvement of the incumbent is good enough
- 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 in one of the following stages of the SCIP solving process:
tries to remove conflicts depending on an old cutoff bound if the improvement of the new incumbent is good enough
- 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 in one of the following stages of the SCIP solving process:
- Parameters
-
scip SCIP data structure event event data
Definition at line 3286 of file scip_prob.c.
References FALSE, NULL, SCIP_CALL, SCIP_EVENTTYPE_BESTSOLFOUND, SCIP_OKAY, SCIPcheckStage(), SCIPconflictstoreCleanNewIncumbent(), SCIPeventGetSol(), SCIPeventGetType(), and TRUE.
Referenced by SCIP_DECL_EVENTEXEC().
◆ SCIPaddConsNode()
| SCIP_RETCODE SCIPaddConsNode | ( | SCIP * | scip, |
| SCIP_NODE * | node, | ||
| SCIP_CONS * | cons, | ||
| SCIP_NODE * | validnode | ||
| ) |
adds constraint to the given node (and all of its subnodes), even if it is a global constraint; It is sometimes desirable to add the constraint to a more local node (i.e., a node of larger depth) even if the constraint is also valid higher in the tree, for example, if one wants to produce a constraint which is only active in a small part of the tree although it is valid in a larger part. In this case, one should pass the more global node where the constraint is valid as "validnode". Note that the same constraint cannot be added twice to the branching tree with different "validnode" parameters. If the constraint is valid at the same node as it is inserted (the usual case), one should pass NULL as "validnode". If the "validnode" is the root node, it is automatically upgraded into a global constraint, but still only added to the given node. If a local constraint is added to the root node, it is added to the global problem instead.
- 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 in one of the following stages of the SCIP solving process:
- Parameters
-
scip SCIP data structure node node to add constraint to cons constraint to add validnode node at which the constraint is valid, or NULL
Definition at line 3323 of file scip_prob.c.
References FALSE, NULL, SCIP_CALL, SCIP_INVALIDDATA, SCIP_OKAY, SCIPcheckStage(), SCIPconsGetName(), SCIPconsSetLocal(), SCIPerrorMessage, SCIPnodeAddCons(), SCIPnodeGetDepth(), SCIPprobAddCons(), SCIPtreeGetEffectiveRootDepth(), TRUE, and SCIP_Cons::validdepth.
Referenced by addBranchingComplementaritiesSOS1(), addLocalConss(), addSplitcons(), applyBinaryConstraints(), branchBalancedCardinality(), branchCons(), createNAryBranch(), executeStrongBranching(), fixVariableZeroNode(), SCIP_DECL_BRANCHEXECLP(), SCIP_DECL_BRANCHEXECPS(), SCIP_DECL_CONFLICTEXEC(), SCIP_DECL_CONSPROP(), SCIP_DECL_HEUREXEC(), SCIPaddConflict(), SCIPaddConsLocal(), and selectVarMultAggrBranching().
◆ SCIPaddConsLocal()
| SCIP_RETCODE SCIPaddConsLocal | ( | SCIP * | scip, |
| SCIP_CONS * | cons, | ||
| SCIP_NODE * | validnode | ||
| ) |
adds constraint locally to the current node (and all of its subnodes), even if it is a global constraint; It is sometimes desirable to add the constraint to a more local node (i.e., a node of larger depth) even if the constraint is also valid higher in the tree, for example, if one wants to produce a constraint which is only active in a small part of the tree although it is valid in a larger part.
If the constraint is valid at the same node as it is inserted (the usual case), one should pass NULL as "validnode". If the "validnode" is the root node, it is automatically upgraded into a global constraint, but still only added to the given node. If a local constraint is added to the root node, it is added to the global problem instead.
- 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 in one of the following stages of the SCIP solving process:
- Note
- The same constraint cannot be added twice to the branching tree with different "validnode" parameters. This is the case due internal data structures and performance issues. In such a case you should try to realize your issue using the method SCIPdisableCons() and SCIPenableCons() and control these via the event system of SCIP.
adds constraint locally to the current node (and all of its subnodes), even if it is a global constraint; It is sometimes desirable to add the constraint to a more local node (i.e., a node of larger depth) even if the constraint is also valid higher in the tree, for example, if one wants to produce a constraint which is only active in a small part of the tree although it is valid in a larger part.
If the constraint is valid at the same node as it is inserted (the usual case), one should pass NULL as "validnode". If the "validnode" is the root node, it is automatically upgraded into a global constraint, but still only added to the given node. If a local constraint is added to the root node, it is added to the global problem instead.
- 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 in one of the following stages of the SCIP solving process:
- Note
- The same constraint cannot be added twice to the branching tree with different "validnode" parameters. This is the case due to internal data structures and performance issues. In such a case you should try to realize your issue using the method SCIPdisableCons() and SCIPenableCons() and control these via the event system of SCIP.
- Parameters
-
scip SCIP data structure cons constraint to add validnode node at which the constraint is valid, or NULL
Definition at line 3393 of file scip_prob.c.
References FALSE, NULL, SCIP_CALL, SCIP_OKAY, SCIPaddConsNode(), SCIPcheckStage(), SCIPtreeGetCurrentNode(), and TRUE.
Referenced by addAllConss(), createConflict(), rangedRowPropagation(), SCIP_DECL_CONSINITLP(), and upgradeCons().
◆ SCIPdelConsNode()
| SCIP_RETCODE SCIPdelConsNode | ( | SCIP * | scip, |
| SCIP_NODE * | node, | ||
| SCIP_CONS * | cons | ||
| ) |
disables constraint's separation, enforcing, and propagation capabilities at the given node (and all subnodes); if the method is called at the root node, the constraint is globally deleted from the problem; the constraint deletion is being remembered at the given node, s.t. after leaving the node's subtree, the constraint is automatically enabled again, and after entering the node's subtree, it is automatically disabled; this may improve performance because redundant checks on this constraint are avoided, but it consumes memory; alternatively, use SCIPdisableCons()
- 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 in one of the following stages of the SCIP solving process:
- Parameters
-
scip SCIP data structure node node to disable constraint in cons constraint to locally delete
Definition at line 3424 of file scip_prob.c.
References FALSE, NULL, SCIP_CALL, SCIP_OKAY, SCIP_STAGE_EXITPRESOLVE, SCIP_STAGE_INITPRESOLVE, SCIPcheckStage(), SCIPconsDelete(), SCIPconsIsAdded(), SCIPnodeDelCons(), SCIPnodeGetDepth(), SCIPtreeGetEffectiveRootDepth(), and TRUE.
Referenced by branchCons(), and createNAryBranch().
◆ SCIPdelConsLocal()
| SCIP_RETCODE SCIPdelConsLocal | ( | SCIP * | scip, |
| SCIP_CONS * | cons | ||
| ) |
disables constraint's separation, enforcing, and propagation capabilities at the current node (and all subnodes); if the method is called during problem modification or at the root node, the constraint is globally deleted from the problem; the constraint deletion is being remembered at the current node, s.t. after leaving the current subtree, the constraint is automatically enabled again, and after reentering the current node's subtree, it is automatically disabled again; this may improve performance because redundant checks on this constraint are avoided, but it consumes memory; alternatively, use SCIPdisableCons()
- 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 in one of the following stages of the SCIP solving process:
disables constraint's separation, enforcing, and propagation capabilities at the current node (and all subnodes); if the method is called during problem modification or at the root node, the constraint is globally deleted from the problem; the constraint deletion is being remembered at the current node, s.t. after leaving the current subtree, the constraint is automatically enabled again, and after reentering the current node's subtree, it is automatically disabled again; this may improve performance because redundant checks on this constraint are avoided, but it consumes memory; alternatively, use SCIPdisableCons()
- 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 in one of the following stages of the SCIP solving process:
- Note
- SCIP stage does not get changed
- Parameters
-
scip SCIP data structure cons constraint to locally delete
Definition at line 3474 of file scip_prob.c.
References SCIP_Cons::addconssetchg, FALSE, NULL, SCIP_CALL, SCIP_INVALIDCALL, SCIP_OKAY, SCIP_STAGE_EXITPRESOLVE, SCIP_STAGE_INITPRESOLVE, SCIP_STAGE_PRESOLVING, SCIP_STAGE_PROBLEM, SCIP_STAGE_SOLVING, SCIPcheckStage(), SCIPconsDelete(), SCIPconsIsAdded(), SCIPerrorMessage, SCIPnodeDelCons(), SCIPnodeGetDepth(), SCIPtreeGetCurrentNode(), SCIPtreeGetEffectiveRootDepth(), and TRUE.
Referenced by addAllConss(), analyzeZeroResultant(), checkBounddisjunction(), checkKnapsack(), checkLogicor(), checkRedundancy(), checkVarbound(), consdataFixOperandsOne(), consdataFixResultantZero(), detectRedundantVars(), initPricing(), presolveRedundantConss(), processBinvarFixings(), processFixings(), processRealBoundChg(), propagateCons(), propCardinality(), propConsSOS1(), propIndicator(), propSOS2(), SCIP_DECL_CONSACTIVE(), SCIP_DECL_CONSPRESOL(), solveIndependentCons(), solveSubproblem(), and upgradeCons().
◆ SCIPgetLocalOrigEstimate()
gets estimate of best primal solution w.r.t. original problem contained in current subtree
- Returns
- estimate of best primal solution w.r.t. original problem contained in current subtree
- Precondition
- this method can be called in one of the following stages of the SCIP solving process:
- Parameters
-
scip SCIP data structure
Definition at line 3527 of file scip_prob.c.
References FALSE, NULL, SCIP_CALL_ABORT, SCIP_INVALID, SCIPcheckStage(), SCIPnodeGetEstimate(), SCIPprobExternObjval(), SCIPtreeGetCurrentNode(), and TRUE.
Referenced by SCIP_DECL_DISPOUTPUT().
◆ SCIPgetLocalTransEstimate()
gets estimate of best primal solution w.r.t. transformed problem contained in current subtree
- Returns
- estimate of best primal solution w.r.t. transformed problem contained in current subtree
- Precondition
- this method can be called in one of the following stages of the SCIP solving process:
- Parameters
-
scip SCIP data structure
Definition at line 3546 of file scip_prob.c.
References FALSE, NULL, SCIP_CALL_ABORT, SCIP_INVALID, SCIPcheckStage(), SCIPnodeGetEstimate(), SCIPtreeGetCurrentNode(), and TRUE.
Referenced by branchBalancedCardinality(), branchCons(), branchUnbalancedCardinality(), enforceConflictgraph(), enforceConssSOS1(), enforceSOS2(), SCIP_DECL_BRANCHEXECLP(), and SCIP_DECL_BRANCHEXECPS().
◆ SCIPgetLocalDualbound()
gets dual bound of current node
- Returns
- dual bound of current node
- Precondition
- this method can be called in one of the following stages of the SCIP solving process:
- Parameters
-
scip SCIP data structure
Definition at line 3566 of file scip_prob.c.
References FALSE, NULL, SCIP_CALL_ABORT, SCIP_INVALID, SCIPcheckStage(), SCIPnodeGetLowerbound(), SCIPprobExternObjval(), SCIPtreeGetCurrentNode(), and TRUE.
Referenced by SCIP_DECL_DISPOUTPUT(), and SCIP_DECL_HEUREXEC().
◆ SCIPgetLocalLowerbound()
gets lower bound of current node in transformed problem
- Returns
- lower bound of current node in transformed problem
- Precondition
- this method can be called in one of the following stages of the SCIP solving process:
- Parameters
-
scip SCIP data structure
Definition at line 3585 of file scip_prob.c.
References FALSE, NULL, SCIP_CALL_ABORT, SCIP_INVALID, SCIPcheckStage(), SCIPnodeGetLowerbound(), SCIPtreeGetCurrentNode(), and TRUE.
Referenced by checkExec(), SCIP_DECL_CONSSEPALP(), SCIP_DECL_HEUREXEC(), and SCIP_DECL_SEPAEXECSOL().
◆ SCIPgetNodeDualbound()
gets dual bound of given node
- Returns
- dual bound of a given node
- Precondition
- this method can be called in one of the following stages of the SCIP solving process:
- Parameters
-
scip SCIP data structure node node to get dual bound for
Definition at line 3605 of file scip_prob.c.
References FALSE, SCIP_CALL_ABORT, SCIPcheckStage(), SCIPnodeGetLowerbound(), SCIPprobExternObjval(), and TRUE.
Referenced by writeBounds().
◆ SCIPgetNodeLowerbound()
gets lower bound of given node in transformed problem
- Returns
- lower bound of given node in transformed problem
- Precondition
- this method can be called in one of the following stages of the SCIP solving process:
- Parameters
-
scip SCIP data structure node node to get dual bound for
Definition at line 3622 of file scip_prob.c.
References FALSE, SCIP_CALL_ABORT, SCIPcheckStage(), SCIPnodeGetLowerbound(), and TRUE.
Referenced by execRelpscost(), SCIP_DECL_HEUREXEC(), SCIPtreemodelSelectCandidate(), and subscipdataCopySubscip().
◆ SCIPupdateLocalDualbound()
| SCIP_RETCODE SCIPupdateLocalDualbound | ( | SCIP * | scip, |
| SCIP_Real | newbound | ||
| ) |
if given value is tighter (larger for minimization, smaller for maximization) than the current node's dual bound (in original problem space), sets the current node's dual bound to the new value
- Note
- the given new bound has to be a dual bound, i.e., it has to be valid for the original problem.
- 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 in one of the following stages of the SCIP solving process:
- Parameters
-
scip SCIP data structure newbound new dual bound for the node (if it's tighter than the old one)
Definition at line 3646 of file scip_prob.c.
References FALSE, SCIP_CALL, SCIP_INVALIDCALL, SCIP_OKAY, SCIP_STAGE_PRESOLVED, SCIP_STAGE_PRESOLVING, SCIP_STAGE_PROBLEM, SCIP_STAGE_SOLVING, SCIPABORT, SCIPcheckStage(), SCIPerrorMessage, SCIPprobExternObjval(), SCIPprobInternObjval(), SCIPprobUpdateDualbound(), SCIPtreeGetCurrentNode(), SCIPupdateNodeLowerbound(), and TRUE.
Referenced by setupAndSolveSubscipRapidlearning(), and setupProblem().
◆ SCIPupdateLocalLowerbound()
| SCIP_RETCODE SCIPupdateLocalLowerbound | ( | SCIP * | scip, |
| SCIP_Real | newbound | ||
| ) |
if given value is larger than the current node's lower bound (in transformed problem), sets the current node's lower bound to the new value
- Note
- the given new bound has to be a lower bound, i.e., it has to be valid for the transformed problem.
- 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 in one of the following stages of the SCIP solving process:
- Parameters
-
scip SCIP data structure newbound new lower bound for the node (if it's larger than the old one)
Definition at line 3696 of file scip_prob.c.
References FALSE, SCIP_CALL, SCIP_INVALIDCALL, SCIP_OKAY, SCIP_STAGE_PRESOLVED, SCIP_STAGE_PRESOLVING, SCIP_STAGE_SOLVING, SCIPABORT, SCIPcheckStage(), SCIPerrorMessage, SCIPprobExternObjval(), SCIPprobUpdateDualbound(), SCIPtreeGetCurrentNode(), SCIPupdateNodeLowerbound(), and TRUE.
Referenced by checkParallelObjective(), SCIP_DECL_PRICERREDCOST(), and solveComponent().
◆ SCIPupdateNodeDualbound()
| SCIP_RETCODE SCIPupdateNodeDualbound | ( | SCIP * | scip, |
| SCIP_NODE * | node, | ||
| SCIP_Real | newbound | ||
| ) |
if given value is tighter (larger for minimization, smaller for maximization) than the node's dual bound, sets the node's dual bound to the new value
- 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 in one of the following stages of the SCIP solving process:
- Parameters
-
scip SCIP data structure node node to update dual bound for newbound new dual bound for the node (if it's tighter than the old one)
Definition at line 3735 of file scip_prob.c.
References FALSE, SCIP_CALL, SCIP_OKAY, SCIPcheckStage(), SCIPprobInternObjval(), SCIPupdateNodeLowerbound(), and TRUE.
◆ SCIPupdateNodeLowerbound()
| SCIP_RETCODE SCIPupdateNodeLowerbound | ( | SCIP * | scip, |
| SCIP_NODE * | node, | ||
| SCIP_Real | newbound | ||
| ) |
if given value is larger than the node's lower bound (in transformed problem), sets the node's lower bound to the new value
- 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 in one of the following stages of the SCIP solving process:
- Parameters
-
scip SCIP data structure node node to update lower bound for newbound new lower bound for the node (if it's larger than the old one)
Definition at line 3757 of file scip_prob.c.
References FALSE, SCIP_CALL, SCIP_OKAY, SCIPcheckStage(), SCIPisGE(), SCIPnodeCutoff(), SCIPnodeUpdateLowerbound(), and TRUE.
Referenced by branch(), branchOnVar(), enforceConflictgraph(), execRelpscost(), SCIP_DECL_BRANCHEXECLP(), SCIPcopyConcurrentSolvingStats(), SCIPupdateLocalDualbound(), SCIPupdateLocalLowerbound(), and SCIPupdateNodeDualbound().
◆ SCIPchgChildPrio()
| SCIP_RETCODE SCIPchgChildPrio | ( | SCIP * | scip, |
| SCIP_NODE * | child, | ||
| SCIP_Real | priority | ||
| ) |
change the node selection priority of the given child
- 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 in one of the following stages of the SCIP solving process:
- Parameters
-
scip SCIP data structure child child to update the node selection priority priority node selection priority value
Definition at line 3791 of file scip_prob.c.
References FALSE, SCIP_CALL, SCIP_INVALIDDATA, SCIP_NODETYPE_CHILD, SCIP_OKAY, SCIPcheckStage(), SCIPchildChgNodeselPrio(), SCIPnodeGetType(), and TRUE.
Referenced by SCIP_DECL_BRANCHEXECLP().