cons_conjunction.c File Reference

Detailed Description

constraint handler for conjunction constraints

Author

Tobias Achterberg

Definition in file cons_conjunction.c.

#include <assert.h>
#include <string.h>
#include <limits.h>
#include "scip/cons_conjunction.h"

Go to the source code of this file.

Macros
#define	CONSHDLR_NAME   "conjunction"
#define	CONSHDLR_DESC   "conjunction of constraints"
#define	CONSHDLR_ENFOPRIORITY   +900000
#define	CONSHDLR_CHECKPRIORITY   -900000
#define	CONSHDLR_EAGERFREQ   100
#define	CONSHDLR_MAXPREROUNDS   -1
#define	CONSHDLR_NEEDSCONS   TRUE
#define	CONSHDLR_PRESOLTIMING   SCIP_PRESOLTIMING_FAST

Functions
static SCIP_RETCODE	consdataCreate (SCIP *scip, SCIP_CONSDATA **consdata, SCIP_CONS **conss, int nconss)
static SCIP_RETCODE	consdataFree (SCIP *scip, SCIP_CONSDATA **consdata)
static SCIP_RETCODE	consdataAddCons (SCIP *scip, SCIP_CONSDATA *consdata, SCIP_CONS *cons)
static SCIP_RETCODE	addAllConss (SCIP *scip, SCIP_CONS **conss, int nconss, SCIP_RESULT *result)
static SCIP_RETCODE	checkAllConss (SCIP *scip, SCIP_CONS **conss, int nconss, SCIP_SOL *sol, SCIP_Bool checkintegrality, SCIP_Bool checklprows, SCIP_Bool printreason, SCIP_RESULT *result)
static	SCIP_DECL_CONSHDLRCOPY (conshdlrCopyConjunction)
static	SCIP_DECL_CONSDELETE (consDeleteConjunction)
static	SCIP_DECL_CONSTRANS (consTransConjunction)
static	SCIP_DECL_CONSENFOLP (consEnfolpConjunction)
static	SCIP_DECL_CONSENFOPS (consEnfopsConjunction)
static	SCIP_DECL_CONSCHECK (consCheckConjunction)
static	SCIP_DECL_CONSPRESOL (consPresolConjunction)
static	SCIP_DECL_CONSLOCK (consLockConjunction)
static	SCIP_DECL_CONSPRINT (consPrintConjunction)
static	SCIP_DECL_CONSPARSE (consParseConjunction)
static	SCIP_DECL_CONSCOPY (consCopyConjunction)
SCIP_RETCODE	SCIPincludeConshdlrConjunction (SCIP *scip)
SCIP_RETCODE	SCIPcreateConsConjunction (SCIP *scip, SCIP_CONS **cons, const char *name, int nconss, SCIP_CONS **conss, SCIP_Bool enforce, SCIP_Bool check, SCIP_Bool local, SCIP_Bool modifiable, SCIP_Bool dynamic)
SCIP_RETCODE	SCIPcreateConsBasicConjunction (SCIP *scip, SCIP_CONS **cons, const char *name, int nconss, SCIP_CONS **conss)
SCIP_RETCODE	SCIPaddConsElemConjunction (SCIP *scip, SCIP_CONS *cons, SCIP_CONS *addcons)

Macro Definition Documentation

#define CONSHDLR_NAME   "conjunction"

Definition at line 31 of file cons_conjunction.c.

Referenced by SCIP_DECL_CONSHDLRCOPY(), SCIPaddConsElemConjunction(), SCIPcreateConsConjunction(), and SCIPincludeConshdlrConjunction().

#define CONSHDLR_DESC   "conjunction of constraints"

Definition at line 32 of file cons_conjunction.c.

Referenced by SCIPincludeConshdlrConjunction().

#define CONSHDLR_ENFOPRIORITY   +900000

priority of the constraint handler for constraint enforcing

Definition at line 33 of file cons_conjunction.c.

Referenced by SCIPincludeConshdlrConjunction().

#define CONSHDLR_CHECKPRIORITY   -900000

priority of the constraint handler for checking feasibility

Definition at line 34 of file cons_conjunction.c.

Referenced by SCIPincludeConshdlrConjunction().

#define CONSHDLR_EAGERFREQ   100

frequency for using all instead of only the useful constraints in separation, propagation and enforcement, -1 for no eager evaluations, 0 for first only

Definition at line 35 of file cons_conjunction.c.

Referenced by SCIPincludeConshdlrConjunction().

#define CONSHDLR_MAXPREROUNDS   -1

maximal number of presolving rounds the constraint handler participates in (-1: no limit)

Definition at line 38 of file cons_conjunction.c.

Referenced by SCIPincludeConshdlrConjunction().

#define CONSHDLR_NEEDSCONS   TRUE

should the constraint handler be skipped, if no constraints are available?

Definition at line 39 of file cons_conjunction.c.

Referenced by SCIPincludeConshdlrConjunction().

#define CONSHDLR_PRESOLTIMING   SCIP_PRESOLTIMING_FAST

Definition at line 41 of file cons_conjunction.c.

Referenced by SCIPincludeConshdlrConjunction().

Function Documentation

static SCIP_RETCODE consdataCreate ( SCIP *  scip, SCIP_CONSDATA **  consdata, SCIP_CONS **  conss, int  nconss  )

static

creates conjunction constraint data, captures initial constraints of conjunction

Parameters

scip	SCIP data structure
consdata	pointer to constraint data
conss	initial constraint in conjunction
nconss	number of initial constraints in conjunction

Definition at line 62 of file cons_conjunction.c.

References consdataFree(), NULL, SCIP_CALL, SCIP_OKAY, SCIPallocBlockMemory, SCIPcaptureCons(), SCIPduplicateBlockMemoryArray, SCIPisTransformed(), and SCIPtransformConss().

Referenced by SCIPcreateConsConjunction().

static SCIP_RETCODE consdataFree ( SCIP *  scip, SCIP_CONSDATA **  consdata  )

static

frees constraint data and releases all constraints in conjunction

Parameters

scip	SCIP data structure
consdata	pointer to constraint data

Definition at line 104 of file cons_conjunction.c.

References consdataAddCons(), NULL, SCIP_CALL, SCIP_OKAY, SCIPfreeBlockMemory, SCIPfreeBlockMemoryArrayNull, and SCIPreleaseCons().

Referenced by consdataCreate(), and SCIP_DECL_CONSDELETE().

static SCIP_RETCODE consdataAddCons ( SCIP *  scip, SCIP_CONSDATA *  consdata, SCIP_CONS *  cons  )

static

adds constraint to conjunction

Parameters

scip	SCIP data structure
consdata	constraint data
cons	constraint to add to the conjunction

Definition at line 129 of file cons_conjunction.c.

References addAllConss(), NULL, SCIP_CALL, SCIP_OKAY, SCIPcaptureCons(), SCIPensureBlockMemoryArray, SCIPisTransformed(), and SCIPtransformCons().

Referenced by consdataFree(), and SCIPaddConsElemConjunction().

static SCIP_RETCODE addAllConss ( SCIP *  scip, SCIP_CONS **  conss, int  nconss, SCIP_RESULT *  result  )

static

adds all constraints in conjunction constraints to the problem; disables unmodifiable conjunction constraints

Parameters

scip	SCIP data structure
conss	active conjunction constraints
nconss	number of active conjunction constraints
result	pointer to store the result

Definition at line 161 of file cons_conjunction.c.

References checkAllConss(), NULL, SCIP_CALL, SCIP_CONSADDED, SCIP_OKAY, SCIPaddConsLocal(), SCIPconsGetData(), SCIPconsGetName(), SCIPconsIsActive(), SCIPconsIsChecked(), SCIPconsIsModifiable(), SCIPdebugMessage, SCIPdelConsLocal(), SCIPsetConsChecked(), and TRUE.

Referenced by consdataAddCons(), SCIP_DECL_CONSENFOLP(), and SCIP_DECL_CONSENFOPS().

static SCIP_RETCODE checkAllConss ( SCIP *  scip, SCIP_CONS **  conss, int  nconss, SCIP_SOL *  sol, SCIP_Bool  checkintegrality, SCIP_Bool  checklprows, SCIP_Bool  printreason, SCIP_RESULT *  result  )

static

checks all constraints in conjunction constraints for feasibility

Parameters

scip	SCIP data structure
conss	active conjunction constraints
nconss	number of active conjunction constraints
sol	solution to check
checkintegrality	Has integrality to be checked?
checklprows	Do constraints represented by rows in the current LP have to be checked?
printreason	Should the reason for the violation be printed?
result	pointer to store the result

Definition at line 210 of file cons_conjunction.c.

References NULL, SCIP_CALL, SCIP_DECL_CONSHDLRCOPY(), SCIP_FEASIBLE, SCIP_INFEASIBLE, SCIP_OKAY, SCIPcheckCons(), SCIPconsGetData(), SCIPconsGetName(), SCIPdebug, SCIPinfoMessage(), and SCIPprintCons().

Referenced by addAllConss(), and SCIP_DECL_CONSCHECK().

static SCIP_DECL_CONSHDLRCOPY ( conshdlrCopyConjunction  )

static

copy method for constraint handler plugins (called when SCIP copies plugins)

Definition at line 258 of file cons_conjunction.c.

References CONSHDLR_NAME, NULL, SCIP_CALL, SCIP_DECL_CONSDELETE(), SCIP_OKAY, SCIPconshdlrGetName(), SCIPincludeConshdlrConjunction(), and TRUE.

Referenced by checkAllConss().

static SCIP_DECL_CONSDELETE ( consDeleteConjunction  )

static

frees specific constraint data

Definition at line 275 of file cons_conjunction.c.

References consdataFree(), SCIP_CALL, SCIP_DECL_CONSTRANS(), and SCIP_OKAY.

Referenced by SCIP_DECL_CONSHDLRCOPY().

static SCIP_DECL_CONSTRANS ( consTransConjunction  )

static

transforms constraint data into data belonging to the transformed problem

Definition at line 284 of file cons_conjunction.c.

References NULL, SCIP_CALL, SCIP_DECL_CONSENFOLP(), SCIP_OKAY, SCIPallocBlockMemory, SCIPallocBlockMemoryArray, SCIPconsGetData(), SCIPconsGetName(), SCIPconsIsChecked(), SCIPconsIsDynamic(), SCIPconsIsEnforced(), SCIPconsIsInitial(), SCIPconsIsLocal(), SCIPconsIsModifiable(), SCIPconsIsPropagated(), SCIPconsIsRemovable(), SCIPconsIsSeparated(), SCIPconsIsStickingAtNode(), SCIPcreateCons(), and SCIPtransformCons().

Referenced by SCIP_DECL_CONSDELETE().

static SCIP_DECL_CONSENFOLP ( consEnfolpConjunction  )

static

constraint enforcing method of constraint handler for LP solutions

Definition at line 326 of file cons_conjunction.c.

References addAllConss(), SCIP_CALL, SCIP_DECL_CONSENFOPS(), SCIP_FEASIBLE, and SCIP_OKAY.

Referenced by SCIP_DECL_CONSTRANS().

static SCIP_DECL_CONSENFOPS ( consEnfopsConjunction  )

static

constraint enforcing method of constraint handler for pseudo solutions

Definition at line 339 of file cons_conjunction.c.

References addAllConss(), SCIP_CALL, SCIP_DECL_CONSCHECK(), SCIP_FEASIBLE, and SCIP_OKAY.

Referenced by SCIP_DECL_CONSENFOLP().

static SCIP_DECL_CONSCHECK ( consCheckConjunction  )

static

feasibility check method of constraint handler for integral solutions

Definition at line 352 of file cons_conjunction.c.

References checkAllConss(), SCIP_CALL, SCIP_DECL_CONSPRESOL(), SCIP_FEASIBLE, and SCIP_OKAY.

Referenced by SCIP_DECL_CONSENFOPS().

static SCIP_DECL_CONSPRESOL ( consPresolConjunction  )

static

presolving method of constraint handler

Definition at line 365 of file cons_conjunction.c.

References NULL, SCIP_CALL, SCIP_DECL_CONSLOCK(), SCIP_DIDNOTFIND, SCIP_OKAY, SCIP_SUCCESS, SCIPaddCons(), SCIPconsGetData(), SCIPconsGetName(), SCIPconsIsActive(), SCIPconsIsChecked(), SCIPconsIsModifiable(), SCIPdebugMessage, SCIPdelCons(), SCIPreleaseCons(), SCIPsetConsChecked(), and TRUE.

Referenced by SCIP_DECL_CONSCHECK().

static SCIP_DECL_CONSLOCK ( consLockConjunction  )

static

variable rounding lock method of constraint handler

Definition at line 421 of file cons_conjunction.c.

References NULL, SCIP_CALL, SCIP_DECL_CONSPRINT(), SCIP_OKAY, SCIPaddConsLocks(), and SCIPconsGetData().

Referenced by SCIP_DECL_CONSPRESOL().

static SCIP_DECL_CONSPRINT ( consPrintConjunction  )

static

constraint display method of constraint handler

Definition at line 441 of file cons_conjunction.c.

References NULL, SCIP_CALL, SCIP_DECL_CONSPARSE(), SCIP_OKAY, SCIPconsGetData(), SCIPinfoMessage(), and SCIPprintCons().

Referenced by SCIP_DECL_CONSLOCK().

static SCIP_DECL_CONSPARSE ( consParseConjunction  )

static

constraint parsing method of constraint handler

Definition at line 468 of file cons_conjunction.c.

References FALSE, NULL, SCIP_CALL, SCIP_DECL_CONSCOPY(), SCIP_OKAY, SCIPallocBufferArray, SCIPcalcMemGrowSize(), SCIPcreateConsConjunction(), SCIPdebugMessage, SCIPduplicateBufferArray, SCIPfreeBufferArray, SCIPparseCons(), SCIPreallocBufferArray, SCIPreleaseCons(), and TRUE.

Referenced by SCIP_DECL_CONSPRINT().

static SCIP_DECL_CONSCOPY ( consCopyConjunction  )

static

constraint copying method of constraint handler

Definition at line 662 of file cons_conjunction.c.

References NULL, SCIP_CALL, SCIP_OKAY, SCIPallocBufferArray, SCIPconsGetData(), SCIPconsGetHdlr(), SCIPconsGetName(), SCIPconsIsChecked(), SCIPconsIsDynamic(), SCIPconsIsEnforced(), SCIPconsIsInitial(), SCIPconsIsLocal(), SCIPconsIsModifiable(), SCIPconsIsPropagated(), SCIPconsIsRemovable(), SCIPconsIsSeparated(), SCIPconsIsStickingAtNode(), SCIPcreateConsConjunction(), SCIPfreeBufferArray, SCIPgetConsCopy(), SCIPincludeConshdlrConjunction(), SCIPreleaseCons(), and TRUE.

Referenced by SCIP_DECL_CONSPARSE().

SCIP_RETCODE SCIPincludeConshdlrConjunction

(

SCIP *

scip

)

creates the handler for conjunction constraints and includes it in SCIP

Parameters

scip	SCIP data structure

Definition at line 730 of file cons_conjunction.c.

References CONSHDLR_CHECKPRIORITY, CONSHDLR_DESC, CONSHDLR_EAGERFREQ, CONSHDLR_ENFOPRIORITY, CONSHDLR_MAXPREROUNDS, CONSHDLR_NAME, CONSHDLR_NEEDSCONS, CONSHDLR_PRESOLTIMING, NULL, SCIP_CALL, SCIP_OKAY, SCIPcreateConsConjunction(), SCIPincludeConshdlrBasic(), SCIPsetConshdlrCopy(), SCIPsetConshdlrDelete(), SCIPsetConshdlrParse(), SCIPsetConshdlrPresol(), SCIPsetConshdlrPrint(), and SCIPsetConshdlrTrans().

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

SCIP_RETCODE SCIPcreateConsConjunction	(	SCIP *	scip,
		SCIP_CONS **	cons,
		const char *	name,
		int	nconss,
		SCIP_CONS **	conss,
		SCIP_Bool	enforce,
		SCIP_Bool	check,
		SCIP_Bool	local,
		SCIP_Bool	modifiable,
		SCIP_Bool	dynamic
	)

creates and captures a conjunction 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
nconss	number of initial constraints in conjunction
conss	initial constraint in conjunction
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.
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.

Definition at line 764 of file cons_conjunction.c.

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

Referenced by SCIP_DECL_CONSCOPY(), SCIP_DECL_CONSPARSE(), SCIPcreateConsBasicConjunction(), and SCIPincludeConshdlrConjunction().

SCIP_RETCODE SCIPcreateConsBasicConjunction	(	SCIP *	scip,
		SCIP_CONS **	cons,
		const char *	name,
		int	nconss,
		SCIP_CONS **	conss
	)

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

See also

SCIPcreateConsConjunction() 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
nconss	number of initial constraints in conjunction
conss	initial constraint in conjunction

Definition at line 813 of file cons_conjunction.c.

References FALSE, NULL, SCIP_CALL, SCIP_OKAY, SCIPaddConsElemConjunction(), SCIPcreateConsConjunction(), and TRUE.

Referenced by SCIPcreateConsConjunction().

SCIP_RETCODE SCIPaddConsElemConjunction	(	SCIP *	scip,
		SCIP_CONS *	cons,
		SCIP_CONS *	addcons
	)

adds constraint to the conjunction of constraints

Parameters

scip	SCIP data structure
cons	conjunction constraint
addcons	additional constraint in conjunction

Definition at line 830 of file cons_conjunction.c.

References consdataAddCons(), CONSHDLR_NAME, NULL, SCIP_CALL, SCIP_INVALIDDATA, SCIP_OKAY, SCIPconsGetData(), SCIPconsGetHdlr(), SCIPconshdlrGetName(), and SCIPerrorMessage.

Referenced by SCIPcreateConsBasicConjunction().