SCIP

Detailed Description

methods to manipulate a SCIP object

Functions
SCIP_RETCODE	SCIPcreate (SCIP **scip)
SCIP_RETCODE	SCIPfree (SCIP **scip)
SCIP_STAGE	SCIPgetStage (SCIP *scip)
SCIP_RETCODE	SCIPprintStage (SCIP *scip, FILE *file)
SCIP_STATUS	SCIPgetStatus (SCIP *scip)
SCIP_RETCODE	SCIPprintStatus (SCIP *scip, FILE *file)
SCIP_Bool	SCIPisTransformed (SCIP *scip)
SCIP_Bool	SCIPisExactSolve (SCIP *scip)
SCIP_Bool	SCIPisPresolveFinished (SCIP *scip)
SCIP_Bool	SCIPhasPerformedPresolve (SCIP *scip)
SCIP_Bool	SCIPpressedCtrlC (SCIP *scip)
SCIP_Bool	SCIPisStopped (SCIP *scip)

Function Documentation

SCIPcreate()

SCIP_RETCODE SCIPcreate

(

SCIP **

scip

)

creates and initializes SCIP data structures

Note

The SCIP default message handler is installed. Use the method SCIPsetMessagehdlr() to install your own message handler or SCIPsetMessagehdlrLogfile() and SCIPsetMessagehdlrQuiet() to write into a log file and turn off/on the display output, respectively.

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.

Postcondition

After calling this method scip reached the solving stage SCIP_STAGE_INIT

See SCIP_STAGE for a complete list of all possible solving stages.

creates and initializes SCIP data structures

Note

The SCIP default message handler is installed. Use the method SCIPsetMessagehdlr() to install your own message handler or SCIPsetMessagehdlrLogfile() and SCIPsetMessagehdlrQuiet() to write into a log file and turn off/on the display output, respectively.

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.

Postcondition

After calling this method SCIP reached the solving stage SCIP_STAGE_INIT

See SCIP_STAGE for a complete list of all possible solving stages.

Parameters

scip	pointer to SCIP data structure

Definition at line 307 of file scip_general.c.

References doScipCreate(), NULL, SCIP_CALL_FINALLY, SCIP_OKAY, and SCIPfree().

Referenced by addScenarioVarsAndConsToProb(), applyCompletesol(), applyOfins(), applyRepair(), applyVbounds(), createSubscip(), createSubSCIP(), doPricing(), execmain(), executeLNSHeuristic(), initConcsolver(), main(), scipexamples::QueensSolver::QueensSolver(), reoptimize(), runBrachistochrone(), runGastrans(), runPacking(), runSCIP(), runShell(), runSpring(), SCIP_DECL_BENDERSCOPY(), SCIP_DECL_HEUREXEC(), SCIP_DECL_RELAXEXEC(), SCIP_DECL_SEPAEXECLP(), SCIP_DECL_SOLVECUMULATIVE(), SCIPapplyProximity(), SCIPapplyRedSize(), SCIPapplyUndercover(), SCIPapplyZeroobj(), SCIPbendersApplyDecomposition(), SCIPcomputeCoverUndercover(), SCIPcreateFiniteSolCopy(), SCIPprobdataCreate(), SCIPrunColoringShell(), SCIPrunCyc(), SCIPrunShell(), SCIPverifyCircularPatternNLP(), searchEcAggr(), setupProbingSCIP(), solveClassification(), solveMinIISC(), solvePricingMINLP(), solveSubMIP(), solveSubproblem(), and writeBounds().

SCIPfree()

SCIP_RETCODE SCIPfree

(

SCIP **

scip

)

frees SCIP data structures

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_INIT
• SCIP_STAGE_PROBLEM
• SCIP_STAGE_TRANSFORMED
• SCIP_STAGE_INITPRESOLVE
• SCIP_STAGE_PRESOLVING
• SCIP_STAGE_PRESOLVED
• SCIP_STAGE_EXITPRESOLVE
• SCIP_STAGE_SOLVING
• SCIP_STAGE_SOLVED
• SCIP_STAGE_FREE

Postcondition

After calling this method SCIP reached the solving stage SCIP_STAGE_FREE

See SCIP_STAGE for a complete list of all possible solving stages.

Parameters

scip	pointer to SCIP data structure

Definition at line 339 of file scip_general.c.

References BMSfreeMemory, FALSE, NULL, SCIP_CALL, SCIP_OKAY, SCIP_STAGE_FREE, SCIP_STAGE_INIT, SCIPcheckStage(), SCIPclockFree(), SCIPdialoghdlrFree(), SCIPfreeProb(), SCIPinterruptFree(), SCIPmemFree(), SCIPmessagehdlrRelease(), SCIPsetFree(), SCIPsyncstoreRelease(), and TRUE.

Referenced by applyCompletesol(), applyOfins(), applyRepair(), applyVbounds(), blockCreateSubscip(), componentCreateSubscip(), createSubscip(), createSubSCIP(), deleteSubproblem(), doPricing(), execmain(), executeLNSHeuristic(), freeBlock(), freeComponent(), freeScenarioTree(), freeSubSCIP(), freeSubscip(), main(), probdataFree(), reoptimize(), runBrachistochrone(), runGastrans(), runPacking(), runSCIP(), runShell(), runSpring(), SCIP_DECL_BENDERSFREE(), SCIP_DECL_CONCSOLVERDESTROYINST(), SCIP_DECL_CONSPRESOL(), SCIP_DECL_HEUREXEC(), SCIP_DECL_RELAXEXEC(), SCIP_DECL_SEPAEXECLP(), SCIP_DECL_SOLVECUMULATIVE(), SCIPapplyRedSize(), SCIPapplyUndercover(), SCIPapplyZeroobj(), SCIPbendersDeactivate(), SCIPcomputeCoverUndercover(), SCIPcreate(), SCIPcreateFiniteSolCopy(), SCIPrunColoringShell(), SCIPrunCyc(), SCIPrunShell(), SCIPverifyCircularPatternNLP(), searchEcAggr(), solveClassification(), solveComponent(), solveMinIISC(), solvePricingMINLP(), solveSubMIP(), solveSubproblem(), subscipdataFreeSubscip(), writeBounds(), and scipexamples::QueensSolver::~QueensSolver().

SCIPgetStage()

SCIP_STAGE SCIPgetStage

(

SCIP *

scip

)

returns current stage of SCIP

Returns

the current SCIP stage

See SCIP_STAGE for a complete list of all possible solving stages.

Parameters

scip	SCIP data structure

Definition at line 380 of file scip_general.c.

References NULL.

Referenced by addCoef(), addOrbitope(), analyzeConflict(), analyzeConflictLowerbound(), analyzeConflictOne(), analyzeConflictRangedRow(), analyzeConflictUpperbound(), analyzeConflictZero(), applyGenVBound(), applyProbing(), applyRepair(), branchruledataEnsureArraySize(), canonicalizeConstraints(), catchEvent(), checkEstimateCriterion(), checkLocksAndRes(), checkTransferBoolParam(), collectEstLst(), componentSetupWorkingSol(), consdataCreate(), consdataSort(), constructCompression(), constructValidSolution(), createAuxVar(), createCGCuts(), createConsSetppc(), createSubproblems(), createSubscip(), createSubSCIP(), deinitSolve(), delCoefPos(), detectNlhdlr(), detectNlhdlrs(), displayRelevantStats(), doCopy(), executeHeuristic(), freeComponent(), generateAndApplyBendersCuts(), generateAndApplyBendersIntegerCuts(), generateAndApplyBendersNogoodCut(), getNNodesBelowIncumbent(), getNRank1Nodes(), getX(), heurdataEnsureArraySize(), initialiseSubproblem(), initPricing(), initSolve(), orbitalReductionPropagateComponent(), performDualfix(), processBinvarFixings(), propagateCons(), propagatePackingPartitioningCons(), propagateVbounds(), propIndicator(), proposeFeasibleSolution(), readDecomposition(), readDiffFile(), readSolFile(), readXmlSolFile(), recomputeNodeInformation(), removeFixedBinvars(), removeVariablesAndConstraintsFromMaster(), resolvePropagationCoretimes(), SCIP_DECL_BENDERSCUTEXEC(), SCIP_DECL_CONSACTIVE(), SCIP_DECL_CONSCHECK(), SCIP_DECL_CONSDEACTIVE(), SCIP_DECL_CONSDELETE(), SCIP_DECL_CONSDISABLE(), SCIP_DECL_CONSENABLE(), SCIP_DECL_CONSPRESOL(), SCIP_DECL_CONSPROP(), SCIP_DECL_CONSTRANS(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_EVENTEXEC(), SCIP_DECL_EVENTFREE(), SCIP_DECL_HEUREXEC(), SCIP_DECL_NLHDLRDETECT(), SCIP_DECL_PARAMCHGD(), SCIP_DECL_PRESOLEXEC(), SCIP_DECL_PROPEXEC(), SCIP_DECL_PROPPRESOL(), SCIP_DECL_READERREAD(), SCIPaddCoefLinear(), SCIPaddExprNonlinear(), SCIPaddLinearVarNonlinear(), SCIPanalyzeDeductionsProbing(), SCIPapplyHeurSubNlp(), SCIPbendersExec(), SCIPbendersFreeSubproblem(), SCIPbendersSolveSubproblemCIP(), SCIPcheckBendersSubproblemOptimality(), SCIPchgCapacityKnapsack(), SCIPchgCoefLinear(), SCIPchgConsName(), SCIPchgExprNonlinear(), SCIPchgLhsNonlinear(), SCIPchgRhsNonlinear(), SCIPchgVarLb(), SCIPchgVarLbGlobal(), SCIPchgVarLbNode(), SCIPchgVarLbProbing(), SCIPchgVarName(), SCIPchgVarType(), SCIPchgVarUb(), SCIPchgVarUbGlobal(), SCIPchgVarUbNode(), SCIPchgVarUbProbing(), SCIPclassifyConstraintTypesLinear(), SCIPcomputeFacetVertexPolyhedralNonlinear(), SCIPcreateConsCardinality(), SCIPcreateConsCumulative(), SCIPcreateConsLinear(), SCIPcreateConsLinking(), SCIPcreateConsLogicor(), SCIPcreateConsOptcumulative(), SCIPcreateConsSOS1(), SCIPgenerateAndApplyBendersOptCut(), SCIPgetNLimSolsFound(), SCIPgetVarCopy(), SCIPincludeNlhdlrNonlinear(), SCIPinferVarFixCons(), SCIPinferVarFixProp(), SCIPinferVarLbCons(), SCIPinferVarLbProp(), SCIPinferVarUbCons(), SCIPinferVarUbProp(), SCIPisConsCompressionEnabled(), SCIPisDualSolAvailable(), SCIPmakeIndicatorFeasible(), SCIPmakeIndicatorsFeasible(), SCIPmergeVariableStatistics(), SCIPprintSolutionStatistics(), SCIPprintStatistics(), SCIPprintTimingStatistics(), SCIPsetLinearConsIndicator(), SCIPsetSlackVarUb(), SCIPsolveConcurrent(), SCIPtightenVarLb(), SCIPtightenVarLbGlobal(), SCIPtightenVarUb(), SCIPtightenVarUbGlobal(), SCIPtransformDecompstore(), SCIPtransformMinUC(), SCIPupdateStartpointHeurSubNlp(), SCIPvalidateSolve(), SCIPwriteSolutionNl(), setupAndSolve(), setupAndSolveSubscipRapidlearning(), solveComponent(), solveSubNLP(), subtreeSumGapUpdate(), tightenBounds(), tightenedLinkvar(), and updateDataStructures().

SCIPprintStage()

SCIP_RETCODE SCIPprintStage	(	SCIP *	scip,
		FILE *	file
	)

outputs SCIP stage and solution status if applicable via the message handler

Note

If the message handler is set to a NULL pointer nothing will be printed

If limits have been changed between the solution and the call to this function, the status is recomputed and thus may to correspond to the original status.

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.

See SCIP_STAGE for a complete list of all possible solving stages.

Parameters

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

Definition at line 402 of file scip_general.c.

References SCIP_CALL, SCIP_INVALIDDATA, SCIP_OKAY, SCIP_Real, SCIP_STAGE_EXITPRESOLVE, SCIP_STAGE_EXITSOLVE, SCIP_STAGE_FREE, SCIP_STAGE_FREETRANS, SCIP_STAGE_INIT, SCIP_STAGE_INITPRESOLVE, SCIP_STAGE_INITSOLVE, SCIP_STAGE_PRESOLVED, SCIP_STAGE_PRESOLVING, SCIP_STAGE_PROBLEM, SCIP_STAGE_SOLVED, SCIP_STAGE_SOLVING, SCIP_STAGE_TRANSFORMED, SCIP_STAGE_TRANSFORMING, SCIPcheckStage(), SCIPerrorMessage, SCIPgetObjsense(), SCIPgetPrimalbound(), SCIPisInfinity(), SCIPmessageFPrintInfo(), SCIPprintStatus(), SCIPsolveIsStopped(), and TRUE.

Referenced by displayRelevantStats(), and SCIPprintStatusStatistics().

SCIPgetStatus()

SCIP_STATUS SCIPgetStatus

(

SCIP *

scip

)

gets solution status

Returns

SCIP solution status

See SCIP_STATUS for a complete list of all possible solving status.

Parameters

scip	SCIP data structure

Definition at line 498 of file scip_general.c.

References NULL, SCIP_CALL_ABORT, SCIP_STAGE_FREE, SCIP_STAGE_INIT, SCIP_STATUS_UNKNOWN, SCIPcheckStage(), and TRUE.

Referenced by createSubSCIP(), doPricing(), executeLNSHeuristic(), main(), reoptimize(), runBenders(), SCIP_DECL_BENDERSCUTEXEC(), SCIP_DECL_CONCSOLVERSYNCWRITE(), SCIP_DECL_CONSEXITPRE(), SCIP_DECL_CONSINITPRE(), SCIP_DECL_CONSINITSOL(), SCIP_DECL_DISPOUTPUT(), SCIP_DECL_EVENTEXEC(), SCIP_DECL_HEUREXEC(), SCIP_DECL_PROPEXITPRE(), SCIP_DECL_RELAXEXEC(), SCIPapplyHeurDualval(), SCIPbendersComputeSubproblemLowerbound(), SCIPbendersSolveSubproblemCIP(), SCIPgetGap(), SCIPgetLowerbound(), SCIPgetTransGap(), SCIPgetUpperbound(), SCIPprintSolutionStatistics(), SCIPprintStatus(), SCIPsolveConcurrent(), SCIPverifyCircularPatternNLP(), SCIPwriteSolutionNl(), searchEcAggrWithMIP(), setupAndSolve(), setupAndSolveCumulativeSubscip(), setupAndSolveSubscip(), setupAndSolveSubscipLocalbranching(), setupAndSolveSubscipRapidlearning(), setupAndSolveSubscipTrustregion(), solveAndEvalSubscip(), solveComponent(), solvePricingMINLP(), solveSubNLP(), solveSubproblem(), solveSubscip(), solveSubscipLpface(), storeAggrFromMIP(), and writeBounds().

SCIPprintStatus()

SCIP_RETCODE SCIPprintStatus	(	SCIP *	scip,
		FILE *	file
	)

outputs solution status

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.

See SCIP_STATUS for a complete list of all possible solving status.

Parameters

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

Definition at line 521 of file scip_general.c.

References SCIP_CALL, SCIP_INVALIDDATA, SCIP_OKAY, SCIP_STATUS_BESTSOLLIMIT, SCIP_STATUS_DUALLIMIT, SCIP_STATUS_GAPLIMIT, SCIP_STATUS_INFEASIBLE, SCIP_STATUS_INFORUNBD, SCIP_STATUS_MEMLIMIT, SCIP_STATUS_NODELIMIT, SCIP_STATUS_OPTIMAL, SCIP_STATUS_PRIMALLIMIT, SCIP_STATUS_RESTARTLIMIT, SCIP_STATUS_SOLLIMIT, SCIP_STATUS_STALLNODELIMIT, SCIP_STATUS_TERMINATE, SCIP_STATUS_TIMELIMIT, SCIP_STATUS_TOTALNODELIMIT, SCIP_STATUS_UNBOUNDED, SCIP_STATUS_UNKNOWN, SCIP_STATUS_USERINTERRUPT, SCIPcheckStage(), SCIPerrorMessage, SCIPgetStatus(), SCIPmessageFPrintInfo(), and TRUE.

Referenced by SCIP_DECL_CONCSOLVEREXEC(), SCIP_DECL_DIALOGEXEC(), SCIPprintStage(), and SCIPwriteSolutionNl().

SCIPisTransformed()

SCIP_Bool SCIPisTransformed

(

SCIP *

scip

)

returns whether the current stage belongs to the transformed problem space

Returns

Returns TRUE if the SCIP instance is transformed, otherwise FALSE

Parameters

scip	SCIP data structure

Definition at line 596 of file scip_general.c.

References NULL, and SCIP_STAGE_TRANSFORMING.

Referenced by addSymmetryInformation(), consdataAddCons(), consdataCreate(), consdataCreateBinvars(), consdataCreateRedundant(), consdataCreateSuperindicator(), consdataFree(), copyProb(), createAndAddAndCons(), createConsSetppc(), freeComponent(), freeOrbitope(), getMaxactImplicObjchg(), lexdataCreate(), readMst(), readSol(), readSolFile(), readXmlSolFile(), SCIP_DECL_CONSCOPY(), SCIP_DECL_CONSDELETE(), SCIP_DECL_CONSGETPERMSYMGRAPH(), SCIP_DECL_CONSGETSIGNEDPERMSYMGRAPH(), SCIP_DECL_CONSPROP(), SCIP_DECL_CONSTRANS(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_EVENTEXITSOL(), SCIP_DECL_EVENTINITSOL(), SCIPapplyHeurDualval(), SCIPapplyHeurSubNlp(), SCIPchgVarBranchPriority(), SCIPcreateConsAnd(), SCIPcreateConsIndicatorGeneric(), SCIPcreateConsIndicatorGenericLinCons(), SCIPcreateConsIndicatorGenericLinConsPure(), SCIPcreateConsKnapsack(), SCIPcreateConsLogicor(), SCIPcreateConsVarbound(), SCIPlexicographicReductionAddPermutation(), SCIPorbitalReductionAddComponent(), SCIPorbitopalReductionAddOrbitope(), SCIPpermuteProb(), SCIPprintSol(), setSetppcType(), solveSubNLP(), and updateRunStats().

SCIPisExactSolve()

SCIP_Bool SCIPisExactSolve

(

SCIP *

scip

)

returns whether the solution process is arithmetically exact, i.e., not subject to roundoff errors

Note

This feature is not supported yet!

Returns

Returns TRUE if SCIP is exact solving mode, otherwise FALSE

returns whether the solution process should be probably correct

Note

This feature is not supported yet!

Returns

Returns TRUE if SCIP is exact solving mode, otherwise FALSE

Parameters

scip	SCIP data structure

Definition at line 611 of file scip_general.c.

References NULL.

Referenced by branch(), branchOnVar(), execRelpscost(), runVanillaStrongBranching(), SCIP_DECL_BRANCHEXECLP(), SCIP_DECL_PROPEXEC(), SCIPselectVarPseudoStrongBranching(), SCIPselectVarStrongBranching(), and selectVarMultAggrBranching().

SCIPisPresolveFinished()

SCIP_Bool SCIPisPresolveFinished

(

SCIP *

scip

)

returns whether the presolving process would be finished given no more presolving reductions are found in this presolving round

Checks whether the number of presolving rounds is not exceeded and the presolving reductions found in the current presolving round suffice to trigger another presolving round.

Note

if subsequent presolvers find more reductions, presolving might continue even if the method returns FALSE

does not check whether infeasibility or unboundedness was already detected in presolving (which would result in presolving being stopped although the method returns TRUE)

Returns

Returns TRUE if presolving is finished if no further reductions are detected

Parameters

scip	SCIP data structure

Definition at line 633 of file scip_general.c.

References FALSE, NULL, SCIP_Bool, SCIP_CALL_ABORT, SCIPcheckStage(), SCIPcliquetableGetNCliques(), and TRUE.

Referenced by presolve(), presolveRound(), SCIP_DECL_CONSPRESOL(), and SCIP_DECL_PROPPRESOL().

SCIPhasPerformedPresolve()

SCIP_Bool SCIPhasPerformedPresolve

(

SCIP *

scip

)

returns whether SCIP has performed presolving during the last solve

Returns

Returns TRUE if presolving was performed during the last solve

Parameters

scip	SCIP data structure

Definition at line 695 of file scip_general.c.

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

Referenced by SCIPwriteSolutionNl().

SCIPpressedCtrlC()

SCIP_Bool SCIPpressedCtrlC

(

SCIP *

scip

)

returns whether the user pressed CTRL-C to interrupt the solving process

Returns

Returns TRUE if Ctrl-C was pressed, otherwise FALSE.

Parameters

scip	SCIP data structure

Definition at line 711 of file scip_general.c.

References SCIPinterrupted().

SCIPisStopped()

SCIP_Bool SCIPisStopped

(

SCIP *

scip

)

returns whether the solving process should be / was stopped before proving optimality; if the solving process should be / was stopped, the status returned by SCIPgetStatus() yields the reason for the premature abort

Returns

Returns TRUE if solving process is stopped/interrupted, otherwise FALSE.

Parameters

scip	SCIP data structure

Definition at line 724 of file scip_general.c.

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

Referenced by applyCliqueFixings(), applyHeur(), applyNlobbt(), applyObbtBilinear(), applyProbing(), applyVbounds(), calculateScoreFromDeeperscore(), calculateScoreFromDeeperscoreAndCutoffs(), checkArraySizesGLS(), checkArraySizesHeur(), checkSystemGF2(), computeRowEchelonGF2(), detectRedundantConstraints(), doSeachEcAggr(), enfopsCons(), execRelpscost(), executeBranchingRecursive(), fillDigraph(), findCumulativeConss(), findNewBounds(), findPrecedenceConss(), generateClusterCuts(), generateGMICuts(), generateOddCycleCut(), heurExec(), liftOddCycleCut(), loadTcliquegraph(), performRandRounding(), preprocessCliques(), preprocessConstraintPairs(), processHashlists(), propagateCons(), removeConstraintsDueToNegCliques(), runVanillaStrongBranching(), SCIP_DECL_BRANCHEXECLP(), SCIP_DECL_CONSPRESOL(), SCIP_DECL_CONSPROP(), SCIP_DECL_CONSSEPALP(), SCIP_DECL_CONSSEPASOL(), SCIP_DECL_HEUREXEC(), SCIP_DECL_PRESOLEXEC(), SCIP_DECL_PROPPRESOL(), SCIP_DECL_SEPAEXECLP(), SCIP_DECL_SEPAEXECSOL(), SCIPapplyLockFixings(), SCIPmatrixCreate(), SCIPperformGenericDivingAlgorithm(), SCIPselectVarStrongBranching(), selectVarRecursive(), separateCardinality(), separateCuts(), separateGLS(), separateHeur(), separateSOS1(), solveBendersSubproblems(), solveLagrangianDual(), solvePricingHeuristic(), strengthenVarbounds(), tcliquegraphConstructCliqueTable(), tryAddSymmetryHandlingMethods(), tryOneOpt(), and writeBounds().