Scippy

SCIP

Solving Constraint Integer Programs

struct_relax.h
Go to the documentation of this file.
1 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
2 /* */
3 /* This file is part of the program and library */
4 /* SCIP --- Solving Constraint Integer Programs */
5 /* */
6 /* Copyright (C) 2002-2022 Konrad-Zuse-Zentrum */
7 /* fuer Informationstechnik Berlin */
8 /* */
9 /* SCIP is distributed under the terms of the ZIB Academic License. */
10 /* */
11 /* You should have received a copy of the ZIB Academic License */
12 /* along with SCIP; see the file COPYING. If not visit scipopt.org. */
13 /* */
14 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
15 
16 /**@file struct_relax.h
17  * @ingroup INTERNALAPI
18  * @brief data structures for relaxators
19  * @author Tobias Achterberg
20  */
21 
22 /*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
23 
24 #ifndef __SCIP_STRUCT_RELAX_H__
25 #define __SCIP_STRUCT_RELAX_H__
26 
27 
28 #include "scip/def.h"
29 #include "scip/type_clock.h"
30 #include "scip/type_relax.h"
31 
32 #ifdef __cplusplus
33 extern "C" {
34 #endif
35 
36 /** relaxators data */
37 struct SCIP_Relax
38 {
39  SCIP_Longint ncalls; /**< number of times, this relaxator was called */
40  SCIP_Longint ncutoffs; /**< number of times, this relaxator cut off a node */
41  SCIP_Longint nimprbounds; /**< number of times, this relaxator improves the node's lower bound (w.r.t. SCIPisRelGT) */
42  SCIP_Longint naddedconss; /**< number of times, this relaxator added constraints */
43  SCIP_Longint nreduceddom; /**< number of times, this relaxator reduced variable domains */
44  SCIP_Longint nseparated; /**< number of times, this relaxator separated cuts */
45  SCIP_Longint lastsolvednode; /**< last total nodes counter, where the current relaxation was solved */
46  char* name; /**< name of relaxator */
47  char* desc; /**< description of relaxator */
48  SCIP_DECL_RELAXCOPY ((*relaxcopy)); /**< copy method of relaxator or NULL if you don't want to copy your plugin into sub-SCIPs */
49  SCIP_DECL_RELAXFREE ((*relaxfree)); /**< destructor of relaxator */
50  SCIP_DECL_RELAXINIT ((*relaxinit)); /**< initialize relaxator */
51  SCIP_DECL_RELAXEXIT ((*relaxexit)); /**< deinitialize relaxator */
52  SCIP_DECL_RELAXINITSOL((*relaxinitsol)); /**< solving process initialization method of relaxator */
53  SCIP_DECL_RELAXEXITSOL((*relaxexitsol)); /**< solving process deinitialization method of relaxator */
54  SCIP_DECL_RELAXEXEC ((*relaxexec)); /**< execution method of relaxator */
55  SCIP_RELAXDATA* relaxdata; /**< relaxators local data */
56  SCIP_CLOCK* setuptime; /**< time spent for setting up this relaxator for the next stages */
57  SCIP_CLOCK* relaxclock; /**< relaxation time */
58  SCIP_Real imprtime; /**< time spent for executing relaxator when improving bound (or cutoff) */
59  int priority; /**< priority of the relaxator */
60  int freq; /**< frequency for calling relaxator */
61  SCIP_Bool initialized; /**< is relaxator initialized? */
62 };
63 
64 /** relaxation information data */
66 {
71  SCIP_RELAX* lastsolrelax; /**< relaxator of the most recent relaxation solution */
72 };
73 
74 
75 #ifdef __cplusplus
76 }
77 #endif
78 
79 #endif
SCIP_DECL_RELAXEXITSOL((*relaxexitsol))
char * desc
Definition: struct_relax.h:47
SCIP_DECL_RELAXCOPY((*relaxcopy))
SCIP_Longint ncutoffs
Definition: struct_relax.h:40
SCIP_RELAX * lastsolrelax
Definition: struct_relax.h:71
SCIP_DECL_RELAXINIT((*relaxinit))
SCIP_DECL_RELAXEXEC((*relaxexec))
SCIP_DECL_RELAXFREE((*relaxfree))
SCIP_RELAXDATA * relaxdata
Definition: struct_relax.h:55
SCIP_CLOCK * relaxclock
Definition: struct_relax.h:57
SCIP_Longint naddedconss
Definition: struct_relax.h:42
SCIP_Bool relaxsolincludeslp
Definition: struct_relax.h:69
SCIP_Real relaxsolobjval
Definition: struct_relax.h:67
SCIP_Bool relaxsolvalid
Definition: struct_relax.h:68
SCIP_Longint nimprbounds
Definition: struct_relax.h:41
SCIP_CLOCK * setuptime
Definition: struct_relax.h:56
type definitions for relaxators
char * name
Definition: struct_relax.h:46
#define SCIP_Bool
Definition: def.h:84
SCIP_Bool initialized
Definition: struct_relax.h:61
SCIP_Longint lastsolvednode
Definition: struct_relax.h:45
type definitions for clocks and timing issues
SCIP_Longint ncalls
Definition: struct_relax.h:39
SCIP_Real imprtime
Definition: struct_relax.h:58
struct SCIP_RelaxData SCIP_RELAXDATA
Definition: type_relax.h:38
SCIP_DECL_RELAXEXIT((*relaxexit))
SCIP_Bool relaxsolzero
Definition: struct_relax.h:70
SCIP_Longint nreduceddom
Definition: struct_relax.h:43
#define SCIP_Real
Definition: def.h:177
#define SCIP_Longint
Definition: def.h:162
SCIP_DECL_RELAXINITSOL((*relaxinitsol))
common defines and data types used in all packages of SCIP
SCIP_Longint nseparated
Definition: struct_relax.h:44