Scippy

SCIP

Solving Constraint Integer Programs

Macros | Typedefs
type_compr.h File Reference
Public API of SCIP » Core API » Type Definitions

Detailed Description

type definitions for tree compression

Author
Jakob Witzig

This file defines the interface for tree compression implemented in C.

Definition in file type_compr.h.

#include "scip/def.h"
#include "scip/type_scip.h"
#include "scip/type_result.h"
#include "scip/type_timing.h"

Go to the source code of this file.

Macros

#define SCIP_DECL_COMPRCOPY(x)   SCIP_RETCODE x (SCIP* scip, SCIP_COMPR* compr)
 
#define SCIP_DECL_COMPRFREE(x)   SCIP_RETCODE x (SCIP* scip, SCIP_COMPR* compr)
 
#define SCIP_DECL_COMPRINIT(x)   SCIP_RETCODE x (SCIP* scip, SCIP_COMPR* compr)
 
#define SCIP_DECL_COMPREXIT(x)   SCIP_RETCODE x (SCIP* scip, SCIP_COMPR* compr)
 
#define SCIP_DECL_COMPRINITSOL(x)   SCIP_RETCODE x (SCIP* scip, SCIP_COMPR* compr)
 
#define SCIP_DECL_COMPREXITSOL(x)   SCIP_RETCODE x (SCIP* scip, SCIP_COMPR* compr)
 
#define SCIP_DECL_COMPREXEC(x)   SCIP_RETCODE x (SCIP* scip, SCIP_COMPR* compr, SCIP_RESULT* result)
 

Typedefs

typedef struct SCIP_Compr SCIP_COMPR
 
typedef struct SCIP_ComprData SCIP_COMPRDATA
 

Macro Definition Documentation

◆ SCIP_DECL_COMPRCOPY

#define SCIP_DECL_COMPRCOPY (   x)    SCIP_RETCODE x (SCIP* scip, SCIP_COMPR* compr)

copy method for compression plugins (called when SCIP copies plugins)

input:

  • scip : SCIP main data structure
  • compr : the compression technique itself

Definition at line 49 of file type_compr.h.

◆ SCIP_DECL_COMPRFREE

#define SCIP_DECL_COMPRFREE (   x)    SCIP_RETCODE x (SCIP* scip, SCIP_COMPR* compr)

destructor of tree compression to free user data (called when SCIP is exiting)

input:

  • scip : SCIP main data structure
  • compr : the compression technique itself

Definition at line 57 of file type_compr.h.

◆ SCIP_DECL_COMPRINIT

#define SCIP_DECL_COMPRINIT (   x)    SCIP_RETCODE x (SCIP* scip, SCIP_COMPR* compr)

initialization method of tree compression (called after problem was transformed)

input:

  • scip : SCIP main data structure
  • compr : the compression technique itself

Definition at line 65 of file type_compr.h.

◆ SCIP_DECL_COMPREXIT

#define SCIP_DECL_COMPREXIT (   x)    SCIP_RETCODE x (SCIP* scip, SCIP_COMPR* compr)

deinitialization method of tree compression (called before transformed problem is freed)

input:

  • scip : SCIP main data structure
  • compr : the compression technique itself

Definition at line 73 of file type_compr.h.

◆ SCIP_DECL_COMPRINITSOL

#define SCIP_DECL_COMPRINITSOL (   x)    SCIP_RETCODE x (SCIP* scip, SCIP_COMPR* compr)

solving process initialization method of tree compressionc (called when branch and bound process is about to begin)

This method is called when the presolving was finished and the branch and bound process is about to begin. The tree compression may use this call to initialize its branch and bound specific data.

input:

  • scip : SCIP main data structure
  • compr : the compression technique itself

Definition at line 84 of file type_compr.h.

◆ SCIP_DECL_COMPREXITSOL

#define SCIP_DECL_COMPREXITSOL (   x)    SCIP_RETCODE x (SCIP* scip, SCIP_COMPR* compr)

solving process deinitialization method of tree compression (called before branch and bound process data is freed)

This method is called before the branch and bound process is freed. The tree compression should use this call to clean up its branch and bound data.

input:

  • scip : SCIP main data structure
  • compr : the compression technique itself

Definition at line 95 of file type_compr.h.

◆ SCIP_DECL_COMPREXEC

#define SCIP_DECL_COMPREXEC (   x)    SCIP_RETCODE x (SCIP* scip, SCIP_COMPR* compr, SCIP_RESULT* result)

execution method of tree compression technique

Try to compress the current search tree. The method is called in the node processing loop.

input:

  • scip : SCIP main data structure
  • compr : the compression technique itself
  • result : pointer to store the result of the heuristic call

possible return values for *result:

  • SCIP_SUCCESS : the tree could be compressed
  • SCIP_DIDNITFIND : the method could not compress the tree
  • SCIP_DIDNOTRUN : the compression was skipped

Definition at line 111 of file type_compr.h.

Typedef Documentation

◆ SCIP_COMPR

typedef struct SCIP_Compr SCIP_COMPR

tree compression

Definition at line 39 of file type_compr.h.

◆ SCIP_COMPRDATA

typedef struct SCIP_ComprData SCIP_COMPRDATA

locally defined tree compression data

Definition at line 40 of file type_compr.h.