Conflict Analysis

Detailed Description

public functions for conflict handlers

Functions
SCIP_RETCODE	SCIPincludeConflicthdlr (SCIP *scip, const char *name, const char *desc, int priority, SCIP_DECL_CONFLICTCOPY((*conflictcopy)), SCIP_DECL_CONFLICTFREE((*conflictfree)), SCIP_DECL_CONFLICTINIT((*conflictinit)), SCIP_DECL_CONFLICTEXIT((*conflictexit)), SCIP_DECL_CONFLICTINITSOL((*conflictinitsol)), SCIP_DECL_CONFLICTEXITSOL((*conflictexitsol)), SCIP_DECL_CONFLICTEXEC((*conflictexec)), SCIP_CONFLICTHDLRDATA *conflicthdlrdata)
SCIP_RETCODE	SCIPincludeConflicthdlrBasic (SCIP *scip, SCIP_CONFLICTHDLR **conflicthdlrptr, const char *name, const char *desc, int priority, SCIP_DECL_CONFLICTEXEC((*conflictexec)), SCIP_CONFLICTHDLRDATA *conflicthdlrdata)
SCIP_RETCODE	SCIPsetConflicthdlrCopy (SCIP *scip, SCIP_CONFLICTHDLR *conflicthdlr,)
SCIP_RETCODE	SCIPsetConflicthdlrFree (SCIP *scip, SCIP_CONFLICTHDLR *conflicthdlr,)
SCIP_RETCODE	SCIPsetConflicthdlrInit (SCIP *scip, SCIP_CONFLICTHDLR *conflicthdlr,)
SCIP_RETCODE	SCIPsetConflicthdlrExit (SCIP *scip, SCIP_CONFLICTHDLR *conflicthdlr,)
SCIP_RETCODE	SCIPsetConflicthdlrInitsol (SCIP *scip, SCIP_CONFLICTHDLR *conflicthdlr,)
SCIP_RETCODE	SCIPsetConflicthdlrExitsol (SCIP *scip, SCIP_CONFLICTHDLR *conflicthdlr,)
SCIP_CONFLICTHDLR *	SCIPfindConflicthdlr (SCIP *scip, const char *name)
SCIP_CONFLICTHDLR **	SCIPgetConflicthdlrs (SCIP *scip)
int	SCIPgetNConflicthdlrs (SCIP *scip)
SCIP_RETCODE	SCIPsetConflicthdlrPriority (SCIP *scip, SCIP_CONFLICTHDLR *conflicthdlr, int priority)

Function Documentation

SCIPincludeConflicthdlr()

SCIP_RETCODE SCIPincludeConflicthdlr	(	SCIP *	scip,
		const char *	name,
		const char *	desc,
		int	priority,
		SCIP_DECL_CONFLICTCOPY((*conflictcopy))	,
		SCIP_DECL_CONFLICTFREE((*conflictfree))	,
		SCIP_DECL_CONFLICTINIT((*conflictinit))	,
		SCIP_DECL_CONFLICTEXIT((*conflictexit))	,
		SCIP_DECL_CONFLICTINITSOL((*conflictinitsol))	,
		SCIP_DECL_CONFLICTEXITSOL((*conflictexitsol))	,
		SCIP_DECL_CONFLICTEXEC((*conflictexec))	,
		SCIP_CONFLICTHDLRDATA *	conflicthdlrdata )

creates a conflict handler and includes it in SCIP

Note

method has all conflict handler callbacks as arguments and is thus changed every time a new callback is added in future releases; consider using SCIPincludeConflicthdlrBasic() and setter functions if you seek for a method which is less likely to change in future releases

creates a conflict handler and includes it in SCIP

Precondition

This method can be called if SCIP is in one of the following stages:

• SCIP_STAGE_INIT
• SCIP_STAGE_PROBLEM

Note

method has all conflict handler callbacks as arguments and is thus changed every time a new callback is added in future releases; consider using SCIPincludeConflicthdlrBasic() and setter functions if you seek for a method which is less likely to change in future releases

Parameters

scip	SCIP data structure
name	name of conflict handler
desc	description of conflict handler
priority	priority of the conflict handler
conflicthdlrdata	conflict handler data

Definition at line 74 of file scip_conflict.c.

References FALSE, NULL, SCIP_CALL, SCIP_INVALIDDATA, SCIP_OKAY, SCIPcheckStage, SCIPconflicthdlrCreate(), SCIPerrorMessage, SCIPfindConflicthdlr(), SCIPsetIncludeConflicthdlr(), and TRUE.

SCIPincludeConflicthdlrBasic()

SCIP_RETCODE SCIPincludeConflicthdlrBasic	(	SCIP *	scip,
		SCIP_CONFLICTHDLR **	conflicthdlrptr,
		const char *	name,
		const char *	desc,
		int	priority,
		SCIP_DECL_CONFLICTEXEC((*conflictexec))	,
		SCIP_CONFLICTHDLRDATA *	conflicthdlrdata )

creates a conflict handler and includes it in SCIP with its most fundamental callbacks. All non-fundamental (or optional) callbacks as, e.g., init and exit callbacks, will be set to NULL. Optional callbacks can be set via specific setter functions SCIPsetConflicthdlrCopy(), SCIPsetConflicthdlrFree(), SCIPsetConflicthdlrInit(), SCIPsetConflicthdlrExit(), SCIPsetConflicthdlrInitsol(), and SCIPsetConflicthdlrExitsol()

Note

if you want to set all callbacks with a single method call, consider using SCIPincludeConflicthdlr() instead

creates a conflict handler and includes it in SCIP with its most fundamental callbacks. All non-fundamental (or optional) callbacks as, e.g., init and exit callbacks, will be set to NULL. Optional callbacks can be set via specific setter functions SCIPsetConflicthdlrCopy(), SCIPsetConflicthdlrFree(), SCIPsetConflicthdlrInit(), SCIPsetConflicthdlrExit(), SCIPsetConflicthdlrInitsol(), and SCIPsetConflicthdlrExitsol()

Precondition

This method can be called if SCIP is in one of the following stages:

• SCIP_STAGE_INIT
• SCIP_STAGE_PROBLEM

Note

if you want to set all callbacks with a single method call, consider using SCIPincludeConflicthdlr() instead

Parameters

scip	SCIP data structure
conflicthdlrptr	reference to a conflict handler pointer, or NULL
name	name of conflict handler
desc	description of conflict handler
priority	priority of the conflict handler
conflicthdlrdata	conflict handler data

Definition at line 121 of file scip_conflict.c.

References FALSE, NULL, SCIP_CALL, SCIP_INVALIDDATA, SCIP_OKAY, SCIPcheckStage, SCIPconflicthdlrCreate(), SCIPerrorMessage, SCIPfindConflicthdlr(), SCIPsetIncludeConflicthdlr(), and TRUE.

Referenced by SCIPincludeConshdlrBounddisjunction(), SCIPincludeConshdlrIndicator(), SCIPincludeConshdlrLinear(), SCIPincludeConshdlrLogicor(), and SCIPincludeConshdlrSetppc().

SCIPsetConflicthdlrCopy()

SCIP_RETCODE SCIPsetConflicthdlrCopy	(	SCIP *	scip,
		SCIP_CONFLICTHDLR *	conflicthdlr )

set copy method of conflict handler

Parameters

scip	SCIP data structure
conflicthdlr	conflict handler copy method of conflict handler

Definition at line 153 of file scip_conflict.c.

References assert(), FALSE, NULL, SCIP_CALL, SCIP_OKAY, SCIPcheckStage, SCIPconflicthdlrSetCopy(), and TRUE.

SCIPsetConflicthdlrFree()

SCIP_RETCODE SCIPsetConflicthdlrFree	(	SCIP *	scip,
		SCIP_CONFLICTHDLR *	conflicthdlr )

set destructor of conflict handler

Parameters

scip	SCIP data structure
conflicthdlr	conflict handler destructor of conflict handler

Definition at line 169 of file scip_conflict.c.

References assert(), FALSE, NULL, SCIP_CALL, SCIP_OKAY, SCIPcheckStage, SCIPconflicthdlrSetFree(), and TRUE.

Referenced by SCIPincludeConshdlrBounddisjunction(), and SCIPincludeConshdlrIndicator().

SCIPsetConflicthdlrInit()

SCIP_RETCODE SCIPsetConflicthdlrInit	(	SCIP *	scip,
		SCIP_CONFLICTHDLR *	conflicthdlr )

set initialization method of conflict handler

Parameters

scip	SCIP data structure
conflicthdlr	conflict handler initialize conflict handler

Definition at line 185 of file scip_conflict.c.

References assert(), FALSE, NULL, SCIP_CALL, SCIP_OKAY, SCIPcheckStage, SCIPconflicthdlrSetInit(), and TRUE.

SCIPsetConflicthdlrExit()

SCIP_RETCODE SCIPsetConflicthdlrExit	(	SCIP *	scip,
		SCIP_CONFLICTHDLR *	conflicthdlr )

set deinitialization method of conflict handler

Parameters

scip	SCIP data structure
conflicthdlr	conflict handler deinitialize conflict handler

Definition at line 201 of file scip_conflict.c.

References assert(), FALSE, NULL, SCIP_CALL, SCIP_OKAY, SCIPcheckStage, SCIPconflicthdlrSetExit(), and TRUE.

SCIPsetConflicthdlrInitsol()

SCIP_RETCODE SCIPsetConflicthdlrInitsol	(	SCIP *	scip,
		SCIP_CONFLICTHDLR *	conflicthdlr )

set solving process initialization method of conflict handler

Parameters

scip	SCIP data structure
conflicthdlr	conflict handler solving process initialization method of conflict handler

Definition at line 217 of file scip_conflict.c.

References assert(), FALSE, NULL, SCIP_CALL, SCIP_OKAY, SCIPcheckStage, SCIPconflicthdlrSetInitsol(), and TRUE.

SCIPsetConflicthdlrExitsol()

SCIP_RETCODE SCIPsetConflicthdlrExitsol	(	SCIP *	scip,
		SCIP_CONFLICTHDLR *	conflicthdlr )

set solving process deinitialization method of conflict handler

Parameters

scip	SCIP data structure
conflicthdlr	conflict handler solving process deinitialization method of conflict handler

Definition at line 233 of file scip_conflict.c.

References assert(), FALSE, NULL, SCIP_CALL, SCIP_OKAY, SCIPcheckStage, SCIPconflicthdlrSetExitsol(), and TRUE.

SCIPfindConflicthdlr()

SCIP_CONFLICTHDLR * SCIPfindConflicthdlr	(	SCIP *	scip,
		const char *	name )

returns the conflict handler of the given name, or NULL if not existing

Parameters

scip	SCIP data structure
name	name of conflict handler

Definition at line 249 of file scip_conflict.c.

References assert(), NULL, and SCIPsetFindConflicthdlr().

Referenced by SCIPincludeConflicthdlr(), and SCIPincludeConflicthdlrBasic().

SCIPgetConflicthdlrs()

SCIP_CONFLICTHDLR ** SCIPgetConflicthdlrs

(

SCIP *

scip

)

returns the array of currently available conflict handlers

Parameters

scip	SCIP data structure

Definition at line 262 of file scip_conflict.c.

References assert(), NULL, and SCIPsetSortConflicthdlrs().

Referenced by SCIP_DECL_DIALOGEXEC(), SCIPincludeDialogDefaultFix(), and SCIPincludeDialogDefaultSet().

SCIPgetNConflicthdlrs()

int SCIPgetNConflicthdlrs

(

SCIP *

scip

)

returns the number of currently available conflict handlers

Parameters

scip	SCIP data structure

Definition at line 275 of file scip_conflict.c.

References assert(), and NULL.

Referenced by SCIP_DECL_DIALOGEXEC(), SCIPincludeDialogDefaultFix(), and SCIPincludeDialogDefaultSet().

SCIPsetConflicthdlrPriority()

SCIP_RETCODE SCIPsetConflicthdlrPriority	(	SCIP *	scip,
		SCIP_CONFLICTHDLR *	conflicthdlr,
		int	priority )

sets the priority of a conflict handler

Parameters

scip	SCIP data structure
conflicthdlr	conflict handler
priority	new priority of the conflict handler

Definition at line 286 of file scip_conflict.c.

References assert(), NULL, SCIP_OKAY, and SCIPconflicthdlrSetPriority().

Referenced by SCIP_DECL_PARAMCHGD().