sepastore.h File Reference

Detailed Description

internal methods for storing separated cuts

Author

Tobias Achterberg

Leona Gottwald

Definition in file sepastore.h.

#include "scip/def.h"
#include "blockmemshell/memory.h"
#include "scip/type_implics.h"
#include "scip/type_retcode.h"
#include "scip/type_set.h"
#include "scip/type_stat.h"
#include "scip/type_event.h"
#include "scip/type_lp.h"
#include "scip/type_prob.h"
#include "scip/type_tree.h"
#include "scip/type_reopt.h"
#include "scip/type_sepastore.h"
#include "scip/type_branch.h"

Go to the source code of this file.

Functions
SCIP_RETCODE	SCIPsepastoreCreate (SCIP_SEPASTORE **sepastore, BMS_BLKMEM *blkmem, SCIP_SET *set)
SCIP_RETCODE	SCIPsepastoreFree (SCIP_SEPASTORE **sepastore, BMS_BLKMEM *blkmem)
void	SCIPsepastoreStartInitialLP (SCIP_SEPASTORE *sepastore)
void	SCIPsepastoreEndInitialLP (SCIP_SEPASTORE *sepastore)
void	SCIPsepastoreStartForceCuts (SCIP_SEPASTORE *sepastore)
void	SCIPsepastoreEndForceCuts (SCIP_SEPASTORE *sepastore)
SCIP_RETCODE	SCIPsepastoreAddCut (SCIP_SEPASTORE *sepastore, BMS_BLKMEM *blkmem, SCIP_SET *set, SCIP_STAT *stat, SCIP_EVENTQUEUE *eventqueue, SCIP_EVENTFILTER *eventfilter, SCIP_LP *lp, SCIP_ROW *cut, SCIP_Bool forcecut, SCIP_Bool root, SCIP_Bool *infeasible)
SCIP_RETCODE	SCIPsepastoreApplyCuts (SCIP_SEPASTORE *sepastore, BMS_BLKMEM *blkmem, SCIP_SET *set, SCIP_STAT *stat, SCIP_PROB *transprob, SCIP_PROB *origprob, SCIP_TREE *tree, SCIP_REOPT *reopt, SCIP_LP *lp, SCIP_BRANCHCAND *branchcand, SCIP_EVENTQUEUE *eventqueue, SCIP_EVENTFILTER *eventfilter, SCIP_CLIQUETABLE *cliquetable, SCIP_Bool root, SCIP_EFFICIACYCHOICE efficiacychoice, SCIP_Bool *cutoff)
SCIP_RETCODE	SCIPsepastoreClearCuts (SCIP_SEPASTORE *sepastore, BMS_BLKMEM *blkmem, SCIP_SET *set, SCIP_EVENTQUEUE *eventqueue, SCIP_EVENTFILTER *eventfilter, SCIP_LP *lp)
SCIP_RETCODE	SCIPsepastoreRemoveInefficaciousCuts (SCIP_SEPASTORE *sepastore, BMS_BLKMEM *blkmem, SCIP_SET *set, SCIP_STAT *stat, SCIP_EVENTQUEUE *eventqueue, SCIP_EVENTFILTER *eventfilter, SCIP_LP *lp, SCIP_Bool root, SCIP_EFFICIACYCHOICE efficiacychoice)
SCIP_Bool	SCIPsepastoreIsCutApplicable (SCIP_SET *set, SCIP_ROW *cut)
SCIP_ROW **	SCIPsepastoreGetCuts (SCIP_SEPASTORE *sepastore)
int	SCIPsepastoreGetNCuts (SCIP_SEPASTORE *sepastore)
int	SCIPsepastoreGetNCutsAdded (SCIP_SEPASTORE *sepastore)
int	SCIPsepastoreGetNCutsAddedViaPool (SCIP_SEPASTORE *sepastore)
int	SCIPsepastoreGetNCutsAddedDirect (SCIP_SEPASTORE *sepastore)
int	SCIPsepastoreGetNCutsFoundRound (SCIP_SEPASTORE *sepastore)
int	SCIPsepastoreGetNCutsApplied (SCIP_SEPASTORE *sepastore)

Function Documentation

SCIPsepastoreCreate()

SCIP_RETCODE SCIPsepastoreCreate	(	SCIP_SEPASTORE **	sepastore,
		BMS_BLKMEM *	blkmem,
		SCIP_SET *	set
	)

creates separation storage

Parameters

sepastore	pointer to store separation storage
blkmem	block memory
set	global SCIP settings

Definition at line 87 of file sepastore.c.

References BMSallocMemory, FALSE, NULL, SCIP_ALLOC, SCIP_CALL, SCIP_OKAY, SCIPrandomCreate(), and SCIPsetInitializeRandomSeed().

Referenced by initSolve().

SCIPsepastoreFree()

SCIP_RETCODE SCIPsepastoreFree	(	SCIP_SEPASTORE **	sepastore,
		BMS_BLKMEM *	blkmem
	)

frees separation storage

Parameters

sepastore	pointer to store separation storage
blkmem	block memory

Definition at line 115 of file sepastore.c.

References BMSfreeMemory, BMSfreeMemoryArrayNull, NULL, SCIP_OKAY, and SCIPrandomFree().

Referenced by freeReoptSolve(), and freeSolve().

SCIPsepastoreStartInitialLP()

void SCIPsepastoreStartInitialLP

(

SCIP_SEPASTORE *

sepastore

)

informs separation storage that the setup of the initial LP starts now

Parameters

sepastore

separation storage

Definition at line 132 of file sepastore.c.

References SCIP_SepaStore::initiallp, SCIP_SepaStore::ncuts, NULL, and TRUE.

Referenced by SCIPconstructCurrentLP(), and SCIPinitConssLP().

SCIPsepastoreEndInitialLP()

void SCIPsepastoreEndInitialLP

(

SCIP_SEPASTORE *

sepastore

)

informs separation storage that the setup of the initial LP is now finished

Parameters

sepastore

separation storage

Definition at line 144 of file sepastore.c.

References FALSE, SCIP_SepaStore::initiallp, SCIP_SepaStore::ncuts, and NULL.

Referenced by SCIPconstructCurrentLP(), and SCIPinitConssLP().

SCIPsepastoreStartForceCuts()

void SCIPsepastoreStartForceCuts

(

SCIP_SEPASTORE *

sepastore

)

informs separation storage that the following cuts should be used in any case

Parameters

sepastore

separation storage

Definition at line 156 of file sepastore.c.

References SCIP_SepaStore::forcecuts, NULL, and TRUE.

Referenced by enforceConstraints().

SCIPsepastoreEndForceCuts()

void SCIPsepastoreEndForceCuts

(

SCIP_SEPASTORE *

sepastore

)

informs separation storage that the following cuts should no longer be used in any case

Parameters

sepastore

separation storage

Definition at line 167 of file sepastore.c.

References FALSE, SCIP_SepaStore::forcecuts, and NULL.

Referenced by enforceConstraints().

SCIPsepastoreAddCut()

SCIP_RETCODE SCIPsepastoreAddCut	(	SCIP_SEPASTORE *	sepastore,
		BMS_BLKMEM *	blkmem,
		SCIP_SET *	set,
		SCIP_STAT *	stat,
		SCIP_EVENTQUEUE *	eventqueue,
		SCIP_EVENTFILTER *	eventfilter,
		SCIP_LP *	lp,
		SCIP_ROW *	cut,
		SCIP_Bool	forcecut,
		SCIP_Bool	root,
		SCIP_Bool *	infeasible
	)

adds cut to separation storage and captures it

Parameters

sepastore	separation storage
blkmem	block memory
set	global SCIP settings
stat	problem statistics data
eventqueue	event queue
eventfilter	event filter for global events
lp	LP data
cut	separated cut
forcecut	should the cut be forced to enter the LP?
root	are we at the root node?
infeasible	pointer to store whether the cut is infeasible

Definition at line 428 of file sepastore.c.

References SCIP_SepaStore::cuts, SCIP_SepaStore::cutssize, SCIP_EventFilter::eventmask, FALSE, SCIP_SepaStore::forcecuts, SCIP_Row::fromcutpool, SCIP_SepaStore::initiallp, SCIP_EventFilter::len, SCIP_SepaStore::ncuts, SCIP_SepaStore::ncutsadded, SCIP_SepaStore::ncutsaddeddirect, SCIP_SepaStore::ncutsaddedviapool, SCIP_SepaStore::ncutsfoundround, SCIP_SepaStore::nforcedcuts, NULL, SCIP_Row::origintype, SCIP_Bool, SCIP_CALL, SCIP_EVENTTYPE_ROWADDEDSEPA, SCIP_EVENTTYPE_ROWDELETEDSEPA, SCIP_OKAY, SCIP_ROWORIGINTYPE_SEPA, SCIPdebugCheckRow, SCIPeventCreateRowAddedSepa(), SCIPeventCreateRowDeletedSepa(), SCIPeventqueueAdd(), SCIProwCapture(), SCIProwChgLocal(), SCIProwGetLhs(), SCIProwGetName(), SCIProwGetNNonz(), SCIProwGetOriginSepa(), SCIProwGetRhs(), SCIProwIsLocal(), SCIProwIsModifiable(), SCIProwRelease(), SCIPsepaDecNCutsAdded(), SCIPsepaIncNCutsAdded(), SCIPsetDebugMsg, SCIPsetGetSepaMaxcuts(), SCIPsetIsInfinity(), sepastoreEnsureCutsMem(), sepastoreIsBdchgApplicable(), sepastoreIsCutRedundant(), and sepastoreIsCutRedundantOrInfeasible().

Referenced by SCIPaddRow(), SCIPconstructCurrentLP(), SCIPcutpoolSeparate(), and SCIPreoptApplyCuts().

SCIPsepastoreApplyCuts()

SCIP_RETCODE SCIPsepastoreApplyCuts	(	SCIP_SEPASTORE *	sepastore,
		BMS_BLKMEM *	blkmem,
		SCIP_SET *	set,
		SCIP_STAT *	stat,
		SCIP_PROB *	transprob,
		SCIP_PROB *	origprob,
		SCIP_TREE *	tree,
		SCIP_REOPT *	reopt,
		SCIP_LP *	lp,
		SCIP_BRANCHCAND *	branchcand,
		SCIP_EVENTQUEUE *	eventqueue,
		SCIP_EVENTFILTER *	eventfilter,
		SCIP_CLIQUETABLE *	cliquetable,
		SCIP_Bool	root,
		SCIP_EFFICIACYCHOICE	efficiacychoice,
		SCIP_Bool *	cutoff
	)

adds cuts to the LP and clears separation storage

Parameters

sepastore	separation storage
blkmem	block memory
set	global SCIP settings
stat	problem statistics
transprob	transformed problem
origprob	original problem
tree	branch and bound tree
reopt	reoptimization data structure
lp	LP data
branchcand	branching candidate storage
eventqueue	event queue
eventfilter	global event filter
cliquetable	clique table data structure
root	are we at the root node?
efficiacychoice	type of solution to base efficiacy computation on
cutoff	pointer to store whether an empty domain was created

Definition at line 921 of file sepastore.c.

References SCIP_SepaStore::cuts, FALSE, SCIP_SepaStore::initiallp, SCIP_SepaStore::ncuts, SCIP_SepaStore::nforcedcuts, NULL, SCIP_Bool, SCIP_CALL, SCIP_OKAY, SCIP_UNUSED, SCIPcutselsSelect(), SCIPnodeGetDepth(), SCIProwGetLPEfficacy(), SCIProwGetName(), SCIProwGetNNonz(), SCIProwIsModifiable(), SCIPsepastoreClearCuts(), SCIPsetDebugMsg, SCIPsetGetSepaMaxcuts(), SCIPsetIsFeasPositive(), SCIPtreeGetCurrentNode(), sepastoreApplyBdchg(), sepastoreApplyCut(), and sepastoreIsBdchgApplicable().

Referenced by applyCuts(), priceAndCutLoop(), SCIPapplyCutsProbing(), SCIPconstructCurrentLP(), and SCIPinitConssLP().

SCIPsepastoreClearCuts()

SCIP_RETCODE SCIPsepastoreClearCuts	(	SCIP_SEPASTORE *	sepastore,
		BMS_BLKMEM *	blkmem,
		SCIP_SET *	set,
		SCIP_EVENTQUEUE *	eventqueue,
		SCIP_EVENTFILTER *	eventfilter,
		SCIP_LP *	lp
	)

clears the separation storage without adding the cuts to the LP

Parameters

sepastore	separation storage
blkmem	block memory
set	global SCIP settings
eventqueue	event queue
eventfilter	event filter for global events
lp	LP data

Definition at line 1027 of file sepastore.c.

References BMSfreeMemoryArrayNull, SCIP_SepaStore::cuts, SCIP_SepaStore::cutssize, SCIP_EventFilter::eventmask, SCIP_SepaStore::initiallp, SCIP_EventFilter::len, SCIP_SepaStore::ncuts, SCIP_SepaStore::ncutsfoundround, SCIP_SepaStore::nforcedcuts, NULL, SCIP_CALL, SCIP_EVENTTYPE_ROWDELETEDSEPA, SCIP_OKAY, SCIPeventCreateRowDeletedSepa(), SCIPeventqueueAdd(), SCIProwRelease(), and SCIPsetDebugMsg.

Referenced by applyCuts(), priceAndCutLoop(), SCIPclearCuts(), SCIPconstructCurrentLP(), SCIPinitConssLP(), and SCIPsepastoreApplyCuts().

SCIPsepastoreRemoveInefficaciousCuts()

SCIP_RETCODE SCIPsepastoreRemoveInefficaciousCuts	(	SCIP_SEPASTORE *	sepastore,
		BMS_BLKMEM *	blkmem,
		SCIP_SET *	set,
		SCIP_STAT *	stat,
		SCIP_EVENTQUEUE *	eventqueue,
		SCIP_EVENTFILTER *	eventfilter,
		SCIP_LP *	lp,
		SCIP_Bool	root,
		SCIP_EFFICIACYCHOICE	efficiacychoice
	)

removes cuts that are inefficacious w.r.t. the current LP solution from separation storage without adding the cuts to the LP

Parameters

sepastore	separation storage
blkmem	block memory
set	global SCIP settings
stat	problem statistics data
eventqueue	event queue
eventfilter	event filter for global events
lp	LP data
root	are we at the root node?
efficiacychoice	type of solution to base efficiacy computation on

Definition at line 1073 of file sepastore.c.

References SCIP_SepaStore::cuts, SCIP_SepaStore::nforcedcuts, NULL, SCIP_CALL, SCIP_EFFICIACYCHOICE_LP, SCIP_EFFICIACYCHOICE_NLP, SCIP_EFFICIACYCHOICE_RELAX, SCIP_INVALIDCALL, SCIP_OKAY, SCIP_Real, SCIPerrorMessage, SCIProwGetLPEfficacy(), SCIProwGetNLPEfficacy(), SCIProwGetRelaxEfficacy(), SCIPsetDebugMsg, SCIPsetIsEfficacious(), and sepastoreDelCut().

Referenced by SCIPremoveInefficaciousCuts().

SCIPsepastoreIsCutApplicable()

SCIP_Bool SCIPsepastoreIsCutApplicable	(	SCIP_SET *	set,
		SCIP_ROW *	cut
	)

indicates whether a cut is applicable

A cut is applicable if it is modifiable, not a bound change, or a bound change that changes bounds by at least epsilon.

Parameters

set	global SCIP settings
cut	cut to check

Definition at line 1130 of file sepastore.c.

References SCIProwGetNNonz(), SCIProwIsModifiable(), and sepastoreIsBdchgApplicable().

Referenced by SCIPisCutApplicable().

SCIPsepastoreGetCuts()

SCIP_ROW** SCIPsepastoreGetCuts

(

SCIP_SEPASTORE *

sepastore

)

get cuts in the separation storage

Parameters

sepastore

separation storage

Definition at line 1139 of file sepastore.c.

References SCIP_SepaStore::cuts, and NULL.

Referenced by SCIPgetCuts().

SCIPsepastoreGetNCuts()

int SCIPsepastoreGetNCuts

(

SCIP_SEPASTORE *

sepastore

)

get number of cuts in the separation storage

Parameters

sepastore

separation storage

Definition at line 1149 of file sepastore.c.

References SCIP_SepaStore::ncuts, and NULL.

Referenced by applyCuts(), cutpoolSeparate(), enforceConstraints(), priceAndCutLoop(), propAndSolve(), SCIPbranchruleExecExternSol(), SCIPbranchruleExecLPSol(), SCIPconshdlrEnforceLPSol(), SCIPconshdlrEnforceRelaxSol(), SCIPconshdlrSeparateLP(), SCIPconshdlrSeparateSol(), SCIPcutpoolSeparate(), SCIPendProbing(), SCIPgetNCuts(), SCIPsepaExecLP(), SCIPsepaExecSol(), separationRoundLP(), separationRoundSol(), solveNode(), and solveNodeLP().

SCIPsepastoreGetNCutsAdded()

int SCIPsepastoreGetNCutsAdded

(

SCIP_SEPASTORE *

sepastore

)

gets the total number of cutting planes added to the separation storage; this is equal to the sum of added cuts directly and via the pool.

Parameters

sepastore

separation storage

Definition at line 1160 of file sepastore.c.

References SCIP_SepaStore::ncutsadded, and NULL.

Referenced by SCIPcutpoolSeparate(), and SCIPgetNCutsFound().

SCIPsepastoreGetNCutsAddedViaPool()

int SCIPsepastoreGetNCutsAddedViaPool

(

SCIP_SEPASTORE *

sepastore

)

gets the number of cutting planes added to the separation storage from the cut pool

Parameters

sepastore

separation storage

Definition at line 1170 of file sepastore.c.

References SCIP_SepaStore::ncutsaddedviapool, and NULL.

SCIPsepastoreGetNCutsAddedDirect()

int SCIPsepastoreGetNCutsAddedDirect

(

SCIP_SEPASTORE *

sepastore

)

gets the number of cutting planes added to the separation storage directly

Parameters

sepastore

separation storage

Definition at line 1180 of file sepastore.c.

References SCIP_SepaStore::ncutsaddeddirect, and NULL.

SCIPsepastoreGetNCutsFoundRound()

int SCIPsepastoreGetNCutsFoundRound

(

SCIP_SEPASTORE *

sepastore

)

get number of cuts found so far in current separation round

Parameters

sepastore

separation storage

Definition at line 1190 of file sepastore.c.

References SCIP_SepaStore::ncutsfoundround, and NULL.

Referenced by SCIPgetNCutsFoundRound().

SCIPsepastoreGetNCutsApplied()

int SCIPsepastoreGetNCutsApplied

(

SCIP_SEPASTORE *

sepastore

)

gets the total number of cutting planes applied to the LP

Parameters

sepastore

separation storage

Definition at line 1200 of file sepastore.c.

References SCIP_SepaStore::ncutsapplied, and NULL.

Referenced by applyCuts(), SCIPgetNCutsApplied(), and solveNodeLP().