Scippy

SCIP

Solving Constraint Integer Programs

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_COMPRDATASCIPcomprGetData (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

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

Definition at line 41 of file compr.c.

References NULL, and SCIP_Compr::priority.

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 53 of file compr.c.

References SCIPcomprGetName().

SCIP_COMPRDATA* SCIPcomprGetData ( SCIP_COMPR compr)

gets user data of tree compression

Parameters
comprtree compression

Definition at line 306 of file compr.c.

References SCIP_Compr::comprdata, and NULL.

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

void SCIPcomprSetData ( SCIP_COMPR compr,
SCIP_COMPRDATA comprdata 
)

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

Parameters
comprtree compression
comprdatanew tree compression user data

Definition at line 316 of file compr.c.

References SCIP_Compr::comprdata, and NULL.

Referenced by SCIP_DECL_COMPRFREE().

const char* SCIPcomprGetName ( SCIP_COMPR compr)

gets name of tree compression

Parameters
comprtree compression

Definition at line 409 of file compr.c.

References SCIP_Compr::name, and NULL.

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

const char* SCIPcomprGetDesc ( SCIP_COMPR compr)

gets description of tree compression

Parameters
comprtree compression

Definition at line 419 of file compr.c.

References SCIP_Compr::desc, and NULL.

Referenced by SCIP_DECL_DIALOGEXEC().

int SCIPcomprGetPriority ( SCIP_COMPR compr)

gets priority of tree compression

Parameters
comprtree compression

Definition at line 429 of file compr.c.

References NULL, and SCIP_Compr::priority.

Referenced by SCIP_DECL_DIALOGEXEC().

int SCIPcomprGetMinNodes ( SCIP_COMPR compr)

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

Parameters
comprtree compression

Definition at line 453 of file compr.c.

References SCIP_Compr::minnnodes, and NULL.

Referenced by constructCompression(), and SCIP_DECL_DIALOGEXEC().

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
comprtree compression

Definition at line 463 of file compr.c.

References SCIP_Compr::ncalls, and NULL.

Referenced by printCompressionStatistics().

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
comprtree compression

Definition at line 473 of file compr.c.

References SCIP_Compr::nfound, and NULL.

Referenced by printCompressionStatistics().

SCIP_Bool SCIPcomprIsInitialized ( SCIP_COMPR compr)

is tree compression initialized?

Parameters
comprtree compression

Definition at line 483 of file compr.c.

References SCIP_Compr::initialized, and NULL.

Referenced by SCIP_DECL_COMPREXEC(), and SCIPsetFindHeur().

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
comprtree compression

Definition at line 493 of file compr.c.

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

Referenced by printCompressionStatistics().

SCIP_Real SCIPcomprGetTime ( SCIP_COMPR compr)

gets time in seconds used in this compression

gets time in seconds used in this heuristic

Parameters
comprtree compression

Definition at line 503 of file compr.c.

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

Referenced by printCompressionStatistics().