Detailed Description

methods for separator plugins

Functions
	SCIP_DECL_SORTPTRCOMP (SCIPsepaComp)

	SCIP_DECL_SORTPTRCOMP (SCIPsepaCompName)

SCIP_SEPADATA *	SCIPsepaGetData (SCIP_SEPA *sepa)

void	SCIPsepaSetData (SCIP_SEPA sepa, SCIP_SEPADATA sepadata)

const char *	SCIPsepaGetName (SCIP_SEPA *sepa)

const char *	SCIPsepaGetDesc (SCIP_SEPA *sepa)

int	SCIPsepaGetPriority (SCIP_SEPA *sepa)

int	SCIPsepaGetFreq (SCIP_SEPA *sepa)

void	SCIPsepaSetFreq (SCIP_SEPA *sepa, int freq)

SCIP_Real	SCIPsepaGetMaxbounddist (SCIP_SEPA *sepa)

SCIP_Bool	SCIPsepaUsesSubscip (SCIP_SEPA *sepa)

SCIP_Real	SCIPsepaGetSetupTime (SCIP_SEPA *sepa)

SCIP_Real	SCIPsepaGetTime (SCIP_SEPA *sepa)

SCIP_Longint	SCIPsepaGetNCalls (SCIP_SEPA *sepa)

int	SCIPsepaGetNCallsAtNode (SCIP_SEPA *sepa)

SCIP_Longint	SCIPsepaGetNCutoffs (SCIP_SEPA *sepa)

SCIP_Longint	SCIPsepaGetNCutsFound (SCIP_SEPA *sepa)

SCIP_Longint	SCIPsepaGetNCutsApplied (SCIP_SEPA *sepa)

SCIP_Longint	SCIPsepaGetNCutsFoundAtNode (SCIP_SEPA *sepa)

SCIP_Longint	SCIPsepaGetNConssFound (SCIP_SEPA *sepa)

SCIP_Longint	SCIPsepaGetNDomredsFound (SCIP_SEPA *sepa)

SCIP_Bool	SCIPsepaIsDelayed (SCIP_SEPA *sepa)

SCIP_Bool	SCIPsepaWasLPDelayed (SCIP_SEPA *sepa)

SCIP_Bool	SCIPsepaWasSolDelayed (SCIP_SEPA *sepa)

SCIP_Bool	SCIPsepaIsInitialized (SCIP_SEPA *sepa)

SCIP_RETCODE	SCIPincludeSepa (SCIP scip, const char name, const char desc, int priority, int freq, SCIP_Real maxbounddist, SCIP_Bool usessubscip, SCIP_Bool delay, SCIP_DECL_SEPACOPY((sepacopy)), SCIP_DECL_SEPAFREE((sepafree)), SCIP_DECL_SEPAINIT((sepainit)), SCIP_DECL_SEPAEXIT((sepaexit)), SCIP_DECL_SEPAINITSOL((sepainitsol)), SCIP_DECL_SEPAEXITSOL((sepaexitsol)), SCIP_DECL_SEPAEXECLP((sepaexeclp)), SCIP_DECL_SEPAEXECSOL((sepaexecsol)), SCIP_SEPADATA sepadata)

SCIP_RETCODE	SCIPincludeSepaBasic (SCIP scip, SCIP_SEPA sepa, const char name, const char desc, int priority, int freq, SCIP_Real maxbounddist, SCIP_Bool usessubscip, SCIP_Bool delay, SCIP_DECL_SEPAEXECLP((sepaexeclp)), SCIP_DECL_SEPAEXECSOL((sepaexecsol)), SCIP_SEPADATA sepadata)

SCIP_RETCODE	SCIPsetSepaCopy (SCIP scip, SCIP_SEPA sepa, SCIP_DECL_SEPACOPY((*sepacopy)))

SCIP_RETCODE	SCIPsetSepaFree (SCIP scip, SCIP_SEPA sepa, SCIP_DECL_SEPAFREE((*sepafree)))

SCIP_RETCODE	SCIPsetSepaInit (SCIP scip, SCIP_SEPA sepa, SCIP_DECL_SEPAINIT((*sepainit)))

SCIP_RETCODE	SCIPsetSepaExit (SCIP scip, SCIP_SEPA sepa, SCIP_DECL_SEPAEXIT((*sepaexit)))

SCIP_RETCODE	SCIPsetSepaInitsol (SCIP scip, SCIP_SEPA sepa, SCIP_DECL_SEPAINITSOL((*sepainitsol)))

SCIP_RETCODE	SCIPsetSepaExitsol (SCIP scip, SCIP_SEPA sepa, SCIP_DECL_SEPAEXITSOL((*sepaexitsol)))

SCIP_SEPA *	SCIPfindSepa (SCIP scip, const char name)

SCIP_SEPA **	SCIPgetSepas (SCIP *scip)

int	SCIPgetNSepas (SCIP *scip)

SCIP_RETCODE	SCIPsetSepaPriority (SCIP scip, SCIP_SEPA sepa, int priority)

SCIP_Real	SCIPgetSepaMinEfficacy (SCIP *scip)

Function Documentation

◆ SCIP_DECL_SORTPTRCOMP() [1/2]

SCIP_DECL_SORTPTRCOMP ( SCIPsepaComp )

compares two separators w. r. to their priority

Definition at line 42 of file sepa.c.

◆ SCIP_DECL_SORTPTRCOMP() [2/2]

SCIP_DECL_SORTPTRCOMP ( SCIPsepaCompName )

comparison method for sorting separators w.r.t. to their name

Definition at line 48 of file sepa.c.

References SCIPsepaGetName().

◆ SCIPsepaGetData()

SCIP_SEPADATA* SCIPsepaGetData ( SCIP_SEPA * sepa )

gets user data of separator

Parameters

sepa separator

Definition at line 600 of file sepa.c.

References NULL, and SCIP_Sepa::sepadata.

Referenced by aggregation(), doSeparation(), freeSubscip(), generateCut(), SCIP_DECL_SEPACOPY(), SCIP_DECL_SEPAEXECLP(), SCIP_DECL_SEPAEXECSOL(), SCIP_DECL_SEPAEXIT(), SCIP_DECL_SEPAEXITSOL(), SCIP_DECL_SEPAFREE(), SCIP_DECL_SEPAINIT(), SCIP_DECL_SEPAINITSOL(), SCIPfindObjSepa(), SCIPgetObjSepa(), SCIPsetBasePointClosecuts(), separateCuts(), and separateOddCycles().

◆ SCIPsepaSetData()

void SCIPsepaSetData	(	SCIP_SEPA *	sepa,
		SCIP_SEPADATA *	sepadata
	)

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

Parameters

sepa	separator
sepadata	new separator user data

Definition at line 610 of file sepa.c.

References NULL, and SCIP_Sepa::sepadata.

Referenced by SCIP_DECL_SEPAFREE().

◆ SCIPsepaGetName()

const char* SCIPsepaGetName ( SCIP_SEPA * sepa )

gets name of separator

Parameters

sepa separator

Definition at line 689 of file sepa.c.

References SCIP_Sepa::name, and NULL.

Referenced by generateDisjCutSOS1(), paramsetSetSeparatingAggressive(), paramsetSetSeparatingDefault(), paramsetSetSeparatingOff(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_SEPACOPY(), SCIP_DECL_SEPAEXECLP(), SCIP_DECL_SEPAEXECSOL(), SCIP_DECL_SEPAEXITSOL(), SCIP_DECL_SEPAFREE(), SCIP_DECL_SEPAINITSOL(), SCIP_DECL_SORTPTRCOMP(), SCIPcopyConcurrentSolvingStats(), SCIPincludeDialogDefaultFix(), SCIPincludeDialogDefaultSet(), SCIPparamsetSetToSubscipsOff(), SCIPprintSeparatorStatistics(), SCIPsepaCopyInclude(), SCIPsetBasePointClosecuts(), SCIPsetFindRelax(), separateCuts(), separateSequLiftedExtendedWeightInequality(), separateSequLiftedMinimalCoverInequality(), separateSupLiftedMinimalCoverInequality(), separationRoundLP(), and separationRoundSol().

◆ SCIPsepaGetDesc()

const char* SCIPsepaGetDesc ( SCIP_SEPA * sepa )

gets description of separator

Parameters

sepa separator

Definition at line 699 of file sepa.c.

References SCIP_Sepa::desc, and NULL.

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

◆ SCIPsepaGetPriority()

int SCIPsepaGetPriority ( SCIP_SEPA * sepa )

gets priority of separator

Parameters

sepa separator

Definition at line 709 of file sepa.c.

References NULL, and SCIP_Sepa::priority.

Referenced by SCIP_DECL_DIALOGEXEC(), separationRoundLP(), and separationRoundSol().

◆ SCIPsepaGetFreq()

int SCIPsepaGetFreq ( SCIP_SEPA * sepa )

gets frequency of separator

Parameters

sepa separator

Definition at line 733 of file sepa.c.

References SCIP_Sepa::freq, and NULL.

Referenced by SCIP_DECL_DIALOGEXEC(), and separateCuts().

◆ SCIPsepaSetFreq()

void SCIPsepaSetFreq	(	SCIP_SEPA *	sepa,
		int	freq
	)

sets frequency of separator

Parameters

sepa	separator
freq	new frequency of separator

Definition at line 743 of file sepa.c.

References SCIP_Sepa::freq, and NULL.

◆ SCIPsepaGetMaxbounddist()

SCIP_Real SCIPsepaGetMaxbounddist ( SCIP_SEPA * sepa )

get maximal bound distance at which the separator is called

Parameters

sepa separator

Definition at line 754 of file sepa.c.

References SCIP_Sepa::maxbounddist, and NULL.

Referenced by SCIP_DECL_DIALOGEXEC().

◆ SCIPsepaUsesSubscip()

SCIP_Bool SCIPsepaUsesSubscip ( SCIP_SEPA * sepa )

does the separator use a secondary SCIP instance?

Parameters

sepa separator

Definition at line 764 of file sepa.c.

References NULL, and SCIP_Sepa::usessubscip.

Referenced by SCIPparamsetSetToSubscipsOff().

◆ SCIPsepaGetSetupTime()

SCIP_Real SCIPsepaGetSetupTime ( SCIP_SEPA * sepa )

gets time in seconds used in this separator for setting up for next stages

Parameters

sepa separator

Definition at line 786 of file sepa.c.

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

Referenced by SCIPprintSeparatorStatistics().

◆ SCIPsepaGetTime()

SCIP_Real SCIPsepaGetTime ( SCIP_SEPA * sepa )

gets time in seconds used in this separator

Parameters

sepa separator

Definition at line 796 of file sepa.c.

References NULL, SCIPclockGetTime(), and SCIP_Sepa::sepaclock.

Referenced by SCIPprintSeparatorStatistics(), and separateOddCycles().

◆ SCIPsepaGetNCalls()

SCIP_Longint SCIPsepaGetNCalls ( SCIP_SEPA * sepa )

gets the total number of times, the separator was called

Parameters

sepa separator

Definition at line 806 of file sepa.c.

References SCIP_Sepa::ncalls, and NULL.

Referenced by SCIPprintSeparatorStatistics(), and separateCuts().

◆ SCIPsepaGetNCallsAtNode()

int SCIPsepaGetNCallsAtNode ( SCIP_SEPA * sepa )

gets the number of times, the separator was called at the current node

Parameters

sepa separator

Definition at line 816 of file sepa.c.

References SCIP_Sepa::ncallsatnode, and NULL.

Referenced by doSeparation(), SCIP_DECL_SEPAEXECLP(), separateCuts(), and separateOddCycles().

◆ SCIPsepaGetNCutoffs()

SCIP_Longint SCIPsepaGetNCutoffs ( SCIP_SEPA * sepa )

gets total number of times, the separator detected a cutoff

Parameters

sepa separator

Definition at line 826 of file sepa.c.

References SCIP_Sepa::ncutoffs, and NULL.

Referenced by SCIPprintSeparatorStatistics().

◆ SCIPsepaGetNCutsFound()

SCIP_Longint SCIPsepaGetNCutsFound ( SCIP_SEPA * sepa )

gets the total number of cutting planes found by this separator

Parameters

sepa separator

Definition at line 836 of file sepa.c.

References SCIP_Sepa::ncutsfound, and NULL.

Referenced by SCIPprintSeparatorStatistics(), separateSequLiftedExtendedWeightInequality(), separateSequLiftedMinimalCoverInequality(), and separateSupLiftedMinimalCoverInequality().

◆ SCIPsepaGetNCutsApplied()

SCIP_Longint SCIPsepaGetNCutsApplied ( SCIP_SEPA * sepa )

gets the total number of cutting planes applied to lp

Parameters

sepa separator

Definition at line 846 of file sepa.c.

References SCIP_Sepa::ncutsapplied, and NULL.

Referenced by SCIPprintSeparatorStatistics().

SCIP_RETCODE SCIPincludeSepa	(	SCIP *	scip,
		const char *	name,
		const char *	desc,
		int	priority,
		int	freq,
		SCIP_Real	maxbounddist,
		SCIP_Bool	usessubscip,
		SCIP_Bool	delay,
		SCIP_DECL_SEPACOPY((*sepacopy))	,
		SCIP_DECL_SEPAFREE((*sepafree))	,
		SCIP_DECL_SEPAINIT((*sepainit))	,
		SCIP_DECL_SEPAEXIT((*sepaexit))	,
		SCIP_DECL_SEPAINITSOL((*sepainitsol))	,
		SCIP_DECL_SEPAEXITSOL((*sepaexitsol))	,
		SCIP_DECL_SEPAEXECLP((*sepaexeclp))	,
		SCIP_DECL_SEPAEXECSOL((*sepaexecsol))	,
		SCIP_SEPADATA *	sepadata
	)

creates a separator and includes it in SCIP.

Note: method has all separator callbacks as arguments and is thus changed every time a new callback is added in future releases; consider using SCIPincludeSepaBasic() 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 separator
desc	description of separator
priority	priority of separator (>= 0: before, < 0: after constraint handlers)
freq	frequency for calling separator
maxbounddist	maximal relative distance from current node's dual bound to primal bound compared to best node's dual bound for applying separation
usessubscip	does the separator use a secondary SCIP instance?
delay	should separator be delayed, if other separators found cuts?
sepadata	separator data

Definition at line 131 of file scip_sepa.c.

References FALSE, Scip::mem, Scip::messagehdlr, NULL, SCIP_CALL, SCIP_INVALIDDATA, SCIP_OKAY, SCIPcheckStage(), SCIPerrorMessage, SCIPfindSepa(), SCIPsepaCreate(), SCIPsetIncludeSepa(), Scip::set, SCIP_Mem::setmem, and TRUE.

Referenced by SCIPincludeObjSepa().

◆ SCIPincludeSepaBasic()

SCIP_RETCODE SCIPincludeSepaBasic	(	SCIP *	scip,
		SCIP_SEPA **	sepa,
		const char *	name,
		const char *	desc,
		int	priority,
		int	freq,
		SCIP_Real	maxbounddist,
		SCIP_Bool	usessubscip,
		SCIP_Bool	delay,
		SCIP_DECL_SEPAEXECLP((*sepaexeclp))	,
		SCIP_DECL_SEPAEXECSOL((*sepaexecsol))	,
		SCIP_SEPADATA *	sepadata
	)

creates a separator 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 SCIPsetSepaInit(), SCIPsetSepaFree(), SCIPsetSepaInitsol(), SCIPsetSepaExitsol(), SCIPsetSepaCopy(), SCIPsetExit().

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

Parameters

scip	SCIP data structure
sepa	reference to a separator, or NULL
name	name of separator
desc	description of separator
priority	priority of separator (>= 0: before, < 0: after constraint handlers)
freq	frequency for calling separator
maxbounddist	maximal relative distance from current node's dual bound to primal bound compared to best node's dual bound for applying separation
usessubscip	does the separator use a secondary SCIP instance?
delay	should separator be delayed, if other separators found cuts?
sepadata	separator data