pub_compr.h File Reference

Detailed Description

public methods for tree compressions

Author

Jakob Witzig

Definition in file pub_compr.h.

#include "scip/def.h"
#include "scip/type_misc.h"
#include "scip/type_compr.h"

Go to the source code of this file.

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)

Function Documentation

SCIP_DECL_SORTPTRCOMP

(

SCIPcomprComp

)

compares two compressions w. r. to their priority

SCIP_DECL_SORTPTRCOMP

(

SCIPcomprCompName

)

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

SCIP_COMPRDATA* SCIPcomprGetData

(

SCIP_COMPR *

compr

)

gets user data of tree compression

Parameters

compr

tree compression

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

const char* SCIPcomprGetName

(

SCIP_COMPR *

heur

)

gets name of tree compression

Parameters

heur	tree compression

const char* SCIPcomprGetDesc

(

SCIP_COMPR *

compr

)

gets description of tree compression

Parameters

compr

tree compression

int SCIPcomprGetPriority

(

SCIP_COMPR *

compr

)

gets priority of tree compression

Parameters

compr

tree compression

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

SCIP_Longint SCIPcomprGetNCalls

(

SCIP_COMPR *

compr

)

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

Parameters

compr

tree compression

SCIP_Longint SCIPcomprGetNFound

(

SCIP_COMPR *

compr

)

gets the number of tree compressions found by this compression

Parameters

compr

tree compression

SCIP_Bool SCIPcomprIsInitialized

(

SCIP_COMPR *

compr

)

is tree compression initialized?

Parameters

compr

tree compression

SCIP_Real SCIPcomprGetSetupTime

(

SCIP_COMPR *

compr

)

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

Parameters

compr

tree compression

SCIP_Real SCIPcomprGetTime

(

SCIP_COMPR *

compr

)

gets time in seconds used in this compression

Parameters

compr

tree compression