Scippy

SCIP

Solving Constraint Integer Programs

Detailed Description

methods for propagator plugins

Functions

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

Function Documentation

◆ SCIP_DECL_SORTPTRCOMP() [1/3]

SCIP_EXPORT SCIP_DECL_SORTPTRCOMP ( SCIPpropComp  )

compares two propagators w. r. to their priority

Definition at line 42 of file prop.c.

◆ SCIP_DECL_SORTPTRCOMP() [2/3]

SCIP_EXPORT SCIP_DECL_SORTPTRCOMP ( SCIPpropCompPresol  )

compares two propagators w. r. to their presolving priority

compares two propagators w. r. to their priority

Definition at line 48 of file prop.c.

◆ SCIP_DECL_SORTPTRCOMP() [3/3]

SCIP_EXPORT SCIP_DECL_SORTPTRCOMP ( SCIPpropCompName  )

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

Definition at line 54 of file prop.c.

References SCIPpropGetName().

◆ SCIPpropGetData()

◆ SCIPpropSetData()

SCIP_EXPORT 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 789 of file prop.c.

References NULL, and SCIP_Prop::propdata.

Referenced by SCIP_DECL_PROPFREE().

◆ SCIPpropGetName()

◆ SCIPpropGetDesc()

SCIP_EXPORT const char* SCIPpropGetDesc ( SCIP_PROP prop)

gets description of propagator

Parameters
proppropagator

Definition at line 941 of file prop.c.

References SCIP_Prop::desc, and NULL.

Referenced by SCIP_DECL_DIALOGEXEC().

◆ SCIPpropGetPriority()

SCIP_EXPORT int SCIPpropGetPriority ( SCIP_PROP prop)

gets priority of propagator

Parameters
proppropagator

Definition at line 951 of file prop.c.

References NULL, and SCIP_Prop::priority.

Referenced by propagationRound(), and SCIP_DECL_DIALOGEXEC().

◆ SCIPpropGetPresolPriority()

SCIP_EXPORT int SCIPpropGetPresolPriority ( SCIP_PROP prop)

gets presolving priority of propagator

Parameters
proppropagator

Definition at line 961 of file prop.c.

References NULL, and SCIP_Prop::presolpriority.

Referenced by presolveRound(), and SCIP_DECL_DIALOGEXEC().

◆ SCIPpropGetFreq()

SCIP_EXPORT int SCIPpropGetFreq ( SCIP_PROP prop)

gets frequency of propagator

Parameters
proppropagator

Definition at line 999 of file prop.c.

References SCIP_Prop::freq, and NULL.

Referenced by SCIP_DECL_DIALOGEXEC().

◆ SCIPpropGetSetupTime()

SCIP_EXPORT SCIP_Real SCIPpropGetSetupTime ( SCIP_PROP prop)

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

Parameters
proppropagator

Definition at line 1024 of file prop.c.

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

Referenced by SCIPprintPresolverStatistics(), and SCIPprintPropagatorStatistics().

◆ SCIPpropSetFreq()

SCIP_EXPORT void SCIPpropSetFreq ( SCIP_PROP prop,
int  freq 
)

sets frequency of propagator

Parameters
proppropagator
freqnew frequency of propagator

Definition at line 1034 of file prop.c.

References SCIP_Prop::freq, and NULL.

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

◆ SCIPpropGetTime()

SCIP_EXPORT 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 1046 of file prop.c.

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

Referenced by SCIPprintPropagatorStatistics().

◆ SCIPpropGetStrongBranchPropTime()

SCIP_EXPORT 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 1056 of file prop.c.

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

Referenced by SCIPprintPropagatorStatistics().

◆ SCIPpropGetRespropTime()

SCIP_EXPORT SCIP_Real SCIPpropGetRespropTime ( SCIP_PROP prop)

gets time in seconds used in this propagator for resolve propagation

Parameters
proppropagator

Definition at line 1066 of file prop.c.

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

Referenced by SCIPprintPropagatorStatistics().

◆ SCIPpropGetPresolTime()

SCIP_EXPORT SCIP_Real SCIPpropGetPresolTime ( SCIP_PROP prop)

gets time in seconds used in this propagator for presolving

Parameters
proppropagator

Definition at line 1076 of file prop.c.

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

Referenced by SCIPprintPresolverStatistics(), and SCIPprintPropagatorStatistics().

◆ SCIPpropGetNCalls()

SCIP_EXPORT SCIP_Longint SCIPpropGetNCalls ( SCIP_PROP prop)

gets the total number of times, the propagator was called

Parameters
proppropagator

Definition at line 1086 of file prop.c.

References SCIP_Prop::ncalls, and NULL.

Referenced by SCIPprintPropagatorStatistics().

◆ SCIPpropGetNRespropCalls()

SCIP_EXPORT 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 1096 of file prop.c.

References SCIP_Prop::nrespropcalls, and NULL.

Referenced by SCIPprintPropagatorStatistics().

◆ SCIPpropGetNCutoffs()

SCIP_EXPORT SCIP_Longint SCIPpropGetNCutoffs ( SCIP_PROP prop)

gets total number of times, this propagator detected a cutoff

Parameters
proppropagator

Definition at line 1106 of file prop.c.

References SCIP_Prop::ncutoffs, and NULL.

Referenced by SCIPprintPropagatorStatistics().

◆ SCIPpropGetNDomredsFound()

SCIP_EXPORT SCIP_Longint SCIPpropGetNDomredsFound ( SCIP_PROP prop)

gets total number of domain reductions found by this propagator

Parameters
proppropagator

Definition at line 1116 of file prop.c.

References SCIP_Prop::ndomredsfound, and NULL.

Referenced by SCIPprintPropagatorStatistics().

◆ SCIPpropIsDelayed()

SCIP_EXPORT SCIP_Bool SCIPpropIsDelayed ( SCIP_PROP prop)

should propagator be delayed, if other propagators found reductions?

Parameters
proppropagator

Definition at line 1126 of file prop.c.

References SCIP_Prop::delay, and NULL.

Referenced by SCIP_DECL_DIALOGEXEC().

◆ SCIPpropWasDelayed()

SCIP_EXPORT SCIP_Bool SCIPpropWasDelayed ( SCIP_PROP prop)

was propagator delayed at the last call?

Parameters
proppropagator

Definition at line 1136 of file prop.c.

References NULL, and SCIP_Prop::wasdelayed.

Referenced by propagationRound().

◆ SCIPpropIsInitialized()

SCIP_EXPORT SCIP_Bool SCIPpropIsInitialized ( SCIP_PROP prop)

is propagator initialized?

Parameters
proppropagator

Definition at line 1146 of file prop.c.

References SCIP_Prop::initialized, and NULL.

Referenced by SCIPsetIncludeSepa().

◆ SCIPpropGetNFixedVars()

SCIP_EXPORT int SCIPpropGetNFixedVars ( SCIP_PROP prop)

gets number of variables fixed during presolving of propagator

Parameters
proppropagator

Definition at line 1156 of file prop.c.

References SCIP_Prop::nfixedvars, and NULL.

Referenced by SCIPprintPresolverStatistics().

◆ SCIPpropGetNAggrVars()

SCIP_EXPORT int SCIPpropGetNAggrVars ( SCIP_PROP prop)

gets number of variables aggregated during presolving of propagator

Parameters
proppropagator

Definition at line 1166 of file prop.c.

References SCIP_Prop::naggrvars, and NULL.

Referenced by SCIPprintPresolverStatistics().

◆ SCIPpropGetNChgVarTypes()

SCIP_EXPORT int SCIPpropGetNChgVarTypes ( SCIP_PROP prop)

gets number of variable types changed during presolving of propagator

Parameters
proppropagator

Definition at line 1176 of file prop.c.

References SCIP_Prop::nchgvartypes, and NULL.

Referenced by SCIPprintPresolverStatistics().

◆ SCIPpropGetNChgBds()

SCIP_EXPORT int SCIPpropGetNChgBds ( SCIP_PROP prop)

gets number of bounds changed during presolving of propagator

Parameters
proppropagator

Definition at line 1186 of file prop.c.

References SCIP_Prop::nchgbds, and NULL.

Referenced by SCIPprintPresolverStatistics().

◆ SCIPpropGetNAddHoles()

SCIP_EXPORT int SCIPpropGetNAddHoles ( SCIP_PROP prop)

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

Parameters
proppropagator

Definition at line 1196 of file prop.c.

References SCIP_Prop::naddholes, and NULL.

Referenced by SCIPprintPresolverStatistics().

◆ SCIPpropGetNDelConss()

SCIP_EXPORT int SCIPpropGetNDelConss ( SCIP_PROP prop)

gets number of constraints deleted during presolving of propagator

Parameters
proppropagator

Definition at line 1206 of file prop.c.

References SCIP_Prop::ndelconss, and NULL.

Referenced by SCIPprintPresolverStatistics().

◆ SCIPpropGetNAddConss()

SCIP_EXPORT int SCIPpropGetNAddConss ( SCIP_PROP prop)

gets number of constraints added during presolving of propagator

Parameters
proppropagator

Definition at line 1216 of file prop.c.

References SCIP_Prop::naddconss, and NULL.

Referenced by SCIPprintPresolverStatistics().

◆ SCIPpropGetNUpgdConss()

SCIP_EXPORT int SCIPpropGetNUpgdConss ( SCIP_PROP prop)

gets number of constraints upgraded during presolving of propagator

Parameters
proppropagator

Definition at line 1226 of file prop.c.

References NULL, and SCIP_Prop::nupgdconss.

◆ SCIPpropGetNChgCoefs()

SCIP_EXPORT int SCIPpropGetNChgCoefs ( SCIP_PROP prop)

gets number of coefficients changed during presolving of propagator

Parameters
proppropagator

Definition at line 1236 of file prop.c.

References SCIP_Prop::nchgcoefs, and NULL.

Referenced by SCIPprintPresolverStatistics().

◆ SCIPpropGetNChgSides()

SCIP_EXPORT int SCIPpropGetNChgSides ( SCIP_PROP prop)

gets number of constraint sides changed during presolving of propagator

Parameters
proppropagator

Definition at line 1246 of file prop.c.

References SCIP_Prop::nchgsides, and NULL.

Referenced by SCIPprintPresolverStatistics().

◆ SCIPpropGetNPresolCalls()

SCIP_EXPORT 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 1256 of file prop.c.

References SCIP_Prop::npresolcalls, and NULL.

Referenced by SCIPprintPresolverStatistics().

◆ SCIPpropGetTimingmask()

SCIP_EXPORT SCIP_PROPTIMING SCIPpropGetTimingmask ( SCIP_PROP prop)

returns the timing mask of the propagator

Parameters
proppropagator

Definition at line 1266 of file prop.c.

References NULL, and SCIP_Prop::timingmask.

Referenced by propagationRound().

◆ SCIPpropDoesPresolve()

SCIP_EXPORT SCIP_Bool SCIPpropDoesPresolve ( SCIP_PROP prop)

does the propagator perform presolving?

Parameters
proppropagator

Definition at line 1276 of file prop.c.

References NULL.

Referenced by SCIPprintPresolverStatistics().

◆ SCIPpropGetPresolTiming()

SCIP_EXPORT SCIP_PRESOLTIMING SCIPpropGetPresolTiming ( SCIP_PROP prop)

returns the timing mask of the presolving method of the propagator

Parameters
proppropagator

Definition at line 1286 of file prop.c.

References NULL, and SCIP_Prop::presoltiming.

Referenced by SCIP_DECL_DIALOGEXEC().

◆ SCIPpropSetPresolTiming()

SCIP_EXPORT 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 1296 of file prop.c.

References NULL, and SCIP_Prop::presoltiming.

◆ SCIPincludeProp()

SCIP_EXPORT 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
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 52 of file scip_prop.c.

References FALSE, Scip::mem, Scip::messagehdlr, NULL, SCIP_CALL, SCIP_INVALIDDATA, SCIP_OKAY, SCIPcheckStage(), SCIPerrorMessage, SCIPfindProp(), SCIPpropCreate(), SCIPsetIncludeProp(), Scip::set, SCIP_Mem::setmem, and TRUE.

Referenced by SCIPincludeObjProp().

◆ SCIPincludePropBasic()

SCIP_EXPORT 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().

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 104 of file scip_prop.c.

References FALSE, Scip::mem, Scip::messagehdlr, NULL, SCIP_CALL, SCIP_INVALIDDATA, SCIP_OKAY, SCIP_PRESOLTIMING_ALWAYS, SCIPcheckStage(), SCIPerrorMessage, SCIPfindProp(), SCIPpropCreate(), SCIPsetIncludeProp(), Scip::set, SCIP_Mem::setmem, and TRUE.

Referenced by SCIPincludePropDualfix(), SCIPincludePropNlobbt(), SCIPincludePropOrbitalfixing(), SCIPincludePropRedcost(), SCIPincludePropRootredcost(), SCIPincludePropStp(), SCIPincludePropSync(), and SCIPincludePropVbounds().

◆ SCIPsetPropCopy()

SCIP_EXPORT SCIP_RETCODE SCIPsetPropCopy ( SCIP scip,
SCIP_PROP prop,
SCIP_DECL_PROPCOPY((*propcopy))   
)

sets copy method of propagator

Parameters
scipSCIP data structure
proppropagator

Definition at line 141 of file scip_prop.c.

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

Referenced by SCIPincludePropDualfix(), SCIPincludePropRedcost(), SCIPincludePropRootredcost(), SCIPincludePropStp(), and SCIPincludePropVbounds().

◆ SCIPsetPropFree()

SCIP_EXPORT SCIP_RETCODE SCIPsetPropFree ( SCIP scip,
SCIP_PROP prop,
SCIP_DECL_PROPFREE((*propfree))   
)

sets destructor method of propagator

Parameters
scipSCIP data structure
proppropagator

Definition at line 157 of file scip_prop.c.

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

Referenced by SCIPincludePropNlobbt(), SCIPincludePropOrbitalfixing(), SCIPincludePropRedcost(), SCIPincludePropRootredcost(), SCIPincludePropStp(), SCIPincludePropSync(), and SCIPincludePropVbounds().

◆ SCIPsetPropInit()

SCIP_EXPORT SCIP_RETCODE SCIPsetPropInit ( SCIP scip,
SCIP_PROP prop,
SCIP_DECL_PROPINIT((*propinit))   
)

sets initialization method of propagator

Parameters
scipSCIP data structure
proppropagator

Definition at line 173 of file scip_prop.c.

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

Referenced by SCIPincludePropOrbitalfixing(), and SCIPincludePropSync().

◆ SCIPsetPropExit()

SCIP_EXPORT SCIP_RETCODE SCIPsetPropExit ( SCIP scip,
SCIP_PROP prop,
SCIP_DECL_PROPEXIT((*propexit))   
)

sets deinitialization method of propagator

Parameters
scipSCIP data structure
proppropagator

Definition at line 189 of file scip_prop.c.

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

Referenced by SCIPincludePropOrbitalfixing(), and SCIPincludePropSync().

◆ SCIPsetPropInitsol()

SCIP_EXPORT SCIP_RETCODE SCIPsetPropInitsol ( SCIP scip,
SCIP_PROP prop,
SCIP_DECL_PROPINITSOL((*propinitsol))   
)

sets solving process initialization method of propagator

Parameters
scipSCIP data structure
proppropagator

Definition at line 205 of file scip_prop.c.

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

Referenced by SCIPincludePropNlobbt(), SCIPincludePropRedcost(), and SCIPincludePropStp().

◆ SCIPsetPropExitsol()

SCIP_EXPORT SCIP_RETCODE SCIPsetPropExitsol ( SCIP scip,
SCIP_PROP prop,
SCIP_DECL_PROPEXITSOL((*propexitsol))   
)

sets solving process deinitialization method of propagator

Parameters
scipSCIP data structure
proppropagator

Definition at line 221 of file scip_prop.c.

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

Referenced by SCIPincludePropNlobbt(), SCIPincludePropRootredcost(), SCIPincludePropStp(), and SCIPincludePropVbounds().

◆ SCIPsetPropInitpre()

SCIP_EXPORT SCIP_RETCODE SCIPsetPropInitpre ( SCIP scip,
SCIP_PROP prop,
SCIP_DECL_PROPINITPRE((*propinitpre))   
)

sets preprocessing initialization method of propagator

Parameters
scipSCIP data structure
proppropagator

Definition at line 237 of file scip_prop.c.

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

Referenced by SCIPincludePropOrbitalfixing(), and SCIPincludePropVbounds().

◆ SCIPsetPropExitpre()

SCIP_EXPORT SCIP_RETCODE SCIPsetPropExitpre ( SCIP scip,
SCIP_PROP prop,
SCIP_DECL_PROPEXITPRE((*propexitpre))   
)

sets preprocessing deinitialization method of propagator

Parameters
scipSCIP data structure
proppropagator

Definition at line 253 of file scip_prop.c.

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

◆ SCIPsetPropPresol()

SCIP_EXPORT 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 269 of file scip_prop.c.

References FALSE, NULL, SCIP_CALL, SCIP_MAXSTRLEN, SCIP_OKAY, SCIPcheckStage(), SCIPpropGetName(), SCIPpropSetPresol(), SCIPsetSetDefaultIntParam(), SCIPsnprintf(), Scip::set, and TRUE.

Referenced by SCIPincludePropDualfix(), SCIPincludePropOrbitalfixing(), SCIPincludePropSync(), and SCIPincludePropVbounds().

◆ SCIPsetPropResprop()

SCIP_EXPORT SCIP_RETCODE SCIPsetPropResprop ( SCIP scip,
SCIP_PROP prop,
SCIP_DECL_PROPRESPROP((*propresprop))   
)

sets propagation conflict resolving callback of propagator

Parameters
scipSCIP data structure
proppropagator

Definition at line 302 of file scip_prop.c.

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

Referenced by SCIPincludePropOrbitalfixing(), and SCIPincludePropVbounds().

◆ SCIPfindProp()

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

returns the propagator of the given name, or NULL if not existing

Parameters
scipSCIP data structure
namename of propagator

Definition at line 319 of file scip_prop.c.

References NULL, SCIPsetFindProp(), and Scip::set.

Referenced by SCIP_DECL_PROPINITSOL(), SCIPcopyConcurrentSolvingStats(), SCIPcreateConcurrent(), SCIPexecPropVbounds(), SCIPfindObjProp(), SCIPincludeProp(), SCIPincludePropBasic(), SCIPisPropagatedVbounds(), SCIPStpNfixedEdges(), and SCIPStpPropGetGraph().

◆ SCIPgetProps()

SCIP_EXPORT SCIP_PROP** SCIPgetProps ( SCIP scip)

returns the array of currently available propagators

Parameters
scipSCIP data structure

Definition at line 332 of file scip_prop.c.

References NULL, SCIP_Set::props, SCIPsetSortProps(), and Scip::set.

Referenced by SCIP_DECL_DIALOGEXEC(), and SCIPcopyConcurrentSolvingStats().

◆ SCIPgetNProps()

SCIP_EXPORT int SCIPgetNProps ( SCIP scip)

returns the number of currently available propagators

Parameters
scipSCIP data structure

Definition at line 345 of file scip_prop.c.

References SCIP_Set::nprops, NULL, and Scip::set.

Referenced by SCIP_DECL_DIALOGEXEC(), and SCIPcopyConcurrentSolvingStats().

◆ SCIPsetPropPriority()

SCIP_EXPORT 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 356 of file scip_prop.c.

References NULL, SCIP_OKAY, SCIPpropSetPriority(), and Scip::set.

Referenced by SCIP_DECL_PARAMCHGD().

◆ SCIPsetPropPresolPriority()

SCIP_EXPORT 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 371 of file scip_prop.c.

References NULL, SCIP_OKAY, SCIPpropSetPresolPriority(), and Scip::set.

Referenced by SCIP_DECL_PARAMCHGD().