Scippy

SCIP

Solving Constraint Integer Programs

Detailed Description

Constraint handler stores the local branching decision data.

Author: Timo Berthold; Stefan Heinz

This constraint handler is used to store the branching decision of the Ryan/Foster branching rule which is implemented in branch_ryanfoster.c.

Definition in file cons_samediff.h.

#include "scip/scip.h"

Go to the source code of this file.

Typedefs
typedef enum ConsType	CONSTYPE

Enumerations
enum	ConsType { DIFFER = 0, SAME = 1 }

Functions
SCIP_RETCODE	SCIPincludeConshdlrSamediff (SCIP *scip)

SCIP_RETCODE	SCIPcreateConsSamediff (SCIP scip, SCIP_CONS cons, const char name, int itemid1, int itemid2, CONSTYPE type, SCIP_NODE *node, SCIP_Bool local)

int	SCIPgetItemid1Samediff (SCIP scip, SCIP_CONS cons)

int	SCIPgetItemid2Samediff (SCIP scip, SCIP_CONS cons)

CONSTYPE	SCIPgetTypeSamediff (SCIP scip, SCIP_CONS cons)

Typedef Documentation

◆ CONSTYPE

typedef enum ConsType CONSTYPE

Definition at line 40 of file cons_samediff.h.

Enumeration Type Documentation

◆ ConsType

Enumerator
DIFFER	constraint representing the branching decision differ(i,j)
SAME	constraint representing the branching decision same(i,j)

Definition at line 35 of file cons_samediff.h.

Function Documentation

◆ SCIPincludeConshdlrSamediff()

SCIP_RETCODE SCIPincludeConshdlrSamediff ( SCIP * scip )

creates the handler for element constraints and includes it in SCIP

creates the handler for samediff constraints and includes it in SCIP

Parameters

scip	SCIP data structure

Definition at line 525 of file cons_samediff.c.

References consCheckSamediff, consEnfolpSamediff, consEnfopsSamediff, CONSHDLR_CHECKPRIORITY, CONSHDLR_DELAYPROP, CONSHDLR_DESC, CONSHDLR_EAGERFREQ, CONSHDLR_ENFOPRIORITY, CONSHDLR_NAME, CONSHDLR_NEEDSCONS, CONSHDLR_PROP_TIMING, CONSHDLR_PROPFREQ, consLockSamediff, NULL, SCIP_CALL, SCIP_OKAY, SCIPcreateConsSamediff(), SCIPincludeConshdlrBasic(), SCIPsetConshdlrActive(), SCIPsetConshdlrDeactive(), SCIPsetConshdlrDelete(), SCIPsetConshdlrPrint(), SCIPsetConshdlrProp(), and SCIPsetConshdlrTrans().

Referenced by runShell(), and SCIP_DECL_CONSPRINT().

◆ SCIPcreateConsSamediff()

SCIP_RETCODE SCIPcreateConsSamediff	(	SCIP *	scip,
		SCIP_CONS **	cons,
		const char *	name,
		int	itemid1,
		int	itemid2,
		CONSTYPE	type,
		SCIP_NODE *	node,
		SCIP_Bool	local
	)

creates and captures a samediff constraint

Parameters

scip	SCIP data structure
cons	pointer to hold the created constraint
name	name of constraint
itemid1	item id one
itemid2	item id two
type	stores whether the items have to be in the SAME or DIFFER packing
node	the node in the B&B-tree at which the cons is sticking
local	is constraint only valid locally?

Definition at line 551 of file cons_samediff.c.

References consdataCreate(), consdataPrint(), CONSHDLR_NAME, FALSE, NULL, SCIP_CALL, SCIP_OKAY, SCIP_PLUGINNOTFOUND, SCIPcreateCons(), SCIPdebug, SCIPdebugMsg, SCIPerrorMessage, SCIPfindConshdlr(), SCIPgetItemid1Samediff(), and TRUE.

Referenced by SCIP_DECL_BRANCHEXECLP(), and SCIPincludeConshdlrSamediff().

◆ SCIPgetItemid1Samediff()

int SCIPgetItemid1Samediff	(	SCIP *	scip,
		SCIP_CONS *	cons
	)

returns item id one

Parameters

scip	SCIP data structure
cons	samediff constraint

Definition at line 587 of file cons_samediff.c.

References NULL, SCIPconsGetData(), and SCIPgetItemid2Samediff().

Referenced by addBranchingDecisionConss(), and SCIPcreateConsSamediff().

◆ SCIPgetItemid2Samediff()

int SCIPgetItemid2Samediff	(	SCIP *	scip,
		SCIP_CONS *	cons
	)

returns item id two

Parameters

scip	SCIP data structure
cons	samediff constraint

Definition at line 603 of file cons_samediff.c.

References NULL, SCIPconsGetData(), and SCIPgetTypeSamediff().

Referenced by addBranchingDecisionConss(), and SCIPgetItemid1Samediff().

◆ SCIPgetTypeSamediff()

CONSTYPE SCIPgetTypeSamediff	(	SCIP *	scip,
		SCIP_CONS *	cons
	)

return constraint type SAME or DIFFER

Parameters

scip	SCIP data structure
cons	samediff constraint

Definition at line 619 of file cons_samediff.c.

References NULL, and SCIPconsGetData().

Referenced by addBranchingDecisionConss(), and SCIPgetItemid2Samediff().