Scippy

SCIP

Solving Constraint Integer Programs

struct_sepa.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-2023 Zuse Institute Berlin (ZIB) */
7 /* */
8 /* Licensed under the Apache License, Version 2.0 (the "License"); */
9 /* you may not use this file except in compliance with the License. */
10 /* You may obtain a copy of the License at */
11 /* */
12 /* http://www.apache.org/licenses/LICENSE-2.0 */
13 /* */
14 /* Unless required by applicable law or agreed to in writing, software */
15 /* distributed under the License is distributed on an "AS IS" BASIS, */
16 /* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. */
17 /* See the License for the specific language governing permissions and */
18 /* limitations under the License. */
19 /* */
20 /* You should have received a copy of the Apache-2.0 license */
21 /* along with SCIP; see the file LICENSE. If not visit scipopt.org. */
22 /* */
23 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
24 
25 /**@file struct_sepa.h
26  * @ingroup INTERNALAPI
27  * @brief datastructures for separators
28  * @author Tobias Achterberg
29  */
30 
31 /*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
32 
33 #ifndef __SCIP_STRUCT_SEPA_H__
34 #define __SCIP_STRUCT_SEPA_H__
35 
36 
37 #include "scip/def.h"
38 #include "scip/type_clock.h"
39 #include "scip/type_sepa.h"
40 
41 #ifdef __cplusplus
42 extern "C" {
43 #endif
44 
45 /** separators data */
46 struct SCIP_Sepa
47 {
48  SCIP_Longint lastsepanode; /**< last (total) node where this separator was called */
49  SCIP_Longint ncalls; /**< number of times, this separator was called */
50  SCIP_Longint nrootcalls; /**< number of times, this separator was called at the root */
51  SCIP_Longint ncutoffs; /**< number of cutoffs found so far by this separator */
52  SCIP_Longint ncutsfound; /**< number of cutting planes found so far by this separator */
53  SCIP_Longint ncutsadded; /**< number of cutting planes added to sepastore equal to
54  * the sum of added cuts via pool and direct.*/
55  SCIP_Longint ncutsaddedviapool; /**< number of cutting planes added from cutpool */
56  SCIP_Longint ncutsaddeddirect; /**< number of cutting planes added directly */
57  SCIP_Longint ncutsappliedviapool;/**< number of cutting planes applied to LP via cutpool */
58  SCIP_Longint ncutsapplieddirect; /**< number of cutting planes applied to LP directly from sepastore */
59  SCIP_Longint nconssfound; /**< number of additional constraints added by this separator */
60  SCIP_Longint ndomredsfound; /**< number of domain reductions found so far by this separator */
61  SCIP_Real maxbounddist; /**< maximal relative distance from current node's dual bound to primal bound compared
62  * to best node's dual bound for applying separation */
63  char* name; /**< name of separator */
64  char* desc; /**< description of separator */
65  SCIP_DECL_SEPACOPY ((*sepacopy)); /**< copy method of separator or NULL if you don't want to copy your plugin into sub-SCIPs */
66  SCIP_DECL_SEPAFREE ((*sepafree)); /**< destructor of separator */
67  SCIP_DECL_SEPAINIT ((*sepainit)); /**< initialize separator */
68  SCIP_DECL_SEPAEXIT ((*sepaexit)); /**< deinitialize separator */
69  SCIP_DECL_SEPAINITSOL ((*sepainitsol)); /**< solving process initialization method of separator */
70  SCIP_DECL_SEPAEXITSOL ((*sepaexitsol)); /**< solving process deinitialization method of separator */
71  SCIP_DECL_SEPAEXECLP ((*sepaexeclp)); /**< LP solution separation method of separator */
72  SCIP_DECL_SEPAEXECSOL ((*sepaexecsol)); /**< arbitrary primal solution separation method of separator */
73  SCIP_SEPADATA* sepadata; /**< separators local data */
74  SCIP_CLOCK* setuptime; /**< time spend for setting up this separator for the next stages */
75  SCIP_CLOCK* sepaclock; /**< separation time */
76  int priority; /**< priority of the separator */
77  int freq; /**< frequency for calling separator */
78  int ncallsatnode; /**< number of times, this separator was called at the current node */
79  int ncutsfoundatnode; /**< number of cutting planes found at the current node */
80  int expbackoff; /**< base for exponential increase of frequency at which the separator is called */
81  SCIP_Bool usessubscip; /**< does the separator use a secondary SCIP instance? */
82  SCIP_Bool delay; /**< should separator be delayed, if other separators found cuts? */
83  SCIP_Bool lpwasdelayed; /**< was the LP separation delayed at the last call? */
84  SCIP_Bool solwasdelayed; /**< was the solution separation delayed at the last call? */
85  SCIP_Bool initialized; /**< is separator initialized? */
86  SCIP_Bool isparentsepa; /**< is separator a parent separator that create cuts of child separators? */
87  struct SCIP_Sepa* parentsepa; /**< pointer to parent separator or NULL */
88 };
89 
90 #ifdef __cplusplus
91 }
92 #endif
93 
94 #endif
SCIP_Bool solwasdelayed
Definition: struct_sepa.h:84
SCIP_Bool usessubscip
Definition: struct_sepa.h:81
SCIP_DECL_SEPAEXECSOL((*sepaexecsol))
SCIP_SEPADATA * sepadata
Definition: struct_sepa.h:73
SCIP_CLOCK * setuptime
Definition: struct_sepa.h:74
SCIP_CLOCK * sepaclock
Definition: struct_sepa.h:75
SCIP_DECL_SEPAEXITSOL((*sepaexitsol))
char * name
Definition: struct_sepa.h:63
SCIP_Longint ncutsapplieddirect
Definition: struct_sepa.h:58
SCIP_Real maxbounddist
Definition: struct_sepa.h:61
SCIP_Bool initialized
Definition: struct_sepa.h:85
SCIP_Longint ncutsfound
Definition: struct_sepa.h:52
SCIP_DECL_SEPAEXECLP((*sepaexeclp))
int ncallsatnode
Definition: struct_sepa.h:78
SCIP_Longint nrootcalls
Definition: struct_sepa.h:50
SCIP_DECL_SEPAEXIT((*sepaexit))
SCIP_Longint nconssfound
Definition: struct_sepa.h:59
SCIP_DECL_SEPAFREE((*sepafree))
SCIP_Longint lastsepanode
Definition: struct_sepa.h:48
SCIP_Bool lpwasdelayed
Definition: struct_sepa.h:83
SCIP_Longint ncalls
Definition: struct_sepa.h:49
SCIP_DECL_SEPAINITSOL((*sepainitsol))
int ncutsfoundatnode
Definition: struct_sepa.h:79
SCIP_Longint ncutsaddedviapool
Definition: struct_sepa.h:55
SCIP_Longint ncutsappliedviapool
Definition: struct_sepa.h:57
#define SCIP_Bool
Definition: def.h:93
SCIP_Longint ncutoffs
Definition: struct_sepa.h:51
type definitions for clocks and timing issues
SCIP_Longint ncutsaddeddirect
Definition: struct_sepa.h:56
SCIP_Bool delay
Definition: struct_sepa.h:82
SCIP_DECL_SEPACOPY((*sepacopy))
type definitions for separators
SCIP_Longint ndomredsfound
Definition: struct_sepa.h:60
#define SCIP_Real
Definition: def.h:186
struct SCIP_Sepa * parentsepa
Definition: struct_sepa.h:87
#define SCIP_Longint
Definition: def.h:171
int priority
Definition: struct_sepa.h:76
SCIP_Longint ncutsadded
Definition: struct_sepa.h:53
common defines and data types used in all packages of SCIP
SCIP_DECL_SEPAINIT((*sepainit))
int expbackoff
Definition: struct_sepa.h:80
struct SCIP_SepaData SCIP_SEPADATA
Definition: type_sepa.h:52
SCIP_Bool isparentsepa
Definition: struct_sepa.h:86
char * desc
Definition: struct_sepa.h:64