Detailed Description

internal methods for tree compressions

Author: Jakob Witzig

Definition in file compr.h.

#include "scip/def.h"
#include "blockmemshell/memory.h"
#include "scip/type_retcode.h"
#include "scip/type_result.h"
#include "scip/type_set.h"
#include "scip/type_compr.h"
#include "scip/pub_compr.h"

Go to the source code of this file.

Functions
SCIP_RETCODE	SCIPcomprCopyInclude (SCIP_COMPR compr, SCIP_SET set)

SCIP_RETCODE	SCIPcomprCreate (SCIP_COMPR *compr, SCIP_SET set, SCIP_MESSAGEHDLR messagehdlr, BMS_BLKMEM blkmem, const char name, const char desc, int priority, int minnnodes, SCIP_DECL_COMPRCOPY((comprcopy)), SCIP_DECL_COMPRFREE((comprfree)), SCIP_DECL_COMPRINIT((comprinit)), SCIP_DECL_COMPREXIT((comprexit)), SCIP_DECL_COMPRINITSOL((comprinitsol)), SCIP_DECL_COMPREXITSOL((comprexitsol)), SCIP_DECL_COMPREXEC((comprexec)), SCIP_COMPRDATA comprdata)

SCIP_RETCODE	SCIPcomprFree (SCIP_COMPR *compr, SCIP_SET set)

SCIP_RETCODE	SCIPcomprInit (SCIP_COMPR compr, SCIP_SET set)

SCIP_RETCODE	SCIPcomprExit (SCIP_COMPR compr, SCIP_SET set)

SCIP_RETCODE	SCIPcomprInitsol (SCIP_COMPR compr, SCIP_SET set)

SCIP_RETCODE	SCIPcomprExitsol (SCIP_COMPR compr, SCIP_SET set)

SCIP_RETCODE	SCIPcomprExec (SCIP_COMPR compr, SCIP_SET set, SCIP_REOPT reopt, SCIP_RESULT result)

void	SCIPcomprSetPriority (SCIP_COMPR compr, SCIP_SET set, int priority)

void	SCIPcomprSetCopy (SCIP_COMPR compr, SCIP_DECL_COMPRCOPY((comprcopy)))

void	SCIPcomprSetFree (SCIP_COMPR compr, SCIP_DECL_COMPRFREE((comprfree)))

void	SCIPcomprSetInit (SCIP_COMPR compr, SCIP_DECL_COMPRINIT((comprinit)))

void	SCIPcomprSetExit (SCIP_COMPR compr, SCIP_DECL_COMPREXIT((comprexit)))

void	SCIPcomprSetInitsol (SCIP_COMPR compr, SCIP_DECL_COMPRINITSOL((comprinitsol)))

void	SCIPcomprSetExitsol (SCIP_COMPR compr, SCIP_DECL_COMPREXITSOL((comprexitsol)))

SCIP_Bool	SCIPcomprShouldBeExecuted (SCIP_COMPR *compr, int depth, int nnodes)

Function Documentation

◆ SCIPcomprCopyInclude()

SCIP_RETCODE SCIPcomprCopyInclude	(	SCIP_COMPR *	compr,
		SCIP_SET *	set
	)

copies the given tree compression to a new scip

Parameters

compr	tree compression
set	SCIP_SET of SCIP to copy to

Definition at line 74 of file compr.c.

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

◆ SCIPcomprCreate()

SCIP_RETCODE SCIPcomprCreate	(	SCIP_COMPR **	compr,
		SCIP_SET *	set,
		SCIP_MESSAGEHDLR *	messagehdlr,
		BMS_BLKMEM *	blkmem,
		const char *	name,
		const char *	desc,
		int	priority,
		int	minnnodes,
		SCIP_DECL_COMPRCOPY((*comprcopy))	,
		SCIP_DECL_COMPRFREE((*comprfree))	,
		SCIP_DECL_COMPRINIT((*comprinit))	,
		SCIP_DECL_COMPREXIT((*comprexit))	,
		SCIP_DECL_COMPRINITSOL((*comprinitsol))	,
		SCIP_DECL_COMPREXITSOL((*comprexitsol))	,
		SCIP_DECL_COMPREXEC((*comprexec))	,
		SCIP_COMPRDATA *	comprdata
	)

creates a tree compression

Parameters

compr	pointer to tree compression data structure
set	global SCIP settings
messagehdlr	message handler
blkmem	block memory for parameter settings
name	name of tree compression
desc	description of tree compression
priority	priority of the tree compression
minnnodes	minimal number of nodes for calling compression
comprdata	tree compression data

Definition at line 160 of file compr.c.

References doComprCreate(), NULL, SCIP_CALL_FINALLY, SCIP_OKAY, and SCIPcomprFree().

Referenced by SCIPincludeCompr(), and SCIPincludeComprBasic().

◆ SCIPcomprFree()

SCIP_RETCODE SCIPcomprFree	(	SCIP_COMPR **	compr,
		SCIP_SET *	set
	)

calls destructor and frees memory of tree compression

Parameters

compr	pointer to tree compression data structure
set	global SCIP settings

Definition at line 193 of file compr.c.

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

Referenced by SCIPcomprCreate(), and SCIPsetFree().

◆ SCIPcomprInit()

SCIP_RETCODE SCIPcomprInit	(	SCIP_COMPR *	compr,
		SCIP_SET *	set
	)

initializes tree compression

Parameters

compr	tree compression
set	global SCIP settings

Definition at line 220 of file compr.c.

References SCIP_Compr::comprclock, SCIP_Compr::initialized, SCIP_Compr::name, SCIP_Compr::ncalls, SCIP_Compr::nfound, NULL, SCIP_CALL, SCIP_INVALIDCALL, SCIP_OKAY, SCIPclockReset(), SCIPclockStart(), SCIPclockStop(), SCIPerrorMessage, SCIP_Compr::setuptime, and TRUE.

Referenced by SCIPsetIncludeExternalCode().

◆ SCIPcomprExit()

SCIP_RETCODE SCIPcomprExit	(	SCIP_COMPR *	compr,
		SCIP_SET *	set
	)

calls exit method of tree compression

Parameters

compr	tree compression
set	global SCIP settings

Definition at line 259 of file compr.c.

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

Referenced by SCIPsetInitPlugins().

◆ SCIPcomprInitsol()

SCIP_RETCODE SCIPcomprInitsol	(	SCIP_COMPR *	compr,
		SCIP_SET *	set
	)

informs tree compression that the branch and bound process is being started

Parameters

compr	tree compression
set	global SCIP settings

◆ SCIPcomprExitsol()

SCIP_RETCODE SCIPcomprExitsol	(	SCIP_COMPR *	compr,
		SCIP_SET *	set
	)

informs tree compression that the branch and bound process data is being freed

Parameters

compr	tree compression
set	global SCIP settings

◆ SCIPcomprExec()

SCIP_RETCODE SCIPcomprExec	(	SCIP_COMPR *	compr,
		SCIP_SET *	set,
		SCIP_REOPT *	reopt,
		SCIP_RESULT *	result
	)

calls execution method of tree compression

Parameters

compr	tree compression
set	global SCIP settings
reopt	reoptimization data structure
result	pointer to store the result of the callback method

Definition at line 289 of file compr.c.

References SCIP_Compr::comprclock, SCIP_Compr::minnnodes, SCIP_Compr::name, SCIP_Compr::ncalls, SCIP_Compr::nfound, NULL, SCIP_CALL, SCIP_DIDNOTFIND, SCIP_DIDNOTRUN, SCIP_INVALIDRESULT, SCIP_OKAY, SCIP_SUCCESS, SCIPclockStart(), SCIPclockStop(), SCIPerrorMessage, SCIPreoptGetNLeaves(), and SCIPsetDebugMsg.

Referenced by compressReoptTree().

◆ SCIPcomprSetPriority()

void SCIPcomprSetPriority	(	SCIP_COMPR *	compr,
		SCIP_SET *	set,
		int	priority
	)

sets priority of tree compression

Parameters

compr	tree compression
set	global SCIP settings
priority	new priority of the tree compression

Definition at line 476 of file compr.c.

References FALSE, NULL, and SCIP_Compr::priority.

Referenced by SCIPsetComprPriority().

◆ SCIPcomprSetCopy()

void SCIPcomprSetCopy	(	SCIP_COMPR *	compr,
		SCIP_DECL_COMPRCOPY((*comprcopy))
	)

sets copy callback of tree compression

Parameters

compr tree compression

Definition at line 366 of file compr.c.

References NULL.

Referenced by SCIPsetComprCopy().

◆ SCIPcomprSetFree()

void SCIPcomprSetFree	(	SCIP_COMPR *	compr,
		SCIP_DECL_COMPRFREE((*comprfree))
	)

sets destructor callback of tree compression

Parameters

compr tree compression

Definition at line 377 of file compr.c.

References NULL.

Referenced by SCIPsetComprFree().

◆ SCIPcomprSetInit()

void SCIPcomprSetInit	(	SCIP_COMPR *	compr,
		SCIP_DECL_COMPRINIT((*comprinit))
	)

sets initialization callback of tree compression

Parameters

compr tree compression

Definition at line 388 of file compr.c.

References NULL.

Referenced by SCIPsetComprInit().

◆ SCIPcomprSetExit()

void SCIPcomprSetExit	(	SCIP_COMPR *	compr,
		SCIP_DECL_COMPREXIT((*comprexit))
	)

sets deinitialization callback of tree compression

Parameters

compr tree compression

Definition at line 399 of file compr.c.

References NULL.

Referenced by SCIPsetComprExit().

◆ SCIPcomprSetInitsol()

void SCIPcomprSetInitsol	(	SCIP_COMPR *	compr,
		SCIP_DECL_COMPRINITSOL((*comprinitsol))
	)

sets solving process initialization callback of tree compression

Parameters

compr tree compression

Definition at line 410 of file compr.c.

References NULL.

Referenced by SCIPsetComprInitsol().

◆ SCIPcomprSetExitsol()

void SCIPcomprSetExitsol	(	SCIP_COMPR *	compr,
		SCIP_DECL_COMPREXITSOL((*comprexitsol))
	)

sets solving process deinitialization callback of tree compression

Parameters

compr tree compression

Definition at line 421 of file compr.c.

References NULL.

Referenced by SCIPsetComprExitsol().

◆ SCIPcomprShouldBeExecuted()

SCIP_Bool SCIPcomprShouldBeExecuted	(	SCIP_COMPR *	compr,
		int	depth,
		int	nnodes
	)

should the compression be executed at the given depth, frequency, timing, ...

should the compression be executed at the given depth, number of nodes

Parameters

compr	tree compression
depth	depth of current node
nnodes	number of open nodes

Definition at line 432 of file compr.c.

References SCIP_Compr::minnnodes, and NULL.

SCIP

Detailed Description

Functions

Function Documentation

◆ SCIPcomprCopyInclude()

◆ SCIPcomprCreate()

◆ SCIPcomprFree()

◆ SCIPcomprInit()

◆ SCIPcomprExit()

◆ SCIPcomprInitsol()

◆ SCIPcomprExitsol()

◆ SCIPcomprExec()

◆ SCIPcomprSetPriority()

◆ SCIPcomprSetCopy()

◆ SCIPcomprSetFree()

◆ SCIPcomprSetInit()

◆ SCIPcomprSetExit()

◆ SCIPcomprSetInitsol()

◆ SCIPcomprSetExitsol()

◆ SCIPcomprShouldBeExecuted()