Detailed Description

public methods for tree compressions

Functions
	SCIP_DECL_SORTPTRCOMP (SCIPcomprComp)

	SCIP_DECL_SORTPTRCOMP (SCIPcomprCompName)

SCIP_COMPRDATA *	SCIPcomprGetData (SCIP_COMPR *compr)

void	SCIPcomprSetData (SCIP_COMPR compr, SCIP_COMPRDATA comprdata)

const char *	SCIPcomprGetName (SCIP_COMPR *heur)

const char *	SCIPcomprGetDesc (SCIP_COMPR *compr)

int	SCIPcomprGetPriority (SCIP_COMPR *compr)

int	SCIPcomprGetMinNodes (SCIP_COMPR *compr)

SCIP_Longint	SCIPcomprGetNCalls (SCIP_COMPR *compr)

SCIP_Longint	SCIPcomprGetNFound (SCIP_COMPR *compr)

SCIP_Bool	SCIPcomprIsInitialized (SCIP_COMPR *compr)

SCIP_Real	SCIPcomprGetSetupTime (SCIP_COMPR *compr)

SCIP_Real	SCIPcomprGetTime (SCIP_COMPR *compr)

SCIP_RETCODE	SCIPincludeCompr (SCIP scip, 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	SCIPincludeComprBasic (SCIP scip, SCIP_COMPR compr, const char name, const char desc, int priority, int minnnodes, SCIP_DECL_COMPREXEC((comprexec)), SCIP_COMPRDATA *comprdata)

SCIP_RETCODE	SCIPsetComprCopy (SCIP scip, SCIP_COMPR compr, SCIP_DECL_COMPRCOPY((*comprcopy)))

SCIP_RETCODE	SCIPsetComprFree (SCIP scip, SCIP_COMPR compr, SCIP_DECL_COMPRFREE((*comprfree)))

SCIP_RETCODE	SCIPsetComprInit (SCIP scip, SCIP_COMPR compr, SCIP_DECL_COMPRINIT((*comprinit)))

SCIP_RETCODE	SCIPsetComprExit (SCIP scip, SCIP_COMPR compr, SCIP_DECL_COMPREXIT((*comprexit)))

SCIP_RETCODE	SCIPsetComprInitsol (SCIP scip, SCIP_COMPR compr, SCIP_DECL_COMPRINITSOL((*comprinitsol)))

SCIP_RETCODE	SCIPsetComprExitsol (SCIP scip, SCIP_COMPR compr, SCIP_DECL_COMPREXITSOL((*comprexitsol)))

SCIP_COMPR *	SCIPfindCompr (SCIP scip, const char name)

SCIP_COMPR **	SCIPgetComprs (SCIP *scip)

int	SCIPgetNCompr (SCIP *scip)

SCIP_RETCODE	SCIPsetComprPriority (SCIP scip, SCIP_COMPR compr, int priority)

Function Documentation

◆ SCIP_DECL_SORTPTRCOMP() [1/2]

SCIP_DECL_SORTPTRCOMP ( SCIPcomprComp )

compares two compressions w. r. to their priority

compares two compression methods w. r. to their delay positions and their priority

Definition at line 42 of file compr.c.

References NULL, and SCIP_Compr::priority.

◆ SCIP_DECL_SORTPTRCOMP() [2/2]

SCIP_DECL_SORTPTRCOMP ( SCIPcomprCompName )

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

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

Definition at line 54 of file compr.c.

References SCIPcomprGetName().

◆ SCIPcomprGetData()

SCIP_COMPRDATA* SCIPcomprGetData ( SCIP_COMPR * compr )

gets user data of tree compression

Parameters

compr tree compression

Definition at line 344 of file compr.c.

References SCIP_Compr::comprdata, and NULL.

Referenced by SCIP_DECL_COMPREXEC(), SCIP_DECL_COMPREXIT(), and SCIP_DECL_COMPRFREE().

◆ SCIPcomprSetData()

void SCIPcomprSetData	(	SCIP_COMPR *	compr,
		SCIP_COMPRDATA *	comprdata
	)

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

Parameters

compr	tree compression
comprdata	new tree compression user data

Definition at line 354 of file compr.c.

References SCIP_Compr::comprdata, and NULL.

Referenced by SCIP_DECL_COMPRFREE().

◆ SCIPcomprGetName()

const char* SCIPcomprGetName ( SCIP_COMPR * compr )

gets name of tree compression

Parameters

compr tree compression

Definition at line 447 of file compr.c.

References SCIP_Compr::name, and NULL.

Referenced by compressReoptTree(), SCIP_DECL_COMPRCOPY(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_SORTPTRCOMP(), SCIPcomprCopyInclude(), and SCIPprintCompressionStatistics().

◆ SCIPcomprGetDesc()

const char* SCIPcomprGetDesc ( SCIP_COMPR * compr )

gets description of tree compression

Parameters

compr tree compression

Definition at line 457 of file compr.c.

References SCIP_Compr::desc, and NULL.

Referenced by SCIP_DECL_DIALOGEXEC().

◆ SCIPcomprGetPriority()

int SCIPcomprGetPriority ( SCIP_COMPR * compr )

gets priority of tree compression

Parameters

compr tree compression

Definition at line 467 of file compr.c.

References NULL, and SCIP_Compr::priority.

Referenced by SCIP_DECL_DIALOGEXEC().

◆ SCIPcomprGetMinNodes()

int SCIPcomprGetMinNodes ( SCIP_COMPR * compr )

gets minimal number of nodes for calling tree compression (returns -1, if no node threshold exists)

Parameters

compr tree compression

Definition at line 491 of file compr.c.

References SCIP_Compr::minnnodes, and NULL.

Referenced by constructCompression(), and SCIP_DECL_DIALOGEXEC().

◆ SCIPcomprGetNCalls()

SCIP_Longint SCIPcomprGetNCalls ( SCIP_COMPR * compr )

gets the number of times, the compression was called and tried to find a compression

gets the number of times, the heuristic was called and tried to find a solution

Parameters

compr tree compression

Definition at line 501 of file compr.c.

References SCIP_Compr::ncalls, and NULL.

Referenced by SCIPprintCompressionStatistics().

◆ SCIPcomprGetNFound()

SCIP_Longint SCIPcomprGetNFound ( SCIP_COMPR * compr )

gets the number of tree compressions found by this compression

gets the number of compressions found by this compression

Parameters

compr tree compression

Definition at line 511 of file compr.c.

References SCIP_Compr::nfound, and NULL.

Referenced by SCIPprintCompressionStatistics().

◆ SCIPcomprIsInitialized()

SCIP_Bool SCIPcomprIsInitialized ( SCIP_COMPR * compr )

is tree compression initialized?

Parameters

compr tree compression

Definition at line 521 of file compr.c.

References SCIP_Compr::initialized, and NULL.

Referenced by SCIP_DECL_COMPREXEC().

◆ SCIPcomprGetSetupTime()

SCIP_Real SCIPcomprGetSetupTime ( SCIP_COMPR * compr )

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

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

Parameters

compr tree compression

Definition at line 531 of file compr.c.

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

Referenced by SCIPprintCompressionStatistics().

◆ SCIPcomprGetTime()

SCIP_Real SCIPcomprGetTime ( SCIP_COMPR * compr )

gets time in seconds used in this compression

gets time in seconds used in this heuristic

Parameters

compr tree compression

Definition at line 541 of file compr.c.

References SCIP_Compr::comprclock, NULL, and SCIPclockGetTime().

Referenced by SCIPprintCompressionStatistics().

◆ SCIPincludeCompr()

SCIP_RETCODE SCIPincludeCompr	(	SCIP *	scip,
		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 and includes it in SCIP.

Note: method has all compression callbacks as arguments and is thus changed every time a new callback is added in future releases; consider using SCIPincludeComprBasic() 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 tree compression
desc	description of tree compression
priority	priority of the tree compression
minnnodes	minimal number of nodes to call compression
comprdata	tree compression data

Definition at line 51 of file scip_compr.c.

References FALSE, Scip::mem, Scip::messagehdlr, NULL, SCIP_CALL, SCIP_INVALIDDATA, SCIP_OKAY, SCIPcheckStage(), SCIPcomprCreate(), SCIPerrorMessage, SCIPfindCompr(), SCIPsetIncludeCompr(), Scip::set, SCIP_Mem::setmem, and TRUE.

◆ SCIPincludeComprBasic()

SCIP_RETCODE SCIPincludeComprBasic	(	SCIP *	scip,
		SCIP_COMPR **	compr,
		const char *	name,
		const char *	desc,
		int	priority,
		int	minnnodes,
		SCIP_DECL_COMPREXEC((*comprexec))	,
		SCIP_COMPRDATA *	comprdata
	)

creates a tree compression 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 SCIPsetComprCopy(), SCIPsetComprFree(), SCIPsetComprInit(), SCIPsetComprExit(), SCIPsetComprInitsol(), and SCIPsetComprExitsol()

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

Parameters

scip	SCIP data structure
compr	pointer to tree compression
name	name of tree compression
desc	description of tree compression
priority	priority of the tree compression
minnnodes	minimal number of nodes to call the compression
comprdata	tree compression data

Definition at line 94 of file scip_compr.c.

References FALSE, Scip::mem, Scip::messagehdlr, NULL, SCIP_CALL, SCIP_INVALIDDATA, SCIP_OKAY, SCIPcheckStage(), SCIPcomprCreate(), SCIPerrorMessage, SCIPfindCompr(), SCIPsetIncludeCompr(), Scip::set, SCIP_Mem::setmem, and TRUE.

Referenced by SCIPincludeComprLargestrepr(), and SCIPincludeComprWeakcompr().

◆ SCIPsetComprCopy()

SCIP_RETCODE SCIPsetComprCopy	(	SCIP *	scip,
		SCIP_COMPR *	compr,
		SCIP_DECL_COMPRCOPY((*comprcopy))
	)

sets copy method of tree compression

Parameters

scip	SCIP data structure
compr	tree compression

Definition at line 132 of file scip_compr.c.

References FALSE, NULL, SCIP_CALL, SCIP_OKAY, SCIPcheckStage(), SCIPcomprSetCopy(), and TRUE.

Referenced by SCIPincludeComprLargestrepr(), and SCIPincludeComprWeakcompr().

◆ SCIPsetComprFree()

SCIP_RETCODE SCIPsetComprFree	(	SCIP *	scip,
		SCIP_COMPR *	compr,
		SCIP_DECL_COMPRFREE((*comprfree))
	)

sets destructor method of tree compression

Parameters

scip	SCIP data structure
compr	tree compression

Definition at line 148 of file scip_compr.c.

References FALSE, NULL, SCIP_CALL, SCIP_OKAY, SCIPcheckStage(), SCIPcomprSetFree(), and TRUE.

Referenced by SCIPincludeComprLargestrepr(), and SCIPincludeComprWeakcompr().

◆ SCIPsetComprInit()

SCIP_RETCODE SCIPsetComprInit	(	SCIP *	scip,
		SCIP_COMPR *	compr,
		SCIP_DECL_COMPRINIT((*comprinit))
	)

sets initialization method of tree compression

Parameters

scip	SCIP data structure
compr	tree compression

Definition at line 164 of file scip_compr.c.

References FALSE, NULL, SCIP_CALL, SCIP_OKAY, SCIPcheckStage(), SCIPcomprSetInit(), and TRUE.

◆ SCIPsetComprExit()

SCIP_RETCODE SCIPsetComprExit	(	SCIP *	scip,
		SCIP_COMPR *	compr,
		SCIP_DECL_COMPREXIT((*comprexit))
	)

sets deinitialization method of tree compression

Parameters

scip	SCIP data structure
compr	tree compression

Definition at line 180 of file scip_compr.c.

References FALSE, NULL, SCIP_CALL, SCIP_OKAY, SCIPcheckStage(), SCIPcomprSetExit(), and TRUE.

Referenced by SCIPincludeComprLargestrepr(), and SCIPincludeComprWeakcompr().

◆ SCIPsetComprInitsol()

SCIP_RETCODE SCIPsetComprInitsol	(	SCIP *	scip,
		SCIP_COMPR *	compr,
		SCIP_DECL_COMPRINITSOL((*comprinitsol))
	)

sets solving process initialization method of tree compression

Parameters

scip	SCIP data structure
compr	tree compression

Definition at line 196 of file scip_compr.c.

References FALSE, NULL, SCIP_CALL, SCIP_OKAY, SCIPcheckStage(), SCIPcomprSetInitsol(), and TRUE.

◆ SCIPsetComprExitsol()

SCIP_RETCODE SCIPsetComprExitsol	(	SCIP *	scip,
		SCIP_COMPR *	compr,
		SCIP_DECL_COMPREXITSOL((*comprexitsol))
	)

sets solving process deinitialization method of tree compression

Parameters

scip	SCIP data structure
compr	tree compression

Definition at line 212 of file scip_compr.c.

References FALSE, NULL, SCIP_CALL, SCIP_OKAY, SCIPcheckStage(), SCIPcomprSetExitsol(), and TRUE.

◆ SCIPfindCompr()

SCIP_COMPR* SCIPfindCompr	(	SCIP *	scip,
		const char *	name
	)

returns the tree compression of the given name, or NULL if not existing

Parameters

scip	SCIP data structure
name	name of tree compression

Definition at line 228 of file scip_compr.c.

References NULL, SCIPsetFindCompr(), and Scip::set.

Referenced by SCIPincludeCompr(), and SCIPincludeComprBasic().

◆ SCIPgetComprs()

SCIP_COMPR** SCIPgetComprs ( SCIP * scip )

returns the array of currently available tree compression

Parameters

scip	SCIP data structure

Definition at line 241 of file scip_compr.c.

References SCIP_Set::comprs, NULL, SCIPsetSortComprs(), and Scip::set.

Referenced by SCIP_DECL_DIALOGEXEC().

◆ SCIPgetNCompr()

int SCIPgetNCompr ( SCIP * scip )

returns the number of currently available tree compression

Parameters

scip	SCIP data structure

Definition at line 254 of file scip_compr.c.

References SCIP_Set::ncomprs, NULL, and Scip::set.

Referenced by SCIP_DECL_DIALOGEXEC().

◆ SCIPsetComprPriority()

SCIP_RETCODE SCIPsetComprPriority	(	SCIP *	scip,
		SCIP_COMPR *	compr,
		int	priority
	)

set the priority of a tree compression method

Parameters

scip	SCIP data structure
compr	compression
priority	new priority of the tree compression

Definition at line 265 of file scip_compr.c.

References NULL, SCIP_OKAY, SCIPcomprSetPriority(), and Scip::set.

Referenced by SCIP_DECL_PARAMCHGD().

SCIP

Detailed Description

Functions

Function Documentation

◆ SCIP_DECL_SORTPTRCOMP() [1/2]

◆ SCIP_DECL_SORTPTRCOMP() [2/2]

◆ SCIPcomprGetData()

◆ SCIPcomprSetData()

◆ SCIPcomprGetName()

◆ SCIPcomprGetDesc()

◆ SCIPcomprGetPriority()

◆ SCIPcomprGetMinNodes()

◆ SCIPcomprGetNCalls()

◆ SCIPcomprGetNFound()

◆ SCIPcomprIsInitialized()

◆ SCIPcomprGetSetupTime()

◆ SCIPcomprGetTime()

◆ SCIPincludeCompr()

◆ SCIPincludeComprBasic()

◆ SCIPsetComprCopy()

◆ SCIPsetComprFree()

◆ SCIPsetComprInit()

◆ SCIPsetComprExit()

◆ SCIPsetComprInitsol()

◆ SCIPsetComprExitsol()

◆ SCIPfindCompr()

◆ SCIPgetComprs()

◆ SCIPgetNCompr()

◆ SCIPsetComprPriority()