Scippy

    SCIP

    Solving Constraint Integer Programs

    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)
     
    const char * SCIPstatusName (SCIP_STATUS status)
     
    SCIP_RETCODE SCIPprintStatus (SCIP *scip, FILE *file)
     
    SCIP_Bool SCIPisTransformed (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
    scippointer to SCIP data structure

    Definition at line 370 of file scip_general.c.

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

    Referenced by addScenarioVarsAndConsToProb(), applyCompletesol(), applyDecomposition(), applyOfins(), applyRepair(), applyVbounds(), bucketCreateSubscip(), createSubscip(), createSubSCIP(), createSubscipIIS(), 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(), 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:
    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
    scippointer to SCIP data structure

    Definition at line 402 of file scip_general.c.

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

    Referenced by applyCompletesol(), applyOfins(), applyRepair(), applyVbounds(), blockCreateSubscip(), componentCreateSubscip(), createSubscip(), createSubSCIP(), deleteSubproblem(), doPricing(), execmain(), executeLNSHeuristic(), freeBlock(), freeBucket(), freeComponent(), freeDecomposition(), freeScenarioTree(), freeSubSCIP(), freeSubscip(), main(), probdataFree(), reoptimize(), runBrachistochrone(), runGastrans(), runPacking(), runSCIP(), runShell(), runSpring(), SCIP_DECL_BENDERSEXIT(), 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(), SCIPiisFree(), SCIPiisReset(), 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
    scipSCIP data structure

    Definition at line 444 of file scip_general.c.

    References NULL.

    Referenced by addCoef(), additionFilterBatch(), addOrbitope(), analyzeConflict(), analyzeConflictLowerbound(), analyzeConflictOne(), analyzeConflictRangedRow(), analyzeConflictUpperbound(), analyzeConflictZero(), applyGenVBound(), applyProbing(), applyRepair(), branchruledataEnsureArraySize(), canonicalizeConstraints(), catchEvent(), checkEstimateCriterion(), checkLocksAndRes(), checkTransferBoolParam(), collectEstLst(), componentSetupWorkingSol(), consdataCreate(), consdataSort(), constructCompression(), constructValidSolution(), createAuxVar(), createCGCuts(), createCons(), createConsSetppc(), createSubproblems(), createSubscip(), createSubSCIP(), deinitSolve(), delCoefPos(), deletionFilterBatch(), detectNlhdlr(), detectNlhdlrs(), displayRelevantStats(), doCopy(), executeHeuristic(), freeComponent(), generateAndApplyBendersCuts(), generateAndApplyBendersIntegerCuts(), generateAndApplyBendersNogoodCut(), getNNodesBelowIncumbent(), getNRank1Nodes(), getX(), heurdataEnsureArraySize(), initialiseSubproblem(), initPricing(), initSolve(), orbitalReductionPropagateComponent(), performDualfix(), processBinvarFixings(), propagateCons(), propagateVbounds(), propIndicator(), proposeFeasibleSolution(), readDecomposition(), readDiffFile(), readSolFile(), readXmlSolFile(), recomputeNodeInformation(), removeFixedBinvars(), 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(), SCIPaddCoefExactLinear(), SCIPaddCoefLinear(), SCIPaddExprNonlinear(), SCIPaddLinearVarNonlinear(), SCIPanalyzeDeductionsProbing(), SCIPapplyHeurSubNlp(), SCIPbendersExec(), SCIPbendersFreeSubproblem(), SCIPbendersSolveSubproblemCIP(), SCIPcheckBendersSubproblemOptimality(), SCIPchgCapacityKnapsack(), SCIPchgCoefExactLinear(), SCIPchgCoefLinear(), SCIPchgConsName(), SCIPchgExprNonlinear(), SCIPchgLhsNonlinear(), SCIPchgRhsNonlinear(), SCIPchgVarImplType(), SCIPchgVarLb(), SCIPchgVarLbExact(), SCIPchgVarLbGlobal(), SCIPchgVarLbNode(), SCIPchgVarLbProbing(), SCIPchgVarName(), SCIPchgVarType(), SCIPchgVarUb(), SCIPchgVarUbExact(), SCIPchgVarUbGlobal(), SCIPchgVarUbNode(), SCIPchgVarUbProbing(), SCIPclassifyConstraintTypesLinear(), SCIPcollectSolutionStatistics(), SCIPcollectTimingStatistics(), SCIPcomputeFacetVertexPolyhedralNonlinear(), SCIPconsCreateRow(), SCIPcreateConsCardinality(), SCIPcreateConsCumulative(), SCIPcreateConsExactLinear(), SCIPcreateConsLinear(), SCIPcreateConsLinking(), SCIPcreateConsLogicor(), SCIPcreateConsOptcumulative(), SCIPcreateConsSOS1(), SCIPenableExactSolving(), SCIPgenerateAndApplyBendersOptCut(), SCIPgetNLimSolsFound(), SCIPgetVarCopy(), SCIPiisGenerate(), SCIPincludeNlhdlrNonlinear(), SCIPinferVarFixCons(), SCIPinferVarFixProp(), SCIPinferVarLbConsExact(), SCIPinferVarLbProp(), SCIPinferVarUbConsExact(), SCIPinferVarUbProp(), SCIPisConsCompressionEnabled(), SCIPisDualSolAvailable(), SCIPmakeIndicatorFeasible(), SCIPmakeIndicatorsFeasible(), SCIPmergeVariableStatistics(), SCIPprintSolutionStatistics(), SCIPprintStatistics(), SCIPprintStatisticsJson(), SCIPprintTimingStatistics(), SCIPsetLinearConsIndicator(), SCIPsetSlackVarUb(), SCIPsolveConcurrent(), SCIPtightenVarLb(), SCIPtightenVarLbExact(), SCIPtightenVarLbGlobal(), SCIPtightenVarUb(), SCIPtightenVarUbExact(), SCIPtightenVarUbGlobal(), SCIPtransformDecompstore(), SCIPtransformMinUC(), SCIPupdateStartpointHeurSubNlp(), SCIPvalidateSolve(), SCIPvalidateSolveExact(), SCIPwriteSolutionNl(), setupAndSolve(), setupAndSolveSubscipRapidlearning(), solveBendersSubproblems(), solveComponent(), solveSubNLP(), subtreeSumGapUpdate(), tightenBounds(), tightenedLinkvar(), tightenVarLbGlobalSafe(), tightenVarUbGlobalSafe(), 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
    scipSCIP data structure
    fileoutput file (or NULL for standard output)

    Definition at line 466 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
    scipSCIP data structure

    Definition at line 562 of file scip_general.c.

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

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

    ◆ SCIPstatusName()

    ◆ 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
    scipSCIP data structure
    fileoutput file (or NULL for standard output)

    Definition at line 631 of file scip_general.c.

    References SCIP_CALL, SCIP_OKAY, SCIPcheckStage, SCIPgetStatus(), SCIPmessageFPrintInfo(), SCIPstatusName(), and TRUE.

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

    ◆ SCIPisTransformed()

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

    Definition at line 668 of file scip_general.c.

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

    Referenced by presolve(), presolveRound(), SCIP_DECL_CONSPRESOL(), SCIP_DECL_PRESOLEXEC(), 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
    scipSCIP data structure

    Definition at line 730 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
    scipSCIP data structure

    Definition at line 746 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
    scipSCIP data structure

    Definition at line 759 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().