Detailed Description
public methods for conflict handlers
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:
- 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 69 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:
- 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 116 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, | ||
SCIP_DECL_CONFLICTCOPY((*conflictcopy)) | |||
) |
set copy method of conflict handler
- Parameters
-
scip SCIP data structure conflicthdlr conflict handler
Definition at line 148 of file scip_conflict.c.
References FALSE, NULL, SCIP_CALL, SCIP_OKAY, SCIPcheckStage(), SCIPconflicthdlrSetCopy(), and TRUE.
◆ SCIPsetConflicthdlrFree()
SCIP_RETCODE SCIPsetConflicthdlrFree | ( | SCIP * | scip, |
SCIP_CONFLICTHDLR * | conflicthdlr, | ||
SCIP_DECL_CONFLICTFREE((*conflictfree)) | |||
) |
set destructor of conflict handler
- Parameters
-
scip SCIP data structure conflicthdlr conflict handler
Definition at line 164 of file scip_conflict.c.
References FALSE, NULL, SCIP_CALL, SCIP_OKAY, SCIPcheckStage(), SCIPconflicthdlrSetFree(), and TRUE.
Referenced by SCIPincludeConshdlrBounddisjunction(), and SCIPincludeConshdlrIndicator().
◆ SCIPsetConflicthdlrInit()
SCIP_RETCODE SCIPsetConflicthdlrInit | ( | SCIP * | scip, |
SCIP_CONFLICTHDLR * | conflicthdlr, | ||
SCIP_DECL_CONFLICTINIT((*conflictinit)) | |||
) |
set initialization method of conflict handler
- Parameters
-
scip SCIP data structure conflicthdlr conflict handler
Definition at line 180 of file scip_conflict.c.
References FALSE, NULL, SCIP_CALL, SCIP_OKAY, SCIPcheckStage(), SCIPconflicthdlrSetInit(), and TRUE.
◆ SCIPsetConflicthdlrExit()
SCIP_RETCODE SCIPsetConflicthdlrExit | ( | SCIP * | scip, |
SCIP_CONFLICTHDLR * | conflicthdlr, | ||
SCIP_DECL_CONFLICTEXIT((*conflictexit)) | |||
) |
set deinitialization method of conflict handler
- Parameters
-
scip SCIP data structure conflicthdlr conflict handler
Definition at line 196 of file scip_conflict.c.
References FALSE, NULL, SCIP_CALL, SCIP_OKAY, SCIPcheckStage(), SCIPconflicthdlrSetExit(), and TRUE.
◆ SCIPsetConflicthdlrInitsol()
SCIP_RETCODE SCIPsetConflicthdlrInitsol | ( | SCIP * | scip, |
SCIP_CONFLICTHDLR * | conflicthdlr, | ||
SCIP_DECL_CONFLICTINITSOL((*conflictinitsol)) | |||
) |
set solving process initialization method of conflict handler
- Parameters
-
scip SCIP data structure conflicthdlr conflict handler
Definition at line 212 of file scip_conflict.c.
References FALSE, NULL, SCIP_CALL, SCIP_OKAY, SCIPcheckStage(), SCIPconflicthdlrSetInitsol(), and TRUE.
◆ SCIPsetConflicthdlrExitsol()
SCIP_RETCODE SCIPsetConflicthdlrExitsol | ( | SCIP * | scip, |
SCIP_CONFLICTHDLR * | conflicthdlr, | ||
SCIP_DECL_CONFLICTEXITSOL((*conflictexitsol)) | |||
) |
set solving process deinitialization method of conflict handler
- Parameters
-
scip SCIP data structure conflicthdlr conflict handler
Definition at line 228 of file scip_conflict.c.
References 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 244 of file scip_conflict.c.
References 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 257 of file scip_conflict.c.
References 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 270 of file scip_conflict.c.
References 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 281 of file scip_conflict.c.
References NULL, SCIP_OKAY, and SCIPconflicthdlrSetPriority().
Referenced by SCIP_DECL_PARAMCHGD().