prop.h File Reference

Detailed Description

internal methods for propagators

Author

Tobias Achterberg

Definition in file prop.h.

#include "scip/def.h"
#include "blockmemshell/memory.h"
#include "scip/type_retcode.h"
#include "scip/type_result.h"
#include "scip/type_set.h"
#include "scip/type_stat.h"
#include "scip/type_lp.h"
#include "scip/type_var.h"
#include "scip/type_prop.h"
#include "scip/pub_prop.h"

Go to the source code of this file.

Functions
SCIP_RETCODE	SCIPpropCopyInclude (SCIP_PROP *prop, SCIP_SET *set)
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_Bool presoldelay, 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_Bool execdelayed, 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)
void	SCIPpropSetPriority (SCIP_PROP *prop, SCIP_SET *set, int priority)
void	SCIPpropSetPresolPriority (SCIP_PROP *prop, SCIP_SET *set, int presolpriority)
void	SCIPpropSetCopy (SCIP_PROP *prop, SCIP_DECL_PROPCOPY((*propcopy)))
void	SCIPpropSetFree (SCIP_PROP *prop, SCIP_DECL_PROPFREE((*propfree)))
void	SCIPpropSetInit (SCIP_PROP *prop, SCIP_DECL_PROPINIT((*propinit)))
void	SCIPpropSetExit (SCIP_PROP *prop, SCIP_DECL_PROPEXIT((*propexit)))
void	SCIPpropSetInitsol (SCIP_PROP *prop, SCIP_DECL_PROPINITSOL((*propinitsol)))
void	SCIPpropSetExitsol (SCIP_PROP *prop, SCIP_DECL_PROPEXITSOL((*propexitsol)))
void	SCIPpropSetInitpre (SCIP_PROP *prop, SCIP_DECL_PROPINITPRE((*propinitpre)))
void	SCIPpropSetExitpre (SCIP_PROP *prop, SCIP_DECL_PROPEXITPRE((*propexitpre)))
void	SCIPpropSetPresol (SCIP_PROP *prop, SCIP_DECL_PROPPRESOL((*proppresol)), int presolpriority, int presolmaxrounds, SCIP_Bool presoldelay)
void	SCIPpropSetResprop (SCIP_PROP *prop, SCIP_DECL_PROPRESPROP((*propresprop)))

Function Documentation

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

References NULL, SCIP_CALL, SCIP_OKAY, SCIPdebugMessage, and SCIPpropGetName().

Referenced by SCIPsetCopyPlugins().

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_Bool	presoldelay,
		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 heuristic 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)
presoldelay	should presolving be delayed, if other presolvers found reductions?
propdata	propagator data

Definition at line 109 of file prop.c.

References BMSallocMemory, BMSduplicateMemoryArray, FALSE, NULL, paramname, SCIP_ALLOC, SCIP_CALL, SCIP_CLOCKTYPE_DEFAULT, SCIP_MAXSTRLEN, SCIP_OKAY, SCIP_PROPTIMING_AFTERLPLOOP, SCIP_PROPTIMING_ALWAYS, SCIP_PROPTIMING_BEFORELP, SCIP_PROPTIMING_DURINGLPLOOP, SCIPclockCreate(), SCIPsetAddBoolParam(), SCIPsetAddIntParam(), SCIPsnprintf(), and TRUE.

Referenced by SCIPincludeProp(), and SCIPincludePropBasic().

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

References BMSfreeMemory, BMSfreeMemoryArray, NULL, SCIP_CALL, SCIP_OKAY, and SCIPclockFree().

Referenced by SCIPsetFree().

SCIP_RETCODE SCIPpropInit	(	SCIP_PROP *	prop,
		SCIP_SET *	set
	)

initializes propagator

Parameters

prop	propagator
set	global SCIP settings

Definition at line 247 of file prop.c.

References 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::presolwasdelayed, SCIP_Prop::proptime, SCIP_Prop::resproptime, SCIP_Prop::sbproptime, SCIP_CALL, SCIP_INVALIDCALL, SCIP_OKAY, SCIPclockReset(), SCIPclockStart(), SCIPclockStop(), SCIPerrorMessage, SCIP_Prop::setuptime, TRUE, and SCIP_Prop::wasdelayed.

Referenced by SCIPsetInitPlugins().

SCIP_RETCODE SCIPpropExit	(	SCIP_PROP *	prop,
		SCIP_SET *	set
	)

calls exit method of propagator

Parameters

prop	propagator
set	global SCIP settings

Definition at line 314 of file prop.c.

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

Referenced by SCIPsetExitPlugins().

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

References 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_Prop::presolwasdelayed, SCIP_CALL, SCIP_OKAY, SCIPclockStart(), SCIPclockStop(), SCIP_Prop::setuptime, and SCIP_Prop::wasdelayed.

Referenced by SCIPsetInitprePlugins().

SCIP_RETCODE SCIPpropExitpre	(	SCIP_PROP *	prop,
		SCIP_SET *	set
	)

informs propagator that the presolving is finished

informs propagator that the presolving process is finished

Parameters

prop	propagator
set	global SCIP settings

Definition at line 381 of file prop.c.

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

Referenced by SCIPsetExitprePlugins().

SCIP_RETCODE SCIPpropInitsol	(	SCIP_PROP *	prop,
		SCIP_SET *	set
	)

informs propagator that the branch and bound process is being started

informs propagator that the prop and bound process is being started

Parameters

prop	propagator
set	global SCIP settings

Definition at line 405 of file prop.c.

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

Referenced by SCIPsetInitsolPlugins().

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

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

informs propagator that the prop 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 429 of file prop.c.

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

Referenced by SCIPsetExitsolPlugins().

SCIP_RETCODE SCIPpropPresol	(	SCIP_PROP *	prop,
		SCIP_SET *	set,
		SCIP_Bool	execdelayed,
		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
execdelayed	execute presolving even if it is marked to be delayed
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 454 of file prop.c.

References 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::presoldelay, SCIP_Prop::presoltime, SCIP_Prop::presolwasdelayed, SCIP_CALL, SCIP_CUTOFF, SCIP_DELAYED, SCIP_DIDNOTFIND, SCIP_DIDNOTRUN, SCIP_INVALIDRESULT, SCIP_OKAY, SCIP_SUCCESS, SCIP_UNBOUNDED, SCIPclockStart(), SCIPclockStop(), SCIPdebugMessage, and SCIPerrorMessage.

Referenced by presolveRound().

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

References SCIP_Prop::delay, 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, SCIP_Prop::sbproptime, SCIP_CALL, SCIP_CUTOFF, SCIP_DELAYED, SCIP_DIDNOTFIND, SCIP_DIDNOTRUN, SCIP_INVALIDRESULT, SCIP_Longint, SCIP_OKAY, SCIP_REDUCEDDOM, SCIPclockStart(), SCIPclockStop(), SCIPdebugMessage, SCIPerrorMessage, and SCIP_Prop::wasdelayed.

Referenced by propagationRound().

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

References SCIP_Prop::name, SCIP_Prop::nrespropcalls, NULL, SCIP_Prop::resproptime, SCIP_BOUNDTYPE_LOWER, SCIP_BOUNDTYPE_UPPER, SCIP_CALL, SCIP_DIDNOTFIND, SCIP_DIDNOTRUN, SCIP_INVALIDRESULT, SCIP_OKAY, SCIP_PLUGINNOTFOUND, SCIP_SUCCESS, SCIPclockStart(), SCIPclockStop(), SCIPerrorMessage, SCIPvarGetLbAtIndex(), SCIPvarGetLbGlobal(), SCIPvarGetUbAtIndex(), SCIPvarGetUbGlobal(), and TRUE.

Referenced by conflictResolveBound().

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

References FALSE, NULL, and SCIP_Prop::priority.

Referenced by SCIPsetPropPriority().

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

References FALSE, NULL, and SCIP_Prop::presolpriority.

Referenced by SCIPsetPropPresolPriority().

void SCIPpropSetCopy	(	SCIP_PROP *	prop,
		SCIP_DECL_PROPCOPY((*propcopy))
	)

sets copy method of propagator

Parameters

prop	propagator

Definition at line 754 of file prop.c.

References NULL.

Referenced by SCIPsetPropCopy().

void SCIPpropSetFree	(	SCIP_PROP *	prop,
		SCIP_DECL_PROPFREE((*propfree))
	)

sets destructor method of propagator

Parameters

prop	propagator

Definition at line 765 of file prop.c.

References NULL.

Referenced by SCIPsetPropFree().

void SCIPpropSetInit	(	SCIP_PROP *	prop,
		SCIP_DECL_PROPINIT((*propinit))
	)

sets initialization method of propagator

Parameters

prop	propagator

Definition at line 776 of file prop.c.

References NULL.

Referenced by SCIPsetPropInit().

void SCIPpropSetExit	(	SCIP_PROP *	prop,
		SCIP_DECL_PROPEXIT((*propexit))
	)

sets deinitialization method of propagator

Parameters

prop	propagator

Definition at line 787 of file prop.c.

References NULL.

Referenced by SCIPsetPropExit().

void SCIPpropSetInitsol	(	SCIP_PROP *	prop,
		SCIP_DECL_PROPINITSOL((*propinitsol))
	)

sets solving process initialization method of propagator

Parameters

prop	propagator

Definition at line 798 of file prop.c.

References NULL.

Referenced by SCIPsetPropInitsol().

void SCIPpropSetExitsol	(	SCIP_PROP *	prop,
		SCIP_DECL_PROPEXITSOL((*propexitsol))
	)

sets solving process deinitialization method of propagator

Parameters

prop	propagator

Definition at line 809 of file prop.c.

References NULL.

Referenced by SCIPsetPropExitsol().

void SCIPpropSetInitpre	(	SCIP_PROP *	prop,
		SCIP_DECL_PROPINITPRE((*propinitpre))
	)

sets preprocessing initialization method of propagator

Parameters

prop	propagator

Definition at line 820 of file prop.c.

References NULL.

Referenced by SCIPsetPropInitpre().

void SCIPpropSetExitpre	(	SCIP_PROP *	prop,
		SCIP_DECL_PROPEXITPRE((*propexitpre))
	)

sets preprocessing deinitialization method of propagator

Parameters

prop	propagator

Definition at line 833 of file prop.c.

References NULL.

Referenced by SCIPsetPropExitpre().

void SCIPpropSetPresol	(	SCIP_PROP *	prop,
		SCIP_DECL_PROPPRESOL((*proppresol))	,
		int	presolpriority,
		int	presolmaxrounds,
		SCIP_Bool	presoldelay
	)

sets presolving method of propagator

Parameters

prop	propagator
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)
presoldelay	should presolving be delayed, if other presolvers found reductions?

Definition at line 844 of file prop.c.

References SCIP_Prop::maxprerounds, NULL, SCIP_Prop::presoldelay, and SCIP_Prop::presolpriority.

Referenced by SCIPsetPropPresol().

void SCIPpropSetResprop	(	SCIP_PROP *	prop,
		SCIP_DECL_PROPRESPROP((*propresprop))
	)

sets propagation conflict resolving callback of propagator

Parameters

prop	propagator

Definition at line 861 of file prop.c.

References NULL.

Referenced by SCIPsetPropResprop().