Detailed Description

Constraint handler for "or" constraints, $r = x_1 \vee x_2 \vee \dots \vee x_n$ .

Author: Tobias Achterberg; Stefan Heinz; Michael Winkler

This constraint handler deals with "or" constraint. These are constraint of the form:

$r = x_1 \vee x_2 \vee \dots \vee x_n$

where $x_i$ is a binary variable for all $i$ . Hence, $r$ is also of binary type. The variable $r$ is called resultant and the $x$ 's operators.

Definition in file cons_or.h.

#include "scip/scip.h"

Go to the source code of this file.

Functions
SCIP_RETCODE	SCIPincludeConshdlrOr (SCIP *scip)

SCIP_RETCODE	SCIPcreateConsOr (SCIP scip, SCIP_CONS cons, const char name, SCIP_VAR resvar, int nvars, SCIP_VAR *vars, SCIP_Bool initial, SCIP_Bool separate, SCIP_Bool enforce, SCIP_Bool check, SCIP_Bool propagate, SCIP_Bool local, SCIP_Bool modifiable, SCIP_Bool dynamic, SCIP_Bool removable, SCIP_Bool stickingatnode)

SCIP_RETCODE	SCIPcreateConsBasicOr (SCIP scip, SCIP_CONS cons, const char name, SCIP_VAR resvar, int nvars, SCIP_VAR *vars)

int	SCIPgetNVarsOr (SCIP scip, SCIP_CONS cons)

SCIP_VAR **	SCIPgetVarsOr (SCIP scip, SCIP_CONS cons)

SCIP_VAR *	SCIPgetResultantOr (SCIP scip, SCIP_CONS cons)

Function Documentation

SCIP_RETCODE SCIPincludeConshdlrOr ( SCIP * scip )

creates the handler for or constraints and includes it in SCIP

Parameters

scip	SCIP data structure

Definition at line 1983 of file cons_or.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, conshdlrdataCreate(), EVENTHDLR_DESC, EVENTHDLR_NAME, NULL, SCIP_CALL, SCIP_OKAY, SCIPincludeConshdlrBasic(), SCIPincludeEventhdlrBasic(), SCIPsetConshdlrCopy(), SCIPsetConshdlrDelete(), SCIPsetConshdlrExitsol(), SCIPsetConshdlrFree(), SCIPsetConshdlrGetNVars(), SCIPsetConshdlrGetVars(), SCIPsetConshdlrInitlp(), SCIPsetConshdlrParse(), SCIPsetConshdlrPresol(), SCIPsetConshdlrPrint(), SCIPsetConshdlrProp(), SCIPsetConshdlrResprop(), SCIPsetConshdlrSepa(), and SCIPsetConshdlrTrans().

Referenced by SCIP_DECL_CONSHDLRCOPY(), and SCIPincludeDefaultPlugins().

SCIP_RETCODE SCIPcreateConsOr	(	SCIP *	scip,
		SCIP_CONS **	cons,
		const char *	name,
		SCIP_VAR *	resvar,
		int	nvars,
		SCIP_VAR **	vars,
		SCIP_Bool	initial,
		SCIP_Bool	separate,
		SCIP_Bool	enforce,
		SCIP_Bool	check,
		SCIP_Bool	propagate,
		SCIP_Bool	local,
		SCIP_Bool	modifiable,
		SCIP_Bool	dynamic,
		SCIP_Bool	removable,
		SCIP_Bool	stickingatnode
	)

creates and captures an or 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
resvar	resultant variable of the operation
nvars	number of operator variables in the constraint
vars	array with operator variables of 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.
modifiable	is constraint modifiable (subject to column generation)? Usually set to FALSE. In column generation applications, set to TRUE if pricing adds coefficients to this constraint.
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 2031 of file cons_or.c.

References consdataCreate(), CONSHDLR_NAME, NULL, SCIP_CALL, SCIP_OKAY, SCIP_PLUGINNOTFOUND, SCIPconshdlrGetData(), SCIPcreateCons(), SCIPerrorMessage, and SCIPfindConshdlr().

Referenced by CREATE_CONSTRAINT(), SCIP_DECL_CONSCOPY(), SCIP_DECL_CONSPARSE(), and SCIPcreateConsBasicOr().

SCIP_RETCODE SCIPcreateConsBasicOr	(	SCIP *	scip,
		SCIP_CONS **	cons,
		const char *	name,
		SCIP_VAR *	resvar,
		int	nvars,
		SCIP_VAR **	vars
	)

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

See Also: SCIPcreateConsOr() 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()

creates and captures an or constraint in its most basic variant, i. e., with all constraint flags set to their default values

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
resvar	resultant variable of the operation
nvars	number of operator variables in the constraint
vars	array with operator variables of constraint

Definition at line 2093 of file cons_or.c.

References FALSE, SCIP_CALL, SCIP_OKAY, SCIPcreateConsOr(), and TRUE.

int SCIPgetNVarsOr	(	SCIP *	scip,
		SCIP_CONS *	cons
	)

gets number of variables in or constraint

Parameters

scip	SCIP data structure
cons	constraint data

Definition at line 2109 of file cons_or.c.

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

Referenced by SCIP_DECL_CONSCOPY().

SCIP_VAR** SCIPgetVarsOr	(	SCIP *	scip,
		SCIP_CONS *	cons
	)

gets array of variables in or constraint

Parameters

scip	SCIP data structure
cons	constraint data

Definition at line 2130 of file cons_or.c.

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

Referenced by SCIP_DECL_CONSCOPY().

SCIP_VAR* SCIPgetResultantOr	(	SCIP *	scip,
		SCIP_CONS *	cons
	)

gets the resultant variable in or constraint

Parameters

scip	SCIP data structure
cons	constraint data

Definition at line 2151 of file cons_or.c.

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

Referenced by SCIP_DECL_CONSCOPY().

SCIP

Detailed Description

Functions

Function Documentation