Separators

Detailed Description

functions 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)
void	SCIPsepaMarkExact (SCIP_SEPA *sepa)
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)
SCIP_Longint	SCIPsepaGetNRootCalls (SCIP_SEPA *sepa)
int	SCIPsepaGetNCallsAtNode (SCIP_SEPA *sepa)
SCIP_Longint	SCIPsepaGetNCutoffs (SCIP_SEPA *sepa)
SCIP_Longint	SCIPsepaGetNCutsFound (SCIP_SEPA *sepa)
SCIP_Longint	SCIPsepaGetNCutsAdded (SCIP_SEPA *sepa)
SCIP_Longint	SCIPsepaGetNCutsAddedViaPool (SCIP_SEPA *sepa)
SCIP_Longint	SCIPsepaGetNCutsAddedDirect (SCIP_SEPA *sepa)
SCIP_Longint	SCIPsepaGetNCutsApplied (SCIP_SEPA *sepa)
SCIP_Longint	SCIPsepaGetNCutsAppliedViaPool (SCIP_SEPA *sepa)
SCIP_Longint	SCIPsepaGetNCutsAppliedDirect (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_Bool	SCIPsepaIsParentsepa (SCIP_SEPA *sepa)
SCIP_SEPA *	SCIPsepaGetParentsepa (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_RETCODE	SCIPsetSepaFree (SCIP *scip, SCIP_SEPA *sepa,)
SCIP_RETCODE	SCIPsetSepaInit (SCIP *scip, SCIP_SEPA *sepa,)
SCIP_RETCODE	SCIPsetSepaExit (SCIP *scip, SCIP_SEPA *sepa,)
SCIP_RETCODE	SCIPsetSepaInitsol (SCIP *scip, SCIP_SEPA *sepa,)
SCIP_RETCODE	SCIPsetSepaExitsol (SCIP *scip, SCIP_SEPA *sepa,)
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)
void	SCIPsetSepaIsParentsepa (SCIP *scip, SCIP_SEPA *sepa)
void	SCIPsetSepaParentsepa (SCIP *scip, SCIP_SEPA *sepa, SCIP_SEPA *parentsepa)
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 52 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 58 of file sepa.c.

References SCIPsepaGetName().

SCIPsepaGetData()

SCIP_SEPADATA * SCIPsepaGetData

(

SCIP_SEPA *

sepa

)

gets user data of separator

Parameters

sepa

separator

Definition at line 636 of file sepa.c.

References assert(), NULL, and SCIP_Sepa::sepadata.

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

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 646 of file sepa.c.

References assert(), NULL, SCIP_Sepa::sepadata, and sepadata.

Referenced by SCIP_DECL_SEPAFREE(), SCIP_DECL_SEPAFREE(), SCIP_DECL_SEPAFREE(), SCIP_DECL_SEPAFREE(), SCIP_DECL_SEPAFREE(), SCIP_DECL_SEPAFREE(), SCIP_DECL_SEPAFREE(), SCIP_DECL_SEPAFREE(), SCIP_DECL_SEPAFREE(), SCIP_DECL_SEPAFREE(), SCIP_DECL_SEPAFREE(), SCIP_DECL_SEPAFREE(), SCIP_DECL_SEPAFREE(), SCIP_DECL_SEPAFREE(), SCIP_DECL_SEPAFREE(), SCIP_DECL_SEPAFREE(), SCIP_DECL_SEPAFREE(), SCIP_DECL_SEPAFREE(), SCIP_DECL_SEPAFREE(), SCIP_DECL_SEPAFREE(), SCIP_DECL_SEPAFREE(), and SCIP_DECL_SEPAFREE().

SCIPsepaGetName()

const char * SCIPsepaGetName

(

SCIP_SEPA *

sepa

)

gets name of separator

Parameters

sepa

separator

Definition at line 746 of file sepa.c.

References assert(), SCIP_Sepa::name, and NULL.

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

SCIPsepaGetDesc()

const char * SCIPsepaGetDesc

(

SCIP_SEPA *

sepa

)

gets description of separator

Parameters

sepa

separator

Definition at line 756 of file sepa.c.

References assert(), SCIP_Sepa::desc, and NULL.

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

SCIPsepaGetPriority()

int SCIPsepaGetPriority

(

SCIP_SEPA *

sepa

)

gets priority of separator

Parameters

sepa

separator

Definition at line 766 of file sepa.c.

References assert(), 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 790 of file sepa.c.

References assert(), SCIP_Sepa::freq, and NULL.

Referenced by SCIP_DECL_DIALOGEXEC(), SCIP_DECL_SEPAEXECLP(), SCIP_DECL_SEPAEXECLP(), 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 800 of file sepa.c.

References assert(), SCIP_Sepa::freq, and NULL.

SCIPsepaMarkExact()

void SCIPsepaMarkExact

(

SCIP_SEPA *

sepa

)

marks the separator as safe to use in exact solving mode

Parameters

sepa

separator

Definition at line 811 of file sepa.c.

References assert(), SCIP_Sepa::exact, NULL, and TRUE.

Referenced by SCIPincludeSepaGomory().

SCIPsepaGetMaxbounddist()

SCIP_Real SCIPsepaGetMaxbounddist

(

SCIP_SEPA *

sepa

)

get maximal bound distance at which the separator is called

Parameters

sepa

separator

Definition at line 821 of file sepa.c.

References assert(), SCIP_Sepa::maxbounddist, NULL, and SCIP_Real.

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 831 of file sepa.c.

References assert(), NULL, SCIP_Bool, 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 853 of file sepa.c.

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

Referenced by SCIPcollectSeparatorStatistics(), and SCIPprintSeparatorStatistics().

SCIPsepaGetTime()

SCIP_Real SCIPsepaGetTime

(

SCIP_SEPA *

sepa

)

gets time in seconds used in this separator

Parameters

sepa

separator

Definition at line 863 of file sepa.c.

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

Referenced by SCIPcollectSeparatorStatistics(), 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 873 of file sepa.c.

References assert(), SCIP_Sepa::ncalls, NULL, and SCIP_Longint.

Referenced by SCIP_DECL_SEPAEXECLP(), SCIPcollectSeparatorStatistics(), SCIPprintSeparatorStatistics(), separateCuts(), and separateCuts().

SCIPsepaGetNRootCalls()

SCIP_Longint SCIPsepaGetNRootCalls

(

SCIP_SEPA *

sepa

)

gets the total number of times the separator was called at the root

Parameters

sepa

separator

Definition at line 883 of file sepa.c.

References assert(), SCIP_Sepa::nrootcalls, NULL, and SCIP_Longint.

Referenced by SCIPcollectSeparatorStatistics(), and SCIPprintSeparatorStatistics().

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 893 of file sepa.c.

References assert(), SCIP_Sepa::ncallsatnode, and NULL.

Referenced by doSeparation(), SCIP_DECL_SEPAEXECLP(), SCIP_DECL_SEPAEXECLP(), SCIP_DECL_SEPAEXECLP(), SCIP_DECL_SEPAEXECLP(), SCIP_DECL_SEPAEXECLP(), SCIP_DECL_SEPAEXECLP(), SCIP_DECL_SEPAEXECLP(), SCIP_DECL_SEPAEXECLP(), SCIP_DECL_SEPAEXECLP(), SCIP_DECL_SEPAEXECLP(), SCIP_DECL_SEPAEXECLP(), SCIP_DECL_SEPAEXECLP(), SCIP_DECL_SEPAEXECLP(), SCIP_DECL_SEPAEXECLP(), SCIP_DECL_SEPAEXECSOL(), SCIP_DECL_SEPAEXECSOL(), 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 903 of file sepa.c.

References assert(), SCIP_Sepa::ncutoffs, NULL, and SCIP_Longint.

Referenced by SCIPcollectSeparatorStatistics(), and SCIPprintSeparatorStatistics().

SCIPsepaGetNCutsFound()

SCIP_Longint SCIPsepaGetNCutsFound

(

SCIP_SEPA *

sepa

)

gets the total number of cutting planes added from the separator to the cut pool and to the sepastore directly

gets the total number of cutting planes added from the separator to the cut pool

Parameters

sepa

separator

Definition at line 913 of file sepa.c.

References assert(), SCIP_Sepa::ncutsfound, NULL, and SCIP_Longint.

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

SCIPsepaGetNCutsAdded()

SCIP_Longint SCIPsepaGetNCutsAdded

(

SCIP_SEPA *

sepa

)

gets the total number of cutting planes added from the separator to the sepastore; equal to the sum of added cuts directly and via the pool.

Parameters

sepa

separator

Definition at line 924 of file sepa.c.

References assert(), SCIP_Sepa::ncutsadded, NULL, and SCIP_Longint.

SCIPsepaGetNCutsAddedViaPool()

SCIP_Longint SCIPsepaGetNCutsAddedViaPool

(

SCIP_SEPA *

sepa

)

gets the number of cutting planes from the separator added from the cut pool

gets the number of cutting planes found by the separator added to the sepastore via the cut pool

Parameters

sepa

separator

Definition at line 934 of file sepa.c.

References assert(), SCIP_Sepa::ncutsaddedviapool, NULL, and SCIP_Longint.

Referenced by SCIPcollectSeparatorStatistics(), and SCIPprintSeparatorStatistics().

SCIPsepaGetNCutsAddedDirect()

SCIP_Longint SCIPsepaGetNCutsAddedDirect

(

SCIP_SEPA *

sepa

)

gets the number of cutting planes from the separator added directly to the sepastore

gets the number of cutting planes found by the separator added directly to the sepastore

Parameters

sepa

separator

Definition at line 944 of file sepa.c.

References assert(), SCIP_Sepa::ncutsaddeddirect, NULL, and SCIP_Longint.

Referenced by SCIPcollectSeparatorStatistics(), and SCIPprintSeparatorStatistics().

SCIPsepaGetNCutsApplied()

SCIP_Longint SCIPsepaGetNCutsApplied

(

SCIP_SEPA *

sepa

)

gets the total number of cutting planes from the separator applied to the LP

gets the total number of cutting planes of the separator finally applied to the LP

Parameters

sepa

separator

Definition at line 954 of file sepa.c.

References assert(), SCIP_Sepa::ncutsapplieddirect, SCIP_Sepa::ncutsappliedviapool, NULL, and SCIP_Longint.

Referenced by SCIPcollectSeparatorStatistics(), and SCIPprintSeparatorStatistics().

SCIPsepaGetNCutsAppliedViaPool()

SCIP_Longint SCIPsepaGetNCutsAppliedViaPool

(

SCIP_SEPA *

sepa

)

gets the total number of cutting planes from the separator applied to the LP from the cutpool

gets the total number of cutting planes of the separator applied to the LP via the cutpool

Parameters

sepa

separator

Definition at line 964 of file sepa.c.

References assert(), SCIP_Sepa::ncutsappliedviapool, NULL, and SCIP_Longint.

Referenced by SCIPcollectSeparatorStatistics(), and SCIPprintSeparatorStatistics().

SCIPsepaGetNCutsAppliedDirect()

SCIP_Longint SCIPsepaGetNCutsAppliedDirect

(

SCIP_SEPA *

sepa

)

gets the total number of cutting planes from the separator applied directly to the LP

gets the total number of cutting planes of the separator applied to the LP via the sepastore directly

Parameters

sepa

separator

Definition at line 974 of file sepa.c.

References assert(), SCIP_Sepa::ncutsapplieddirect, NULL, and SCIP_Longint.

Referenced by SCIPcollectSeparatorStatistics(), and SCIPprintSeparatorStatistics().

SCIPsepaGetNCutsFoundAtNode()

SCIP_Longint SCIPsepaGetNCutsFoundAtNode

(

SCIP_SEPA *

sepa

)

gets the number of cutting planes found by this separator at the current node

Parameters

sepa

separator

Definition at line 1072 of file sepa.c.

References assert(), SCIP_Sepa::ncutsfoundatnode, NULL, and SCIP_Longint.

SCIPsepaGetNConssFound()

SCIP_Longint SCIPsepaGetNConssFound

(

SCIP_SEPA *

sepa

)

gets total number of additional constraints added by this separator

Parameters

sepa

separator

Definition at line 1082 of file sepa.c.

References assert(), SCIP_Sepa::nconssfound, NULL, and SCIP_Longint.

Referenced by SCIPcollectSeparatorStatistics(), and SCIPprintSeparatorStatistics().

SCIPsepaGetNDomredsFound()

SCIP_Longint SCIPsepaGetNDomredsFound

(

SCIP_SEPA *

sepa

)

gets total number of domain reductions found by this separator

Parameters

sepa

separator

Definition at line 1092 of file sepa.c.

References assert(), SCIP_Sepa::ndomredsfound, NULL, and SCIP_Longint.

Referenced by SCIPcollectSeparatorStatistics(), and SCIPprintSeparatorStatistics().

SCIPsepaIsDelayed()

SCIP_Bool SCIPsepaIsDelayed

(

SCIP_SEPA *

sepa

)

should separator be delayed, if other separators found cuts?

Parameters

sepa

separator

Definition at line 1102 of file sepa.c.

References assert(), SCIP_Sepa::delay, NULL, and SCIP_Bool.

Referenced by SCIP_DECL_DIALOGEXEC().

SCIPsepaWasLPDelayed()

SCIP_Bool SCIPsepaWasLPDelayed

(

SCIP_SEPA *

sepa

)

was separation of the LP solution delayed at the last call?

Parameters

sepa

separator

Definition at line 1112 of file sepa.c.

References assert(), SCIP_Sepa::lpwasdelayed, NULL, and SCIP_Bool.

Referenced by SCIP_DECL_SEPAEXECLP(), separateCuts(), and separationRoundLP().

SCIPsepaWasSolDelayed()

SCIP_Bool SCIPsepaWasSolDelayed

(

SCIP_SEPA *

sepa

)

was separation of the primal solution delayed at the last call?

Parameters

sepa

separator

Definition at line 1122 of file sepa.c.

References assert(), NULL, SCIP_Bool, and SCIP_Sepa::solwasdelayed.

Referenced by separationRoundSol().

SCIPsepaIsInitialized()

SCIP_Bool SCIPsepaIsInitialized

(

SCIP_SEPA *

sepa

)

is separator initialized?

Parameters

sepa

separator

Definition at line 1132 of file sepa.c.

References assert(), SCIP_Sepa::initialized, NULL, and SCIP_Bool.

SCIPsepaIsParentsepa()

SCIP_Bool SCIPsepaIsParentsepa

(

SCIP_SEPA *

sepa

)

gets whether separator is a parent separator

Parameters

sepa

separator

Definition at line 1142 of file sepa.c.

References assert(), SCIP_Sepa::isparentsepa, NULL, and SCIP_Bool.

Referenced by SCIPcollectSeparatorStatistics(), and SCIPprintSeparatorStatistics().

SCIPsepaGetParentsepa()

SCIP_SEPA * SCIPsepaGetParentsepa

(

SCIP_SEPA *

sepa

)

gets parent separator (or NULL)

Parameters

sepa

separator

Definition at line 1152 of file sepa.c.

References assert(), NULL, and SCIP_Sepa::parentsepa.

Referenced by SCIPcollectSeparatorStatistics(), SCIPprintSeparatorStatistics(), SCIPsepaDecNCutsAdded(), SCIPsepaIncNCutsAdded(), and SCIPsepaIncNCutsApplied().

SCIPincludeSepa()

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

creates a separator 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 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 65 of file scip_sepa.c.

References FALSE, NULL, SCIP_Bool, SCIP_CALL, SCIP_DECL_SEPACOPY, SCIP_DECL_SEPAEXECLP, SCIP_DECL_SEPAEXECSOL, SCIP_DECL_SEPAEXIT, SCIP_DECL_SEPAEXITSOL, SCIP_DECL_SEPAFREE, SCIP_DECL_SEPAINIT, SCIP_DECL_SEPAINITSOL, SCIP_INVALIDDATA, SCIP_OKAY, SCIP_Real, SCIPcheckStage, SCIPerrorMessage, SCIPfindSepa(), SCIPsepaCreate(), SCIPsetIncludeSepa(), sepadata, 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

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().

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 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

Definition at line 115 of file scip_sepa.c.

References assert(), FALSE, NULL, SCIP_Bool, SCIP_CALL, SCIP_DECL_SEPAEXECLP, SCIP_DECL_SEPAEXECSOL, SCIP_INVALIDDATA, SCIP_OKAY, SCIP_Real, SCIPcheckStage, SCIPerrorMessage, SCIPfindSepa(), SCIPsepaCreate(), SCIPsetIncludeSepa(), sepadata, and TRUE.

Referenced by SCIPincludeSepaAggregation(), SCIPincludeSepaCGMIP(), SCIPincludeSepaClique(), SCIPincludeSepaClosecuts(), SCIPincludeSepaConvexproj(), SCIPincludeSepaDisjunctive(), SCIPincludeSepaEccuts(), SCIPincludeSepaEdge(), SCIPincludeSepaFlower(), SCIPincludeSepaGauge(), SCIPincludeSepaGMI(), SCIPincludeSepaGomory(), SCIPincludeSepaImpliedbounds(), SCIPincludeSepaInterminor(), SCIPincludeSepaIntobj(), SCIPincludeSepaLagromory(), SCIPincludeSepaMcf(), SCIPincludeSepaMinor(), SCIPincludeSepaMixing(), SCIPincludeSepaOddcycle(), SCIPincludeSepaPartition(), SCIPincludeSepaRapidlearning(), SCIPincludeSepaRlt(), SCIPincludeSepaSubtour(), and SCIPincludeSepaZerohalf().

SCIPsetSepaCopy()

SCIP_RETCODE SCIPsetSepaCopy	(	SCIP *	scip,
		SCIP_SEPA *	sepa )

sets copy method of separator

Parameters

scip	SCIP data structure
sepa	separator copy method of separator or NULL if you don't want to copy your plugin into sub-SCIPs

Definition at line 157 of file scip_sepa.c.

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

Referenced by SCIPincludeSepaAggregation(), SCIPincludeSepaCGMIP(), SCIPincludeSepaClique(), SCIPincludeSepaClosecuts(), SCIPincludeSepaConvexproj(), SCIPincludeSepaDisjunctive(), SCIPincludeSepaEccuts(), SCIPincludeSepaEdge(), SCIPincludeSepaFlower(), SCIPincludeSepaGauge(), SCIPincludeSepaGMI(), SCIPincludeSepaGomory(), SCIPincludeSepaImpliedbounds(), SCIPincludeSepaInterminor(), SCIPincludeSepaIntobj(), SCIPincludeSepaLagromory(), SCIPincludeSepaMcf(), SCIPincludeSepaMinor(), SCIPincludeSepaMixing(), SCIPincludeSepaOddcycle(), SCIPincludeSepaPartition(), SCIPincludeSepaRapidlearning(), SCIPincludeSepaRlt(), SCIPincludeSepaSubtour(), and SCIPincludeSepaZerohalf().

SCIPsetSepaFree()

SCIP_RETCODE SCIPsetSepaFree	(	SCIP *	scip,
		SCIP_SEPA *	sepa )

sets destructor method of separator

Parameters

scip	SCIP data structure
sepa	separator destructor of separator

Definition at line 173 of file scip_sepa.c.

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

Referenced by SCIPincludeSepaAggregation(), SCIPincludeSepaCGMIP(), SCIPincludeSepaClique(), SCIPincludeSepaClosecuts(), SCIPincludeSepaConvexproj(), SCIPincludeSepaDisjunctive(), SCIPincludeSepaEccuts(), SCIPincludeSepaFlower(), SCIPincludeSepaGauge(), SCIPincludeSepaGMI(), SCIPincludeSepaGomory(), SCIPincludeSepaImpliedbounds(), SCIPincludeSepaInterminor(), SCIPincludeSepaIntobj(), SCIPincludeSepaLagromory(), SCIPincludeSepaMcf(), SCIPincludeSepaMinor(), SCIPincludeSepaMixing(), SCIPincludeSepaOddcycle(), SCIPincludeSepaRapidlearning(), SCIPincludeSepaRlt(), and SCIPincludeSepaZerohalf().

SCIPsetSepaInit()

SCIP_RETCODE SCIPsetSepaInit	(	SCIP *	scip,
		SCIP_SEPA *	sepa )

sets initialization method of separator

Parameters

scip	SCIP data structure
sepa	separator initialize separator

Definition at line 189 of file scip_sepa.c.

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

Referenced by SCIPincludeSepaCGMIP(), SCIPincludeSepaFlower(), SCIPincludeSepaGomory(), SCIPincludeSepaInterminor(), SCIPincludeSepaLagromory(), SCIPincludeSepaMinor(), and SCIPincludeSepaOddcycle().

SCIPsetSepaExit()

SCIP_RETCODE SCIPsetSepaExit	(	SCIP *	scip,
		SCIP_SEPA *	sepa )

sets deinitialization method of separator

Parameters

scip	SCIP data structure
sepa	separator deinitialize separator

Definition at line 205 of file scip_sepa.c.

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

Referenced by SCIPincludeSepaCGMIP(), SCIPincludeSepaGomory(), SCIPincludeSepaInterminor(), SCIPincludeSepaLagromory(), and SCIPincludeSepaMinor().

SCIPsetSepaInitsol()

SCIP_RETCODE SCIPsetSepaInitsol	(	SCIP *	scip,
		SCIP_SEPA *	sepa )

sets solving process initialization method of separator

Parameters

scip	SCIP data structure
sepa	separator solving process initialization method of separator

Definition at line 221 of file scip_sepa.c.

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

Referenced by SCIPincludeSepaDisjunctive(), SCIPincludeSepaInterminor(), SCIPincludeSepaMcf(), SCIPincludeSepaMinor(), SCIPincludeSepaOddcycle(), and SCIPincludeSepaZerohalf().

SCIPsetSepaExitsol()

SCIP_RETCODE SCIPsetSepaExitsol	(	SCIP *	scip,
		SCIP_SEPA *	sepa )

sets solving process deinitialization method of separator

Parameters

scip	SCIP data structure
sepa	separator solving process deinitialization method of separator

Definition at line 237 of file scip_sepa.c.

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

Referenced by SCIPincludeSepaClique(), SCIPincludeSepaClosecuts(), SCIPincludeSepaConvexproj(), SCIPincludeSepaEccuts(), SCIPincludeSepaFlower(), SCIPincludeSepaGauge(), SCIPincludeSepaInterminor(), SCIPincludeSepaIntobj(), SCIPincludeSepaMcf(), SCIPincludeSepaMinor(), SCIPincludeSepaRlt(), and SCIPincludeSepaZerohalf().

SCIPfindSepa()

SCIP_SEPA * SCIPfindSepa	(	SCIP *	scip,
		const char *	name )

returns the separator of the given name, or NULL if not existing

Parameters

scip	SCIP data structure
name	name of separator

Definition at line 253 of file scip_sepa.c.

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

Referenced by SCIPcopyConcurrentSolvingStats(), SCIPfindObjSepa(), SCIPincludeSepa(), SCIPincludeSepaBasic(), and SCIPsetBasePointClosecuts().

SCIPgetSepas()

SCIP_SEPA ** SCIPgetSepas

(

SCIP *

scip

)

returns the array of currently available separators

Parameters

scip	SCIP data structure

Definition at line 266 of file scip_sepa.c.

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

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

SCIPgetNSepas()

int SCIPgetNSepas

(

SCIP *

scip

)

returns the number of currently available separators

Parameters

scip	SCIP data structure

Definition at line 279 of file scip_sepa.c.

References assert(), and NULL.

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

SCIPsetSepaPriority()

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

sets the priority of a separator

Parameters

scip	SCIP data structure
sepa	separator
priority	new priority of the separator

Definition at line 290 of file scip_sepa.c.

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

Referenced by SCIP_DECL_PARAMCHGD().

SCIPsetSepaIsParentsepa()

void SCIPsetSepaIsParentsepa	(	SCIP *	scip,
		SCIP_SEPA *	sepa )

declares separator to be a parent separator

Parent separators generate cuts of several types. To distinguish these cuts, they create child separators, which are only needed to detect which cuts are applied.

Parameters

scip	SCIP data structure
sepa	separator

Definition at line 309 of file scip_sepa.c.

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

Referenced by SCIPincludeSepaAggregation(), and SCIPincludeSepaGomory().

SCIPsetSepaParentsepa()

void SCIPsetSepaParentsepa	(	SCIP *	scip,
		SCIP_SEPA *	sepa,
		SCIP_SEPA *	parentsepa )

sets the parent separator

Informs SCIP that the separator sepa depends on the parent separator parentsepa.

Parameters

scip	SCIP data structure
sepa	separator
parentsepa	parent separator

Definition at line 324 of file scip_sepa.c.

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

Referenced by SCIPincludeSepaAggregation(), and SCIPincludeSepaGomory().

SCIPgetSepaMinEfficacy()

SCIP_Real SCIPgetSepaMinEfficacy

(

SCIP *

scip

)

gets value of minimal efficacy for a cut to enter the LP

Precondition

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

• SCIP_STAGE_SOLVING

Returns

value of "separating/minefficacyroot" if at root node, otherwise value of "separating/minefficacy"

Parameters

scip	SCIP data structure

Definition at line 345 of file scip_sepa.c.

References assert(), FALSE, NULL, SCIP_CALL_ABORT, SCIP_Real, SCIPcheckStage, SCIPtreeGetCurrentDepth(), and TRUE.

Referenced by SCIPcleanupRowprep(), and SCIPprocessRowprepNonlinear().