Detailed Description

Constraint handler for variable bound constraints $lhs \leq x + c y \leq rhs$ .

Author: Tobias Achterberg; Timo Berthold; Michael Winkler; Gerald Gamrath; Stefan Heinz

This constraint handler handles a special type of linear constraints, namely variable bound constraints. A variable bound constraint has the form

$lhs \leq x + c y \leq rhs$

with coefficient $c \in Q$ , $lhs\in Q \cup \{-\infty\}$ , $rhs\in Q \cup \{\infty\}$ , and decision variables $x$ (non-binary) and $y$ (binary or integer).

Definition in file cons_varbound.h.

#include "scip/scip.h"

Go to the source code of this file.

Functions
SCIP_RETCODE	SCIPincludeConshdlrVarbound (SCIP *scip)

SCIP_RETCODE	SCIPcreateConsVarbound (SCIP scip, SCIP_CONS cons, const char name, SCIP_VAR var, SCIP_VAR vbdvar, SCIP_Real vbdcoef, SCIP_Real lhs, SCIP_Real rhs, 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	SCIPcreateConsBasicVarbound (SCIP scip, SCIP_CONS cons, const char name, SCIP_VAR var, SCIP_VAR vbdvar, SCIP_Real vbdcoef, SCIP_Real lhs, SCIP_Real rhs)

SCIP_Real	SCIPgetLhsVarbound (SCIP scip, SCIP_CONS cons)

SCIP_Real	SCIPgetRhsVarbound (SCIP scip, SCIP_CONS cons)

SCIP_VAR *	SCIPgetVarVarbound (SCIP scip, SCIP_CONS cons)

SCIP_VAR *	SCIPgetVbdvarVarbound (SCIP scip, SCIP_CONS cons)

SCIP_Real	SCIPgetVbdcoefVarbound (SCIP scip, SCIP_CONS cons)

SCIP_Real	SCIPgetDualsolVarbound (SCIP scip, SCIP_CONS cons)

SCIP_Real	SCIPgetDualfarkasVarbound (SCIP scip, SCIP_CONS cons)

SCIP_ROW *	SCIPgetRowVarbound (SCIP scip, SCIP_CONS cons)

Function Documentation

SCIP_RETCODE SCIPincludeConshdlrVarbound ( SCIP * scip )

creates the handler for variable bound constraints and includes it in SCIP

Parameters

scip	SCIP data structure

Definition at line 4479 of file cons_varbound.c.

References CONSHDLR_CHECKPRIORITY, CONSHDLR_DELAYPROP, CONSHDLR_DELAYSEPA, CONSHDLR_DESC, CONSHDLR_EAGERFREQ, CONSHDLR_ENFOPRIORITY, CONSHDLR_MAXPREROUNDS, CONSHDLR_NAME, CONSHDLR_NEEDSCONS, CONSHDLR_PRESOLTIMING, CONSHDLR_PROP_TIMING, CONSHDLR_PROPFREQ, CONSHDLR_SEPAFREQ, CONSHDLR_SEPAPRIORITY, conshdlrdataCreate(), DEFAULT_MAXLPCOEF, DEFAULT_PRESOLPAIRWISE, DEFAULT_USEBDWIDENING, EVENTHDLR_DESC, EVENTHDLR_NAME, FALSE, LINCONSUPGD_PRIORITY, NULL, SCIP_CALL, SCIP_OKAY, SCIPaddBoolParam(), SCIPaddRealParam(), SCIPcreateConsVarbound(), SCIPfindConshdlr(), SCIPincludeConshdlrBasic(), SCIPincludeEventhdlrBasic(), SCIPincludeLinconsUpgrade(), SCIPsetConshdlrCopy(), SCIPsetConshdlrDelete(), SCIPsetConshdlrExitsol(), SCIPsetConshdlrFree(), SCIPsetConshdlrGetNVars(), SCIPsetConshdlrGetVars(), SCIPsetConshdlrInitlp(), SCIPsetConshdlrParse(), SCIPsetConshdlrPresol(), SCIPsetConshdlrPrint(), SCIPsetConshdlrProp(), SCIPsetConshdlrResprop(), SCIPsetConshdlrSepa(), SCIPsetConshdlrTrans(), and TRUE.

Referenced by SCIP_DECL_CONSHDLRCOPY(), SCIP_DECL_EVENTEXEC(), and SCIPincludeDefaultPlugins().

SCIP_RETCODE SCIPcreateConsVarbound	(	SCIP *	scip,
		SCIP_CONS **	cons,
		const char *	name,
		SCIP_VAR *	var,
		SCIP_VAR *	vbdvar,
		SCIP_Real	vbdcoef,
		SCIP_Real	lhs,
		SCIP_Real	rhs,
		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 a variable bound constraint: lhs <= x + c*y <= rhs

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
var	variable x that has variable bound
vbdvar	binary, integer or implicit integer bounding variable y
vbdcoef	coefficient c of bounding variable y
lhs	left hand side of variable bound inequality
rhs	right hand side of variable bound inequality
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 4545 of file cons_varbound.c.

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

Referenced by addVarbound(), createPrecedenceCons(), createVarUbs(), presolveTryAddLinearReform(), SCIP_DECL_CONSINITLP(), SCIP_DECL_CONSPARSE(), SCIP_DECL_CONSPRESOL(), SCIP_DECL_LINCONSUPGD(), SCIPcreateConsBasicVarbound(), and SCIPincludeConshdlrVarbound().

SCIP_RETCODE SCIPcreateConsBasicVarbound	(	SCIP *	scip,
		SCIP_CONS **	cons,
		const char *	name,
		SCIP_VAR *	var,
		SCIP_VAR *	vbdvar,
		SCIP_Real	vbdcoef,
		SCIP_Real	lhs,
		SCIP_Real	rhs
	)

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

See also: SCIPcreateConsVarbound() 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 a variable bound constraint: lhs <= x + c*y <= rhs 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
var	variable x that has variable bound
vbdvar	binary, integer or implicit integer bounding variable y
vbdcoef	coefficient c of bounding variable y
lhs	left hand side of variable bound inequality
rhs	right hand side of variable bound inequality

Definition at line 4615 of file cons_varbound.c.

References FALSE, SCIP_CALL, SCIP_OKAY, SCIP_Real, SCIPcreateConsVarbound(), SCIPgetLhsVarbound(), and TRUE.

Referenced by SCIPcreateConsVarbound().

SCIP_Real SCIPgetLhsVarbound	(	SCIP *	scip,
		SCIP_CONS *	cons
	)

gets left hand side of variable bound constraint lhs <= x + c*y <= rhs

Parameters

scip	SCIP data structure
cons	constraint data

Definition at line 4633 of file cons_varbound.c.

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

Referenced by addVarboundConstraints(), checkVarbound(), printRangeSection(), SCIP_DECL_CONSCOPY(), SCIP_DECL_READERWRITE(), SCIPcreateConsBasicVarbound(), SCIPmatrixCreate(), SCIPwriteGms(), SCIPwriteLp(), SCIPwritePip(), writeFzn(), and writeOpbConstraints().

SCIP_Real SCIPgetRhsVarbound	(	SCIP *	scip,
		SCIP_CONS *	cons
	)

gets right hand side of variable bound constraint lhs <= x + c*y <= rhs

Parameters

scip	SCIP data structure
cons	constraint data

Definition at line 4654 of file cons_varbound.c.

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

Referenced by addVarboundConstraints(), checkVarbound(), printRangeSection(), SCIP_DECL_CONSCOPY(), SCIP_DECL_READERWRITE(), SCIPgetLhsVarbound(), SCIPmatrixCreate(), SCIPwriteGms(), SCIPwriteLp(), SCIPwritePip(), writeFzn(), and writeOpbConstraints().

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

gets bounded variable x of variable bound constraint lhs <= x + c*y <= rhs

Parameters

scip	SCIP data structure
cons	constraint data

Definition at line 4675 of file cons_varbound.c.

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

Referenced by addVarboundConstraints(), checkVarbound(), SCIP_DECL_CONSCOPY(), SCIP_DECL_READERWRITE(), SCIPgetRhsVarbound(), SCIPmatrixCreate(), SCIPwriteCcg(), SCIPwriteGms(), SCIPwriteLp(), SCIPwritePbm(), SCIPwritePip(), SCIPwritePpm(), writeFzn(), and writeOpbConstraints().

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

gets bounding variable y of variable bound constraint lhs <= x + c*y <= rhs

Parameters

scip	SCIP data structure
cons	constraint data

Definition at line 4696 of file cons_varbound.c.

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

Referenced by addVarboundConstraints(), checkVarbound(), SCIP_DECL_CONSCOPY(), SCIP_DECL_READERWRITE(), SCIPgetVarVarbound(), SCIPmatrixCreate(), SCIPwriteCcg(), SCIPwriteGms(), SCIPwriteLp(), SCIPwritePbm(), SCIPwritePip(), SCIPwritePpm(), writeFzn(), and writeOpbConstraints().

SCIP_Real SCIPgetVbdcoefVarbound	(	SCIP *	scip,
		SCIP_CONS *	cons
	)

gets bound coefficient c of variable bound constraint lhs <= x + c*y <= rhs

Parameters

scip	SCIP data structure
cons	constraint data

Definition at line 4717 of file cons_varbound.c.

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

Referenced by addVarboundConstraints(), checkVarbound(), SCIP_DECL_CONSCOPY(), SCIP_DECL_READERWRITE(), SCIPgetVbdvarVarbound(), SCIPmatrixCreate(), SCIPwriteCcg(), SCIPwriteGms(), SCIPwriteLp(), SCIPwritePbm(), SCIPwritePip(), SCIPwritePpm(), writeFzn(), and writeOpbConstraints().

SCIP_Real SCIPgetDualsolVarbound	(	SCIP *	scip,
		SCIP_CONS *	cons
	)

gets the dual solution of the variable bound constraint in the current LP

Parameters

scip	SCIP data structure
cons	constraint data

Definition at line 4738 of file cons_varbound.c.

References CONSHDLR_NAME, NULL, SCIP_INVALID, SCIP_Real, SCIPABORT, SCIPconsGetData(), SCIPconsGetHdlr(), SCIPconshdlrGetName(), SCIPerrorMessage, SCIPgetDualfarkasVarbound(), and SCIProwGetDualsol().

Referenced by SCIPgetVbdcoefVarbound().

SCIP_Real SCIPgetDualfarkasVarbound	(	SCIP *	scip,
		SCIP_CONS *	cons
	)

gets the dual Farkas value of the variable bound constraint in the current infeasible LP

Parameters

scip	SCIP data structure
cons	constraint data

Definition at line 4762 of file cons_varbound.c.

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

Referenced by SCIPgetDualsolVarbound().

SCIP_ROW* SCIPgetRowVarbound	(	SCIP *	scip,
		SCIP_CONS *	cons
	)

returns the linear relaxation of the given variable bound constraint; may return NULL if no LP row was yet created; the user must not modify the row!

Parameters

scip	SCIP data structure
cons	constraint data

Definition at line 4788 of file cons_varbound.c.

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

Referenced by SCIPgetDualfarkasVarbound().

SCIP

Detailed Description

Functions

Function Documentation