SCIP Doxygen Documentation
 
Loading...
Searching...
No Matches

Detailed Description

methods for propagator plugins

Functions

 SCIP_DECL_SORTPTRCOMP (SCIPpropComp)
 
 SCIP_DECL_SORTPTRCOMP (SCIPpropCompPresol)
 
 SCIP_DECL_SORTPTRCOMP (SCIPpropCompName)
 
SCIP_PROPDATASCIPpropGetData (SCIP_PROP *prop)
 
void SCIPpropSetData (SCIP_PROP *prop, SCIP_PROPDATA *propdata)
 
const char * SCIPpropGetName (SCIP_PROP *prop)
 
const char * SCIPpropGetDesc (SCIP_PROP *prop)
 
int SCIPpropGetPriority (SCIP_PROP *prop)
 
int SCIPpropGetPresolPriority (SCIP_PROP *prop)
 
int SCIPpropGetFreq (SCIP_PROP *prop)
 
SCIP_Real SCIPpropGetSetupTime (SCIP_PROP *prop)
 
void SCIPpropSetFreq (SCIP_PROP *prop, int freq)
 
SCIP_Real SCIPpropGetTime (SCIP_PROP *prop)
 
SCIP_Real SCIPpropGetStrongBranchPropTime (SCIP_PROP *prop)
 
SCIP_Real SCIPpropGetRespropTime (SCIP_PROP *prop)
 
SCIP_Real SCIPpropGetPresolTime (SCIP_PROP *prop)
 
SCIP_Longint SCIPpropGetNCalls (SCIP_PROP *prop)
 
SCIP_Longint SCIPpropGetNRespropCalls (SCIP_PROP *prop)
 
SCIP_Longint SCIPpropGetNCutoffs (SCIP_PROP *prop)
 
SCIP_Longint SCIPpropGetNDomredsFound (SCIP_PROP *prop)
 
SCIP_Bool SCIPpropIsDelayed (SCIP_PROP *prop)
 
SCIP_Bool SCIPpropWasDelayed (SCIP_PROP *prop)
 
SCIP_Bool SCIPpropIsInitialized (SCIP_PROP *prop)
 
int SCIPpropGetNFixedVars (SCIP_PROP *prop)
 
int SCIPpropGetNAggrVars (SCIP_PROP *prop)
 
int SCIPpropGetNChgVarTypes (SCIP_PROP *prop)
 
int SCIPpropGetNChgBds (SCIP_PROP *prop)
 
int SCIPpropGetNAddHoles (SCIP_PROP *prop)
 
int SCIPpropGetNDelConss (SCIP_PROP *prop)
 
int SCIPpropGetNAddConss (SCIP_PROP *prop)
 
int SCIPpropGetNUpgdConss (SCIP_PROP *prop)
 
int SCIPpropGetNChgCoefs (SCIP_PROP *prop)
 
int SCIPpropGetNChgSides (SCIP_PROP *prop)
 
int SCIPpropGetNPresolCalls (SCIP_PROP *prop)
 
SCIP_PROPTIMING SCIPpropGetTimingmask (SCIP_PROP *prop)
 
SCIP_Bool SCIPpropDoesPresolve (SCIP_PROP *prop)
 
SCIP_PRESOLTIMING SCIPpropGetPresolTiming (SCIP_PROP *prop)
 
void SCIPpropSetPresolTiming (SCIP_PROP *prop, SCIP_PRESOLTIMING presoltiming)
 
SCIP_RETCODE SCIPincludeProp (SCIP *scip, const char *name, const char *desc, int priority, int freq, SCIP_Bool delay, SCIP_PROPTIMING timingmask, int presolpriority, int presolmaxrounds, SCIP_PRESOLTIMING presoltiming, SCIP_DECL_PROPCOPY((*propcopy)), SCIP_DECL_PROPFREE((*propfree)), SCIP_DECL_PROPINIT((*propinit)), SCIP_DECL_PROPEXIT((*propexit)), SCIP_DECL_PROPINITPRE((*propinitpre)), SCIP_DECL_PROPEXITPRE((*propexitpre)), SCIP_DECL_PROPINITSOL((*propinitsol)), SCIP_DECL_PROPEXITSOL((*propexitsol)), SCIP_DECL_PROPPRESOL((*proppresol)), SCIP_DECL_PROPEXEC((*propexec)), SCIP_DECL_PROPRESPROP((*propresprop)), SCIP_PROPDATA *propdata)
 
SCIP_RETCODE SCIPincludePropBasic (SCIP *scip, SCIP_PROP **propptr, const char *name, const char *desc, int priority, int freq, SCIP_Bool delay, SCIP_PROPTIMING timingmask, SCIP_DECL_PROPEXEC((*propexec)), SCIP_PROPDATA *propdata)
 
SCIP_RETCODE SCIPsetPropCopy (SCIP *scip, SCIP_PROP *prop,)
 
SCIP_RETCODE SCIPsetPropFree (SCIP *scip, SCIP_PROP *prop,)
 
SCIP_RETCODE SCIPsetPropInit (SCIP *scip, SCIP_PROP *prop,)
 
SCIP_RETCODE SCIPsetPropExit (SCIP *scip, SCIP_PROP *prop,)
 
SCIP_RETCODE SCIPsetPropInitsol (SCIP *scip, SCIP_PROP *prop,)
 
SCIP_RETCODE SCIPsetPropExitsol (SCIP *scip, SCIP_PROP *prop,)
 
SCIP_RETCODE SCIPsetPropInitpre (SCIP *scip, SCIP_PROP *prop,)
 
SCIP_RETCODE SCIPsetPropExitpre (SCIP *scip, SCIP_PROP *prop,)
 
SCIP_RETCODE SCIPsetPropPresol (SCIP *scip, SCIP_PROP *prop, SCIP_DECL_PROPPRESOL((*proppresol)), int presolpriority, int presolmaxrounds, SCIP_PRESOLTIMING presoltiming)
 
SCIP_RETCODE SCIPsetPropResprop (SCIP *scip, SCIP_PROP *prop,)
 
SCIP_PROPSCIPfindProp (SCIP *scip, const char *name)
 
SCIP_PROP ** SCIPgetProps (SCIP *scip)
 
int SCIPgetNProps (SCIP *scip)
 
SCIP_RETCODE SCIPsetPropPriority (SCIP *scip, SCIP_PROP *prop, int priority)
 
SCIP_RETCODE SCIPsetPropPresolPriority (SCIP *scip, SCIP_PROP *prop, int presolpriority)
 

Function Documentation

◆ SCIP_DECL_SORTPTRCOMP() [1/3]

SCIP_DECL_SORTPTRCOMP ( SCIPpropComp )

compares two propagators w. r. to their priority

Definition at line 52 of file prop.c.

◆ SCIP_DECL_SORTPTRCOMP() [2/3]

SCIP_DECL_SORTPTRCOMP ( SCIPpropCompPresol )

compares two propagators w. r. to their presolving priority

compares two propagators w. r. to their priority

Definition at line 58 of file prop.c.

◆ SCIP_DECL_SORTPTRCOMP() [3/3]

SCIP_DECL_SORTPTRCOMP ( SCIPpropCompName )

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

Definition at line 64 of file prop.c.

References SCIPpropGetName().

◆ SCIPpropGetData()

SCIP_PROPDATA * SCIPpropGetData ( SCIP_PROP * prop)

gets user data of propagator

Parameters
proppropagator

Definition at line 789 of file prop.c.

References assert(), NULL, and SCIP_Prop::propdata.

Referenced by applyGenVBounds(), initData(), propagateCutoffbound(), propagateCutoffboundBinvar(), propagateCutoffboundBinvars(), propagateCutoffboundGlobally(), propagateLowerbound(), propagateVbounds(), SCIP_DECL_EVENTEXEC(), SCIP_DECL_PROPCOPY(), SCIP_DECL_PROPEXEC(), SCIP_DECL_PROPEXEC(), SCIP_DECL_PROPEXEC(), SCIP_DECL_PROPEXEC(), SCIP_DECL_PROPEXEC(), SCIP_DECL_PROPEXEC(), SCIP_DECL_PROPEXEC(), SCIP_DECL_PROPEXEC(), SCIP_DECL_PROPEXEC(), SCIP_DECL_PROPEXEC(), SCIP_DECL_PROPEXIT(), SCIP_DECL_PROPEXIT(), SCIP_DECL_PROPEXIT(), SCIP_DECL_PROPEXIT(), SCIP_DECL_PROPEXIT(), SCIP_DECL_PROPEXITPRE(), SCIP_DECL_PROPEXITPRE(), SCIP_DECL_PROPEXITPRE(), SCIP_DECL_PROPEXITPRE(), SCIP_DECL_PROPEXITSOL(), SCIP_DECL_PROPEXITSOL(), SCIP_DECL_PROPEXITSOL(), SCIP_DECL_PROPEXITSOL(), SCIP_DECL_PROPEXITSOL(), SCIP_DECL_PROPEXITSOL(), SCIP_DECL_PROPEXITSOL(), SCIP_DECL_PROPEXITSOL(), SCIP_DECL_PROPFREE(), SCIP_DECL_PROPFREE(), SCIP_DECL_PROPFREE(), SCIP_DECL_PROPFREE(), SCIP_DECL_PROPFREE(), SCIP_DECL_PROPFREE(), SCIP_DECL_PROPFREE(), SCIP_DECL_PROPFREE(), SCIP_DECL_PROPFREE(), SCIP_DECL_PROPFREE(), SCIP_DECL_PROPFREE(), SCIP_DECL_PROPINIT(), SCIP_DECL_PROPINIT(), SCIP_DECL_PROPINIT(), SCIP_DECL_PROPINIT(), SCIP_DECL_PROPINITPRE(), SCIP_DECL_PROPINITPRE(), SCIP_DECL_PROPINITPRE(), SCIP_DECL_PROPINITPRE(), SCIP_DECL_PROPINITPRE(), SCIP_DECL_PROPINITSOL(), SCIP_DECL_PROPINITSOL(), SCIP_DECL_PROPINITSOL(), SCIP_DECL_PROPINITSOL(), SCIP_DECL_PROPINITSOL(), SCIP_DECL_PROPINITSOL(), SCIP_DECL_PROPPRESOL(), SCIP_DECL_PROPPRESOL(), SCIP_DECL_PROPPRESOL(), SCIP_DECL_PROPPRESOL(), SCIP_DECL_PROPPRESOL(), SCIP_DECL_PROPPRESOL(), SCIP_DECL_PROPPRESOL(), SCIP_DECL_PROPRESPROP(), SCIP_DECL_PROPRESPROP(), SCIP_DECL_PROPRESPROP(), SCIP_DECL_PROPRESPROP(), SCIPcreateSymOpNodeType(), SCIPfindObjProp(), SCIPgenVBoundAdd(), SCIPgetObjProp(), SCIPgetSymmetry(), SCIPgetSymmetryNGenerators(), SCIPgetSymOpNodeType(), SCIPisPropagatedVbounds(), SCIPpropSyncAddBndchg(), SCIPpropSyncGetNTightenedBnds(), SCIPpropSyncGetNTightenedIntBnds(), and tryAddSymmetryHandlingMethods().

◆ SCIPpropSetData()

void SCIPpropSetData ( SCIP_PROP * prop,
SCIP_PROPDATA * propdata )

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

Parameters
proppropagator
propdatanew propagator user data

Definition at line 799 of file prop.c.

References assert(), NULL, and SCIP_Prop::propdata.

Referenced by SCIP_DECL_PROPFREE(), SCIP_DECL_PROPFREE(), SCIP_DECL_PROPFREE(), SCIP_DECL_PROPFREE(), SCIP_DECL_PROPFREE(), SCIP_DECL_PROPFREE(), SCIP_DECL_PROPFREE(), SCIP_DECL_PROPFREE(), SCIP_DECL_PROPFREE(), and SCIP_DECL_PROPFREE().

◆ SCIPpropGetName()

◆ SCIPpropGetDesc()

const char * SCIPpropGetDesc ( SCIP_PROP * prop)

gets description of propagator

Parameters
proppropagator

Definition at line 951 of file prop.c.

References assert(), SCIP_Prop::desc, and NULL.

Referenced by SCIP_DECL_DIALOGEXEC().

◆ SCIPpropGetPriority()

int SCIPpropGetPriority ( SCIP_PROP * prop)

gets priority of propagator

Parameters
proppropagator

Definition at line 961 of file prop.c.

References assert(), NULL, and SCIP_Prop::priority.

Referenced by propagationRound(), and SCIP_DECL_DIALOGEXEC().

◆ SCIPpropGetPresolPriority()

int SCIPpropGetPresolPriority ( SCIP_PROP * prop)

gets presolving priority of propagator

Parameters
proppropagator

Definition at line 971 of file prop.c.

References assert(), NULL, and SCIP_Prop::presolpriority.

Referenced by presolveRound(), and SCIP_DECL_DIALOGEXEC().

◆ SCIPpropGetFreq()

int SCIPpropGetFreq ( SCIP_PROP * prop)

gets frequency of propagator

Parameters
proppropagator

Definition at line 1009 of file prop.c.

References assert(), SCIP_Prop::freq, and NULL.

Referenced by SCIP_DECL_DIALOGEXEC().

◆ SCIPpropGetSetupTime()

SCIP_Real SCIPpropGetSetupTime ( SCIP_PROP * prop)

gets time in seconds used for setting up this propagator for new stages

Parameters
proppropagator

Definition at line 1034 of file prop.c.

References assert(), NULL, SCIP_Real, SCIPclockGetTime(), and SCIP_Prop::setuptime.

Referenced by SCIPprintPresolverStatistics(), and SCIPprintPropagatorStatistics().

◆ SCIPpropSetFreq()

void SCIPpropSetFreq ( SCIP_PROP * prop,
int freq )

sets frequency of propagator

Parameters
proppropagator
freqnew frequency of propagator

Definition at line 1044 of file prop.c.

References assert(), SCIP_Prop::freq, and NULL.

Referenced by SCIP_DECL_PROPEXEC(), SCIP_DECL_PROPPRESOL(), and SCIPpropSyncAddBndchg().

◆ SCIPpropGetTime()

SCIP_Real SCIPpropGetTime ( SCIP_PROP * prop)

gets time in seconds used in this propagator

gets time in seconds used in this propagator for propagation

Parameters
proppropagator

Definition at line 1056 of file prop.c.

References assert(), NULL, SCIP_Prop::proptime, SCIP_Real, and SCIPclockGetTime().

Referenced by SCIP_DECL_PROPPRESOL(), and SCIPprintPropagatorStatistics().

◆ SCIPpropGetStrongBranchPropTime()

SCIP_Real SCIPpropGetStrongBranchPropTime ( SCIP_PROP * prop)

gets time in seconds used in this propagator during strong branching

gets time in seconds used in this propagator for propagation during strong branching

Parameters
proppropagator

Definition at line 1066 of file prop.c.

References assert(), NULL, SCIP_Prop::sbproptime, SCIP_Real, and SCIPclockGetTime().

Referenced by SCIPprintPropagatorStatistics().

◆ SCIPpropGetRespropTime()

SCIP_Real SCIPpropGetRespropTime ( SCIP_PROP * prop)

gets time in seconds used in this propagator for resolve propagation

Parameters
proppropagator

Definition at line 1076 of file prop.c.

References assert(), NULL, SCIP_Prop::resproptime, SCIP_Real, and SCIPclockGetTime().

Referenced by SCIPprintPropagatorStatistics().

◆ SCIPpropGetPresolTime()

SCIP_Real SCIPpropGetPresolTime ( SCIP_PROP * prop)

gets time in seconds used in this propagator for presolving

Parameters
proppropagator

Definition at line 1086 of file prop.c.

References assert(), NULL, SCIP_Prop::presoltime, SCIP_Real, and SCIPclockGetTime().

Referenced by SCIPprintPresolverStatistics(), and SCIPprintPropagatorStatistics().

◆ SCIPpropGetNCalls()

SCIP_Longint SCIPpropGetNCalls ( SCIP_PROP * prop)

gets the total number of times, the propagator was called

Parameters
proppropagator

Definition at line 1096 of file prop.c.

References assert(), SCIP_Prop::ncalls, NULL, and SCIP_Longint.

Referenced by SCIPprintPropagatorStatistics().

◆ SCIPpropGetNRespropCalls()

SCIP_Longint SCIPpropGetNRespropCalls ( SCIP_PROP * prop)

gets the total number of times, the propagator was called for resolving a propagation

Parameters
proppropagator

Definition at line 1106 of file prop.c.

References assert(), SCIP_Prop::nrespropcalls, NULL, and SCIP_Longint.

Referenced by SCIPprintPropagatorStatistics().

◆ SCIPpropGetNCutoffs()

SCIP_Longint SCIPpropGetNCutoffs ( SCIP_PROP * prop)

gets total number of times, this propagator detected a cutoff

Parameters
proppropagator

Definition at line 1116 of file prop.c.

References assert(), SCIP_Prop::ncutoffs, NULL, and SCIP_Longint.

Referenced by SCIPprintPropagatorStatistics().

◆ SCIPpropGetNDomredsFound()

SCIP_Longint SCIPpropGetNDomredsFound ( SCIP_PROP * prop)

gets total number of domain reductions found by this propagator

Parameters
proppropagator

Definition at line 1126 of file prop.c.

References assert(), SCIP_Prop::ndomredsfound, NULL, and SCIP_Longint.

Referenced by SCIPprintPropagatorStatistics().

◆ SCIPpropIsDelayed()

SCIP_Bool SCIPpropIsDelayed ( SCIP_PROP * prop)

should propagator be delayed, if other propagators found reductions?

Parameters
proppropagator

Definition at line 1136 of file prop.c.

References assert(), SCIP_Prop::delay, NULL, and SCIP_Bool.

Referenced by SCIP_DECL_DIALOGEXEC().

◆ SCIPpropWasDelayed()

SCIP_Bool SCIPpropWasDelayed ( SCIP_PROP * prop)

was propagator delayed at the last call?

Parameters
proppropagator

Definition at line 1146 of file prop.c.

References assert(), NULL, SCIP_Bool, and SCIP_Prop::wasdelayed.

Referenced by propagationRound().

◆ SCIPpropIsInitialized()

SCIP_Bool SCIPpropIsInitialized ( SCIP_PROP * prop)

is propagator initialized?

Parameters
proppropagator

Definition at line 1156 of file prop.c.

References assert(), SCIP_Prop::initialized, NULL, and SCIP_Bool.

◆ SCIPpropGetNFixedVars()

int SCIPpropGetNFixedVars ( SCIP_PROP * prop)

gets number of variables fixed during presolving of propagator

Parameters
proppropagator

Definition at line 1166 of file prop.c.

References assert(), SCIP_Prop::nfixedvars, and NULL.

Referenced by SCIPprintPresolverStatistics().

◆ SCIPpropGetNAggrVars()

int SCIPpropGetNAggrVars ( SCIP_PROP * prop)

gets number of variables aggregated during presolving of propagator

Parameters
proppropagator

Definition at line 1176 of file prop.c.

References assert(), SCIP_Prop::naggrvars, and NULL.

Referenced by SCIPprintPresolverStatistics().

◆ SCIPpropGetNChgVarTypes()

int SCIPpropGetNChgVarTypes ( SCIP_PROP * prop)

gets number of variable types changed during presolving of propagator

Parameters
proppropagator

Definition at line 1186 of file prop.c.

References assert(), SCIP_Prop::nchgvartypes, and NULL.

Referenced by SCIPprintPresolverStatistics().

◆ SCIPpropGetNChgBds()

int SCIPpropGetNChgBds ( SCIP_PROP * prop)

gets number of bounds changed during presolving of propagator

Parameters
proppropagator

Definition at line 1196 of file prop.c.

References assert(), SCIP_Prop::nchgbds, and NULL.

Referenced by SCIPprintPresolverStatistics().

◆ SCIPpropGetNAddHoles()

int SCIPpropGetNAddHoles ( SCIP_PROP * prop)

gets number of holes added to domains of variables during presolving of propagator

Parameters
proppropagator

Definition at line 1206 of file prop.c.

References assert(), SCIP_Prop::naddholes, and NULL.

Referenced by SCIPprintPresolverStatistics().

◆ SCIPpropGetNDelConss()

int SCIPpropGetNDelConss ( SCIP_PROP * prop)

gets number of constraints deleted during presolving of propagator

Parameters
proppropagator

Definition at line 1216 of file prop.c.

References assert(), SCIP_Prop::ndelconss, and NULL.

Referenced by SCIPprintPresolverStatistics().

◆ SCIPpropGetNAddConss()

int SCIPpropGetNAddConss ( SCIP_PROP * prop)

gets number of constraints added during presolving of propagator

Parameters
proppropagator

Definition at line 1226 of file prop.c.

References assert(), SCIP_Prop::naddconss, and NULL.

Referenced by SCIPprintPresolverStatistics().

◆ SCIPpropGetNUpgdConss()

int SCIPpropGetNUpgdConss ( SCIP_PROP * prop)

gets number of constraints upgraded during presolving of propagator

Parameters
proppropagator

Definition at line 1236 of file prop.c.

References assert(), NULL, and SCIP_Prop::nupgdconss.

◆ SCIPpropGetNChgCoefs()

int SCIPpropGetNChgCoefs ( SCIP_PROP * prop)

gets number of coefficients changed during presolving of propagator

Parameters
proppropagator

Definition at line 1246 of file prop.c.

References assert(), SCIP_Prop::nchgcoefs, and NULL.

Referenced by SCIPprintPresolverStatistics().

◆ SCIPpropGetNChgSides()

int SCIPpropGetNChgSides ( SCIP_PROP * prop)

gets number of constraint sides changed during presolving of propagator

Parameters
proppropagator

Definition at line 1256 of file prop.c.

References assert(), SCIP_Prop::nchgsides, and NULL.

Referenced by SCIPprintPresolverStatistics().

◆ SCIPpropGetNPresolCalls()

int SCIPpropGetNPresolCalls ( SCIP_PROP * prop)

gets number of times the propagator was called in presolving and tried to find reductions

Parameters
proppropagator

Definition at line 1266 of file prop.c.

References assert(), SCIP_Prop::npresolcalls, and NULL.

Referenced by SCIPprintPresolverStatistics().

◆ SCIPpropGetTimingmask()

SCIP_PROPTIMING SCIPpropGetTimingmask ( SCIP_PROP * prop)

returns the timing mask of the propagator

Parameters
proppropagator

Definition at line 1276 of file prop.c.

References assert(), NULL, and SCIP_Prop::timingmask.

Referenced by propagationRound().

◆ SCIPpropDoesPresolve()

SCIP_Bool SCIPpropDoesPresolve ( SCIP_PROP * prop)

does the propagator perform presolving?

Parameters
proppropagator

Definition at line 1286 of file prop.c.

References assert(), NULL, and SCIP_Bool.

Referenced by SCIPprintPresolverStatistics().

◆ SCIPpropGetPresolTiming()

SCIP_PRESOLTIMING SCIPpropGetPresolTiming ( SCIP_PROP * prop)

returns the timing mask of the presolving method of the propagator

Parameters
proppropagator

Definition at line 1296 of file prop.c.

References assert(), NULL, and SCIP_Prop::presoltiming.

Referenced by SCIP_DECL_DIALOGEXEC().

◆ SCIPpropSetPresolTiming()

void SCIPpropSetPresolTiming ( SCIP_PROP * prop,
SCIP_PRESOLTIMING presoltiming )

sets the timing mask of the presolving method of the propagator

Parameters
proppropagator
presoltimingtiming mask to be set

Definition at line 1306 of file prop.c.

References assert(), NULL, and SCIP_Prop::presoltiming.

◆ SCIPincludeProp()

SCIP_RETCODE SCIPincludeProp ( SCIP * scip,
const char * name,
const char * desc,
int priority,
int freq,
SCIP_Bool delay,
SCIP_PROPTIMING timingmask,
int presolpriority,
int presolmaxrounds,
SCIP_PRESOLTIMING presoltiming,
SCIP_DECL_PROPCOPY((*propcopy)) ,
SCIP_DECL_PROPFREE((*propfree)) ,
SCIP_DECL_PROPINIT((*propinit)) ,
SCIP_DECL_PROPEXIT((*propexit)) ,
SCIP_DECL_PROPINITPRE((*propinitpre)) ,
SCIP_DECL_PROPEXITPRE((*propexitpre)) ,
SCIP_DECL_PROPINITSOL((*propinitsol)) ,
SCIP_DECL_PROPEXITSOL((*propexitsol)) ,
SCIP_DECL_PROPPRESOL((*proppresol)) ,
SCIP_DECL_PROPEXEC((*propexec)) ,
SCIP_DECL_PROPRESPROP((*propresprop)) ,
SCIP_PROPDATA * propdata )

creates a propagator and includes it in SCIP.

Note
method has all propagator callbacks as arguments and is thus changed every time a new callback is added in future releases; consider using SCIPincludePropBasic() and setter functions if you seek for a method which is less likely to change in future releases

creates a propagator and includes it in SCIP.

Precondition
This method can be called if SCIP is in one of the following stages:
Note
method has all propagator callbacks as arguments and is thus changed every time a new callback is added in future releases; consider using SCIPincludePropBasic() and setter functions if you seek for a method which is less likely to change in future releases
Parameters
scipSCIP data structure
namename of propagator
descdescription of propagator
prioritypriority of the propagator (>= 0: before, < 0: after constraint handlers)
freqfrequency for calling propagator
delayshould propagator be delayed, if other propagators found reductions?
timingmaskpositions in the node solving loop where propagator should be executed
presolprioritypresolving priority of the propagator (>= 0: before, < 0: after constraint handlers)
presolmaxroundsmaximal number of presolving rounds the propagator participates in (-1: no limit)
presoltimingtiming mask of the propagator's presolving method
propdatapropagator data

Definition at line 66 of file scip_prop.c.

References FALSE, NULL, SCIP_Bool, SCIP_CALL, SCIP_DECL_PROPCOPY, SCIP_DECL_PROPEXEC, SCIP_DECL_PROPEXIT, SCIP_DECL_PROPEXITPRE, SCIP_DECL_PROPEXITSOL, SCIP_DECL_PROPFREE, SCIP_DECL_PROPINIT, SCIP_DECL_PROPINITPRE, SCIP_DECL_PROPINITSOL, SCIP_DECL_PROPPRESOL, SCIP_DECL_PROPRESPROP, SCIP_INVALIDDATA, SCIP_OKAY, SCIPcheckStage(), SCIPerrorMessage, SCIPfindProp(), SCIPpropCreate(), SCIPsetIncludeProp(), and TRUE.

Referenced by SCIPincludeObjProp().

◆ SCIPincludePropBasic()

SCIP_RETCODE SCIPincludePropBasic ( SCIP * scip,
SCIP_PROP ** propptr,
const char * name,
const char * desc,
int priority,
int freq,
SCIP_Bool delay,
SCIP_PROPTIMING timingmask,
SCIP_DECL_PROPEXEC((*propexec)) ,
SCIP_PROPDATA * propdata )

creates a propagator and includes it in SCIP. All non-fundamental (or optional) callbacks will be set to NULL. Optional callbacks can be set via specific setter functions, see SCIPsetPropInit(), SCIPsetPropExit(), SCIPsetPropCopy(), SCIPsetPropFree(), SCIPsetPropInitsol(), SCIPsetPropExitsol(), SCIPsetPropInitpre(), SCIPsetPropExitpre(), SCIPsetPropPresol(), and SCIPsetPropResprop().

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 SCIPincludeProp() instead

creates a propagator and includes it in SCIP. All non-fundamental (or optional) callbacks will be set to NULL. Optional callbacks can be set via specific setter functions, see SCIPsetPropInit(), SCIPsetPropExit(), SCIPsetPropCopy(), SCIPsetPropFree(), SCIPsetPropInitsol(), SCIPsetPropExitsol(), SCIPsetPropInitpre(), SCIPsetPropExitpre(), SCIPsetPropPresol(), and SCIPsetPropResprop().

Note
if you want to set all callbacks with a single method call, consider using SCIPincludeProp() instead
Parameters
scipSCIP data structure
propptrreference to a propagator pointer, or NULL
namename of propagator
descdescription of propagator
prioritypriority of the propagator (>= 0: before, < 0: after constraint handlers)
freqfrequency for calling propagator
delayshould propagator be delayed, if other propagators found reductions?
timingmaskpositions in the node solving loop where propagators should be executed
propdatapropagator data

Definition at line 118 of file scip_prop.c.

References FALSE, NULL, SCIP_Bool, SCIP_CALL, SCIP_DECL_PROPEXEC, SCIP_INVALIDDATA, SCIP_OKAY, SCIP_PRESOLTIMING_ALWAYS, SCIPcheckStage(), SCIPerrorMessage, SCIPfindProp(), SCIPpropCreate(), SCIPsetIncludeProp(), and TRUE.

Referenced by SCIPincludePropDualfix(), SCIPincludePropGenvbounds(), SCIPincludePropNlobbt(), SCIPincludePropObbt(), SCIPincludePropProbing(), SCIPincludePropPseudoobj(), SCIPincludePropRedcost(), SCIPincludePropRootredcost(), SCIPincludePropSymmetry(), SCIPincludePropSync(), and SCIPincludePropVbounds().

◆ SCIPsetPropCopy()

SCIP_RETCODE SCIPsetPropCopy ( SCIP * scip,
SCIP_PROP * prop )

sets copy method of propagator

Parameters
scipSCIP data structure
proppropagator copy method of propagator or NULL if you don't want to copy your plugin into sub-SCIPs

Definition at line 155 of file scip_prop.c.

References assert(), FALSE, NULL, SCIP_CALL, SCIP_DECL_PROPCOPY, SCIP_OKAY, SCIPcheckStage(), SCIPpropSetCopy(), and TRUE.

Referenced by SCIPincludePropDualfix(), SCIPincludePropGenvbounds(), SCIPincludePropNlobbt(), SCIPincludePropObbt(), SCIPincludePropProbing(), SCIPincludePropPseudoobj(), SCIPincludePropRedcost(), SCIPincludePropRootredcost(), and SCIPincludePropVbounds().

◆ SCIPsetPropFree()

◆ SCIPsetPropInit()

SCIP_RETCODE SCIPsetPropInit ( SCIP * scip,
SCIP_PROP * prop )

sets initialization method of propagator

Parameters
scipSCIP data structure
proppropagator initialize propagator

Definition at line 187 of file scip_prop.c.

References assert(), FALSE, NULL, SCIP_CALL, SCIP_DECL_PROPINIT, SCIP_OKAY, SCIPcheckStage(), SCIPpropSetInit(), and TRUE.

Referenced by SCIPincludePropGenvbounds(), SCIPincludePropProbing(), and SCIPincludePropSync().

◆ SCIPsetPropExit()

SCIP_RETCODE SCIPsetPropExit ( SCIP * scip,
SCIP_PROP * prop )

sets deinitialization method of propagator

Parameters
scipSCIP data structure
proppropagator deinitialize propagator

Definition at line 203 of file scip_prop.c.

References assert(), FALSE, NULL, SCIP_CALL, SCIP_DECL_PROPEXIT, SCIP_OKAY, SCIPcheckStage(), SCIPpropSetExit(), and TRUE.

Referenced by SCIPincludePropGenvbounds(), SCIPincludePropProbing(), SCIPincludePropSymmetry(), and SCIPincludePropSync().

◆ SCIPsetPropInitsol()

SCIP_RETCODE SCIPsetPropInitsol ( SCIP * scip,
SCIP_PROP * prop )

sets solving process initialization method of propagator

Parameters
scipSCIP data structure
proppropagator solving process initialization method of propagator

Definition at line 219 of file scip_prop.c.

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

Referenced by SCIPincludePropNlobbt(), SCIPincludePropObbt(), SCIPincludePropProbing(), SCIPincludePropPseudoobj(), and SCIPincludePropRedcost().

◆ SCIPsetPropExitsol()

SCIP_RETCODE SCIPsetPropExitsol ( SCIP * scip,
SCIP_PROP * prop )

sets solving process deinitialization method of propagator

Parameters
scipSCIP data structure
proppropagator solving process deinitialization method of propagator

Definition at line 235 of file scip_prop.c.

References assert(), FALSE, NULL, SCIP_CALL, SCIP_DECL_PROPEXITSOL, SCIP_OKAY, SCIPcheckStage(), SCIPpropSetExitsol(), and TRUE.

Referenced by SCIPincludePropGenvbounds(), SCIPincludePropNlobbt(), SCIPincludePropObbt(), SCIPincludePropPseudoobj(), SCIPincludePropRootredcost(), SCIPincludePropSymmetry(), and SCIPincludePropVbounds().

◆ SCIPsetPropInitpre()

SCIP_RETCODE SCIPsetPropInitpre ( SCIP * scip,
SCIP_PROP * prop )

sets preprocessing initialization method of propagator

Parameters
scipSCIP data structure
proppropagator preprocessing initialization method of propagator

Definition at line 251 of file scip_prop.c.

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

Referenced by SCIPincludePropGenvbounds(), SCIPincludePropProbing(), SCIPincludePropSymmetry(), and SCIPincludePropVbounds().

◆ SCIPsetPropExitpre()

SCIP_RETCODE SCIPsetPropExitpre ( SCIP * scip,
SCIP_PROP * prop )

sets preprocessing deinitialization method of propagator

Parameters
scipSCIP data structure
proppropagator preprocessing deinitialization method of propagator

Definition at line 267 of file scip_prop.c.

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

Referenced by SCIPincludePropGenvbounds(), SCIPincludePropProbing(), and SCIPincludePropSymmetry().

◆ SCIPsetPropPresol()

SCIP_RETCODE SCIPsetPropPresol ( SCIP * scip,
SCIP_PROP * prop,
SCIP_DECL_PROPPRESOL((*proppresol)) ,
int presolpriority,
int presolmaxrounds,
SCIP_PRESOLTIMING presoltiming )

sets presolving method of propagator

Parameters
scipSCIP data structure
proppropagator
presolprioritypresolving priority of the propagator (>= 0: before, < 0: after constraint handlers)
presolmaxroundsmaximal number of presolving rounds the propagator participates in (-1: no limit)
presoltimingtiming mask of the propagator's presolving method

Definition at line 283 of file scip_prop.c.

References assert(), FALSE, NULL, paramname, SCIP_CALL, SCIP_MAXSTRLEN, SCIP_OKAY, SCIPcheckStage(), SCIPpropGetName(), SCIPpropSetPresol(), SCIPsetSetDefaultIntParam(), SCIPsnprintf(), and TRUE.

Referenced by SCIPincludePropDualfix(), SCIPincludePropGenvbounds(), SCIPincludePropProbing(), SCIPincludePropPseudoobj(), SCIPincludePropSymmetry(), SCIPincludePropSync(), and SCIPincludePropVbounds().

◆ SCIPsetPropResprop()

SCIP_RETCODE SCIPsetPropResprop ( SCIP * scip,
SCIP_PROP * prop )

sets propagation conflict resolving callback of propagator

Parameters
scipSCIP data structure
proppropagator propagation conflict resolving callback

Definition at line 316 of file scip_prop.c.

References assert(), FALSE, NULL, SCIP_CALL, SCIP_DECL_PROPRESPROP, SCIP_OKAY, SCIPcheckStage(), SCIPpropSetResprop(), and TRUE.

Referenced by SCIPincludePropGenvbounds(), SCIPincludePropObbt(), SCIPincludePropProbing(), SCIPincludePropPseudoobj(), SCIPincludePropSymmetry(), and SCIPincludePropVbounds().

◆ SCIPfindProp()

SCIP_PROP * SCIPfindProp ( SCIP * scip,
const char * name )

◆ SCIPgetProps()

SCIP_PROP ** SCIPgetProps ( SCIP * scip)

returns the array of currently available propagators

Parameters
scipSCIP data structure

Definition at line 346 of file scip_prop.c.

References assert(), NULL, and SCIPsetSortProps().

Referenced by SCIP_DECL_DIALOGEXEC(), and SCIPcopyConcurrentSolvingStats().

◆ SCIPgetNProps()

int SCIPgetNProps ( SCIP * scip)

returns the number of currently available propagators

Parameters
scipSCIP data structure

Definition at line 359 of file scip_prop.c.

References assert(), and NULL.

Referenced by SCIP_DECL_DIALOGEXEC(), and SCIPcopyConcurrentSolvingStats().

◆ SCIPsetPropPriority()

SCIP_RETCODE SCIPsetPropPriority ( SCIP * scip,
SCIP_PROP * prop,
int priority )

sets the priority of a propagator

Parameters
scipSCIP data structure
proppropagator
prioritynew priority of the propagator

Definition at line 370 of file scip_prop.c.

References assert(), NULL, SCIP_OKAY, and SCIPpropSetPriority().

Referenced by SCIP_DECL_PARAMCHGD().

◆ SCIPsetPropPresolPriority()

SCIP_RETCODE SCIPsetPropPresolPriority ( SCIP * scip,
SCIP_PROP * prop,
int presolpriority )

sets the presolving priority of a propagator

Parameters
scipSCIP data structure
proppropagator
presolprioritynew presol priority of the propagator

Definition at line 385 of file scip_prop.c.

References assert(), NULL, SCIP_OKAY, and SCIPpropSetPresolPriority().

Referenced by SCIP_DECL_PARAMCHGD().