Detailed Description

constraint handler for indicator constraints over arbitrary constraint types

Author: Ambros Gleixner; Frederic Pythoud

Superindicator constraints are constraints of the form

$x_i = 1 \Rightarrow C(x)$

where $ x_i $ is a binary variable and $C(\dot)$ a constraint. The superindicator constraint is satisfied if and only if x_i is zero or C is satisfied.

Definition in file cons_superindicator.h.

#include "scip/scip.h"

Go to the source code of this file.

Functions
SCIP_RETCODE	SCIPincludeConshdlrSuperindicator (SCIP *scip)

SCIP_RETCODE	SCIPcreateConsSuperindicator (SCIP scip, SCIP_CONS cons, const char name, SCIP_VAR binvar, SCIP_CONS slackcons, SCIP_Bool initial, SCIP_Bool separate, SCIP_Bool enforce, SCIP_Bool check, SCIP_Bool propagate, SCIP_Bool local, SCIP_Bool dynamic, SCIP_Bool removable, SCIP_Bool stickingatnode)

SCIP_RETCODE	SCIPcreateConsBasicSuperindicator (SCIP scip, SCIP_CONS cons, const char name, SCIP_VAR binvar, SCIP_CONS slackcons)

SCIP_VAR *	SCIPgetBinaryVarSuperindicator (SCIP_CONS *cons)

SCIP_CONS *	SCIPgetSlackConsSuperindicator (SCIP_CONS *cons)

SCIP_RETCODE	SCIPtransformMinUC (SCIP scip, SCIP_Bool success)

	SCIP_DECL_DIALOGEXEC (SCIPdialogExecChangeMinUC)

Function Documentation

SCIP_RETCODE SCIPincludeConshdlrSuperindicator ( SCIP * scip )

creates the handler for superindicator constraints and includes it in SCIP

Parameters

scip	SCIP data structure

Definition at line 1853 of file cons_superindicator.c.

References CONSHDLR_CHECKPRIORITY, CONSHDLR_DELAYPRESOL, CONSHDLR_DELAYPROP, CONSHDLR_DELAYSEPA, CONSHDLR_DESC, CONSHDLR_EAGERFREQ, CONSHDLR_ENFOPRIORITY, CONSHDLR_MAXPREROUNDS, CONSHDLR_NAME, CONSHDLR_NEEDSCONS, CONSHDLR_PROP_TIMING, CONSHDLR_PROPFREQ, CONSHDLR_SEPAFREQ, CONSHDLR_SEPAPRIORITY, DEFAULT_CHECKSLACKTYPE, DEFAULT_MAXUPGDCOEFLINEAR, DEFAULT_UPGDPRIOINDICATOR, DEFAULT_UPGDPRIOLINEAR, FALSE, NULL, SCIP_CALL, SCIP_OKAY, SCIP_PLUGINNOTFOUND, SCIPaddBoolParam(), SCIPaddDialogEntry(), SCIPaddIntParam(), SCIPaddRealParam(), SCIPallocMemory, SCIPdialogFindEntry(), SCIPdialogHasEntry(), SCIPerrorMessage, SCIPgetRootDialog(), SCIPincludeConshdlrBasic(), SCIPincludeDialog(), SCIPincludeDialogDefault(), SCIPreleaseDialog(), SCIPsetConshdlrCopy(), SCIPsetConshdlrDelete(), SCIPsetConshdlrFree(), SCIPsetConshdlrGetNVars(), SCIPsetConshdlrGetVars(), SCIPsetConshdlrInitlp(), SCIPsetConshdlrInitpre(), SCIPsetConshdlrParse(), SCIPsetConshdlrPresol(), SCIPsetConshdlrPrint(), SCIPsetConshdlrProp(), SCIPsetConshdlrResprop(), SCIPsetConshdlrSepa(), SCIPsetConshdlrTrans(), and TRUE.

Referenced by SCIP_DECL_CONSHDLRCOPY(), and SCIPincludeDefaultPlugins().

SCIP_RETCODE SCIPcreateConsSuperindicator	(	SCIP *	scip,
		SCIP_CONS **	cons,
		const char *	name,
		SCIP_VAR *	binvar,
		SCIP_CONS *	slackcons,
		SCIP_Bool	initial,
		SCIP_Bool	separate,
		SCIP_Bool	enforce,
		SCIP_Bool	check,
		SCIP_Bool	propagate,
		SCIP_Bool	local,
		SCIP_Bool	dynamic,
		SCIP_Bool	removable,
		SCIP_Bool	stickingatnode
	)

creates and captures a superindicator constraint

Note: the constraint gets captured, hence at one point you have to release it using the method SCIPreleaseCons()

Parameters

scip	SCIP data structure
cons	pointer to hold the created constraint
name	name of constraint
binvar	pointer to the indicator constraint
slackcons	constraint corresponding to the handled constraint
initial	should the LP relaxation of constraint be in the initial LP? Usually set to TRUE. Set to FALSE for 'lazy constraints'.
separate	should the constraint be separated during LP processing? Usually set to TRUE.
enforce	should the constraint be enforced during node processing? TRUE for model constraints, FALSE for additional, redundant constraints.
check	should the constraint be checked for feasibility? TRUE for model constraints, FALSE for additional, redundant constraints.
propagate	should the constraint be propagated during node processing? Usually set to TRUE.
local	is constraint only valid locally? Usually set to FALSE. Has to be set to TRUE, e.g., for branching constraints.
dynamic	is constraint subject to aging? Usually set to FALSE. Set to TRUE for own cuts which are separated as constraints.
removable	should the relaxation be removed from the LP due to aging or cleanup? Usually set to FALSE. Set to TRUE for 'lazy constraints' and 'user cuts'.
stickingatnode	should the constraint always be kept at the node where it was added, even if it may be moved to a more global node? Usually set to FALSE. Set to TRUE to for constraints that represent node data.

Definition at line 1955 of file cons_superindicator.c.

References consdataCreateSuperindicator(), CONSHDLR_NAME, FALSE, NULL, SCIP_Bool, SCIP_CALL, SCIP_INVALIDCALL, SCIP_OKAY, SCIP_PLUGINNOTFOUND, SCIPconsGetHdlr(), SCIPconsGetName(), SCIPconshdlrGetData(), SCIPconshdlrGetName(), SCIPcreateCons(), SCIPerrorMessage, SCIPfindConshdlr(), and SCIPwarningMessage().

Referenced by SCIP_DECL_CONSCOPY(), SCIP_DECL_CONSPARSE(), SCIPcreateConsBasicSuperindicator(), and SCIPtransformMinUC().

SCIP_RETCODE SCIPcreateConsBasicSuperindicator	(	SCIP *	scip,
		SCIP_CONS **	cons,
		const char *	name,
		SCIP_VAR *	binvar,
		SCIP_CONS *	slackcons
	)

creates and captures a superindicator constraint in its most basic version, i. e., all constraint flags are set to their basic value as explained for the method SCIPcreateConsSuperindicator(); all flags can be set via SCIPsetConsFLAGNAME-methods in scip.h

See Also: SCIPcreateConsSuperindicator() for information about the basic constraint flag configuration

Note: the constraint gets captured, hence at one point you have to release it using the method SCIPreleaseCons()

Parameters

scip	SCIP data structure
cons	pointer to hold the created constraint
name	name of constraint
binvar	pointer to the indicator constraint
slackcons	constraint corresponding to the handled constraint

Definition at line 2066 of file cons_superindicator.c.

References FALSE, NULL, SCIP_CALL, SCIP_OKAY, SCIPcreateConsSuperindicator(), and TRUE.

SCIP_VAR* SCIPgetBinaryVarSuperindicator ( SCIP_CONS * cons )

gets binary variable corresponding to the superindicator constraint

gets binary variable corresponding to the general indicator constraint

Parameters

cons	superindicator constraint

Definition at line 2088 of file cons_superindicator.c.

References CONSHDLR_NAME, NULL, SCIPconsGetData(), SCIPconsGetHdlr(), and SCIPconshdlrGetName().

SCIP_CONS* SCIPgetSlackConsSuperindicator ( SCIP_CONS * cons )

gets the slack constraint corresponding to the superindicator constraint

gets the slack constraint corresponding to the general indicator constraint

Parameters

cons	superindicator constraint

Definition at line 2100 of file cons_superindicator.c.

References CONSHDLR_NAME, NULL, SCIPconsGetData(), SCIPconsGetHdlr(), and SCIPconshdlrGetName().

SCIP_RETCODE SCIPtransformMinUC	(	SCIP *	scip,
		SCIP_Bool *	success
	)

transforms the current problem into a MinUC problem (minimizing the number of unsatisfied constraints), a CIP generalization of the MinULR (min. unsatisfied linear relations) problem

Parameters

scip	SCIP data structure
success	pointer to store whether all constraints could be transformed

Definition at line 2119 of file cons_superindicator.c.

References BMSduplicateMemoryArray, BMSfreeMemoryArray, FALSE, NULL, SCIP_ALLOC, SCIP_CALL, SCIP_INVALIDCALL, SCIP_MAXSTRLEN, SCIP_OBJSENSE_MINIMIZE, SCIP_OKAY, SCIP_STAGE_PROBLEM, SCIP_VARTYPE_BINARY, SCIPaddCons(), SCIPaddVar(), SCIPchgVarBranchPriority(), SCIPchgVarObj(), SCIPconsGetHdlr(), SCIPconsGetName(), SCIPconshdlrGetName(), SCIPconsIsChecked(), SCIPconsIsDynamic(), SCIPconsIsEnforced(), SCIPconsIsInitial(), SCIPconsIsLocal(), SCIPconsIsPropagated(), SCIPconsIsRemovable(), SCIPconsIsSeparated(), SCIPconsIsStickingAtNode(), SCIPcreateConsSuperindicator(), SCIPcreateVar(), SCIPdebugMessage, SCIPdelCons(), SCIPerrorMessage, SCIPgetConss(), SCIPgetNConss(), SCIPgetNegatedVar(), SCIPgetStage(), SCIPgetVarsData(), SCIPreleaseCons(), SCIPreleaseVar(), SCIPsetObjsense(), SCIPsnprintf(), SCIPvarGetBranchPriority(), and TRUE.

Referenced by SCIP_DECL_DIALOGEXEC().

SCIP_DECL_DIALOGEXEC ( SCIPdialogExecChangeMinUC )

dialog execution method for the SCIPtransformMinUC() command

dialog execution method for the SCIPtransformMinUC() method

Definition at line 2253 of file cons_superindicator.c.

References FALSE, NULL, SCIP_Bool, SCIP_CALL, SCIP_INVALIDCALL, SCIP_OKAY, SCIP_STAGE_EXITPRESOLVE, SCIP_STAGE_EXITSOLVE, SCIP_STAGE_FREE, SCIP_STAGE_FREETRANS, SCIP_STAGE_INIT, SCIP_STAGE_INITPRESOLVE, SCIP_STAGE_INITSOLVE, SCIP_STAGE_PRESOLVED, SCIP_STAGE_PRESOLVING, SCIP_STAGE_PROBLEM, SCIP_STAGE_SOLVED, SCIP_STAGE_SOLVING, SCIP_STAGE_TRANSFORMED, SCIP_STAGE_TRANSFORMING, SCIPdialoghdlrAddHistory(), SCIPdialoghdlrGetRoot(), SCIPdialogMessage(), SCIPerrorMessage, SCIPgetNBinVars(), SCIPgetNConss(), SCIPgetNContVars(), SCIPgetNImplVars(), SCIPgetNIntVars(), SCIPgetNVars(), SCIPgetStage(), and SCIPtransformMinUC().

SCIP

Detailed Description

Functions

Function Documentation