Detailed Description

methods for cut selectors

Author: Felipe Serrano; Mark Turner

Definition in file cutsel.c.

#include <assert.h>
#include "scip/set.h"
#include "scip/clock.h"
#include "scip/paramset.h"
#include "scip/scip.h"
#include "scip/cutsel.h"
#include "scip/struct_cutsel.h"

Go to the source code of this file.

Functions
static	SCIP_DECL_PARAMCHGD (paramChgdCutselPriority)

static SCIP_RETCODE	doCutselCreate (SCIP_CUTSEL *cutsel, SCIP_SET set, SCIP_MESSAGEHDLR messagehdlr, BMS_BLKMEM blkmem, 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	SCIPcutselCreate (SCIP_CUTSEL *cutsel, SCIP_SET set, SCIP_MESSAGEHDLR messagehdlr, BMS_BLKMEM blkmem, 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)

const char *	SCIPcutselGetName (SCIP_CUTSEL *cutsel)

SCIP_RETCODE	SCIPcutselsSelect (SCIP_SET set, SCIP_ROW cuts, int ncuts, int nforcedcuts, SCIP_Bool root, SCIP_Bool initiallp, int maxnselectedcuts, int nselectedcuts)

const char *	SCIPcutselGetDesc (SCIP_CUTSEL *cutsel)

SCIP_RETCODE	SCIPcutselCopyInclude (SCIP_CUTSEL cutsel, SCIP_SET set)

SCIP_RETCODE	SCIPcutselFree (SCIP_CUTSEL *cutsel, SCIP_SET set)

SCIP_RETCODE	SCIPcutselInit (SCIP_CUTSEL cutsel, SCIP_SET set)

SCIP_RETCODE	SCIPcutselExit (SCIP_CUTSEL cutsel, SCIP_SET set)

SCIP_RETCODE	SCIPcutselInitsol (SCIP_CUTSEL cutsel, SCIP_SET set)

SCIP_RETCODE	SCIPcutselExitsol (SCIP_CUTSEL cutsel, SCIP_SET set)

SCIP_CUTSELDATA *	SCIPcutselGetData (SCIP_CUTSEL *cutsel)

void	SCIPcutselSetData (SCIP_CUTSEL cutsel, SCIP_CUTSELDATA cutseldata)

int	SCIPcutselGetPriority (SCIP_CUTSEL *cutsel)

void	SCIPcutselEnableOrDisableClocks (SCIP_CUTSEL *cutsel, SCIP_Bool enable)

void	SCIPcutselSetCopy (SCIP_CUTSEL cutsel, SCIP_DECL_CUTSELCOPY((cutselcopy)))

void	SCIPcutselSetFree (SCIP_CUTSEL cutsel, SCIP_DECL_CUTSELFREE((cutselfree)))

void	SCIPcutselSetInit (SCIP_CUTSEL cutsel, SCIP_DECL_CUTSELINIT((cutselinit)))

void	SCIPcutselSetExit (SCIP_CUTSEL cutsel, SCIP_DECL_CUTSELEXIT((cutselexit)))

void	SCIPcutselSetInitsol (SCIP_CUTSEL cutsel, SCIP_DECL_CUTSELINITSOL((cutselinitsol)))

void	SCIPcutselSetExitsol (SCIP_CUTSEL cutsel, SCIP_DECL_CUTSELEXITSOL((cutselexitsol)))

void	SCIPcutselSetPriority (SCIP_CUTSEL cutsel, SCIP_SET set, int priority)

SCIP_Bool	SCIPcutselIsInitialized (SCIP_CUTSEL *cutsel)

SCIP_Real	SCIPcutselGetSetupTime (SCIP_CUTSEL *cutsel)

SCIP_Real	SCIPcutselGetTime (SCIP_CUTSEL *cutsel)

SCIP_Longint	SCIPcutselGetNCalls (SCIP_CUTSEL *cutsel)

SCIP_Longint	SCIPcutselGetNRootCalls (SCIP_CUTSEL *cutsel)

SCIP_Longint	SCIPcutselGetNRootCuts (SCIP_CUTSEL *cutsel)

SCIP_Longint	SCIPcutselGetNRootForcedCuts (SCIP_CUTSEL *cutsel)

SCIP_Longint	SCIPcutselGetNRootCutsFiltered (SCIP_CUTSEL *cutsel)

SCIP_Longint	SCIPcutselGetNLocalCuts (SCIP_CUTSEL *cutsel)

SCIP_Longint	SCIPcutselGetNLocalForcedCuts (SCIP_CUTSEL *cutsel)

SCIP_Longint	SCIPcutselGetNLocalCutsFiltered (SCIP_CUTSEL *cutsel)

	SCIP_DECL_SORTPTRCOMP (SCIPcutselComp)

Function Documentation

◆ SCIP_DECL_PARAMCHGD()

static SCIP_DECL_PARAMCHGD ( paramChgdCutselPriority )

static

method to call, when the priority of a cut selector was changed

Definition at line 38 of file cutsel.c.

References NULL, SCIP_CALL, SCIP_OKAY, SCIPparamGetData(), SCIPparamGetInt(), and SCIPsetCutselPriority().

◆ doCutselCreate()

static SCIP_RETCODE doCutselCreate	(	SCIP_CUTSEL **	cutsel,
		SCIP_SET *	set,
		SCIP_MESSAGEHDLR *	messagehdlr,
		BMS_BLKMEM *	blkmem,
		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
	)

static

internal method for creating a cut selector

Parameters

cutsel	pointer to store cut selector
set	global SCIP settings
messagehdlr	message handler
blkmem	block memory for parameter settings
name	name of cut selector
desc	description of cut selector
priority	priority of the cut selector
cutseldata	cut selector data

Definition at line 53 of file cutsel.c.

References BMSallocMemory, BMSclearMemory, BMSduplicateMemoryArray, FALSE, NULL, paramname, SCIP_ALLOC, SCIP_CALL, SCIP_CLOCKTYPE_DEFAULT, SCIP_MAXSTRLEN, SCIP_OKAY, SCIPclockCreate(), SCIPsetAddIntParam(), and SCIPsnprintf().

Referenced by SCIPcutselCreate().

◆ SCIPcutselCreate()

SCIP_RETCODE SCIPcutselCreate	(	SCIP_CUTSEL **	cutsel,
		SCIP_SET *	set,
		SCIP_MESSAGEHDLR *	messagehdlr,
		BMS_BLKMEM *	blkmem,
		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

Parameters

cutsel	pointer to store cut selector
set	global SCIP settings
messagehdlr	message handler
blkmem	block memory for parameter settings
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 119 of file cutsel.c.

References doCutselCreate(), NULL, SCIP_CALL_FINALLY, SCIP_OKAY, and SCIPcutselFree().

Referenced by SCIPincludeCutsel(), and SCIPincludeCutselBasic().

◆ SCIPcutselsSelect()

SCIP_RETCODE SCIPcutselsSelect	(	SCIP_SET *	set,
		SCIP_ROW **	cuts,
		int	ncuts,
		int	nforcedcuts,
		SCIP_Bool	root,
		SCIP_Bool	initiallp,
		int	maxnselectedcuts,
		int *	nselectedcuts
	)

calls cut selectors to select cuts

Parameters

set	global SCIP settings
cuts	array with cuts to select from
ncuts	length of cuts
nforcedcuts	number of forced cuts at start of given array
root	are we at the root node?
initiallp	is the separation storage currently being filled with the initial LP rows?
maxnselectedcuts	maximum number of cuts to be selected
nselectedcuts	pointer to return number of selected cuts

Definition at line 160 of file cutsel.c.

References SCIP_Cutsel::cutseltime, SCIP_Cutsel::ncalls, SCIP_Cutsel::nlocalcutsfiltered, SCIP_Cutsel::nlocalcutsforced, SCIP_Cutsel::nlocalcutsselected, SCIP_Cutsel::nrootcalls, SCIP_Cutsel::nrootcutsfiltered, SCIP_Cutsel::nrootcutsforced, SCIP_Cutsel::nrootcutsselected, NULL, SCIP_CALL, SCIP_DIDNOTFIND, SCIP_OKAY, SCIP_SUCCESS, SCIPclockStart(), SCIPclockStop(), and SCIPsetSortCutsels().

Referenced by SCIPsepastoreApplyCuts().

◆ SCIPcutselCopyInclude()

SCIP_RETCODE SCIPcutselCopyInclude	(	SCIP_CUTSEL *	cutsel,
		SCIP_SET *	set
	)

copies the given cut selector to a new scip

Parameters

cutsel	cut selector
set	SCIP_SET of SCIP to copy to

Definition at line 245 of file cutsel.c.

References NULL, SCIP_CALL, SCIP_OKAY, SCIPcutselGetName(), and SCIPsetDebugMsg.

Referenced by SCIPsetCopyPlugins().

◆ SCIPcutselFree()

SCIP_RETCODE SCIPcutselFree	(	SCIP_CUTSEL **	cutsel,
		SCIP_SET *	set
	)

frees memory of cut selector

Parameters

cutsel	pointer to cut selector data structure
set	global SCIP settings

Definition at line 263 of file cutsel.c.

References BMSfreeMemory, BMSfreeMemoryArrayNull, NULL, SCIP_CALL, SCIP_OKAY, and SCIPclockFree().

Referenced by SCIPcutselCreate().

◆ SCIPcutselInit()

SCIP_RETCODE SCIPcutselInit	(	SCIP_CUTSEL *	cutsel,
		SCIP_SET *	set
	)

initializes cut selector

Parameters

cutsel	cut selector
set	global SCIP settings

Definition at line 294 of file cutsel.c.

References SCIP_Cutsel::cutseltime, SCIP_Cutsel::initialized, SCIP_Cutsel::name, NULL, SCIP_CALL, SCIP_INVALIDCALL, SCIP_OKAY, SCIPclockReset(), SCIPclockStart(), SCIPclockStop(), SCIPerrorMessage, SCIP_Cutsel::setuptime, and TRUE.

Referenced by SCIPsetIncludeExternalCode().

◆ SCIPcutselExit()

SCIP_RETCODE SCIPcutselExit	(	SCIP_CUTSEL *	cutsel,
		SCIP_SET *	set
	)

deinitializes cut selector

Parameters

cutsel	cut selector
set	global SCIP settings

Definition at line 331 of file cutsel.c.

References FALSE, SCIP_Cutsel::initialized, SCIP_Cutsel::name, NULL, SCIP_CALL, SCIP_INVALIDCALL, SCIP_OKAY, SCIPclockStart(), SCIPclockStop(), SCIPerrorMessage, and SCIP_Cutsel::setuptime.

Referenced by SCIPsetInitPlugins().

◆ SCIPcutselInitsol()

SCIP_RETCODE SCIPcutselInitsol	(	SCIP_CUTSEL *	cutsel,
		SCIP_SET *	set
	)

informs cut selector that the branch and bound process is being started

Parameters

cutsel	cut selector
set	global SCIP settings

Definition at line 361 of file cutsel.c.

References NULL, SCIP_CALL, SCIP_OKAY, SCIPclockStart(), SCIPclockStop(), and SCIP_Cutsel::setuptime.

Referenced by SCIPsetExitprePlugins().

◆ SCIPcutselExitsol()

SCIP_RETCODE SCIPcutselExitsol	(	SCIP_CUTSEL *	cutsel,
		SCIP_SET *	set
	)

informs cut selector that the branch and bound process is being started

Parameters

cutsel	cut selector
set	global SCIP settings

Definition at line 385 of file cutsel.c.

References NULL, SCIP_CALL, SCIP_OKAY, SCIPclockStart(), SCIPclockStop(), and SCIP_Cutsel::setuptime.

Referenced by SCIPsetInitsolPlugins().

◆ SCIPcutselEnableOrDisableClocks()

void SCIPcutselEnableOrDisableClocks	(	SCIP_CUTSEL *	cutsel,
		SCIP_Bool	enable
	)

enables or disables all clocks of cutsel, depending on the value of the flag

Parameters

cutsel	the cut selector for which all clocks should be enabled or disabled
enable	should the clocks of the cut selector be enabled?

Definition at line 440 of file cutsel.c.

References SCIP_Cutsel::cutseltime, NULL, SCIPclockEnableOrDisable(), and SCIP_Cutsel::setuptime.

◆ SCIPcutselSetCopy()

void SCIPcutselSetCopy	(	SCIP_CUTSEL *	cutsel,
		SCIP_DECL_CUTSELCOPY((*cutselcopy))
	)

sets copy method of cut selector

Parameters

cutsel cut selector

Definition at line 455 of file cutsel.c.

References NULL.

Referenced by SCIPsetCutselCopy().

◆ SCIPcutselSetFree()

void SCIPcutselSetFree	(	SCIP_CUTSEL *	cutsel,
		SCIP_DECL_CUTSELFREE((*cutselfree))
	)

sets destructor method of cut selector

Parameters

cutsel cut selector

Definition at line 466 of file cutsel.c.

References NULL.

Referenced by SCIPsetCutselFree().

◆ SCIPcutselSetInit()

void SCIPcutselSetInit	(	SCIP_CUTSEL *	cutsel,
		SCIP_DECL_CUTSELINIT((*cutselinit))
	)

sets initialization method of cut selector

Parameters

cutsel cut selector

Definition at line 477 of file cutsel.c.

References NULL.

Referenced by SCIPsetCutselInit().

◆ SCIPcutselSetExit()

void SCIPcutselSetExit	(	SCIP_CUTSEL *	cutsel,
		SCIP_DECL_CUTSELEXIT((*cutselexit))
	)

sets deinitialization method of cut selector

Parameters

cutsel cut selector

Definition at line 488 of file cutsel.c.

References NULL.

Referenced by SCIPsetCutselExit().

◆ SCIPcutselSetInitsol()

void SCIPcutselSetInitsol	(	SCIP_CUTSEL *	cutsel,
		SCIP_DECL_CUTSELINITSOL((*cutselinitsol))
	)

sets solving process initialization method of cut selector

Parameters

cutsel cut selector

Definition at line 499 of file cutsel.c.

References NULL.

Referenced by SCIPsetCutselInitsol().

◆ SCIPcutselSetExitsol()

void SCIPcutselSetExitsol	(	SCIP_CUTSEL *	cutsel,
		SCIP_DECL_CUTSELEXITSOL((*cutselexitsol))
	)

sets solving process deinitialization method of cut selector

Parameters

cutsel cut selector

Definition at line 510 of file cutsel.c.

References NULL.

Referenced by SCIPsetCutselExitsol().

◆ SCIPcutselSetPriority()

void SCIPcutselSetPriority	(	SCIP_CUTSEL *	cutsel,
		SCIP_SET *	set,
		int	priority
	)

sets priority of cut selector

Parameters

cutsel	cut selector
set	global SCIP settings
priority	new priority of the cut selector

Definition at line 521 of file cutsel.c.

References FALSE, NULL, and SCIP_Cutsel::priority.

Referenced by SCIPsetCutselPriority().

SCIP

Detailed Description

Functions

Function Documentation

◆ SCIP_DECL_PARAMCHGD()

◆ doCutselCreate()

◆ SCIPcutselCreate()

◆ SCIPcutselsSelect()

◆ SCIPcutselCopyInclude()

◆ SCIPcutselFree()

◆ SCIPcutselInit()

◆ SCIPcutselExit()

◆ SCIPcutselInitsol()

◆ SCIPcutselExitsol()

◆ SCIPcutselEnableOrDisableClocks()

◆ SCIPcutselSetCopy()

◆ SCIPcutselSetFree()

◆ SCIPcutselSetInit()

◆ SCIPcutselSetExit()

◆ SCIPcutselSetInitsol()

◆ SCIPcutselSetExitsol()

◆ SCIPcutselSetPriority()