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 90 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 118 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 135 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 147 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 159 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 170 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 439 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 935 of file sepastore.c.

References SCIP_SepaStore::cuts, FALSE, SCIP_SepaStore::initiallp, SCIP_Lp::lpexact, MIN, SCIP_SepaStore::ncuts, SCIP_SepaStore::nforcedcuts, NULL, SCIP_Row::rowexact, SCIP_Bool, SCIP_CALL, SCIP_OKAY, SCIP_UNUSED, SCIPaddPoolCut(), SCIPaddRowExact(), SCIPcutselsSelect(), SCIPdelPoolCut(), SCIPisCutNew(), SCIPnodeGetDepth(), SCIProwExactCreateFromRow(), SCIProwGetLPEfficacy(), SCIProwGetName(), SCIProwGetNNonz(), SCIProwGetRowExact(), SCIProwIsLocal(), SCIProwIsModifiable(), SCIPsepastoreClearCuts(), SCIPsetDebugMsg, SCIPsetGetSepaMaxcuts(), SCIPsetIsFeasPositive(), SCIPtreeGetCurrentNode(), sepastoreApplyBdchg(), sepastoreApplyCut(), sepastoreIsBdchgApplicable(), and TRUE.

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