Scippy

SCIP

Solving Constraint Integer Programs

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

Detailed Description

type definitions for Benders' decomposition cut

Author
Stephen J. Maher

This file defines the interface for Benders' decomposition cut implemented in C.

Definition in file type_benderscut.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_BENDERSCUTCOPY(x)   SCIP_RETCODE x (SCIP* scip, SCIP_BENDERS* benders, SCIP_BENDERSCUT* benderscut)
 
#define SCIP_DECL_BENDERSCUTFREE(x)   SCIP_RETCODE x (SCIP* scip, SCIP_BENDERSCUT* benderscut)
 
#define SCIP_DECL_BENDERSCUTINIT(x)   SCIP_RETCODE x (SCIP* scip, SCIP_BENDERSCUT* benderscut)
 
#define SCIP_DECL_BENDERSCUTEXIT(x)   SCIP_RETCODE x (SCIP* scip, SCIP_BENDERSCUT* benderscut)
 
#define SCIP_DECL_BENDERSCUTINITSOL(x)   SCIP_RETCODE x (SCIP* scip, SCIP_BENDERSCUT* benderscut)
 
#define SCIP_DECL_BENDERSCUTEXITSOL(x)   SCIP_RETCODE x (SCIP* scip, SCIP_BENDERSCUT* benderscut)
 
#define SCIP_DECL_BENDERSCUTEXEC(x)
 

Typedefs

typedef struct SCIP_Benderscut SCIP_BENDERSCUT
 
typedef struct SCIP_BenderscutData SCIP_BENDERSCUTDATA
 

Macro Definition Documentation

◆ SCIP_DECL_BENDERSCUTCOPY

#define SCIP_DECL_BENDERSCUTCOPY (   x)    SCIP_RETCODE x (SCIP* scip, SCIP_BENDERS* benders, SCIP_BENDERSCUT* benderscut)

copy method for the Benders' decomposition cut plugins (called when SCIP copies plugins)

input:

  • scip : SCIP main data structure
  • benders : the Benders' decomposition structure
  • benderscut : the Benders' decomposition cut structure

Definition at line 50 of file type_benderscut.h.

◆ SCIP_DECL_BENDERSCUTFREE

#define SCIP_DECL_BENDERSCUTFREE (   x)    SCIP_RETCODE x (SCIP* scip, SCIP_BENDERSCUT* benderscut)

destructor of the Benders' decomposition cut to free user data (called when SCIP is exiting)

input:

  • scip : SCIP main data structure
  • benderscut : the Benders' decomposition cut structure

Definition at line 58 of file type_benderscut.h.

◆ SCIP_DECL_BENDERSCUTINIT

#define SCIP_DECL_BENDERSCUTINIT (   x)    SCIP_RETCODE x (SCIP* scip, SCIP_BENDERSCUT* benderscut)

initialization method of the Benders' decomposition cut (called after problem was transformed)

input:

  • scip : SCIP main data structure
  • benderscut : the Benders' decomposition cut structure

Definition at line 66 of file type_benderscut.h.

◆ SCIP_DECL_BENDERSCUTEXIT

#define SCIP_DECL_BENDERSCUTEXIT (   x)    SCIP_RETCODE x (SCIP* scip, SCIP_BENDERSCUT* benderscut)

deinitialization method of the Benders' decomposition cut (called before transformed problem is freed)

input:

  • scip : SCIP main data structure
  • benderscut : the Benders' decomposition cut structure

Definition at line 74 of file type_benderscut.h.

◆ SCIP_DECL_BENDERSCUTINITSOL

#define SCIP_DECL_BENDERSCUTINITSOL (   x)    SCIP_RETCODE x (SCIP* scip, SCIP_BENDERSCUT* benderscut)

solving process initialization method of the Benders' decomposition cut (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.

input:

  • scip : SCIP main data structure
  • benderscut : the Benders' decomposition cut structure

Definition at line 84 of file type_benderscut.h.

◆ SCIP_DECL_BENDERSCUTEXITSOL

#define SCIP_DECL_BENDERSCUTEXITSOL (   x)    SCIP_RETCODE x (SCIP* scip, SCIP_BENDERSCUT* benderscut)

solving process deinitialization method of the Benders' decomposition cut (called before branch and bound process data is freed)

This method is called before the branch and bound process is freed. The Benders' decomposition cut should use this call to clean up its branch and bound data.

input:

  • scip : SCIP main data structure
  • benderscut : the Benders' decomposition cut structure

Definition at line 95 of file type_benderscut.h.

◆ SCIP_DECL_BENDERSCUTEXEC

#define SCIP_DECL_BENDERSCUTEXEC (   x)
Value:
SCIP_RETCODE x (SCIP* scip, SCIP_BENDERS* benders, SCIP_BENDERSCUT* benderscut,\
SCIP_SOL* sol, int probnumber, SCIP_BENDERSENFOTYPE type, SCIP_RESULT* result)
SCIP_RESULT
enum SCIP_Result SCIP_RESULT
Definition: type_result.h:52
SCIP_Benderscut
Definition: struct_benderscut.h:37
SCIP_RETCODE
enum SCIP_Retcode SCIP_RETCODE
Definition: type_retcode.h:54
SCIP_BENDERSENFOTYPE
enum SCIP_BendersEnfoType SCIP_BENDERSENFOTYPE
Definition: type_benders.h:42
x
SCIP_VAR ** x
Definition: circlepacking.c:54
SCIP_Benders
Definition: struct_benders.h:48
SCIP_Sol
Definition: struct_sol.h:64

execution method of the Benders' decomposition cut technique

input:

  • scip : SCIP main data structure
  • benders : the Benders' decomposition structure
  • benderscut : the Benders' cut structure
  • sol : the solution that was used for setting up the subproblems
  • probnumber : the number of the subproblem from which the cut is generated
  • type : the enforcement type that called the subproblem solve
  • result : pointer to store the result of the cut algorithm

possible return values for *result (if more than one applies, the first in the list should be used):

  • SCIP_DIDNOTRUN : if the Benders' cut was not run.
  • SCIP_DIDNOTFIND : if the Benders' cut was run, but there was an error in generating the cut.
  • SCIP_FEASIBLE : if the Benders' decomposition cut algorithm has not generated a constraint or cut.
  • SCIP_CONSADDED : an additional constraint for the Benders' decomposition cut was generated
  • SCIP_SEPARATED : a cutting plane representing the Benders' decomposition cut was generated

Definition at line 115 of file type_benderscut.h.

Typedef Documentation

◆ SCIP_BENDERSCUT

typedef struct SCIP_Benderscut SCIP_BENDERSCUT

Benders' decomposition cut

Definition at line 39 of file type_benderscut.h.

◆ SCIP_BENDERSCUTDATA

typedef struct SCIP_BenderscutData SCIP_BENDERSCUTDATA

locally defined Benders' decomposition cut data

Definition at line 40 of file type_benderscut.h.