Detailed Description

methods for implications, variable bounds, and clique tables

Author: Tobias Achterberg

Definition in file implics.c.

#include <stdlib.h>
#include <assert.h>
#include "scip/def.h"
#include "scip/set.h"
#include "scip/stat.h"
#include "scip/event.h"
#include "scip/var.h"
#include "scip/implics.h"
#include "scip/pub_message.h"
#include "scip/pub_misc.h"
#include "scip/debug.h"
#include "scip/struct_implics.h"

Go to the source code of this file.

Functions
static SCIP_RETCODE	vboundsCreate (SCIP_VBOUNDS *vbounds, BMS_BLKMEM blkmem)

void	SCIPvboundsFree (SCIP_VBOUNDS *vbounds, BMS_BLKMEM blkmem)

static SCIP_RETCODE	vboundsEnsureSize (SCIP_VBOUNDS *vbounds, BMS_BLKMEM blkmem, SCIP_SET *set, int num)

static SCIP_RETCODE	vboundsSearchPos (SCIP_VBOUNDS vbounds, SCIP_VAR var, SCIP_Bool negativecoef, int insertpos, SCIP_Bool found)

SCIP_RETCODE	SCIPvboundsAdd (SCIP_VBOUNDS *vbounds, BMS_BLKMEM blkmem, SCIP_SET set, SCIP_BOUNDTYPE vboundtype, SCIP_VAR var, SCIP_Real coef, SCIP_Real constant, SCIP_Bool *added)

SCIP_RETCODE	SCIPvboundsDel (SCIP_VBOUNDS *vbounds, BMS_BLKMEM blkmem, SCIP_VAR *vbdvar, SCIP_Bool negativecoef)

void	SCIPvboundsShrink (SCIP_VBOUNDS *vbounds, BMS_BLKMEM blkmem, int newnvbds)

static	SCIP_DECL_SORTPTRCOMP (compVars)

static void	checkImplics (SCIP_IMPLICS implics, SCIP_SET set)

static SCIP_RETCODE	implicsCreate (SCIP_IMPLICS *implics, BMS_BLKMEM blkmem)

void	SCIPimplicsFree (SCIP_IMPLICS *implics, BMS_BLKMEM blkmem)

static SCIP_RETCODE	implicsEnsureSize (SCIP_IMPLICS *implics, BMS_BLKMEM blkmem, SCIP_SET *set, SCIP_Bool varfixing, int num)

static void	implicsSearchVar (SCIP_IMPLICS implics, SCIP_Bool varfixing, SCIP_VAR implvar, int poslower, int posupper, int *posadd)

static SCIP_Bool	implicsSearchImplic (SCIP_IMPLICS implics, SCIP_Bool varfixing, SCIP_VAR implvar, SCIP_BOUNDTYPE impltype, int poslower, int posupper, int *posadd)

SCIP_RETCODE	SCIPimplicsAdd (SCIP_IMPLICS *implics, BMS_BLKMEM blkmem, SCIP_SET set, SCIP_STAT stat, SCIP_Bool varfixing, SCIP_VAR implvar, SCIP_BOUNDTYPE impltype, SCIP_Real implbound, SCIP_Bool isshortcut, SCIP_Bool conflict, SCIP_Bool *added)

SCIP_RETCODE	SCIPimplicsDel (SCIP_IMPLICS *implics, BMS_BLKMEM blkmem, SCIP_SET set, SCIP_Bool varfixing, SCIP_VAR implvar, SCIP_BOUNDTYPE impltype)

void	SCIPimplicsGetVarImplics (SCIP_IMPLICS implics, SCIP_Bool varfixing, SCIP_VAR implvar, SCIP_Bool haslowerimplic, SCIP_Bool hasupperimplic)

SCIP_Bool	SCIPimplicsContainsImpl (SCIP_IMPLICS implics, SCIP_Bool varfixing, SCIP_VAR implvar, SCIP_BOUNDTYPE impltype)

static SCIP_RETCODE	cliqueCreateWithData (SCIP_CLIQUE *clique, BMS_BLKMEM blkmem, int size, SCIP_VAR *vars, SCIP_Bool values, int nvars, int id)

static void	cliqueFree (SCIP_CLIQUE *clique, BMS_BLKMEM blkmem)

static SCIP_RETCODE	cliqueEnsureSize (SCIP_CLIQUE clique, BMS_BLKMEM blkmem, SCIP_SET *set, int num)

int	SCIPcliqueSearchVar (SCIP_CLIQUE clique, SCIP_VAR var, SCIP_Bool value)

SCIP_Bool	SCIPcliqueHasVar (SCIP_CLIQUE clique, SCIP_VAR var, SCIP_Bool value)

SCIP_RETCODE	SCIPcliqueAddVar (SCIP_CLIQUE clique, BMS_BLKMEM blkmem, SCIP_SET set, SCIP_VAR var, SCIP_Bool value, SCIP_Bool doubleentry, SCIP_Bool oppositeentry)

SCIP_RETCODE	SCIPcliqueDelVar (SCIP_CLIQUE clique, SCIP_VAR var, SCIP_Bool value)

static int	cliquesSearchClique (SCIP_CLIQUE *cliques, int ncliques, SCIP_CLIQUE clique)

static void	cliqueCheck (SCIP_CLIQUE *clique)

static SCIP_RETCODE	cliquelistCreate (SCIP_CLIQUELIST *cliquelist, BMS_BLKMEM blkmem)

void	SCIPcliquelistFree (SCIP_CLIQUELIST *cliquelist, BMS_BLKMEM blkmem)

static SCIP_RETCODE	cliquelistEnsureSize (SCIP_CLIQUELIST cliquelist, BMS_BLKMEM blkmem, SCIP_SET *set, SCIP_Bool value, int num)

SCIP_RETCODE	SCIPcliquelistAdd (SCIP_CLIQUELIST *cliquelist, BMS_BLKMEM blkmem, SCIP_SET set, SCIP_Bool value, SCIP_CLIQUE clique)

SCIP_RETCODE	SCIPcliquelistDel (SCIP_CLIQUELIST *cliquelist, BMS_BLKMEM blkmem, SCIP_Bool value, SCIP_CLIQUE *clique)

SCIP_Bool	SCIPcliquelistsHaveCommonClique (SCIP_CLIQUELIST cliquelist1, SCIP_Bool value1, SCIP_CLIQUELIST cliquelist2, SCIP_Bool value2)

void	SCIPcliquelistRemoveFromCliques (SCIP_CLIQUELIST cliquelist, SCIP_VAR var)

SCIP_RETCODE	SCIPcliquetableCreate (SCIP_CLIQUETABLE **cliquetable)

SCIP_RETCODE	SCIPcliquetableFree (SCIP_CLIQUETABLE *cliquetable, BMS_BLKMEM blkmem)

static SCIP_RETCODE	cliquetableEnsureSize (SCIP_CLIQUETABLE cliquetable, SCIP_SET set, int num)

SCIP_RETCODE	SCIPcliquetableAdd (SCIP_CLIQUETABLE cliquetable, BMS_BLKMEM blkmem, SCIP_SET set, SCIP_STAT stat, SCIP_PROB transprob, SCIP_PROB origprob, SCIP_TREE tree, SCIP_LP lp, SCIP_BRANCHCAND branchcand, SCIP_EVENTQUEUE eventqueue, SCIP_VAR *vars, SCIP_Bool values, int nvars, SCIP_Bool infeasible, int nbdchgs)

static	SCIP_DECL_HASHGETKEY (hashgetkeyClique)

static	SCIP_DECL_HASHKEYEQ (hashkeyeqClique)

static	SCIP_DECL_HASHKEYVAL (hashkeyvalClique)

SCIP_RETCODE	SCIPcliquetableCleanup (SCIP_CLIQUETABLE cliquetable, BMS_BLKMEM blkmem, SCIP_SET set, SCIP_STAT stat, SCIP_PROB transprob, SCIP_PROB origprob, SCIP_TREE tree, SCIP_LP lp, SCIP_BRANCHCAND branchcand, SCIP_EVENTQUEUE eventqueue, SCIP_Bool *infeasible)

int	SCIPvboundsGetNVbds (SCIP_VBOUNDS *vbounds)

SCIP_VAR **	SCIPvboundsGetVars (SCIP_VBOUNDS *vbounds)

SCIP_Real *	SCIPvboundsGetCoefs (SCIP_VBOUNDS *vbounds)

SCIP_Real *	SCIPvboundsGetConstants (SCIP_VBOUNDS *vbounds)

int	SCIPimplicsGetNImpls (SCIP_IMPLICS *implics, SCIP_Bool varfixing)

int	SCIPimplicsGetNBinImpls (SCIP_IMPLICS *implics, SCIP_Bool varfixing)

SCIP_VAR **	SCIPimplicsGetVars (SCIP_IMPLICS *implics, SCIP_Bool varfixing)

SCIP_BOUNDTYPE *	SCIPimplicsGetTypes (SCIP_IMPLICS *implics, SCIP_Bool varfixing)

SCIP_Real *	SCIPimplicsGetBounds (SCIP_IMPLICS *implics, SCIP_Bool varfixing)

int *	SCIPimplicsGetIds (SCIP_IMPLICS *implics, SCIP_Bool varfixing)

int	SCIPcliqueGetNVars (SCIP_CLIQUE *clique)

SCIP_VAR **	SCIPcliqueGetVars (SCIP_CLIQUE *clique)

SCIP_Bool *	SCIPcliqueGetValues (SCIP_CLIQUE *clique)

int	SCIPcliqueGetId (SCIP_CLIQUE *clique)

int	SCIPcliquelistGetNCliques (SCIP_CLIQUELIST *cliquelist, SCIP_Bool value)

SCIP_CLIQUE **	SCIPcliquelistGetCliques (SCIP_CLIQUELIST *cliquelist, SCIP_Bool value)

void	SCIPcliquelistCheck (SCIP_CLIQUELIST cliquelist, SCIP_VAR var)

int	SCIPcliquetableGetNCliques (SCIP_CLIQUETABLE *cliquetable)

SCIP_CLIQUE **	SCIPcliquetableGetCliques (SCIP_CLIQUETABLE *cliquetable)

Function Documentation

static SCIP_RETCODE vboundsCreate	(	SCIP_VBOUNDS **	vbounds,
		BMS_BLKMEM *	blkmem
	)

static

creates a variable bounds data structure

Parameters

vbounds	pointer to store variable bounds data structure
blkmem	block memory

Definition at line 48 of file implics.c.

References BMSallocBlockMemory, NULL, SCIP_ALLOC, and SCIP_OKAY.

Referenced by vboundsEnsureSize().

void SCIPvboundsFree	(	SCIP_VBOUNDS **	vbounds,
		BMS_BLKMEM *	blkmem
	)

frees a variable bounds data structure

Parameters

vbounds	pointer to store variable bounds data structure
blkmem	block memory

Definition at line 66 of file implics.c.

References BMSfreeBlockMemory, BMSfreeBlockMemoryArrayNull, and NULL.

Referenced by SCIPvarAggregate(), SCIPvarRemove(), SCIPvboundsDel(), SCIPvboundsShrink(), and varFree().

static SCIP_RETCODE vboundsEnsureSize	(	SCIP_VBOUNDS **	vbounds,
		BMS_BLKMEM *	blkmem,
		SCIP_SET *	set,
		int	num
	)

static

ensures, that variable bounds arrays can store at least num entries

Parameters

vbounds	pointer to variable bounds data structure
blkmem	block memory
set	global SCIP settings
num	minimum number of entries to store

Definition at line 84 of file implics.c.

References BMSreallocBlockMemoryArray, NULL, SCIP_ALLOC, SCIP_CALL, SCIP_OKAY, SCIPsetCalcMemGrowSize(), and vboundsCreate().

Referenced by SCIPvboundsAdd().

static SCIP_RETCODE vboundsSearchPos	(	SCIP_VBOUNDS *	vbounds,
		SCIP_VAR *	var,
		SCIP_Bool	negativecoef,
		int *	insertpos,
		SCIP_Bool *	found
	)

static

binary searches the insertion position of the given variable in the vbounds data structure

Parameters

vbounds	variable bounds data structure, or NULL
var	variable to search in vbounds data structure
negativecoef	is coefficient b negative?
insertpos	pointer to store position where to insert new entry
found	pointer to store whether the same variable was found at the returned pos

Definition at line 118 of file implics.c.

References SCIP_VBounds::coefs, FALSE, SCIP_VBounds::len, NULL, SCIP_Bool, SCIP_OKAY, SCIPsortedvecFindPtr(), TRUE, and SCIP_VBounds::vars.

Referenced by SCIPvboundsAdd(), and SCIPvboundsDel().

SCIP_RETCODE SCIPvboundsAdd	(	SCIP_VBOUNDS **	vbounds,
		BMS_BLKMEM *	blkmem,
		SCIP_SET *	set,
		SCIP_BOUNDTYPE	vboundtype,
		SCIP_VAR *	var,
		SCIP_Real	coef,
		SCIP_Real	constant,
		SCIP_Bool *	added
	)

adds a variable bound to the variable bounds data structure

Parameters

vbounds	pointer to variable bounds data structure
blkmem	block memory
set	global SCIP settings
vboundtype	type of variable bound (LOWER or UPPER)
var	variable z in x <= bz + d or x >= bz + d
coef	coefficient b in x <= bz + d or x >= bz + d
constant	constant d in x <= bz + d or x >= bz + d
added	pointer to store whether the variable bound was added

Definition at line 199 of file implics.c.

References FALSE, MAX, MIN, NULL, SCIP_Bool, SCIP_BOUNDTYPE_UPPER, SCIP_CALL, SCIP_OKAY, SCIP_VARSTATUS_COLUMN, SCIP_VARSTATUS_LOOSE, SCIP_VARTYPE_CONTINUOUS, SCIPsetIsZero(), SCIPvarGetStatus(), SCIPvarGetType(), TRUE, vboundsEnsureSize(), and vboundsSearchPos().

Referenced by varAddVbound().

SCIP_RETCODE SCIPvboundsDel	(	SCIP_VBOUNDS **	vbounds,
		BMS_BLKMEM *	blkmem,
		SCIP_VAR *	vbdvar,
		SCIP_Bool	negativecoef
	)

removes from variable x a variable bound x >=/<= b*z + d with binary or integer z

Parameters

vbounds	pointer to variable bounds data structure
blkmem	block memory
vbdvar	variable z in x >=/<= b*z + d
negativecoef	is coefficient b negative?

Definition at line 281 of file implics.c.

References NULL, SCIP_Bool, SCIP_CALL, SCIP_OKAY, SCIPvboundsFree(), and vboundsSearchPos().

Referenced by varRemoveImplicsVbs().

void SCIPvboundsShrink	(	SCIP_VBOUNDS **	vbounds,
		BMS_BLKMEM *	blkmem,
		int	newnvbds
	)

reduces the number of variable bounds stored in the given variable bounds data structure

Parameters

vbounds	pointer to variable bounds data structure
blkmem	block memory
newnvbds	new number of variable bounds

Definition at line 326 of file implics.c.

References NULL, and SCIPvboundsFree().

Referenced by varRemoveImplicsVbs().

static SCIP_DECL_SORTPTRCOMP ( compVars )

static

comparator function for implication variables in the implication data structure

Definition at line 352 of file implics.c.

References NULL, SCIP_VARTYPE_BINARY, SCIPABORT, SCIPvarGetIndex(), and SCIPvarGetType().

static void checkImplics	(	SCIP_IMPLICS *	implics,
		SCIP_SET *	set
	)

static

performs integrity check on implications data structure

Parameters

implics	implications data structure
set	global SCIP settings

Definition at line 400 of file implics.c.

References SCIP_Implics::bounds, FALSE, SCIP_Implics::nbinimpls, SCIP_Implics::nimpls, NULL, SCIP_Bool, SCIP_BOUNDTYPE_LOWER, SCIP_BOUNDTYPE_UPPER, SCIP_Real, SCIP_VARTYPE_BINARY, SCIPsetIsFeasEQ(), SCIPsetIsFeasZero(), SCIPvarGetType(), TRUE, SCIP_Implics::types, and SCIP_Implics::vars.

Referenced by SCIPimplicsAdd(), and SCIPimplicsDel().

static SCIP_RETCODE implicsCreate	(	SCIP_IMPLICS **	implics,
		BMS_BLKMEM *	blkmem
	)

static

creates an implications data structure

Parameters

implics	pointer to store implications data structure
blkmem	block memory

Definition at line 489 of file implics.c.

References BMSallocBlockMemory, NULL, SCIP_ALLOC, and SCIP_OKAY.

Referenced by implicsEnsureSize().

void SCIPimplicsFree	(	SCIP_IMPLICS **	implics,
		BMS_BLKMEM *	blkmem
	)

frees an implications data structure

Parameters

implics	pointer of implications data structure to free
blkmem	block memory

Definition at line 518 of file implics.c.

References BMSfreeBlockMemory, BMSfreeBlockMemoryArrayNull, and NULL.

Referenced by SCIPimplicsDel(), SCIPvarAggregate(), SCIPvarRemove(), varFree(), and varRemoveImplicsVbs().

static SCIP_RETCODE implicsEnsureSize	(	SCIP_IMPLICS **	implics,
		BMS_BLKMEM *	blkmem,
		SCIP_SET *	set,
		SCIP_Bool	varfixing,
		int	num
	)

static

ensures, that arrays for x == 0 or x == 1 in implications data structure can store at least num entries

Parameters

implics	pointer to implications data structure
blkmem	block memory
set	global SCIP settings
varfixing	FALSE if size of arrays for x == 0 has to be ensured, TRUE for x == 1
num	minimum number of entries to store

Definition at line 541 of file implics.c.

References BMSreallocBlockMemoryArray, implicsCreate(), NULL, SCIP_ALLOC, SCIP_CALL, SCIP_OKAY, and SCIPsetCalcMemGrowSize().

Referenced by SCIPimplicsAdd().

static void implicsSearchVar	(	SCIP_IMPLICS *	implics,
		SCIP_Bool	varfixing,
		SCIP_VAR *	implvar,
		int *	poslower,
		int *	posupper,
		int *	posadd
	)

static

gets the positions of the implications y >= l and y <= u in the implications data structure; if no lower or upper bound implication for y was found, -1 is returned

Parameters

implics	implications data structure
varfixing	FALSE if y is searched in implications for x == 0, TRUE for x == 1
implvar	variable y to search for
poslower	pointer to store position of y_lower (-1 if not found)
posupper	pointer to store position of y_upper (-1 if not found)
posadd	pointer to store position of first y entry, or where a new y entry should be placed

Definition at line 583 of file implics.c.

References SCIP_Implics::nbinimpls, SCIP_Implics::nimpls, NULL, SCIP_Bool, SCIP_BOUNDTYPE_LOWER, SCIP_BOUNDTYPE_UPPER, SCIP_VARTYPE_BINARY, SCIPsortedvecFindPtr(), SCIPvarGetType(), SCIP_Implics::types, and SCIP_Implics::vars.

Referenced by implicsSearchImplic(), and SCIPimplicsGetVarImplics().

static SCIP_Bool implicsSearchImplic	(	SCIP_IMPLICS *	implics,
		SCIP_Bool	varfixing,
		SCIP_VAR *	implvar,
		SCIP_BOUNDTYPE	impltype,
		int *	poslower,
		int *	posupper,
		int *	posadd
	)

static

returns whether variable y is already contained in implications for x == 0 or x == 1 with the given impltype y can be contained in structure with y >= b (y_lower) and y <= b (y_upper)

Parameters

implics	implications data structure
varfixing	FALSE if y is searched in implications for x == 0, TRUE for x == 1
implvar	variable y to search for
impltype	type of implication y <=/>= b to search for
poslower	pointer to store position of y_lower (inf if not found)
posupper	pointer to store position of y_upper (inf if not found)
posadd	pointer to store correct position (with respect to impltype) to add y

Definition at line 691 of file implics.c.

References implicsSearchVar(), NULL, and SCIP_BOUNDTYPE_LOWER.

Referenced by SCIPimplicsAdd(), SCIPimplicsContainsImpl(), and SCIPimplicsDel().

SCIP_RETCODE SCIPimplicsAdd	(	SCIP_IMPLICS **	implics,
		BMS_BLKMEM *	blkmem,
		SCIP_SET *	set,
		SCIP_STAT *	stat,
		SCIP_Bool	varfixing,
		SCIP_VAR *	implvar,
		SCIP_BOUNDTYPE	impltype,
		SCIP_Real	implbound,
		SCIP_Bool	isshortcut,
		SCIP_Bool *	conflict,
		SCIP_Bool *	added
	)

adds an implication x == 0/1 -> y <= b or y >= b to the implications data structure; the implication must be non-redundant

Parameters

implics	pointer to implications data structure
blkmem	block memory
set	global SCIP settings
stat	problem statistics
varfixing	FALSE if implication for x == 0 has to be added, TRUE for x == 1
implvar	variable y in implication y <= b or y >= b
impltype	type of implication y <= b (SCIP_BOUNDTYPE_UPPER) or y >= b (SCIP_BOUNDTYPE_LOWER)
implbound	bound b in implication y <= b or y >= b
isshortcut	is the implication a shortcut, i.e., added as part of the transitive closure of another implication?
conflict	pointer to store whether implication causes a conflict for variable x
added	pointer to store whether the implication was added

Definition at line 728 of file implics.c.

References BMSmoveMemoryArray, checkImplics(), FALSE, implicsEnsureSize(), implicsSearchImplic(), SCIP_Stat::nimplications, NULL, SCIP_Bool, SCIP_BOUNDTYPE_LOWER, SCIP_BOUNDTYPE_UPPER, SCIP_CALL, SCIP_OKAY, SCIP_VARSTATUS_COLUMN, SCIP_VARSTATUS_LOOSE, SCIP_VARTYPE_BINARY, SCIPdebugMessage, SCIPsetIsFeasGE(), SCIPsetIsFeasGT(), SCIPsetIsFeasLE(), SCIPsetIsFeasLT(), SCIPvarGetLbGlobal(), SCIPvarGetName(), SCIPvarGetStatus(), SCIPvarGetType(), SCIPvarGetUbGlobal(), SCIPvarIsActive(), and TRUE.

Referenced by varAddImplic().

SCIP_RETCODE SCIPimplicsDel	(	SCIP_IMPLICS **	implics,
		BMS_BLKMEM *	blkmem,
		SCIP_SET *	set,
		SCIP_Bool	varfixing,
		SCIP_VAR *	implvar,
		SCIP_BOUNDTYPE	impltype
	)

removes the implication x <= 0 or x >= 1 ==> y <= b or y >= b from the implications data structure

Parameters

implics	pointer to implications data structure
blkmem	block memory
set	global SCIP settings
varfixing	FALSE if y should be removed from implications for x <= 0, TRUE for x >= 1
implvar	variable y in implication y <= b or y >= b
impltype	type of implication y <= b (SCIP_BOUNDTYPE_UPPER) or y >= b (SCIP_BOUNDTYPE_LOWER)

Definition at line 939 of file implics.c.

References BMSmoveMemoryArray, checkImplics(), implicsSearchImplic(), NULL, SCIP_Bool, SCIP_BOUNDTYPE_LOWER, SCIP_BOUNDTYPE_UPPER, SCIP_OKAY, SCIP_VARTYPE_BINARY, SCIPdebugMessage, SCIPimplicsFree(), SCIPvarGetName(), and SCIPvarGetType().

Referenced by varAddImplic(), and varRemoveImplicsVbs().

void SCIPimplicsGetVarImplics	(	SCIP_IMPLICS *	implics,
		SCIP_Bool	varfixing,
		SCIP_VAR *	implvar,
		SCIP_Bool *	haslowerimplic,
		SCIP_Bool *	hasupperimplic
	)

returns which implications on given variable y are contained in implications for x == 0 or x == 1

Parameters

implics	implications data structure
varfixing	FALSE if y should be searched in implications for x == 0, TRUE for x == 1
implvar	variable y to search for
haslowerimplic	pointer to store whether there exists an implication y >= l
hasupperimplic	pointer to store whether there exists an implication y <= u

Definition at line 1004 of file implics.c.

References implicsSearchVar(), and NULL.

SCIP_Bool SCIPimplicsContainsImpl	(	SCIP_IMPLICS *	implics,
		SCIP_Bool	varfixing,
		SCIP_VAR *	implvar,
		SCIP_BOUNDTYPE	impltype
	)

returns whether an implication y <= b or y >= b is contained in implications for x == 0 or x == 1

Parameters

implics	implications data structure
varfixing	FALSE if y should be searched in implications for x == 0, TRUE for x == 1
implvar	variable y to search for
impltype	type of implication y <=/>= b to search for

Definition at line 1026 of file implics.c.

References implicsSearchImplic().

Referenced by SCIPvarHasImplic().

static SCIP_RETCODE cliqueCreateWithData	(	SCIP_CLIQUE **	clique,
		BMS_BLKMEM *	blkmem,
		int	size,
		SCIP_VAR **	vars,
		SCIP_Bool *	values,
		int	nvars,
		int	id
	)

static

creates a clique data structure with already created variables and values arrays in the size of 'size'

Parameters

clique	pointer to store clique data structure
blkmem	block memory
size	initial size of clique
vars	binary variables in the clique: at most one can be set to the given value
values	values of the variables in the clique
nvars	number of variables in the clique
id	unique identifier of the clique

Definition at line 1081 of file implics.c.

References BMSallocBlockMemory, FALSE, NULL, SCIP_ALLOC, and SCIP_OKAY.

Referenced by SCIPcliquetableAdd().

static void cliqueFree	(	SCIP_CLIQUE **	clique,
		BMS_BLKMEM *	blkmem
	)

static

frees a clique data structure

Parameters

clique	pointer to store clique data structure
blkmem	block memory

Definition at line 1111 of file implics.c.

References BMSfreeBlockMemory, BMSfreeBlockMemoryArrayNull, and NULL.

Referenced by SCIPcliquetableCleanup(), and SCIPcliquetableFree().

static SCIP_RETCODE cliqueEnsureSize	(	SCIP_CLIQUE *	clique,
		BMS_BLKMEM *	blkmem,
		SCIP_SET *	set,
		int	num
	)

static

ensures, that clique arrays can store at least num entries

Parameters

clique	clique data structure
blkmem	block memory
set	global SCIP settings
num	minimum number of entries to store

Definition at line 1128 of file implics.c.

References BMSreallocBlockMemoryArray, NULL, SCIP_ALLOC, SCIP_OKAY, SCIPsetCalcMemGrowSize(), SCIP_Clique::size, SCIP_Clique::values, and SCIP_Clique::vars.

Referenced by SCIPcliqueAddVar().

int SCIPcliqueSearchVar	(	SCIP_CLIQUE *	clique,
		SCIP_VAR *	var,
		SCIP_Bool	value
	)

returns the position of the given variable/value pair in the clique; returns -1 if variable/value pair is not member of the clique

Parameters

clique	clique data structure
var	variable to search for
value	value of the variable in the clique

Definition at line 1154 of file implics.c.

References NULL, SCIP_Clique::nvars, SCIPvarGetIndex(), SCIP_Clique::values, and SCIP_Clique::vars.

Referenced by SCIPcliqueDelVar(), SCIPcliqueHasVar(), SCIPcliquelistCheck(), and SCIPcliquelistRemoveFromCliques().

SCIP_Bool SCIPcliqueHasVar	(	SCIP_CLIQUE *	clique,
		SCIP_VAR *	var,
		SCIP_Bool	value
	)

returns whether the given variable/value pair is member of the given clique

Parameters

clique	clique data structure
var	variable to remove from the clique
value	value of the variable in the clique

Definition at line 1214 of file implics.c.

References SCIPcliqueSearchVar().

SCIP_RETCODE SCIPcliqueAddVar	(	SCIP_CLIQUE *	clique,
		BMS_BLKMEM *	blkmem,
		SCIP_SET *	set,
		SCIP_VAR *	var,
		SCIP_Bool	value,
		SCIP_Bool *	doubleentry,
		SCIP_Bool *	oppositeentry
	)

adds a single variable to the given clique

Parameters

clique	clique data structure
blkmem	block memory
set	global SCIP settings
var	variable to add to the clique
value	value of the variable in the clique
doubleentry	pointer to store whether the variable and value occurs twice in the clique
oppositeentry	pointer to store whether the variable with opposite value is in the clique

Definition at line 1224 of file implics.c.

References BMSmoveMemoryArray, cliqueEnsureSize(), SCIP_Clique::eventsissued, FALSE, SCIP_Clique::id, NULL, SCIP_Clique::nvars, SCIP_CALL, SCIP_OKAY, SCIP_VARSTATUS_COLUMN, SCIP_VARSTATUS_LOOSE, SCIPdebugMessage, SCIPsortedvecFindPtr(), SCIPvarGetName(), SCIPvarGetStatus(), SCIPvarIsBinary(), TRUE, SCIP_Clique::values, and SCIP_Clique::vars.

Referenced by SCIPvarAddClique().

SCIP_RETCODE SCIPcliqueDelVar	(	SCIP_CLIQUE *	clique,
		SCIP_VAR *	var,
		SCIP_Bool	value
	)

removes a single variable from the given clique

Parameters

clique	clique data structure
var	variable to remove from the clique
value	value of the variable in the clique

Definition at line 1358 of file implics.c.

References SCIP_Clique::id, NULL, SCIP_Clique::nvars, SCIP_OKAY, SCIP_VARSTATUS_COLUMN, SCIP_VARSTATUS_LOOSE, SCIPcliqueSearchVar(), SCIPdebugMessage, SCIPvarGetName(), SCIPvarGetStatus(), SCIPvarIsBinary(), SCIP_Clique::values, and SCIP_Clique::vars.

Referenced by SCIPvarDelClique().

static int cliquesSearchClique	(	SCIP_CLIQUE **	cliques,
		int	ncliques,
		SCIP_CLIQUE *	clique
	)

static

gets the position of the given clique in the cliques array; returns -1 if clique is not member of cliques array

Parameters

cliques	array of cliques
ncliques	number of cliques in the cliques array
clique	clique to search for

Definition at line 1391 of file implics.c.

References SCIP_Clique::id, and NULL.

Referenced by cliqueCheck(), and SCIPcliquelistDel().

static void cliqueCheck ( SCIP_CLIQUE * clique )

static

checks whether clique appears in all clique lists of the involved variables

Parameters

clique clique data structure

Definition at line 1432 of file implics.c.

References cliquesSearchClique(), NULL, SCIP_Clique::nvars, SCIPvarGetCliques(), SCIPvarGetIndex(), SCIPvarGetNCliques(), SCIP_Clique::values, and SCIP_Clique::vars.

Referenced by SCIPcliquelistRemoveFromCliques(), and SCIPcliquetableAdd().

static SCIP_RETCODE cliquelistCreate	(	SCIP_CLIQUELIST **	cliquelist,
		BMS_BLKMEM *	blkmem
	)

static

creates a clique list data structure

Parameters

cliquelist	pointer to store clique list data structure
blkmem	block memory

Definition at line 1461 of file implics.c.

References BMSallocBlockMemory, NULL, SCIP_ALLOC, and SCIP_OKAY.

Referenced by SCIPcliquelistAdd().

void SCIPcliquelistFree	(	SCIP_CLIQUELIST **	cliquelist,
		BMS_BLKMEM *	blkmem
	)

frees a clique list data structure

Parameters

cliquelist	pointer to the clique list data structure
blkmem	block memory

Definition at line 1480 of file implics.c.

References BMSfreeBlockMemory, BMSfreeBlockMemoryArrayNull, and NULL.

Referenced by SCIPcliquelistDel(), SCIPvarAggregate(), SCIPvarFix(), SCIPvarMultiaggregate(), and varFree().

static SCIP_RETCODE cliquelistEnsureSize	(	SCIP_CLIQUELIST *	cliquelist,
		BMS_BLKMEM *	blkmem,
		SCIP_SET *	set,
		SCIP_Bool	value,
		int	num
	)

static

ensures, that clique list arrays can store at least num entries

Parameters

cliquelist	clique list data structure
blkmem	block memory
set	global SCIP settings
value	value of the variable for which the clique list should be extended
num	minimum number of entries to store

Definition at line 1497 of file implics.c.

References BMSreallocBlockMemoryArray, SCIP_CliqueList::cliques, NULL, SCIP_ALLOC, SCIP_OKAY, SCIPsetCalcMemGrowSize(), and SCIP_CliqueList::size.

Referenced by SCIPcliquelistAdd().

SCIP_RETCODE SCIPcliquelistAdd	(	SCIP_CLIQUELIST **	cliquelist,
		BMS_BLKMEM *	blkmem,
		SCIP_SET *	set,
		SCIP_Bool	value,
		SCIP_CLIQUE *	clique
	)

adds a clique to the clique list

Parameters

cliquelist	pointer to the clique list data structure
blkmem	block memory
set	global SCIP settings
value	value of the variable for which the clique list should be extended
clique	clique that should be added to the clique list

Definition at line 1521 of file implics.c.

References cliquelistCreate(), cliquelistEnsureSize(), SCIP_Clique::id, SCIP_CliqueList::ncliques, NULL, SCIP_CALL, SCIP_OKAY, and SCIPdebugMessage.

Referenced by SCIPvarAddClique(), and SCIPvarsAddClique().

SCIP_RETCODE SCIPcliquelistDel	(	SCIP_CLIQUELIST **	cliquelist,
		BMS_BLKMEM *	blkmem,
		SCIP_Bool	value,
		SCIP_CLIQUE *	clique
	)

removes a clique from the clique list

Parameters

cliquelist	pointer to the clique list data structure
blkmem	block memory
value	value of the variable for which the clique list should be reduced
clique	clique that should be deleted from the clique list

Definition at line 1557 of file implics.c.

References BMSmoveMemoryArray, cliquesSearchClique(), SCIP_Clique::id, SCIP_CliqueList::ncliques, NULL, SCIP_OKAY, SCIPcliquelistFree(), and SCIPdebugMessage.

Referenced by SCIPvarDelClique(), and SCIPvarDelCliqueFromList().

SCIP_Bool SCIPcliquelistsHaveCommonClique	(	SCIP_CLIQUELIST *	cliquelist1,
		SCIP_Bool	value1,
		SCIP_CLIQUELIST *	cliquelist2,
		SCIP_Bool	value2
	)

returns whether the given clique lists have a non-empty intersection, i.e. whether there is a clique that appears in both lists

Parameters

cliquelist1	first clique list data structure
value1	value of first variable
cliquelist2	second clique list data structure
value2	value of second variable

Definition at line 1594 of file implics.c.

References SCIP_CliqueList::cliques, FALSE, SCIP_CliqueList::ncliques, NULL, SCIPcliqueGetId(), and TRUE.

Referenced by SCIPvarsHaveCommonClique().

void SCIPcliquelistRemoveFromCliques	(	SCIP_CLIQUELIST *	cliquelist,
		SCIP_VAR *	var
	)

removes all listed entries from the cliques

Parameters

cliquelist	clique list data structure
var	active problem variable the clique list belongs to

Definition at line 1672 of file implics.c.

References BMSmoveMemoryArray, cliqueCheck(), SCIP_CliqueList::cliques, SCIP_Clique::id, SCIP_CliqueList::ncliques, NULL, SCIP_Clique::nvars, SCIP_Bool, SCIPcliqueSearchVar(), SCIPdebugMessage, SCIPvarGetCliques(), SCIPvarGetName(), SCIPvarGetNCliques(), SCIPvarIsBinary(), SCIP_Clique::values, and SCIP_Clique::vars.

Referenced by SCIPvarAggregate(), SCIPvarFix(), and SCIPvarMultiaggregate().

SCIP_RETCODE SCIPcliquetableCreate ( SCIP_CLIQUETABLE ** cliquetable )

creates a clique table data structure

Parameters

cliquetable pointer to store clique table data structure

Definition at line 1724 of file implics.c.

References BMSallocMemory, NULL, SCIP_ALLOC, and SCIP_OKAY.

Referenced by SCIPtransformProb().

SCIP_RETCODE SCIPcliquetableFree	(	SCIP_CLIQUETABLE **	cliquetable,
		BMS_BLKMEM *	blkmem
	)

frees a clique table data structure

Parameters

cliquetable	pointer to store clique table data structure
blkmem	block memory

Definition at line 1743 of file implics.c.

References BMSfreeMemory, BMSfreeMemoryArrayNull, cliqueFree(), NULL, and SCIP_OKAY.

Referenced by freeTransform().

static SCIP_RETCODE cliquetableEnsureSize	(	SCIP_CLIQUETABLE *	cliquetable,
		SCIP_SET *	set,
		int	num
	)

static

ensures, that clique table arrays can store at least num entries

Parameters

cliquetable	clique table data structure
set	global SCIP settings
num	minimum number of entries to store

Definition at line 1768 of file implics.c.

References BMSreallocMemoryArray, SCIP_CliqueTable::cliques, NULL, SCIP_ALLOC, SCIP_OKAY, SCIPsetCalcMemGrowSize(), and SCIP_CliqueTable::size.

Referenced by SCIPcliquetableAdd().

SCIP_RETCODE SCIPcliquetableAdd	(	SCIP_CLIQUETABLE *	cliquetable,
		BMS_BLKMEM *	blkmem,
		SCIP_SET *	set,
		SCIP_STAT *	stat,
		SCIP_PROB *	transprob,
		SCIP_PROB *	origprob,
		SCIP_TREE *	tree,
		SCIP_LP *	lp,
		SCIP_BRANCHCAND *	branchcand,
		SCIP_EVENTQUEUE *	eventqueue,
		SCIP_VAR **	vars,
		SCIP_Bool *	values,
		int	nvars,
		SCIP_Bool *	infeasible,
		int *	nbdchgs
	)

adds a clique to the clique table, using the given values for the given variables; performs implications if the clique contains the same variable twice

Parameters

cliquetable	clique table data structure
blkmem	block memory
set	global SCIP settings
stat	problem statistics
transprob	transformed problem
origprob	original problem
tree	branch and bound tree if in solving stage
lp	current LP data
branchcand	branching candidate storage
eventqueue	event queue
vars	binary variables in the clique: at most one can be set to the given value
values	values of the variables in the clique; NULL to use TRUE for all vars
nvars	number of variables in the clique
infeasible	pointer to store whether an infeasibility was detected
nbdchgs	pointer to count the number of performed bound changes, or NULL

Definition at line 1792 of file implics.c.

References BMSallocBlockMemoryArray, BMSduplicateBlockMemoryArray, BMSfreeBlockMemoryArray, cliqueCheck(), cliqueCreateWithData(), SCIP_CliqueTable::cliques, cliquetableEnsureSize(), FALSE, SCIP_CliqueTable::ncliques, SCIP_CliqueTable::ncreatedcliques, NULL, SCIP_ALLOC, SCIP_Bool, SCIP_CALL, SCIP_OKAY, SCIP_VARSTATUS_COLUMN, SCIP_VARSTATUS_FIXED, SCIP_VARSTATUS_LOOSE, SCIP_VARSTATUS_MULTAGGR, SCIPdebugCheckClique, SCIPdebugMessage, SCIPsortPtrBool(), SCIPvarAddClique(), SCIPvarFixBinary(), SCIPvarGetLbGlobal(), SCIPvarGetStatus(), SCIPvarGetUbGlobal(), SCIPvarIsBinary(), SCIPvarsAddClique(), SCIPvarsGetProbvarBinary(), and TRUE.

Referenced by SCIPaddClique().

static SCIP_DECL_HASHGETKEY ( hashgetkeyClique )

static

gets the key of the given element

Definition at line 2055 of file implics.c.

static SCIP_DECL_HASHKEYEQ ( hashkeyeqClique )

static

returns TRUE iff both keys are equal

Definition at line 2062 of file implics.c.

References FALSE, NULL, SCIP_Clique::nvars, TRUE, SCIP_Clique::values, and SCIP_Clique::vars.

static SCIP_DECL_HASHKEYVAL ( hashkeyvalClique )

static

returns the hash value of the key

Definition at line 2088 of file implics.c.

References SCIP_Clique::nvars, SCIP_Clique::values, and SCIP_Clique::vars.

SCIP_RETCODE SCIPcliquetableCleanup	(	SCIP_CLIQUETABLE *	cliquetable,
		BMS_BLKMEM *	blkmem,
		SCIP_SET *	set,
		SCIP_STAT *	stat,
		SCIP_PROB *	transprob,
		SCIP_PROB *	origprob,
		SCIP_TREE *	tree,
		SCIP_LP *	lp,
		SCIP_BRANCHCAND *	branchcand,
		SCIP_EVENTQUEUE *	eventqueue,
		SCIP_Bool *	infeasible
	)

removes all empty and single variable cliques from the clique table, and converts all two variable cliques into implications; removes double entries from the clique table

Parameters

cliquetable	clique table data structure
blkmem	block memory
set	global SCIP settings
stat	problem statistics
transprob	transformed problem
origprob	original problem
tree	branch and bound tree if in solving stage
lp	current LP data
branchcand	branching candidate storage
eventqueue	event queue
infeasible	pointer to store whether an infeasibility was detected

Definition at line 2108 of file implics.c.

References cliqueFree(), SCIP_CliqueTable::cliques, SCIP_Clique::eventsissued, FALSE, MAX, SCIP_CliqueTable::ncleanupaggrvars, SCIP_CliqueTable::ncleanupcliques, SCIP_CliqueTable::ncleanupfixedvars, SCIP_CliqueTable::ncliques, SCIP_Stat::npresolaggrvars, SCIP_Stat::npresolfixedvars, NULL, SCIP_Clique::nvars, SCIP_BOUNDTYPE_LOWER, SCIP_BOUNDTYPE_UPPER, SCIP_CALL, SCIP_HASHSIZE_CLIQUES, SCIP_HASHSIZE_CLIQUES_SMALL, SCIP_OKAY, SCIP_Real, SCIP_VARTYPE_BINARY, SCIPcalcHashtableSize(), SCIPeventCreateImplAdded(), SCIPeventqueueAdd(), SCIPeventqueueDelay(), SCIPeventqueueProcess(), SCIPhashtableCreate(), SCIPhashtableExists(), SCIPhashtableFree(), SCIPhashtableInsert(), SCIPvarAddImplic(), SCIPvarAddVlb(), SCIPvarAddVub(), SCIPvarDelCliqueFromList(), SCIPvarGetType(), SCIPvarIsBinary(), TRUE, SCIP_Clique::values, and SCIP_Clique::vars.

Referenced by exitPresolve(), and presolveRound().

int SCIPvboundsGetNVbds ( SCIP_VBOUNDS * vbounds )

gets number of variable bounds contained in given variable bounds data structure

Parameters

vbounds variable bounds data structure

Definition at line 2273 of file implics.c.

References SCIP_VBounds::len, and NULL.

Referenced by SCIPvarAggregate(), SCIPvarGetNVlbs(), SCIPvarGetNVubs(), varAddTransitiveImplic(), and varRemoveImplicsVbs().

SCIP_VAR** SCIPvboundsGetVars ( SCIP_VBOUNDS * vbounds )

gets array of variables contained in given variable bounds data structure

Parameters

vbounds variable bounds data structure

Definition at line 2281 of file implics.c.

References NULL, and SCIP_VBounds::vars.

Referenced by SCIPvarAggregate(), SCIPvarGetVlbVars(), SCIPvarGetVubVars(), varAddTransitiveImplic(), and varRemoveImplicsVbs().

SCIP_Real* SCIPvboundsGetCoefs ( SCIP_VBOUNDS * vbounds )

gets array of coefficients contained in given variable bounds data structure

Parameters

vbounds variable bounds data structure

Definition at line 2289 of file implics.c.

References SCIP_VBounds::coefs, and NULL.

Referenced by SCIPvarAggregate(), SCIPvarGetVlbCoefs(), SCIPvarGetVubCoefs(), varAddTransitiveImplic(), and varRemoveImplicsVbs().

SCIP_Real* SCIPvboundsGetConstants ( SCIP_VBOUNDS * vbounds )

gets array of constants contained in given variable bounds data structure

Parameters

vbounds variable bounds data structure

Definition at line 2297 of file implics.c.

References SCIP_VBounds::constants, and NULL.

Referenced by SCIPvarAggregate(), SCIPvarGetVlbConstants(), SCIPvarGetVubConstants(), varAddTransitiveImplic(), and varRemoveImplicsVbs().

int SCIPimplicsGetNImpls	(	SCIP_IMPLICS *	implics,
		SCIP_Bool	varfixing
	)

gets number of implications for a given binary variable fixing

Parameters

implics	implication data
varfixing	should the implications on var == FALSE or var == TRUE be returned?

Definition at line 2305 of file implics.c.

References SCIP_Implics::nimpls, and NULL.

Referenced by SCIPvarAggregate(), SCIPvarGetNImpls(), varAddTransitiveBinaryClosureImplic(), and varRemoveImplicsVbs().

int SCIPimplicsGetNBinImpls	(	SCIP_IMPLICS *	implics,
		SCIP_Bool	varfixing
	)

gets number of implications on binary variables for a given binary variable fixing

Parameters

implics	implication data
varfixing	should the implications on var == FALSE or var == TRUE be returned?

Definition at line 2314 of file implics.c.

References SCIP_Implics::nbinimpls, and NULL.

Referenced by SCIPvarGetImplRedcost(), SCIPvarGetNBinImpls(), and varRemoveImplicsVbs().

SCIP_VAR** SCIPimplicsGetVars	(	SCIP_IMPLICS *	implics,
		SCIP_Bool	varfixing
	)

gets array with implied variables for a given binary variable fixing

Parameters

implics	implication data
varfixing	should the implications on var == FALSE or var == TRUE be returned?

Definition at line 2323 of file implics.c.

References NULL, and SCIP_Implics::vars.

Referenced by SCIPvarAggregate(), SCIPvarGetImplRedcost(), SCIPvarGetImplVars(), varAddTransitiveBinaryClosureImplic(), and varRemoveImplicsVbs().

SCIP_BOUNDTYPE* SCIPimplicsGetTypes	(	SCIP_IMPLICS *	implics,
		SCIP_Bool	varfixing
	)

gets array with implication types for a given binary variable fixing

Parameters

implics	implication data
varfixing	should the implications on var == FALSE or var == TRUE be returned?

Definition at line 2332 of file implics.c.

References NULL, and SCIP_Implics::types.

Referenced by SCIPvarAggregate(), SCIPvarGetImplRedcost(), SCIPvarGetImplTypes(), varAddTransitiveBinaryClosureImplic(), and varRemoveImplicsVbs().

SCIP_Real* SCIPimplicsGetBounds	(	SCIP_IMPLICS *	implics,
		SCIP_Bool	varfixing
	)

gets array with implication bounds for a given binary variable fixing

Parameters

implics	implication data
varfixing	should the implications on var == FALSE or var == TRUE be returned?

Definition at line 2341 of file implics.c.

References SCIP_Implics::bounds, and NULL.

Referenced by SCIPvarAggregate(), SCIPvarGetImplBounds(), varAddTransitiveBinaryClosureImplic(), and varRemoveImplicsVbs().

int* SCIPimplicsGetIds	(	SCIP_IMPLICS *	implics,
		SCIP_Bool	varfixing
	)

Gets array with unique implication identifiers for a given binary variable fixing. If an implication is a shortcut, i.e., it was added as part of the transitive closure of another implication, its id is negative, otherwise it is nonnegative.

Parameters