Scippy

    SCIP

    Solving Constraint Integer Programs

    Modules | Functions
    Primal Heuristics
    Public API of SCIP » Core API » Methods for managing plugins

    Detailed Description

    methods for primal heuristic plugins

    Modules

     Special Methods
     methods commonly used by primal heuristics
     

    Functions

     SCIP_DECL_SORTPTRCOMP (SCIPheurComp)
     
     SCIP_DECL_SORTPTRCOMP (SCIPheurCompPriority)
     
     SCIP_DECL_SORTPTRCOMP (SCIPheurCompName)
     
    SCIP_HEURDATA * SCIPheurGetData (SCIP_HEUR *heur)
     
    void SCIPheurSetData (SCIP_HEUR *heur, SCIP_HEURDATA *heurdata)
     
    void SCIPheurMarkExact (SCIP_HEUR *heur)
     
    const char * SCIPheurGetName (SCIP_HEUR *heur)
     
    const char * SCIPheurGetDesc (SCIP_HEUR *heur)
     
    char SCIPheurGetDispchar (SCIP_HEUR *heur)
     
    SCIP_HEURTIMING SCIPheurGetTimingmask (SCIP_HEUR *heur)
     
    void SCIPheurSetTimingmask (SCIP_HEUR *heur, SCIP_HEURTIMING timingmask)
     
    SCIP_Bool SCIPheurUsesSubscip (SCIP_HEUR *heur)
     
    int SCIPheurGetPriority (SCIP_HEUR *heur)
     
    int SCIPheurGetFreq (SCIP_HEUR *heur)
     
    void SCIPheurSetFreq (SCIP_HEUR *heur, int freq)
     
    int SCIPheurGetFreqofs (SCIP_HEUR *heur)
     
    int SCIPheurGetMaxdepth (SCIP_HEUR *heur)
     
    SCIP_Longint SCIPheurGetNCalls (SCIP_HEUR *heur)
     
    SCIP_Longint SCIPheurGetNSolsFound (SCIP_HEUR *heur)
     
    SCIP_Longint SCIPheurGetNBestSolsFound (SCIP_HEUR *heur)
     
    SCIP_Bool SCIPheurIsInitialized (SCIP_HEUR *heur)
     
    SCIP_Real SCIPheurGetSetupTime (SCIP_HEUR *heur)
     
    SCIP_Real SCIPheurGetTime (SCIP_HEUR *heur)
     
    SCIP_DIVESET ** SCIPheurGetDivesets (SCIP_HEUR *heur)
     
    int SCIPheurGetNDivesets (SCIP_HEUR *heur)
     
    SCIP_RETCODE SCIPincludeHeur (SCIP *scip, const char *name, const char *desc, char dispchar, int priority, int freq, int freqofs, int maxdepth, SCIP_HEURTIMING timingmask, SCIP_Bool usessubscip, SCIP_DECL_HEURCOPY((*heurcopy)), SCIP_DECL_HEURFREE((*heurfree)), SCIP_DECL_HEURINIT((*heurinit)), SCIP_DECL_HEUREXIT((*heurexit)), SCIP_DECL_HEURINITSOL((*heurinitsol)), SCIP_DECL_HEUREXITSOL((*heurexitsol)), SCIP_DECL_HEUREXEC((*heurexec)), SCIP_HEURDATA *heurdata)
     
    SCIP_RETCODE SCIPincludeHeurBasic (SCIP *scip, SCIP_HEUR **heur, const char *name, const char *desc, char dispchar, int priority, int freq, int freqofs, int maxdepth, SCIP_HEURTIMING timingmask, SCIP_Bool usessubscip, SCIP_DECL_HEUREXEC((*heurexec)), SCIP_HEURDATA *heurdata)
     
    SCIP_RETCODE SCIPsetHeurCopy (SCIP *scip, SCIP_HEUR *heur, SCIP_DECL_HEURCOPY((*heurcopy)))
     
    SCIP_RETCODE SCIPsetHeurFree (SCIP *scip, SCIP_HEUR *heur, SCIP_DECL_HEURFREE((*heurfree)))
     
    SCIP_RETCODE SCIPsetHeurInit (SCIP *scip, SCIP_HEUR *heur, SCIP_DECL_HEURINIT((*heurinit)))
     
    SCIP_RETCODE SCIPsetHeurExit (SCIP *scip, SCIP_HEUR *heur, SCIP_DECL_HEUREXIT((*heurexit)))
     
    SCIP_RETCODE SCIPsetHeurInitsol (SCIP *scip, SCIP_HEUR *heur, SCIP_DECL_HEURINITSOL((*heurinitsol)))
     
    SCIP_RETCODE SCIPsetHeurExitsol (SCIP *scip, SCIP_HEUR *heur, SCIP_DECL_HEUREXITSOL((*heurexitsol)))
     
    SCIP_HEUR * SCIPfindHeur (SCIP *scip, const char *name)
     
    SCIP_HEUR ** SCIPgetHeurs (SCIP *scip)
     
    int SCIPgetNHeurs (SCIP *scip)
     
    SCIP_RETCODE SCIPsetHeurPriority (SCIP *scip, SCIP_HEUR *heur, int priority)
     

    Function Documentation

    ◆ SCIP_DECL_SORTPTRCOMP() [1/3]

    SCIP_DECL_SORTPTRCOMP ( SCIPheurComp  )

    compares two heuristics w.r.t. to their delay positions and priorities

    Definition at line 51 of file heur.c.

    References SCIP_Heur::delaypos, SCIP_Heur::freq, SCIP_Heur::name, SCIP_Heur::ncalls, NULL, and SCIP_Heur::priority.

    ◆ SCIP_DECL_SORTPTRCOMP() [2/3]

    SCIP_DECL_SORTPTRCOMP ( SCIPheurCompPriority  )

    compares two heuristics w.r.t. to their priority values

    Definition at line 77 of file heur.c.

    References SCIPheurGetPriority().

    ◆ SCIP_DECL_SORTPTRCOMP() [3/3]

    SCIP_DECL_SORTPTRCOMP ( SCIPheurCompName  )

    comparison method for sorting heuristics w.r.t. to their name

    Definition at line 84 of file heur.c.

    References SCIPheurGetName().

    ◆ SCIPheurGetData()

    SCIP_HEURDATA * SCIPheurGetData ( SCIP_HEUR *  heur)

    gets user data of primal heuristic

    Parameters
    heurprimal heuristic

    Definition at line 1368 of file heur.c.

    References SCIP_Heur::heurdata, and NULL.

    Referenced by addCandSolCyckerlin(), addLocalbranchingConstraintAndObjcutoff(), applyRepair(), createNewSol(), createSolFromNLP(), createSolFromSubScipSol(), determineLimits(), executeDivingHeuristic(), executeHeuristic(), executeLNSHeuristic(), initRest(), processNLPSol(), reoptimize(), SCIP_DECL_DIVESETAVAILABLE(), SCIP_DECL_DIVESETGETSCORE(), SCIP_DECL_HEURCOPY(), SCIP_DECL_HEUREXEC(), SCIP_DECL_HEUREXIT(), SCIP_DECL_HEUREXITSOL(), SCIP_DECL_HEURFREE(), SCIP_DECL_HEURINIT(), SCIP_DECL_HEURINITSOL(), SCIP_DECL_TABLECOLLECT(), SCIP_DECL_TABLEOUTPUT(), SCIPapplyHeurDualval(), SCIPapplyHeurSubNlp(), SCIPapplyLockFixings(), SCIPapplyProximity(), SCIPapplyUndercover(), SCIPapplyZeroobj(), SCIPdeleteSubproblemProximity(), SCIPfindObjHeur(), SCIPgetObjHeur(), SCIPgetStartCandidateHeurSubNlp(), SCIPheurPassIndicator(), SCIPheurPassSolAddSol(), SCIPheurPassSolTrySol(), SCIPheurSyncPassSol(), SCIPinitHeurOptcumulative(), SCIPinitializeHeurListScheduling(), SCIPreoptsolsGetNCheckedsols(), SCIPreoptsolsGetNImprovingsols(), SCIPupdateStartpointHeurSubNlp(), setupAndSolveSubscip(), setupAndSolveSubscipLocalbranching(), setupAndSolveSubscipMutation(), setupAndSolveSubscipTrustregion(), setupSubScip(), solveSubNLP(), solveSubproblem(), and storeSolution().

    ◆ SCIPheurSetData()

    void SCIPheurSetData ( SCIP_HEUR *  heur,
    SCIP_HEURDATA *  heurdata 
    )

    sets user data of primal heuristic; user has to free old data in advance!

    Parameters
    heurprimal heuristic
    heurdatanew primal heuristic user data

    Definition at line 1378 of file heur.c.

    References SCIP_Heur::heurdata, and NULL.

    Referenced by presolveTwoOpt(), SCIP_DECL_HEUREXIT(), SCIP_DECL_HEUREXITSOL(), SCIP_DECL_HEURFREE(), SCIP_DECL_HEURINIT(), and SCIP_DECL_HEURINITSOL().

    ◆ SCIPheurMarkExact()

    void SCIPheurMarkExact ( SCIP_HEUR *  heur)

    marks the primal heuristic as safe to use in exact solving mode

    Parameters
    heurprimal heuristic

    Definition at line 1457 of file heur.c.

    References SCIP_Heur::exact, NULL, and TRUE.

    Referenced by SCIPincludeHeurActconsdiving(), SCIPincludeHeurAdaptivediving(), SCIPincludeHeurAlns(), SCIPincludeHeurBound(), SCIPincludeHeurClique(), SCIPincludeHeurCoefdiving(), SCIPincludeHeurCompletesol(), SCIPincludeHeurConflictdiving(), SCIPincludeHeurCrossover(), SCIPincludeHeurDins(), SCIPincludeHeurDistributiondiving(), SCIPincludeHeurDps(), SCIPincludeHeurDualval(), SCIPincludeHeurFarkasdiving(), SCIPincludeHeurFeaspump(), SCIPincludeHeurFixandinfer(), SCIPincludeHeurFracdiving(), SCIPincludeHeurGins(), SCIPincludeHeurGuideddiving(), SCIPincludeHeurIndicator(), SCIPincludeHeurIndicatordiving(), SCIPincludeHeurIntdiving(), SCIPincludeHeurIntshifting(), SCIPincludeHeurLinesearchdiving(), SCIPincludeHeurLocalbranching(), SCIPincludeHeurLocks(), SCIPincludeHeurLpface(), SCIPincludeHeurMutation(), SCIPincludeHeurObjpscostdiving(), SCIPincludeHeurOctane(), SCIPincludeHeurOfins(), SCIPincludeHeurOneopt(), SCIPincludeHeurPADM(), SCIPincludeHeurProximity(), SCIPincludeHeurPscostdiving(), SCIPincludeHeurRandrounding(), SCIPincludeHeurReoptsols(), SCIPincludeHeurRepair(), SCIPincludeHeurRins(), SCIPincludeHeurRootsoldiving(), SCIPincludeHeurRounding(), SCIPincludeHeurScheduler(), SCIPincludeHeurShiftandpropagate(), SCIPincludeHeurShifting(), SCIPincludeHeurSimplerounding(), SCIPincludeHeurSync(), SCIPincludeHeurTrivial(), SCIPincludeHeurTrivialnegation(), SCIPincludeHeurTrustregion(), SCIPincludeHeurTrySol(), SCIPincludeHeurTwoopt(), SCIPincludeHeurVbounds(), SCIPincludeHeurVeclendiving(), SCIPincludeHeurZeroobj(), and SCIPincludeHeurZirounding().

    ◆ SCIPheurGetName()

    const char * SCIPheurGetName ( SCIP_HEUR *  heur)

    gets name of primal heuristic

    Parameters
    heurprimal heuristic

    Definition at line 1467 of file heur.c.

    References SCIP_Heur::name, and NULL.

    Referenced by bufferSolution(), fromCommandLine(), notifyNlhdlrNewsol(), paramsetSetHeuristicsAggressive(), paramsetSetHeuristicsDefault(), paramsetSetHeuristicsFast(), paramsetSetHeuristicsOff(), presolve(), presolveRound(), proposeFeasibleSolution(), SCIP_DECL_CONCSOLVERCOPYSOLVINGDATA(), SCIP_DECL_CONSCHECK(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DISPOUTPUT(), SCIP_DECL_EVENTEXEC(), SCIP_DECL_HEURCOPY(), SCIP_DECL_HEUREXEC(), SCIP_DECL_HEUREXIT(), SCIP_DECL_HEUREXITSOL(), SCIP_DECL_HEURFREE(), SCIP_DECL_HEURINIT(), SCIP_DECL_HEURINITSOL(), SCIP_DECL_SORTPTRCOMP(), SCIPapplyProximity(), SCIPcollectHeuristicStatistics(), SCIPcopyConcurrentSolvingStats(), SCIPdivesetCreate(), SCIPgetStartCandidateHeurSubNlp(), SCIPheurCopyInclude(), SCIPheurPassIndicator(), SCIPheurPassSolAddSol(), SCIPheurPassSolTrySol(), SCIPheurSyncPassSol(), SCIPincludeDialogDefaultFix(), SCIPincludeDialogDefaultSet(), SCIPparamsetSetEmphasis(), SCIPparamsetSetToSubscipsOff(), SCIPperformGenericDivingAlgorithm(), SCIPprimalHeuristics(), SCIPprintHeuristicStatistics(), SCIPprintSolutionStatistics(), SCIPreoptAddSol(), SCIPupdateStartpointHeurSubNlp(), soltreeAddSol(), and solveComponent().

    ◆ SCIPheurGetDesc()

    const char * SCIPheurGetDesc ( SCIP_HEUR *  heur)

    gets description of primal heuristic

    Parameters
    heurprimal heuristic

    Definition at line 1477 of file heur.c.

    References SCIP_Heur::desc, and NULL.

    Referenced by SCIP_DECL_DIALOGEXEC(), SCIPcollectHeuristicStatistics(), SCIPincludeDialogDefaultFix(), and SCIPincludeDialogDefaultSet().

    ◆ SCIPheurGetDispchar()

    char SCIPheurGetDispchar ( SCIP_HEUR *  heur)

    gets display character of primal heuristic

    Parameters
    heurprimal heuristic

    Definition at line 1487 of file heur.c.

    References SCIP_Heur::dispchar, and NULL.

    Referenced by SCIP_DECL_DIALOGEXEC(), and SCIP_DECL_DISPOUTPUT().

    ◆ SCIPheurGetTimingmask()

    SCIP_HEURTIMING SCIPheurGetTimingmask ( SCIP_HEUR *  heur)

    returns the timing mask of the heuristic

    Parameters
    heurprimal heuristic

    Definition at line 1497 of file heur.c.

    References NULL, and SCIP_Heur::timingmask.

    Referenced by SCIP_DECL_HEURINITSOL().

    ◆ SCIPheurSetTimingmask()

    void SCIPheurSetTimingmask ( SCIP_HEUR *  heur,
    SCIP_HEURTIMING  timingmask 
    )

    sets new timing mask for heuristic

    Parameters
    heurprimal heuristic
    timingmasknew timing mask of heuristic

    Definition at line 1507 of file heur.c.

    References NULL, and SCIP_Heur::timingmask.

    Referenced by SCIP_DECL_HEUREXEC(), SCIP_DECL_HEUREXITSOL(), SCIP_DECL_HEURINIT(), SCIP_DECL_HEURINITSOL(), and SCIPheurPassIndicator().

    ◆ SCIPheurUsesSubscip()

    SCIP_Bool SCIPheurUsesSubscip ( SCIP_HEUR *  heur)

    does the heuristic use a secondary SCIP instance?

    Parameters
    heurprimal heuristic

    Definition at line 1518 of file heur.c.

    References NULL, and SCIP_Heur::usessubscip.

    Referenced by paramsetSetHeuristicsFast(), SCIPparamsetSetEmphasis(), and SCIPparamsetSetToSubscipsOff().

    ◆ SCIPheurGetPriority()

    int SCIPheurGetPriority ( SCIP_HEUR *  heur)

    gets priority of primal heuristic

    Parameters
    heurprimal heuristic

    Definition at line 1528 of file heur.c.

    References NULL, and SCIP_Heur::priority.

    Referenced by includeDivingHeurs(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_SORTPTRCOMP(), and SCIPprimalHeuristics().

    ◆ SCIPheurGetFreq()

    int SCIPheurGetFreq ( SCIP_HEUR *  heur)

    gets frequency of primal heuristic

    Parameters
    heurprimal heuristic

    Definition at line 1552 of file heur.c.

    References SCIP_Heur::freq, and NULL.

    Referenced by checkParameters(), fromCommandLine(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_HEUREXEC(), SCIP_DECL_HEURINIT(), SCIP_DECL_HEURINITSOL(), and SCIPupdateStartpointHeurSubNlp().

    ◆ SCIPheurSetFreq()

    void SCIPheurSetFreq ( SCIP_HEUR *  heur,
    int  freq 
    )

    sets frequency of primal heuristic

    Parameters
    heurprimal heuristic
    freqnew frequency of heuristic

    Definition at line 1562 of file heur.c.

    References SCIP_Heur::freq, and NULL.

    Referenced by SCIP_DECL_HEUREXEC(), SCIPheurSyncPassSol(), and storeSolution().

    ◆ SCIPheurGetFreqofs()

    int SCIPheurGetFreqofs ( SCIP_HEUR *  heur)

    gets frequency offset of primal heuristic

    Parameters
    heurprimal heuristic

    Definition at line 1573 of file heur.c.

    References SCIP_Heur::freqofs, and NULL.

    Referenced by SCIP_DECL_DIALOGEXEC(), SCIP_DECL_HEURINIT(), and SCIP_DECL_HEURINITSOL().

    ◆ SCIPheurGetMaxdepth()

    int SCIPheurGetMaxdepth ( SCIP_HEUR *  heur)

    gets maximal depth level for calling primal heuristic (returns -1, if no depth limit exists)

    Parameters
    heurprimal heuristic

    Definition at line 1583 of file heur.c.

    References SCIP_Heur::maxdepth, and NULL.

    ◆ SCIPheurGetNCalls()

    SCIP_Longint SCIPheurGetNCalls ( SCIP_HEUR *  heur)

    gets the number of times, the heuristic was called and tried to find a solution

    Parameters
    heurprimal heuristic

    Definition at line 1593 of file heur.c.

    References SCIP_Heur::ncalls, and NULL.

    Referenced by applyVbounds(), calcNodeLimit(), determineLimits(), getLPIterlimit(), SCIP_DECL_HEUREXEC(), SCIP_DECL_HEUREXIT(), SCIPapplyZeroobj(), SCIPcollectHeuristicStatistics(), SCIPprintHeuristicStatistics(), selectDiving(), setupAndSolveSubscipCrossover(), and setupSubScip().

    ◆ SCIPheurGetNSolsFound()

    SCIP_Longint SCIPheurGetNSolsFound ( SCIP_HEUR *  heur)

    gets the number of primal feasible solutions found by this heuristic

    Parameters
    heurprimal heuristic

    Definition at line 1603 of file heur.c.

    References SCIP_Heur::nsolsfound, and NULL.

    Referenced by getLPIterlimit(), SCIP_DECL_HEUREXEC(), SCIP_DECL_HEUREXIT(), SCIPcollectHeuristicStatistics(), and SCIPprintHeuristicStatistics().

    ◆ SCIPheurGetNBestSolsFound()

    SCIP_Longint SCIPheurGetNBestSolsFound ( SCIP_HEUR *  heur)

    gets the number of new best primal feasible solutions found by this heuristic

    Parameters
    heurprimal heuristic

    Definition at line 1613 of file heur.c.

    References SCIP_Heur::nbestsolsfound, and NULL.

    Referenced by applyVbounds(), determineLimits(), getLPIterlimit(), SCIP_DECL_HEUREXEC(), SCIPcollectHeuristicStatistics(), and SCIPprintHeuristicStatistics().

    ◆ SCIPheurIsInitialized()

    SCIP_Bool SCIPheurIsInitialized ( SCIP_HEUR *  heur)

    is primal heuristic initialized?

    Parameters
    heurprimal heuristic

    Definition at line 1623 of file heur.c.

    References SCIP_Heur::initialized, and NULL.

    ◆ SCIPheurGetSetupTime()

    SCIP_Real SCIPheurGetSetupTime ( SCIP_HEUR *  heur)

    gets time in seconds used in this heuristic for setting up for next stages

    Parameters
    heurprimal heuristic

    Definition at line 1645 of file heur.c.

    References NULL, SCIPclockGetTime(), and SCIP_Heur::setuptime.

    Referenced by SCIPcollectHeuristicStatistics(), and SCIPprintHeuristicStatistics().

    ◆ SCIPheurGetTime()

    SCIP_Real SCIPheurGetTime ( SCIP_HEUR *  heur)

    gets time in seconds used in this heuristic

    Parameters
    heurprimal heuristic

    Definition at line 1655 of file heur.c.

    References SCIP_Heur::heurclock, NULL, and SCIPclockGetTime().

    Referenced by reoptimize(), SCIP_DECL_HEUREXIT(), SCIPcollectHeuristicStatistics(), and SCIPprintHeuristicStatistics().

    ◆ SCIPheurGetDivesets()

    SCIP_DIVESET ** SCIPheurGetDivesets ( SCIP_HEUR *  heur)

    returns array of divesets of this primal heuristic, or NULL if it has no divesets

    Parameters
    heurprimal heuristic

    Definition at line 1665 of file heur.c.

    References SCIP_Heur::divesets, and NULL.

    Referenced by findAndStoreDivesets(), includeDivingHeurs(), SCIP_DECL_HEUREXEC(), SCIPcollectHeuristicStatistics(), and SCIPprintHeuristicStatistics().

    ◆ SCIPheurGetNDivesets()

    int SCIPheurGetNDivesets ( SCIP_HEUR *  heur)

    returns the number of divesets of this primal heuristic

    Parameters
    heurprimal heuristic

    Definition at line 1675 of file heur.c.

    References SCIP_Heur::ndivesets, and NULL.

    Referenced by findAndStoreDivesets(), includeDivingHeurs(), SCIP_DECL_HEUREXEC(), SCIPcollectHeuristicStatistics(), and SCIPprintHeuristicStatistics().

    ◆ SCIPincludeHeur()

    SCIP_RETCODE SCIPincludeHeur ( SCIP *  scip,
    const char *  name,
    const char *  desc,
    char  dispchar,
    int  priority,
    int  freq,
    int  freqofs,
    int  maxdepth,
    SCIP_HEURTIMING  timingmask,
    SCIP_Bool  usessubscip,
    SCIP_DECL_HEURCOPY((*heurcopy))  ,
    SCIP_DECL_HEURFREE((*heurfree))  ,
    SCIP_DECL_HEURINIT((*heurinit))  ,
    SCIP_DECL_HEUREXIT((*heurexit))  ,
    SCIP_DECL_HEURINITSOL((*heurinitsol))  ,
    SCIP_DECL_HEUREXITSOL((*heurexitsol))  ,
    SCIP_DECL_HEUREXEC((*heurexec))  ,
    SCIP_HEURDATA *  heurdata 
    )

    creates a primal heuristic and includes it in SCIP.

    Note
    method has all heuristic callbacks as arguments and is thus changed every time a new callback is added in future releases; consider using SCIPincludeHeurBasic() and setter functions if you seek for a method which is less likely to change in future releases
    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
    namename of primal heuristic
    descdescription of primal heuristic
    dispchardisplay character of primal heuristic
    prioritypriority of the primal heuristic
    freqfrequency for calling primal heuristic
    freqofsfrequency offset for calling primal heuristic
    maxdepthmaximal depth level to call heuristic at (-1: no limit)
    timingmaskpositions in the node solving loop where heuristic should be executed; see definition of SCIP_HEURTIMING for possible values
    usessubscipdoes the heuristic use a secondary SCIP instance?
    heurdataprimal heuristic data

    Definition at line 67 of file scip_heur.c.

    References FALSE, NULL, SCIP_CALL, SCIP_INVALIDDATA, SCIP_OKAY, SCIPcheckStage, SCIPerrorMessage, SCIPfindHeur(), SCIPheurCreate(), SCIPsetIncludeHeur(), and TRUE.

    Referenced by SCIPincludeHeurOptcumulative(), and SCIPincludeObjHeur().

    ◆ SCIPincludeHeurBasic()

    SCIP_RETCODE SCIPincludeHeurBasic ( SCIP *  scip,
    SCIP_HEUR **  heur,
    const char *  name,
    const char *  desc,
    char  dispchar,
    int  priority,
    int  freq,
    int  freqofs,
    int  maxdepth,
    SCIP_HEURTIMING  timingmask,
    SCIP_Bool  usessubscip,
    SCIP_DECL_HEUREXEC((*heurexec))  ,
    SCIP_HEURDATA *  heurdata 
    )

    creates a primal heuristic and includes it in SCIP with its most fundamental callbacks. All non-fundamental (or optional) callbacks as, e. g., init and exit callbacks, will be set to NULL. Optional callbacks can be set via specific setter functions, see SCIPsetHeurCopy(), SCIPsetHeurFree(), SCIPsetHeurInit(), SCIPsetHeurExit(), SCIPsetHeurInitsol(), and SCIPsetHeurExitsol()

    Note
    if you want to set all callbacks with a single method call, consider using SCIPincludeHeur() instead

    creates a primal heuristic and includes it in SCIP with its most fundamental callbacks. All non-fundamental (or optional) callbacks as, e. g., init and exit callbacks, will be set to NULL. Optional callbacks can be set via specific setter functions, see SCIPsetHeurCopy(), SCIPsetHeurFree(), SCIPsetHeurInit(), SCIPsetHeurExit(), SCIPsetHeurInitsol(), and SCIPsetHeurExitsol()

    Precondition
    This method can be called if SCIP is in one of the following stages:
    Note
    if you want to set all callbacks with a single method call, consider using SCIPincludeHeur() instead
    Parameters
    scipSCIP data structure
    heurpointer to primal heuristic
    namename of primal heuristic
    descdescription of primal heuristic
    dispchardisplay character of primal heuristic
    prioritypriority of the primal heuristic
    freqfrequency for calling primal heuristic
    freqofsfrequency offset for calling primal heuristic
    maxdepthmaximal depth level to call heuristic at (-1: no limit)
    timingmaskpositions in the node solving loop where heuristic should be executed; see definition of SCIP_HEURTIMING for possible values
    usessubscipdoes the heuristic use a secondary SCIP instance?
    heurdataprimal heuristic data

    Definition at line 122 of file scip_heur.c.

    References FALSE, NULL, SCIP_CALL, SCIP_INVALIDDATA, SCIP_OKAY, SCIPcheckStage, SCIPerrorMessage, SCIPfindHeur(), SCIPheurCreate(), SCIPsetIncludeHeur(), and TRUE.

    Referenced by SCIPincludeHeurActconsdiving(), SCIPincludeHeurAdaptivediving(), SCIPincludeHeurAlns(), SCIPincludeHeurBound(), SCIPincludeHeurClique(), SCIPincludeHeurCoefdiving(), SCIPincludeHeurCompletesol(), SCIPincludeHeurConflictdiving(), SCIPincludeHeurCrossover(), SCIPincludeHeurCycGreedy(), SCIPincludeHeurCycKerlin(), SCIPincludeHeurDins(), SCIPincludeHeurDistributiondiving(), SCIPincludeHeurDKS(), SCIPincludeHeurDps(), SCIPincludeHeurDualval(), SCIPincludeHeurFarkasdiving(), SCIPincludeHeurFeaspump(), SCIPincludeHeurFixandinfer(), SCIPincludeHeurFracdiving(), SCIPincludeHeurFuzzyround(), SCIPincludeHeurGins(), SCIPincludeHeurGuideddiving(), SCIPincludeHeurIndicator(), SCIPincludeHeurIndicatordiving(), SCIPincludeHeurInit(), SCIPincludeHeurIntdiving(), SCIPincludeHeurIntshifting(), SCIPincludeHeurLinesearchdiving(), SCIPincludeHeurListScheduling(), SCIPincludeHeurLocalbranching(), SCIPincludeHeurLocks(), SCIPincludeHeurLpface(), SCIPincludeHeurMpec(), SCIPincludeHeurMultistart(), SCIPincludeHeurMutation(), SCIPincludeHeurNlpdiving(), SCIPincludeHeurObjpscostdiving(), SCIPincludeHeurOctane(), SCIPincludeHeurOfins(), SCIPincludeHeurOneopt(), SCIPincludeHeurPADM(), SCIPincludeHeurProximity(), SCIPincludeHeurPscostdiving(), SCIPincludeHeurRandrounding(), SCIPincludeHeurRedsize(), SCIPincludeHeurReoptsols(), SCIPincludeHeurRepair(), SCIPincludeHeurRins(), SCIPincludeHeurRootsoldiving(), SCIPincludeHeurRounding(), SCIPincludeHeurScheduler(), SCIPincludeHeurShiftandpropagate(), SCIPincludeHeurShifting(), SCIPincludeHeurSimplerounding(), SCIPincludeHeurSubNlp(), SCIPincludeHeurSync(), SCIPincludeHeurTrivial(), SCIPincludeHeurTrivialnegation(), SCIPincludeHeurTrustregion(), SCIPincludeHeurTrySol(), SCIPincludeHeurTwoopt(), SCIPincludeHeurUndercover(), SCIPincludeHeurVbounds(), SCIPincludeHeurVeclendiving(), SCIPincludeHeurZeroobj(), and SCIPincludeHeurZirounding().

    ◆ SCIPsetHeurCopy()

    SCIP_RETCODE SCIPsetHeurCopy ( SCIP *  scip,
    SCIP_HEUR *  heur,
    SCIP_DECL_HEURCOPY((*heurcopy))   
    )

    sets copy method of primal heuristic

    Parameters
    scipSCIP data structure
    heurprimal heuristic

    Definition at line 167 of file scip_heur.c.

    References FALSE, NULL, SCIP_CALL, SCIP_OKAY, SCIPcheckStage, SCIPheurSetCopy(), and TRUE.

    Referenced by SCIPincludeHeurActconsdiving(), SCIPincludeHeurAdaptivediving(), SCIPincludeHeurAlns(), SCIPincludeHeurBound(), SCIPincludeHeurClique(), SCIPincludeHeurCoefdiving(), SCIPincludeHeurCompletesol(), SCIPincludeHeurConflictdiving(), SCIPincludeHeurCrossover(), SCIPincludeHeurCycGreedy(), SCIPincludeHeurCycKerlin(), SCIPincludeHeurDins(), SCIPincludeHeurDistributiondiving(), SCIPincludeHeurDKS(), SCIPincludeHeurDps(), SCIPincludeHeurDualval(), SCIPincludeHeurFarkasdiving(), SCIPincludeHeurFeaspump(), SCIPincludeHeurFixandinfer(), SCIPincludeHeurFracdiving(), SCIPincludeHeurGins(), SCIPincludeHeurGuideddiving(), SCIPincludeHeurIndicator(), SCIPincludeHeurIndicatordiving(), SCIPincludeHeurInit(), SCIPincludeHeurIntdiving(), SCIPincludeHeurIntshifting(), SCIPincludeHeurLinesearchdiving(), SCIPincludeHeurLocalbranching(), SCIPincludeHeurLocks(), SCIPincludeHeurLpface(), SCIPincludeHeurMpec(), SCIPincludeHeurMultistart(), SCIPincludeHeurMutation(), SCIPincludeHeurNlpdiving(), SCIPincludeHeurObjpscostdiving(), SCIPincludeHeurOctane(), SCIPincludeHeurOfins(), SCIPincludeHeurOneopt(), SCIPincludeHeurPADM(), SCIPincludeHeurProximity(), SCIPincludeHeurPscostdiving(), SCIPincludeHeurRandrounding(), SCIPincludeHeurRedsize(), SCIPincludeHeurReoptsols(), SCIPincludeHeurRepair(), SCIPincludeHeurRins(), SCIPincludeHeurRootsoldiving(), SCIPincludeHeurRounding(), SCIPincludeHeurScheduler(), SCIPincludeHeurShiftandpropagate(), SCIPincludeHeurShifting(), SCIPincludeHeurSimplerounding(), SCIPincludeHeurSubNlp(), SCIPincludeHeurTrivial(), SCIPincludeHeurTrivialnegation(), SCIPincludeHeurTrustregion(), SCIPincludeHeurTrySol(), SCIPincludeHeurTwoopt(), SCIPincludeHeurUndercover(), SCIPincludeHeurVbounds(), SCIPincludeHeurVeclendiving(), SCIPincludeHeurZeroobj(), and SCIPincludeHeurZirounding().

    ◆ SCIPsetHeurFree()

    SCIP_RETCODE SCIPsetHeurFree ( SCIP *  scip,
    SCIP_HEUR *  heur,
    SCIP_DECL_HEURFREE((*heurfree))   
    )

    sets destructor method of primal heuristic

    Parameters
    scipSCIP data structure
    heurprimal heuristic

    Definition at line 183 of file scip_heur.c.

    References FALSE, NULL, SCIP_CALL, SCIP_OKAY, SCIPcheckStage, SCIPheurSetFree(), and TRUE.

    Referenced by SCIPincludeHeurActconsdiving(), SCIPincludeHeurAdaptivediving(), SCIPincludeHeurAlns(), SCIPincludeHeurBound(), SCIPincludeHeurClique(), SCIPincludeHeurCoefdiving(), SCIPincludeHeurCompletesol(), SCIPincludeHeurConflictdiving(), SCIPincludeHeurCrossover(), SCIPincludeHeurCycGreedy(), SCIPincludeHeurCycKerlin(), SCIPincludeHeurDins(), SCIPincludeHeurDistributiondiving(), SCIPincludeHeurDKS(), SCIPincludeHeurDps(), SCIPincludeHeurDualval(), SCIPincludeHeurFarkasdiving(), SCIPincludeHeurFeaspump(), SCIPincludeHeurFixandinfer(), SCIPincludeHeurFracdiving(), SCIPincludeHeurGins(), SCIPincludeHeurGuideddiving(), SCIPincludeHeurIndicator(), SCIPincludeHeurIndicatordiving(), SCIPincludeHeurInit(), SCIPincludeHeurIntdiving(), SCIPincludeHeurLinesearchdiving(), SCIPincludeHeurListScheduling(), SCIPincludeHeurLocalbranching(), SCIPincludeHeurLocks(), SCIPincludeHeurLpface(), SCIPincludeHeurMpec(), SCIPincludeHeurMultistart(), SCIPincludeHeurMutation(), SCIPincludeHeurNlpdiving(), SCIPincludeHeurObjpscostdiving(), SCIPincludeHeurOctane(), SCIPincludeHeurOfins(), SCIPincludeHeurOneopt(), SCIPincludeHeurPADM(), SCIPincludeHeurProximity(), SCIPincludeHeurPscostdiving(), SCIPincludeHeurRandrounding(), SCIPincludeHeurRedsize(), SCIPincludeHeurReoptsols(), SCIPincludeHeurRepair(), SCIPincludeHeurRins(), SCIPincludeHeurRootsoldiving(), SCIPincludeHeurRounding(), SCIPincludeHeurScheduler(), SCIPincludeHeurShiftandpropagate(), SCIPincludeHeurSimplerounding(), SCIPincludeHeurSubNlp(), SCIPincludeHeurSync(), SCIPincludeHeurTrustregion(), SCIPincludeHeurTrySol(), SCIPincludeHeurTwoopt(), SCIPincludeHeurUndercover(), SCIPincludeHeurVbounds(), SCIPincludeHeurVeclendiving(), SCIPincludeHeurZeroobj(), and SCIPincludeHeurZirounding().

    ◆ SCIPsetHeurInit()

    SCIP_RETCODE SCIPsetHeurInit ( SCIP *  scip,
    SCIP_HEUR *  heur,
    SCIP_DECL_HEURINIT((*heurinit))   
    )

    sets initialization method of primal heuristic

    Parameters
    scipSCIP data structure
    heurprimal heuristic

    Definition at line 199 of file scip_heur.c.

    References FALSE, NULL, SCIP_CALL, SCIP_OKAY, SCIPcheckStage, SCIPheurSetInit(), and TRUE.

    Referenced by SCIPincludeHeurActconsdiving(), SCIPincludeHeurAdaptivediving(), SCIPincludeHeurAlns(), SCIPincludeHeurClique(), SCIPincludeHeurCoefdiving(), SCIPincludeHeurConflictdiving(), SCIPincludeHeurCrossover(), SCIPincludeHeurCycGreedy(), SCIPincludeHeurCycKerlin(), SCIPincludeHeurDistributiondiving(), SCIPincludeHeurDualval(), SCIPincludeHeurFarkasdiving(), SCIPincludeHeurFeaspump(), SCIPincludeHeurFracdiving(), SCIPincludeHeurGins(), SCIPincludeHeurGuideddiving(), SCIPincludeHeurIndicatordiving(), SCIPincludeHeurIntdiving(), SCIPincludeHeurIntshifting(), SCIPincludeHeurLinesearchdiving(), SCIPincludeHeurLocalbranching(), SCIPincludeHeurLocks(), SCIPincludeHeurLpface(), SCIPincludeHeurMultistart(), SCIPincludeHeurMutation(), SCIPincludeHeurNlpdiving(), SCIPincludeHeurObjpscostdiving(), SCIPincludeHeurOctane(), SCIPincludeHeurOneopt(), SCIPincludeHeurProximity(), SCIPincludeHeurPscostdiving(), SCIPincludeHeurRandrounding(), SCIPincludeHeurReoptsols(), SCIPincludeHeurRepair(), SCIPincludeHeurRins(), SCIPincludeHeurRootsoldiving(), SCIPincludeHeurRounding(), SCIPincludeHeurScheduler(), SCIPincludeHeurShiftandpropagate(), SCIPincludeHeurShifting(), SCIPincludeHeurSimplerounding(), SCIPincludeHeurSubNlp(), SCIPincludeHeurTrustregion(), SCIPincludeHeurTwoopt(), SCIPincludeHeurUndercover(), SCIPincludeHeurVeclendiving(), SCIPincludeHeurZeroobj(), and SCIPincludeHeurZirounding().

    ◆ SCIPsetHeurExit()

    SCIP_RETCODE SCIPsetHeurExit ( SCIP *  scip,
    SCIP_HEUR *  heur,
    SCIP_DECL_HEUREXIT((*heurexit))   
    )

    sets deinitialization method of primal heuristic

    Parameters
    scipSCIP data structure
    heurprimal heuristic

    Definition at line 215 of file scip_heur.c.

    References FALSE, NULL, SCIP_CALL, SCIP_OKAY, SCIPcheckStage, SCIPheurSetExit(), and TRUE.

    Referenced by SCIPincludeHeurActconsdiving(), SCIPincludeHeurAdaptivediving(), SCIPincludeHeurAlns(), SCIPincludeHeurCoefdiving(), SCIPincludeHeurConflictdiving(), SCIPincludeHeurCrossover(), SCIPincludeHeurDistributiondiving(), SCIPincludeHeurDualval(), SCIPincludeHeurFarkasdiving(), SCIPincludeHeurFeaspump(), SCIPincludeHeurFracdiving(), SCIPincludeHeurGins(), SCIPincludeHeurGuideddiving(), SCIPincludeHeurIndicatordiving(), SCIPincludeHeurIntdiving(), SCIPincludeHeurIntshifting(), SCIPincludeHeurLinesearchdiving(), SCIPincludeHeurLocks(), SCIPincludeHeurLpface(), SCIPincludeHeurMultistart(), SCIPincludeHeurMutation(), SCIPincludeHeurNlpdiving(), SCIPincludeHeurObjpscostdiving(), SCIPincludeHeurOctane(), SCIPincludeHeurPscostdiving(), SCIPincludeHeurRandrounding(), SCIPincludeHeurRepair(), SCIPincludeHeurRootsoldiving(), SCIPincludeHeurRounding(), SCIPincludeHeurScheduler(), SCIPincludeHeurShiftandpropagate(), SCIPincludeHeurShifting(), SCIPincludeHeurSimplerounding(), SCIPincludeHeurSync(), SCIPincludeHeurTrySol(), SCIPincludeHeurTwoopt(), SCIPincludeHeurUndercover(), SCIPincludeHeurVeclendiving(), and SCIPincludeHeurZirounding().

    ◆ SCIPsetHeurInitsol()

    SCIP_RETCODE SCIPsetHeurInitsol ( SCIP *  scip,
    SCIP_HEUR *  heur,
    SCIP_DECL_HEURINITSOL((*heurinitsol))   
    )

    sets solving process initialization method of primal heuristic

    Parameters
    scipSCIP data structure
    heurprimal heuristic

    Definition at line 231 of file scip_heur.c.

    References FALSE, NULL, SCIP_CALL, SCIP_OKAY, SCIPcheckStage, SCIPheurSetInitsol(), and TRUE.

    Referenced by SCIPincludeHeurAlns(), SCIPincludeHeurDins(), SCIPincludeHeurDualval(), SCIPincludeHeurFarkasdiving(), SCIPincludeHeurFeaspump(), SCIPincludeHeurIndicator(), SCIPincludeHeurIntshifting(), SCIPincludeHeurLpface(), SCIPincludeHeurMpec(), SCIPincludeHeurNlpdiving(), SCIPincludeHeurOneopt(), SCIPincludeHeurRandrounding(), SCIPincludeHeurRounding(), SCIPincludeHeurScheduler(), SCIPincludeHeurShifting(), SCIPincludeHeurSimplerounding(), SCIPincludeHeurSubNlp(), SCIPincludeHeurTwoopt(), SCIPincludeHeurUndercover(), and SCIPincludeHeurZirounding().

    ◆ SCIPsetHeurExitsol()

    SCIP_RETCODE SCIPsetHeurExitsol ( SCIP *  scip,
    SCIP_HEUR *  heur,
    SCIP_DECL_HEUREXITSOL((*heurexitsol))   
    )

    sets solving process deinitialization method of primal heuristic

    Parameters
    scipSCIP data structure
    heurprimal heuristic

    Definition at line 247 of file scip_heur.c.

    References FALSE, NULL, SCIP_CALL, SCIP_OKAY, SCIPcheckStage, SCIPheurSetExitsol(), and TRUE.

    Referenced by SCIPincludeHeurCycGreedy(), SCIPincludeHeurCycKerlin(), SCIPincludeHeurDins(), SCIPincludeHeurDualval(), SCIPincludeHeurFeaspump(), SCIPincludeHeurGins(), SCIPincludeHeurIndicator(), SCIPincludeHeurLpface(), SCIPincludeHeurMpec(), SCIPincludeHeurNlpdiving(), SCIPincludeHeurOneopt(), SCIPincludeHeurProximity(), SCIPincludeHeurRandrounding(), SCIPincludeHeurRounding(), SCIPincludeHeurSimplerounding(), SCIPincludeHeurSubNlp(), SCIPincludeHeurTwoopt(), SCIPincludeHeurUndercover(), and SCIPincludeHeurVbounds().

    ◆ SCIPfindHeur()

    SCIP_HEUR * SCIPfindHeur ( SCIP *  scip,
    const char *  name 
    )

    returns the primal heuristic of the given name, or NULL if not existing

    Parameters
    scipSCIP data structure
    namename of primal heuristic

    Definition at line 263 of file scip_heur.c.

    References NULL, and SCIPsetFindHeur().

    Referenced by addCandSolCyckerlin(), checkSystemGF2(), constructValidSolution(), extendToCover(), SCIP_DECL_CONCSOLVERCOPYSOLVINGDATA(), SCIP_DECL_CONSINIT(), SCIP_DECL_CONSINITPRE(), SCIP_DECL_HEURINIT(), SCIP_DECL_HEURINITSOL(), SCIP_DECL_SEPAINIT(), SCIP_DECL_TABLECOLLECT(), SCIP_DECL_TABLEOUTPUT(), SCIPapplyLockFixings(), SCIPcopyConcurrentSolvingStats(), SCIPcreateConcurrent(), SCIPdeleteSubproblemProximity(), SCIPfindObjHeur(), SCIPincludeHeur(), SCIPincludeHeurBasic(), SCIPinitHeurOptcumulative(), SCIPinitializeHeurListScheduling(), SCIPreoptsolsGetNCheckedsols(), SCIPreoptsolsGetNImprovingsols(), and solveComponent().

    ◆ SCIPgetHeurs()

    SCIP_HEUR ** SCIPgetHeurs ( SCIP *  scip)

    returns the array of currently available primal heuristics

    Parameters
    scipSCIP data structure

    Definition at line 276 of file scip_heur.c.

    References NULL.

    Referenced by checkParameters(), findAndStoreDivesets(), fromCommandLine(), includeDivingHeurs(), paramsetSetHeuristicsFast(), SCIP_DECL_DIALOGEXEC(), SCIPcopyConcurrentSolvingStats(), SCIPincludeDialogDefaultFix(), and SCIPincludeDialogDefaultSet().

    ◆ SCIPgetNHeurs()

    int SCIPgetNHeurs ( SCIP *  scip)

    returns the number of currently available primal heuristics

    Parameters
    scipSCIP data structure

    Definition at line 287 of file scip_heur.c.

    References NULL.

    Referenced by checkParameters(), findAndStoreDivesets(), fromCommandLine(), includeDivingHeurs(), paramsetSetHeuristicsFast(), SCIP_DECL_DIALOGEXEC(), SCIPcopyConcurrentSolvingStats(), SCIPincludeDialogDefaultFix(), and SCIPincludeDialogDefaultSet().

    ◆ SCIPsetHeurPriority()

    SCIP_RETCODE SCIPsetHeurPriority ( SCIP *  scip,
    SCIP_HEUR *  heur,
    int  priority 
    )

    sets the priority of a primal heuristic

    Parameters
    scipSCIP data structure
    heurprimal heuristic
    prioritynew priority of the primal heuristic

    Definition at line 298 of file scip_heur.c.

    References NULL, SCIP_OKAY, and SCIPheurSetPriority().

    Referenced by SCIP_DECL_PARAMCHGD().