Detailed Description

methods and datastructures for propagators

Author: Tobias Achterberg; Timo Berthold

Definition in file prop.c.

#include <assert.h>
#include <string.h>
#include "scip/def.h"
#include "scip/set.h"
#include "scip/stat.h"
#include "scip/clock.h"
#include "scip/paramset.h"
#include "scip/var.h"
#include "scip/scip.h"
#include "scip/prop.h"
#include "scip/pub_message.h"
#include "scip/pub_misc.h"
#include "scip/struct_prop.h"

Go to the source code of this file.

Functions
	SCIP_DECL_SORTPTRCOMP (SCIPpropComp)
	SCIP_DECL_SORTPTRCOMP (SCIPpropCompPresol)
	SCIP_DECL_SORTPTRCOMP (SCIPpropCompName)
static	SCIP_DECL_PARAMCHGD (paramChgdPropPriority)
static	SCIP_DECL_PARAMCHGD (paramChgdPropPresolPriority)
SCIP_RETCODE	SCIPpropCopyInclude (SCIP_PROP prop, SCIP_SET set)
static SCIP_RETCODE	doPropCreate (SCIP_PROP *prop, SCIP_SET set, SCIP_MESSAGEHDLR messagehdlr, BMS_BLKMEM blkmem, 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	SCIPpropCreate (SCIP_PROP *prop, SCIP_SET set, SCIP_MESSAGEHDLR messagehdlr, BMS_BLKMEM blkmem, 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	SCIPpropFree (SCIP_PROP *prop, SCIP_SET set)
SCIP_RETCODE	SCIPpropInit (SCIP_PROP prop, SCIP_SET set)
SCIP_RETCODE	SCIPpropExit (SCIP_PROP prop, SCIP_SET set)
SCIP_RETCODE	SCIPpropInitpre (SCIP_PROP prop, SCIP_SET set)
SCIP_RETCODE	SCIPpropExitpre (SCIP_PROP prop, SCIP_SET set)
SCIP_RETCODE	SCIPpropInitsol (SCIP_PROP prop, SCIP_SET set)
SCIP_RETCODE	SCIPpropExitsol (SCIP_PROP prop, SCIP_SET set, SCIP_Bool restart)
SCIP_RETCODE	SCIPpropPresol (SCIP_PROP prop, SCIP_SET set, SCIP_PRESOLTIMING timing, int nrounds, int nfixedvars, int naggrvars, int nchgvartypes, int nchgbds, int naddholes, int ndelconss, int naddconss, int nupgdconss, int nchgcoefs, int nchgsides, SCIP_RESULT *result)
SCIP_RETCODE	SCIPpropExec (SCIP_PROP prop, SCIP_SET set, SCIP_STAT stat, int depth, SCIP_Bool execdelayed, SCIP_Bool instrongbranching, SCIP_PROPTIMING proptiming, SCIP_RESULT result)
SCIP_RETCODE	SCIPpropResolvePropagation (SCIP_PROP prop, SCIP_SET set, SCIP_VAR infervar, int inferinfo, SCIP_BOUNDTYPE inferboundtype, SCIP_BDCHGIDX bdchgidx, SCIP_Real relaxedbd, SCIP_RESULT *result)
SCIP_PROPDATA *	SCIPpropGetData (SCIP_PROP *prop)
void	SCIPpropSetData (SCIP_PROP prop, SCIP_PROPDATA propdata)
void	SCIPpropSetCopy (SCIP_PROP *prop,)
void	SCIPpropSetFree (SCIP_PROP *prop,)
void	SCIPpropSetInit (SCIP_PROP *prop,)
void	SCIPpropSetExit (SCIP_PROP *prop,)
void	SCIPpropSetInitsol (SCIP_PROP *prop,)
void	SCIPpropSetExitsol (SCIP_PROP *prop,)
void	SCIPpropSetInitpre (SCIP_PROP *prop,)
void	SCIPpropSetExitpre (SCIP_PROP *prop,)
SCIP_RETCODE	SCIPpropSetPresol (SCIP_PROP prop, SCIP_DECL_PROPPRESOL((proppresol)), int presolpriority, int presolmaxrounds, SCIP_PRESOLTIMING presoltiming)
void	SCIPpropSetResprop (SCIP_PROP *prop,)
void	SCIPpropMarkExact (SCIP_PROP *prop)
const char *	SCIPpropGetName (SCIP_PROP *prop)
const char *	SCIPpropGetDesc (SCIP_PROP *prop)
int	SCIPpropGetPriority (SCIP_PROP *prop)
int	SCIPpropGetPresolPriority (SCIP_PROP *prop)
void	SCIPpropSetPriority (SCIP_PROP prop, SCIP_SET set, int priority)
void	SCIPpropSetPresolPriority (SCIP_PROP prop, SCIP_SET set, int presolpriority)
int	SCIPpropGetFreq (SCIP_PROP *prop)
void	SCIPpropEnableOrDisableClocks (SCIP_PROP *prop, SCIP_Bool enable)
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)
void	SCIPpropSetTimingmask (SCIP_PROP *prop, SCIP_PROPTIMING timingmask)
SCIP_Bool	SCIPpropDoesPresolve (SCIP_PROP *prop)
SCIP_PRESOLTIMING	SCIPpropGetPresolTiming (SCIP_PROP *prop)
void	SCIPpropSetPresolTiming (SCIP_PROP *prop, SCIP_PRESOLTIMING presoltiming)

Function Documentation

◆ SCIP_DECL_PARAMCHGD() [1/2]

SCIP_DECL_PARAMCHGD ( paramChgdPropPriority )

static

method to call, when the priority of a propagator was changed

Definition at line 71 of file prop.c.

References assert(), NULL, SCIP_CALL, SCIP_DECL_PARAMCHGD, SCIP_OKAY, SCIPparamGetData(), SCIPparamGetInt(), and SCIPsetPropPriority().

◆ SCIP_DECL_PARAMCHGD() [2/2]

SCIP_DECL_PARAMCHGD ( paramChgdPropPresolPriority )

static

method to call, when the presolving priority of a propagator was changed

Definition at line 86 of file prop.c.

References assert(), NULL, SCIP_CALL, SCIP_DECL_PARAMCHGD, SCIP_OKAY, SCIPparamGetData(), SCIPparamGetInt(), and SCIPsetPropPresolPriority().

◆ SCIPpropCopyInclude()

SCIP_RETCODE SCIPpropCopyInclude	(	SCIP_PROP *	prop,
		SCIP_SET *	set )

copies the given propagator to a new scip

Parameters

prop	propagator
set	SCIP_SET of SCIP to copy to

Definition at line 100 of file prop.c.

References assert(), NULL, SCIP_CALL, SCIP_OKAY, SCIPpropCopyInclude(), SCIPpropGetName(), and SCIPsetDebugMsg.

Referenced by SCIPpropCopyInclude(), and SCIPsetCopyPlugins().

◆ doPropCreate()

SCIP_RETCODE doPropCreate	(	SCIP_PROP **	prop,
		SCIP_SET *	set,
		SCIP_MESSAGEHDLR *	messagehdlr,
		BMS_BLKMEM *	blkmem,
		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 )

static

internal method for creating a propagator

Parameters

prop	pointer to propagator data structure
set	global SCIP settings
messagehdlr	message handler
blkmem	block memory for parameter settings
name	name of propagator
desc	description of propagator
priority	priority of the propagator (>= 0: before, < 0: after constraint handlers)
freq	frequency for calling propagator
delay	should propagator be delayed, if other propagators found reductions?
timingmask	positions in the node solving loop where propagator should be executed
presolpriority	priority of the propagator (>= 0: before, < 0: after constraint handlers)
presolmaxrounds	maximal number of presolving rounds the propagator participates in (-1: no limit)
presoltiming	timing mask of the propagator's presolving method
-	copy method of propagator or NULL if you don't want to copy your plugin into sub-SCIPs
-	destructor of propagator
-	initialize propagator
-	deinitialize propagator
-	presolving initialization method of propagator
-	presolving deinitialization method of propagator
-	solving process initialization method of propagator
-	solving process deinitialization method of propagator
-	presolving method
-	execution method of propagator
-	propagation conflict resolving method
propdata	propagator data

Definition at line 119 of file prop.c.

References assert(), BMSallocMemory, BMSclearMemory, BMSduplicateMemoryArray, doPropCreate(), FALSE, NULL, SCIP_ALLOC, SCIP_Bool, SCIP_CALL, SCIP_CLOCKTYPE_DEFAULT, 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_MAXSTRLEN, SCIP_MAXTREEDEPTH, SCIP_OKAY, SCIP_PARAMETERWRONGVAL, SCIP_PRESOLTIMING_EXHAUSTIVE, SCIP_PRESOLTIMING_FAST, SCIP_PRESOLTIMING_FINAL, SCIP_PRESOLTIMING_MAX, SCIP_PRESOLTIMING_MEDIUM, SCIP_PRESOLTIMING_NONE, SCIP_PROPTIMING_AFTERLPLOOP, SCIP_PROPTIMING_ALWAYS, SCIP_PROPTIMING_BEFORELP, SCIP_PROPTIMING_DURINGLPLOOP, SCIP_PROPTIMING_NONE, SCIPclockCreate(), SCIPmessagePrintError(), SCIPsetAddBoolParam(), SCIPsetAddIntParam(), SCIPsnprintf(), and TRUE.

Referenced by doPropCreate(), and SCIPpropCreate().

◆ SCIPpropCreate()

SCIP_RETCODE SCIPpropCreate	(	SCIP_PROP **	prop,
		SCIP_SET *	set,
		SCIP_MESSAGEHDLR *	messagehdlr,
		BMS_BLKMEM *	blkmem,
		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

Parameters

prop	pointer to propagator data structure
set	global SCIP settings
messagehdlr	message handler
blkmem	block memory for parameter settings
name	name of propagator
desc	description of propagator
priority	priority of the propagator (>= 0: before, < 0: after constraint handlers)
freq	frequency for calling propagator
delay	should propagator be delayed, if other propagators found reductions?
timingmask	positions in the node solving loop where propagator should be executed
presolpriority	priority of the propagator (>= 0: before, < 0: after constraint handlers)
presolmaxrounds	maximal number of presolving rounds the propagator participates in (-1: no limit)
presoltiming	timing mask of the propagator's presolving method
-	copy method of propagator or NULL if you don't want to copy your plugin into sub-SCIPs
-	destructor of propagator
-	initialize propagator
-	deinitialize propagator
-	presolving initialization method of propagator
-	presolving deinitialization method of propagator
-	solving process initialization method of propagator
-	solving process deinitialization method of propagator
-	presolving method
-	execution method of propagator
-	propagation conflict resolving method
propdata	propagator data

Definition at line 243 of file prop.c.

References assert(), doPropCreate(), NULL, SCIP_Bool, SCIP_CALL_FINALLY, 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_OKAY, SCIPpropCreate(), and SCIPpropFree().

Referenced by SCIPincludeProp(), SCIPincludePropBasic(), and SCIPpropCreate().

◆ SCIPpropFree()

SCIP_RETCODE SCIPpropFree	(	SCIP_PROP **	prop,
		SCIP_SET *	set )

calls destructor and frees memory of propagator

Parameters

prop	pointer to propagator data structure
set	global SCIP settings

Definition at line 285 of file prop.c.

References assert(), BMSfreeMemory, BMSfreeMemoryArrayNull, NULL, SCIP_CALL, SCIP_OKAY, SCIPclockFree(), and SCIPpropFree().

Referenced by SCIPpropCreate(), and SCIPpropFree().

◆ SCIPpropInit()

SCIP_RETCODE SCIPpropInit	(	SCIP_PROP *	prop,
		SCIP_SET *	set )

initializes propagator

Parameters

prop	propagator
set	global SCIP settings

Definition at line 315 of file prop.c.

References assert(), FALSE, SCIP_Prop::initialized, SCIP_Prop::lastnaddconss, SCIP_Prop::lastnaddholes, SCIP_Prop::lastnaggrvars, SCIP_Prop::lastnchgbds, SCIP_Prop::lastnchgcoefs, SCIP_Prop::lastnchgsides, SCIP_Prop::lastnchgvartypes, SCIP_Prop::lastndelconss, SCIP_Prop::lastnfixedvars, SCIP_Prop::lastnupgdconss, SCIP_Prop::naddconss, SCIP_Prop::naddholes, SCIP_Prop::naggrvars, SCIP_Prop::name, SCIP_Prop::ncalls, SCIP_Prop::nchgbds, SCIP_Prop::nchgcoefs, SCIP_Prop::nchgsides, SCIP_Prop::nchgvartypes, SCIP_Prop::ncutoffs, SCIP_Prop::ndelconss, SCIP_Prop::ndomredsfound, SCIP_Prop::nfixedvars, SCIP_Prop::npresolcalls, SCIP_Prop::nrespropcalls, NULL, SCIP_Prop::nupgdconss, SCIP_Prop::presoltime, SCIP_Prop::proptime, SCIP_Prop::resproptime, SCIP_Prop::sbproptime, SCIP_CALL, SCIP_INVALIDCALL, SCIP_OKAY, SCIPclockReset(), SCIPclockStart(), SCIPclockStop(), SCIPerrorMessage, SCIPpropInit(), SCIP_Prop::setuptime, TRUE, and SCIP_Prop::wasdelayed.

Referenced by SCIPpropInit().

◆ SCIPpropExit()

SCIP_RETCODE SCIPpropExit	(	SCIP_PROP *	prop,
		SCIP_SET *	set )

calls exit method of propagator

Parameters

prop	propagator
set	global SCIP settings

Definition at line 381 of file prop.c.

References assert(), FALSE, SCIP_Prop::initialized, SCIP_Prop::name, NULL, SCIP_CALL, SCIP_INVALIDCALL, SCIP_OKAY, SCIPclockStart(), SCIPclockStop(), SCIPerrorMessage, SCIPpropExit(), and SCIP_Prop::setuptime.

Referenced by SCIPpropExit().

◆ SCIPpropInitpre()

SCIP_RETCODE SCIPpropInitpre	(	SCIP_PROP *	prop,
		SCIP_SET *	set )

informs propagator that the presolving process is being started

Parameters

prop	propagator
set	global SCIP settings

Definition at line 411 of file prop.c.

References assert(), FALSE, SCIP_Prop::lastnaddconss, SCIP_Prop::lastnaddholes, SCIP_Prop::lastnaggrvars, SCIP_Prop::lastnchgbds, SCIP_Prop::lastnchgcoefs, SCIP_Prop::lastnchgsides, SCIP_Prop::lastnchgvartypes, SCIP_Prop::lastndelconss, SCIP_Prop::lastnfixedvars, SCIP_Prop::lastnupgdconss, NULL, SCIP_CALL, SCIP_OKAY, SCIPclockStart(), SCIPclockStop(), SCIPpropInitpre(), SCIP_Prop::setuptime, and SCIP_Prop::wasdelayed.

Referenced by SCIPpropInitpre().

◆ SCIPpropExitpre()

SCIP_RETCODE SCIPpropExitpre	(	SCIP_PROP *	prop,
		SCIP_SET *	set )

informs propagator that the presolving process is finished

informs propagator that the presolving is finished

Parameters

prop	propagator
set	global SCIP settings

Definition at line 447 of file prop.c.

References assert(), NULL, SCIP_CALL, SCIP_OKAY, SCIPclockStart(), SCIPclockStop(), SCIPpropExitpre(), and SCIP_Prop::setuptime.

Referenced by SCIPpropExitpre().

◆ SCIPpropInitsol()

SCIP_RETCODE SCIPpropInitsol	(	SCIP_PROP *	prop,
		SCIP_SET *	set )

informs propagator that the prop and bound process is being started

informs propagator that the branch and bound process is being started

Parameters

prop	propagator
set	global SCIP settings

Definition at line 471 of file prop.c.

References assert(), NULL, SCIP_CALL, SCIP_OKAY, SCIPclockStart(), SCIPclockStop(), SCIPpropInitsol(), and SCIP_Prop::setuptime.

Referenced by SCIPpropInitsol().

◆ SCIPpropExitsol()

SCIP_RETCODE SCIPpropExitsol	(	SCIP_PROP *	prop,
		SCIP_SET *	set,
		SCIP_Bool	restart )

informs propagator that the prop and bound process data is being freed

informs propagator that the branch and bound process data is being freed

Parameters

prop	propagator
set	global SCIP settings
restart	was this exit solve call triggered by a restart?

Definition at line 495 of file prop.c.

References assert(), NULL, SCIP_Bool, SCIP_CALL, SCIP_OKAY, SCIPclockStart(), SCIPclockStop(), SCIPpropExitsol(), and SCIP_Prop::setuptime.

Referenced by SCIPpropExitsol().

◆ SCIPpropPresol()

SCIP_RETCODE SCIPpropPresol	(	SCIP_PROP *	prop,
		SCIP_SET *	set,
		SCIP_PRESOLTIMING	timing,
		int	nrounds,
		int *	nfixedvars,
		int *	naggrvars,
		int *	nchgvartypes,
		int *	nchgbds,
		int *	naddholes,
		int *	ndelconss,
		int *	naddconss,
		int *	nupgdconss,
		int *	nchgcoefs,
		int *	nchgsides,
		SCIP_RESULT *	result )

executes presolving method of propagator

Parameters

prop	propagator
set	global SCIP settings
timing	current presolving timing
nrounds	number of presolving rounds already done
nfixedvars	pointer to total number of variables fixed of all presolvers
naggrvars	pointer to total number of variables aggregated of all presolvers
nchgvartypes	pointer to total number of variable type changes of all presolvers
nchgbds	pointer to total number of variable bounds tightened of all presolvers
naddholes	pointer to total number of domain holes added of all presolvers
ndelconss	pointer to total number of deleted constraints of all presolvers
naddconss	pointer to total number of added constraints of all presolvers
nupgdconss	pointer to total number of upgraded constraints of all presolvers
nchgcoefs	pointer to total number of changed coefficients of all presolvers
nchgsides	pointer to total number of changed left/right hand sides of all presolvers
result	pointer to store the result of the callback method

Definition at line 520 of file prop.c.

References assert(), SCIP_Prop::exact, SCIP_Prop::lastnaddconss, SCIP_Prop::lastnaddholes, SCIP_Prop::lastnaggrvars, SCIP_Prop::lastnchgbds, SCIP_Prop::lastnchgcoefs, SCIP_Prop::lastnchgsides, SCIP_Prop::lastnchgvartypes, SCIP_Prop::lastndelconss, SCIP_Prop::lastnfixedvars, SCIP_Prop::lastnupgdconss, SCIP_Prop::maxprerounds, SCIP_Prop::naddconss, SCIP_Prop::naddholes, SCIP_Prop::naggrvars, SCIP_Prop::name, SCIP_Prop::nchgbds, SCIP_Prop::nchgcoefs, SCIP_Prop::nchgsides, SCIP_Prop::nchgvartypes, SCIP_Prop::ndelconss, SCIP_Prop::nfixedvars, SCIP_Prop::npresolcalls, NULL, SCIP_Prop::nupgdconss, SCIP_Prop::presoltime, SCIP_Prop::presoltiming, result, SCIP_CALL, SCIP_CUTOFF, SCIP_DIDNOTFIND, SCIP_DIDNOTRUN, SCIP_INVALIDRESULT, SCIP_OKAY, SCIP_SUCCESS, SCIP_UNBOUNDED, SCIPclockStart(), SCIPclockStop(), SCIPerrorMessage, SCIPpropPresol(), and SCIPsetDebugMsg.

Referenced by presolveRound(), and SCIPpropPresol().

◆ SCIPpropExec()

SCIP_RETCODE SCIPpropExec	(	SCIP_PROP *	prop,
		SCIP_SET *	set,
		SCIP_STAT *	stat,
		int	depth,
		SCIP_Bool	execdelayed,
		SCIP_Bool	instrongbranching,
		SCIP_PROPTIMING	proptiming,
		SCIP_RESULT *	result )

calls execution method of propagator

Parameters

prop	propagator
set	global SCIP settings
stat	dynamic problem statistics
depth	depth of current node
execdelayed	execute propagator even if it is marked to be delayed
instrongbranching	are we currently doing strong branching?
proptiming	current point in the node solving process
result	pointer to store the result of the callback method

Definition at line 646 of file prop.c.

References assert(), SCIP_Prop::delay, depth, SCIP_Prop::exact, SCIP_Prop::freq, SCIP_Prop::name, SCIP_Stat::nboundchgs, SCIP_Prop::ncalls, SCIP_Prop::ncutoffs, SCIP_Prop::ndomredsfound, SCIP_Stat::nholechgs, SCIP_Stat::nprobboundchgs, SCIP_Stat::nprobholechgs, NULL, SCIP_Prop::proptime, result, SCIP_Prop::sbproptime, SCIP_Bool, SCIP_CALL, SCIP_CUTOFF, SCIP_DELAYED, SCIP_DELAYNODE, SCIP_DIDNOTFIND, SCIP_DIDNOTRUN, SCIP_INVALIDRESULT, SCIP_Longint, SCIP_OKAY, SCIP_REDUCEDDOM, SCIPclockStart(), SCIPclockStop(), SCIPerrorMessage, SCIPpropExec(), SCIPsetDebugMsg, and SCIP_Prop::wasdelayed.

Referenced by propagationRound(), and SCIPpropExec().

◆ SCIPpropResolvePropagation()

SCIP_RETCODE SCIPpropResolvePropagation	(	SCIP_PROP *	prop,
		SCIP_SET *	set,
		SCIP_VAR *	infervar,
		int	inferinfo,
		SCIP_BOUNDTYPE	inferboundtype,
		SCIP_BDCHGIDX *	bdchgidx,
		SCIP_Real	relaxedbd,
		SCIP_RESULT *	result )

resolves the given conflicting bound, that was deduced by the given propagator, by putting all "reason" bounds leading to the deduction into the conflict queue with calls to SCIPaddConflictLb(), SCIPaddConflictUb(), SCIPaddConflictBd(), SCIPaddConflictRelaxedLb(), SCIPaddConflictRelaxedUb(), SCIPaddConflictRelaxedBd(), or SCIPaddConflictBinvar();

Note: it is sufficient to explain the relaxed bound change

Parameters

prop	propagator
set	global SCIP settings
infervar	variable whose bound was deduced by the constraint
inferinfo	user inference information attached to the bound change
inferboundtype	bound that was deduced (lower or upper bound)
bdchgidx	bound change index, representing the point of time where change took place
relaxedbd	the relaxed bound
result	pointer to store the result of the callback method

Definition at line 739 of file prop.c.

References assert(), SCIP_Prop::name, SCIP_Prop::nrespropcalls, NULL, SCIP_Prop::resproptime, result, SCIP_BOUNDTYPE_LOWER, SCIP_BOUNDTYPE_UPPER, SCIP_CALL, SCIP_DIDNOTFIND, SCIP_DIDNOTRUN, SCIP_INVALIDRESULT, SCIP_OKAY, SCIP_PLUGINNOTFOUND, SCIP_Real, SCIP_SUCCESS, SCIPclockStart(), SCIPclockStop(), SCIPerrorMessage, SCIPgetVarLbAtIndex(), SCIPgetVarUbAtIndex(), SCIPpropResolvePropagation(), SCIPvarGetLbGlobal(), SCIPvarGetUbGlobal(), and TRUE.

Referenced by conflictResolveBound(), and SCIPpropResolvePropagation().

◆ SCIPpropSetCopy()

void SCIPpropSetCopy ( SCIP_PROP * prop )

sets copy method of propagator

Parameters

prop	propagator copy method of propagator or NULL if you don't want to copy your plugin into sub-SCIPs

Definition at line 812 of file prop.c.

References assert(), NULL, SCIP_DECL_PROPCOPY, and SCIPpropSetCopy().

Referenced by SCIPpropSetCopy(), and SCIPsetPropCopy().

◆ SCIPpropSetFree()

void SCIPpropSetFree ( SCIP_PROP * prop )

sets destructor method of propagator

Parameters

prop	propagator destructor of propagator

Definition at line 823 of file prop.c.

References assert(), NULL, SCIP_DECL_PROPFREE, and SCIPpropSetFree().

Referenced by SCIPpropSetFree(), and SCIPsetPropFree().

◆ SCIPpropSetInit()

void SCIPpropSetInit ( SCIP_PROP * prop )

sets initialization method of propagator

Parameters

prop	propagator initialize propagator

Definition at line 834 of file prop.c.

References assert(), NULL, SCIP_DECL_PROPINIT, and SCIPpropSetInit().

Referenced by SCIPpropSetInit(), and SCIPsetPropInit().

◆ SCIPpropSetExit()

void SCIPpropSetExit ( SCIP_PROP * prop )

sets deinitialization method of propagator

Parameters

prop	propagator deinitialize propagator

Definition at line 845 of file prop.c.

References assert(), NULL, SCIP_DECL_PROPEXIT, and SCIPpropSetExit().

Referenced by SCIPpropSetExit(), and SCIPsetPropExit().

◆ SCIPpropSetInitsol()

void SCIPpropSetInitsol ( SCIP_PROP * prop )

sets solving process initialization method of propagator

Parameters

prop	propagator solving process initialization method of propagator

Definition at line 856 of file prop.c.

References assert(), NULL, SCIP_DECL_PROPINITSOL, and SCIPpropSetInitsol().

Referenced by SCIPpropSetInitsol(), and SCIPsetPropInitsol().

◆ SCIPpropSetExitsol()

void SCIPpropSetExitsol ( SCIP_PROP * prop )

sets solving process deinitialization method of propagator

Parameters

prop	propagator solving process deinitialization method of propagator

Definition at line 867 of file prop.c.

References assert(), NULL, SCIP_DECL_PROPEXITSOL, and SCIPpropSetExitsol().

Referenced by SCIPpropSetExitsol(), and SCIPsetPropExitsol().

◆ SCIPpropSetInitpre()

void SCIPpropSetInitpre ( SCIP_PROP * prop )

sets preprocessing initialization method of propagator

Parameters

prop	propagator preprocessing initialization method of propagator

Definition at line 878 of file prop.c.

References assert(), NULL, SCIP_DECL_PROPINITPRE, and SCIPpropSetInitpre().

Referenced by SCIPpropSetInitpre(), and SCIPsetPropInitpre().

◆ SCIPpropSetExitpre()

void SCIPpropSetExitpre ( SCIP_PROP * prop )

sets preprocessing deinitialization method of propagator

Parameters

prop	propagator preprocessing deinitialization method of propagator

Definition at line 889 of file prop.c.

References assert(), NULL, SCIP_DECL_PROPEXITPRE, and SCIPpropSetExitpre().

Referenced by SCIPpropSetExitpre(), and SCIPsetPropExitpre().

◆ SCIPpropSetPresol()

SCIP_RETCODE SCIPpropSetPresol	(	SCIP_PROP *	prop,
		SCIP_DECL_PROPPRESOL((*proppresol))	,
		int	presolpriority,
		int	presolmaxrounds,
		SCIP_PRESOLTIMING	presoltiming )

sets presolving method of propagator

Parameters

prop	propagator
-	presolving method
presolpriority	presolving priority of the propagator (>= 0: before, < 0: after constraint handlers)
presolmaxrounds	maximal number of presolving rounds the propagator participates in (-1: no limit)
presoltiming	timing mask of the propagator's presolving method

Definition at line 900 of file prop.c.

References assert(), SCIP_Prop::maxprerounds, SCIP_Prop::name, NULL, SCIP_Prop::presolpriority, SCIP_Prop::presoltiming, SCIP_DECL_PROPPRESOL, SCIP_OKAY, SCIP_PARAMETERWRONGVAL, SCIP_PRESOLTIMING_MAX, SCIPmessagePrintError(), and SCIPpropSetPresol().

Referenced by SCIPpropSetPresol(), and SCIPsetPropPresol().

◆ SCIPpropSetResprop()

void SCIPpropSetResprop ( SCIP_PROP * prop )

sets propagation conflict resolving callback of propagator

Parameters

prop	propagator propagation conflict resolving callback

Definition at line 930 of file prop.c.

References assert(), NULL, SCIP_DECL_PROPRESPROP, and SCIPpropSetResprop().

Referenced by SCIPpropSetResprop(), and SCIPsetPropResprop().

◆ SCIPpropSetPriority()

void SCIPpropSetPriority	(	SCIP_PROP *	prop,
		SCIP_SET *	set,
		int	priority )

sets priority of propagator

Parameters

prop	propagator
set	global SCIP settings
priority	new priority of the propagator

Definition at line 991 of file prop.c.

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

Referenced by SCIPpropSetPriority(), and SCIPsetPropPriority().

◆ SCIPpropSetPresolPriority()

void SCIPpropSetPresolPriority	(	SCIP_PROP *	prop,
		SCIP_SET *	set,
		int	presolpriority )

sets presolving priority of propagator

Parameters

prop	propagator
set	global SCIP settings
presolpriority	new priority of the propagator

Definition at line 1005 of file prop.c.

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

Referenced by SCIPpropSetPresolPriority(), and SCIPsetPropPresolPriority().

◆ SCIPpropEnableOrDisableClocks()

void SCIPpropEnableOrDisableClocks	(	SCIP_PROP *	prop,
		SCIP_Bool	enable )

enables or disables all clocks of prop, depending on the value of the flag

Parameters

prop	the propagator for which all clocks should be enabled or disabled
enable	should the clocks of the propagator be enabled?

Definition at line 1029 of file prop.c.

References assert(), NULL, SCIP_Prop::presoltime, SCIP_Prop::proptime, SCIP_Prop::resproptime, SCIP_Prop::sbproptime, SCIP_Bool, SCIPclockEnableOrDisable(), SCIPpropEnableOrDisableClocks(), and SCIP_Prop::setuptime.

Referenced by SCIPpropEnableOrDisableClocks().

Detailed Description

Functions

Function Documentation

◆ SCIP_DECL_PARAMCHGD() [1/2]

◆ SCIP_DECL_PARAMCHGD() [2/2]

◆ SCIPpropCopyInclude()

◆ doPropCreate()

◆ SCIPpropCreate()

◆ SCIPpropFree()

◆ SCIPpropInit()

◆ SCIPpropExit()

◆ SCIPpropInitpre()

◆ SCIPpropExitpre()

◆ SCIPpropInitsol()

◆ SCIPpropExitsol()

◆ SCIPpropPresol()

◆ SCIPpropExec()

◆ SCIPpropResolvePropagation()

◆ SCIPpropSetCopy()

◆ SCIPpropSetFree()

◆ SCIPpropSetInit()

◆ SCIPpropSetExit()

◆ SCIPpropSetInitsol()

◆ SCIPpropSetExitsol()

◆ SCIPpropSetInitpre()

◆ SCIPpropSetExitpre()

◆ SCIPpropSetPresol()

◆ SCIPpropSetResprop()

◆ SCIPpropSetPriority()

◆ SCIPpropSetPresolPriority()

◆ SCIPpropEnableOrDisableClocks()