Scippy

GCG

Branch-and-Price & Column Generation for Everyone

Macros | Typedefs
type_masterdiving.h File Reference
Public API of GCG » Core API » Type Definitions

Detailed Description

type definitions for GCG diving heuristics on the master variables

Author
Christian Puchert

Definition in file type_masterdiving.h.

#include "scip/type_scip.h"

Go to the source code of this file.

Macros

#define GCG_DECL_DIVINGFREE(x)   SCIP_RETCODE x (SCIP* scip, SCIP_HEUR* heur)
 
#define GCG_DECL_DIVINGINIT(x)   SCIP_RETCODE x (SCIP* scip, SCIP_HEUR* heur)
 
#define GCG_DECL_DIVINGEXIT(x)   SCIP_RETCODE x (SCIP* scip, SCIP_HEUR* heur)
 
#define GCG_DECL_DIVINGINITSOL(x)   SCIP_RETCODE x (SCIP* scip, SCIP_HEUR* heur)
 
#define GCG_DECL_DIVINGEXITSOL(x)   SCIP_RETCODE x (SCIP* scip, SCIP_HEUR* heur)
 
#define GCG_DECL_DIVINGINITEXEC(x)   SCIP_RETCODE x (SCIP* scip, SCIP_HEUR* heur)
 
#define GCG_DECL_DIVINGEXITEXEC(x)   SCIP_RETCODE x (SCIP* scip, SCIP_HEUR* heur)
 
#define GCG_DECL_DIVINGSELECTVAR(x)   SCIP_RETCODE x (SCIP* scip, SCIP_HEUR* heur, SCIP_VAR** tabulist, int tabulistsize, SCIP_VAR** bestcand, SCIP_Bool* bestcandmayround)
 

Typedefs

typedef struct GCG_DivingData GCG_DIVINGDATA
 

Macro Definition Documentation

◆ GCG_DECL_DIVINGFREE

#define GCG_DECL_DIVINGFREE (   x)    SCIP_RETCODE x (SCIP* scip, SCIP_HEUR* heur)

destructor of diving heuristic to free user data (called when GCG is exiting)

input:

  • scip : SCIP main data structure
  • heur : the diving heuristic itself

Definition at line 54 of file type_masterdiving.h.

◆ GCG_DECL_DIVINGINIT

#define GCG_DECL_DIVINGINIT (   x)    SCIP_RETCODE x (SCIP* scip, SCIP_HEUR* heur)

initialization method of diving heuristic (called after problem was transformed)

input:

  • scip : SCIP main data structure
  • heur : the diving heuristic itself

Definition at line 62 of file type_masterdiving.h.

◆ GCG_DECL_DIVINGEXIT

#define GCG_DECL_DIVINGEXIT (   x)    SCIP_RETCODE x (SCIP* scip, SCIP_HEUR* heur)

deinitialization method of diving heuristic (called before transformed problem is freed)

input:

  • scip : SCIP main data structure
  • heur : the diving heuristic itself

Definition at line 70 of file type_masterdiving.h.

◆ GCG_DECL_DIVINGINITSOL

#define GCG_DECL_DIVINGINITSOL (   x)    SCIP_RETCODE x (SCIP* scip, SCIP_HEUR* heur)

solving process initialization method of diving heuristic (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 diving heuristic may use this call to initialize its branch and bound specific data.

input:

  • scip : SCIP main data structure
  • heur : the diving heuristic itself

Definition at line 81 of file type_masterdiving.h.

◆ GCG_DECL_DIVINGEXITSOL

#define GCG_DECL_DIVINGEXITSOL (   x)    SCIP_RETCODE x (SCIP* scip, SCIP_HEUR* heur)

solving process deinitialization method of primal heuristic (called before branch and bound process data is freed)

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

input:

  • scip : SCIP main data structure
  • heur : the diving heuristic itself

Definition at line 92 of file type_masterdiving.h.

◆ GCG_DECL_DIVINGINITEXEC

#define GCG_DECL_DIVINGINITEXEC (   x)    SCIP_RETCODE x (SCIP* scip, SCIP_HEUR* heur)

execution initialization method of diving heuristic (called when execution of diving heuristic is about to begin)

This method is called when the execution of the diving heuristic starts, before the diving loop. The diving heuristic may use this call to collect data which is specific to this call of the heuristic.

input:

  • scip : SCIP main data structure
  • heur : the diving heuristic itself

Definition at line 103 of file type_masterdiving.h.

◆ GCG_DECL_DIVINGEXITEXEC

#define GCG_DECL_DIVINGEXITEXEC (   x)    SCIP_RETCODE x (SCIP* scip, SCIP_HEUR* heur)

execution deinitialization method of diving heuristic (called when execution data is freed)

This method is called before the execution of the heuristic stops. The diving heuristic should use this call to clean up its execution specific data.

input:

  • scip : SCIP main data structure
  • heur : the diving heuristic itself

Definition at line 114 of file type_masterdiving.h.

◆ GCG_DECL_DIVINGSELECTVAR

#define GCG_DECL_DIVINGSELECTVAR (   x)    SCIP_RETCODE x (SCIP* scip, SCIP_HEUR* heur, SCIP_VAR** tabulist, int tabulistsize, SCIP_VAR** bestcand, SCIP_Bool* bestcandmayround)

variable selection method of diving heuristic

Selects an original variable to dive on

input:

  • scip : SCIP main data structure
  • heur : the diving heuristic itself
  • tabulist : an array containing variables that must not be chosen
  • tabulistsize : the size of the array
  • bestcand : pointer to store the SCIP_VAR* returned by the selection rule
  • bestcandmayround : pointer to store whether the variable may be rounded without losing LP feasibility

Definition at line 128 of file type_masterdiving.h.

Typedef Documentation

◆ GCG_DIVINGDATA

typedef struct GCG_DivingData GCG_DIVINGDATA

locally defined diving data

Definition at line 45 of file type_masterdiving.h.