Detailed Description

methods for cut selectors

Functions
const char *	SCIPcutselGetName (SCIP_CUTSEL *cutsel)

SCIP_CUTSELDATA *	SCIPcutselGetData (SCIP_CUTSEL *cutsel)

const char *	SCIPcutselGetDesc (SCIP_CUTSEL *cutsel)

int	SCIPcutselGetPriority (SCIP_CUTSEL *cutsel)

void	SCIPcutselSetData (SCIP_CUTSEL cutsel, SCIP_CUTSELDATA cutseldata)

SCIP_Bool	SCIPcutselIsInitialized (SCIP_CUTSEL *cutsel)

SCIP_Real	SCIPcutselGetSetupTime (SCIP_CUTSEL *cutsel)

SCIP_Real	SCIPcutselGetTime (SCIP_CUTSEL *cutsel)

	SCIP_DECL_SORTPTRCOMP (SCIPcutselComp)

SCIP_RETCODE	SCIPincludeCutsel (SCIP scip, const char name, const char desc, int priority, SCIP_DECL_CUTSELCOPY((cutselcopy)), SCIP_DECL_CUTSELFREE((cutselfree)), SCIP_DECL_CUTSELINIT((cutselinit)), SCIP_DECL_CUTSELEXIT((cutselexit)), SCIP_DECL_CUTSELINITSOL((cutselinitsol)), SCIP_DECL_CUTSELEXITSOL((cutselexitsol)), SCIP_DECL_CUTSELSELECT((cutselselect)), SCIP_CUTSELDATA *cutseldata)

SCIP_RETCODE	SCIPincludeCutselBasic (SCIP scip, SCIP_CUTSEL cutsel, const char name, const char desc, int priority, SCIP_DECL_CUTSELSELECT((cutselselect)), SCIP_CUTSELDATA *cutseldata)

SCIP_RETCODE	SCIPsetCutselCopy (SCIP scip, SCIP_CUTSEL cutsel, SCIP_DECL_CUTSELCOPY((*cutselcopy)))

SCIP_RETCODE	SCIPsetCutselFree (SCIP scip, SCIP_CUTSEL cutsel, SCIP_DECL_CUTSELFREE((*cutselfree)))

SCIP_RETCODE	SCIPsetCutselInit (SCIP scip, SCIP_CUTSEL cutsel, SCIP_DECL_CUTSELINIT((*cutselinit)))

SCIP_RETCODE	SCIPsetCutselExit (SCIP scip, SCIP_CUTSEL cutsel, SCIP_DECL_CUTSELEXIT((*cutselexit)))

SCIP_RETCODE	SCIPsetCutselInitsol (SCIP scip, SCIP_CUTSEL cutsel, SCIP_DECL_CUTSELINITSOL((*cutselinitsol)))

SCIP_RETCODE	SCIPsetCutselExitsol (SCIP scip, SCIP_CUTSEL cutsel, SCIP_DECL_CUTSELEXITSOL((*cutselexitsol)))

SCIP_CUTSEL *	SCIPfindCutsel (SCIP scip, const char name)

SCIP_CUTSEL **	SCIPgetCutsels (SCIP *scip)

int	SCIPgetNCutsels (SCIP *scip)

SCIP_RETCODE	SCIPsetCutselPriority (SCIP scip, SCIP_CUTSEL cutsel, int priority)

Function Documentation

◆ SCIPcutselGetName()

const char* SCIPcutselGetName ( SCIP_CUTSEL * cutsel )

gets name of cut selector

Parameters

cutsel cut selector

Definition at line 142 of file cutsel.c.

References SCIP_Cutsel::name, and NULL.

Referenced by SCIP_DECL_CUTSELCOPY(), SCIP_DECL_DIALOGEXEC(), SCIPcutselCopyInclude(), SCIPincludeDialogDefaultFix(), SCIPincludeDialogDefaultSet(), and SCIPprintCutselectorStatistics().

◆ SCIPcutselGetData()

SCIP_CUTSELDATA* SCIPcutselGetData ( SCIP_CUTSEL * cutsel )

gets user data of cut selector

Parameters

cutsel cut selector

Definition at line 371 of file cutsel.c.

References SCIP_Cutsel::cutseldata, and NULL.

Referenced by SCIP_DECL_CUTSELCOPY(), SCIP_DECL_CUTSELEXIT(), SCIP_DECL_CUTSELEXITSOL(), SCIP_DECL_CUTSELFREE(), SCIP_DECL_CUTSELINIT(), SCIP_DECL_CUTSELINITSOL(), SCIP_DECL_CUTSELSELECT(), SCIPfindObjCutsel(), and SCIPgetObjCutsel().

◆ SCIPcutselGetDesc()

const char* SCIPcutselGetDesc ( SCIP_CUTSEL * cutsel )

gets description of cut selector

Parameters

cutsel cut selector

Definition at line 197 of file cutsel.c.

References SCIP_Cutsel::desc, and NULL.

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

◆ SCIPcutselGetPriority()

int SCIPcutselGetPriority ( SCIP_CUTSEL * cutsel )

gets priority of cut selector

Parameters

cutsel cut selector

Definition at line 392 of file cutsel.c.

References NULL, and SCIP_Cutsel::priority.

Referenced by SCIP_DECL_DIALOGEXEC().

◆ SCIPcutselSetData()

void SCIPcutselSetData	(	SCIP_CUTSEL *	cutsel,
		SCIP_CUTSELDATA *	cutseldata
	)

sets user data of cut selector; user has to free old data in advance!

Parameters

cutsel	cut selector
cutseldata	new cut selector user data

Definition at line 381 of file cutsel.c.

References SCIP_Cutsel::cutseldata, and NULL.

Referenced by SCIP_DECL_CUTSELFREE().

◆ SCIPcutselIsInitialized()

SCIP_Bool SCIPcutselIsInitialized ( SCIP_CUTSEL * cutsel )

is cut selector initialized?

Parameters

cutsel cut selector

Definition at line 497 of file cutsel.c.

References SCIP_Cutsel::initialized, and NULL.

◆ SCIPcutselGetSetupTime()

SCIP_Real SCIPcutselGetSetupTime ( SCIP_CUTSEL * cutsel )

gets time in seconds used in this cut selector for setting up for next stages

Parameters

cutsel cut selector

Definition at line 507 of file cutsel.c.

References NULL, SCIPclockGetTime(), and SCIP_Cutsel::setuptime.

Referenced by SCIPprintCutselectorStatistics().

◆ SCIPcutselGetTime()

SCIP_Real SCIPcutselGetTime ( SCIP_CUTSEL * cutsel )

gets time in seconds used in this cut selector

Parameters

cutsel cut selector

Definition at line 517 of file cutsel.c.

References SCIP_Cutsel::cutseltime, NULL, and SCIPclockGetTime().

Referenced by SCIPprintCutselectorStatistics().

◆ SCIP_DECL_SORTPTRCOMP()

SCIP_DECL_SORTPTRCOMP ( SCIPcutselComp )

compares two cut selectors w. r. to their priority

Definition at line 527 of file cutsel.c.

◆ SCIPincludeCutsel()

SCIP_RETCODE SCIPincludeCutsel	(	SCIP *	scip,
		const char *	name,
		const char *	desc,
		int	priority,
		SCIP_DECL_CUTSELCOPY((*cutselcopy))	,
		SCIP_DECL_CUTSELFREE((*cutselfree))	,
		SCIP_DECL_CUTSELINIT((*cutselinit))	,
		SCIP_DECL_CUTSELEXIT((*cutselexit))	,
		SCIP_DECL_CUTSELINITSOL((*cutselinitsol))	,
		SCIP_DECL_CUTSELEXITSOL((*cutselexitsol))	,
		SCIP_DECL_CUTSELSELECT((*cutselselect))	,
		SCIP_CUTSELDATA *	cutseldata
	)

creates a cut selector and includes it in SCIP

Note: this method has all cut selector callbacks as arguments and is thus changed every time a new callback is added in future releases; consider using SCIPincludeCutselBasic() 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 cut selector
desc	description of cut selector
priority	priority of the cut selector
cutseldata	cut selector data

Definition at line 41 of file scip_cutsel.c.

References FALSE, Scip::mem, Scip::messagehdlr, NULL, SCIP_CALL, SCIP_INVALIDDATA, SCIP_OKAY, SCIPcheckStage(), SCIPcutselCreate(), SCIPerrorMessage, SCIPfindCutsel(), SCIPsetIncludeCutsel(), Scip::set, SCIP_Mem::setmem, and TRUE.

Referenced by SCIPincludeObjCutsel().

◆ SCIPincludeCutselBasic()

SCIP_RETCODE SCIPincludeCutselBasic	(	SCIP *	scip,
		SCIP_CUTSEL **	cutsel,
		const char *	name,
		const char *	desc,
		int	priority,
		SCIP_DECL_CUTSELSELECT((*cutselselect))	,
		SCIP_CUTSELDATA *	cutseldata
	)

Creates a cut selector 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, see SCIPsetCutselCopy(), SCIPsetCutselFree(), SCIPsetCutselInit(), SCIPsetCutselExit(), SCIPsetCutselInitsol(), and SCIPsetCutselExitsol()

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

Parameters

scip	SCIP data structure
cutsel	reference to a cut selector, or NULL
name	name of cut selector
desc	description of cut selector
priority	priority of the cut selector in standard mode
cutseldata	cut selector data

Definition at line 83 of file scip_cutsel.c.

References FALSE, Scip::mem, Scip::messagehdlr, NULL, SCIP_CALL, SCIP_INVALIDDATA, SCIP_OKAY, SCIPcheckStage(), SCIPcutselCreate(), SCIPerrorMessage, SCIPfindCutsel(), SCIPsetIncludeCutsel(), Scip::set, SCIP_Mem::setmem, and TRUE.

Referenced by SCIPincludeCutselHybrid().

◆ SCIPsetCutselCopy()

SCIP_RETCODE SCIPsetCutselCopy	(	SCIP *	scip,
		SCIP_CUTSEL *	cutsel,
		SCIP_DECL_CUTSELCOPY((*cutselcopy))
	)

sets copy method of cut selector

Parameters

scip	SCIP data structure
cutsel	cut selector

Definition at line 116 of file scip_cutsel.c.

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

Referenced by SCIPincludeCutselHybrid().

◆ SCIPsetCutselFree()

SCIP_RETCODE SCIPsetCutselFree	(	SCIP *	scip,
		SCIP_CUTSEL *	cutsel,
		SCIP_DECL_CUTSELFREE((*cutselfree))
	)

sets destructor method of cut selector

Parameters

scip	SCIP data structure
cutsel	cut selector

Definition at line 132 of file scip_cutsel.c.

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

Referenced by SCIPincludeCutselHybrid().

◆ SCIPsetCutselInit()

SCIP_RETCODE SCIPsetCutselInit	(	SCIP *	scip,
		SCIP_CUTSEL *	cutsel,
		SCIP_DECL_CUTSELINIT((*cutselinit))
	)

sets initialization method of cut selector

Parameters

scip	SCIP data structure
cutsel	cut selector

Definition at line 148 of file scip_cutsel.c.

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

Referenced by SCIPincludeCutselHybrid().

◆ SCIPsetCutselExit()

SCIP_RETCODE SCIPsetCutselExit	(	SCIP *	scip,
		SCIP_CUTSEL *	cutsel,
		SCIP_DECL_CUTSELEXIT((*cutselexit))
	)

sets deinitialization method of cut selector

Parameters

scip	SCIP data structure
cutsel	cut selector

Definition at line 164 of file scip_cutsel.c.

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

Referenced by SCIPincludeCutselHybrid().

◆ SCIPsetCutselInitsol()

SCIP_RETCODE SCIPsetCutselInitsol	(	SCIP *	scip,
		SCIP_CUTSEL *	cutsel,
		SCIP_DECL_CUTSELINITSOL((*cutselinitsol))
	)

sets solving process initialization method of cut selector

Parameters

scip	SCIP data structure
cutsel	cut selector

Definition at line 180 of file scip_cutsel.c.

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

◆ SCIPsetCutselExitsol()

SCIP_RETCODE SCIPsetCutselExitsol	(	SCIP *	scip,
		SCIP_CUTSEL *	cutsel,
		SCIP_DECL_CUTSELEXITSOL((*cutselexitsol))
	)

sets solving process deinitialization method of cut selector

Parameters

scip	SCIP data structure
cutsel	cut selector

Definition at line 196 of file scip_cutsel.c.

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

◆ SCIPfindCutsel()

SCIP_CUTSEL* SCIPfindCutsel	(	SCIP *	scip,
		const char *	name
	)

returns the cut selector of the given name, or NULL if not existing

Parameters

scip	SCIP data structure
name	name of cut selector

Definition at line 212 of file scip_cutsel.c.

References NULL, SCIPsetFindCutsel(), and Scip::set.

Referenced by SCIPfindObjCutsel(), SCIPincludeCutsel(), and SCIPincludeCutselBasic().

◆ SCIPgetCutsels()

SCIP_CUTSEL** SCIPgetCutsels ( SCIP * scip )

returns the array of currently available cut selectors

Parameters

scip	SCIP data structure

Definition at line 225 of file scip_cutsel.c.

References SCIP_Set::cutsels, NULL, SCIPsetSortCutsels(), and Scip::set.

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

◆ SCIPgetNCutsels()

int SCIPgetNCutsels ( SCIP * scip )

returns the number of currently available cut selectors

Parameters

scip	SCIP data structure

Definition at line 238 of file scip_cutsel.c.

References SCIP_Set::ncutsels, NULL, and Scip::set.

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

◆ SCIPsetCutselPriority()

SCIP_RETCODE SCIPsetCutselPriority	(	SCIP *	scip,
		SCIP_CUTSEL *	cutsel,
		int	priority
	)

sets the priority of a cut selector

Parameters

scip	SCIP data structure
cutsel	cut selector
priority	new priority of the separator

Definition at line 249 of file scip_cutsel.c.

References NULL, SCIP_OKAY, SCIPcutselSetPriority(), and Scip::set.

Referenced by SCIP_DECL_PARAMCHGD().

SCIP

Detailed Description

Functions

Function Documentation

◆ SCIPcutselGetName()

◆ SCIPcutselGetData()

◆ SCIPcutselGetDesc()

◆ SCIPcutselGetPriority()

◆ SCIPcutselSetData()

◆ SCIPcutselIsInitialized()

◆ SCIPcutselGetSetupTime()

◆ SCIPcutselGetTime()

◆ SCIP_DECL_SORTPTRCOMP()

◆ SCIPincludeCutsel()

◆ SCIPincludeCutselBasic()

◆ SCIPsetCutselCopy()

◆ SCIPsetCutselFree()

◆ SCIPsetCutselInit()

◆ SCIPsetCutselExit()

◆ SCIPsetCutselInitsol()

◆ SCIPsetCutselExitsol()

◆ SCIPfindCutsel()

◆ SCIPgetCutsels()

◆ SCIPgetNCutsels()

◆ SCIPsetCutselPriority()