1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
/* */
/* This file is part of the program and library */
/* SCIP --- Solving Constraint Integer Programs */
/* */
/* Copyright 2002-2022 Zuse Institute Berlin */
/* */
/* Licensed under the Apache License, Version 2.0 (the "License"); */
/* you may not use this file except in compliance with the License. */
/* You may obtain a copy of the License at */
/* */
/* http://www.apache.org/licenses/LICENSE-2.0 */
/* */
/* Unless required by applicable law or agreed to in writing, software */
/* distributed under the License is distributed on an "AS IS" BASIS, */
/* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. */
/* See the License for the specific language governing permissions and */
/* limitations under the License. */
/* */
/* You should have received a copy of the Apache-2.0 license */
/* along with SCIP; see the file LICENSE. If not visit scipopt.org. */
/* */
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
/**@file scip_cutsel.h
* @ingroup PUBLICCOREAPI
* @brief public methods for cut selector plugins
* @author Felipe Serrano
* @author Mark Turner
*/
/*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
#ifndef __SCIP_SCIP_CUTSEL_H__
#define __SCIP_SCIP_CUTSEL_H__
#include "scip/def.h"
#include "scip/type_cutsel.h"
#include "scip/type_retcode.h"
#include "scip/type_scip.h"
#include "scip/type_tree.h"
#ifdef __cplusplus
extern "C" {
#endif
/**@addtogroup PublicCutSelectorMethods
*
* @{
*/
/** creates a cut selector and includes it in SCIP
*
* @note this method has all cut selector callbacks as arguments and is thus changed every time a new
* callback is added in future releases; consider using SCIPincludeCutselBasic() and setter functions
* if you seek for a method which is less likely to change in future releases
*/
SCIP_EXPORT
SCIP_RETCODE SCIPincludeCutsel(
SCIP* scip, /**< SCIP data structure */
const char* name, /**< name of cut selector */
const char* desc, /**< description of cut selector */
int priority, /**< priority of the cut selector */
SCIP_DECL_CUTSELCOPY ((*cutselcopy)), /**< copy method of cut selector or NULL if you don't want to copy your plugin into sub-SCIPs */
SCIP_DECL_CUTSELFREE ((*cutselfree)), /**< destructor of cut selector */
SCIP_DECL_CUTSELINIT ((*cutselinit)), /**< initialize cut selector */
SCIP_DECL_CUTSELEXIT ((*cutselexit)), /**< deinitialize cut selector */
SCIP_DECL_CUTSELINITSOL((*cutselinitsol)),/**< solving process initialization method of cut selector */
SCIP_DECL_CUTSELEXITSOL((*cutselexitsol)),/**< solving process deinitialization method of cut selector */
SCIP_DECL_CUTSELSELECT((*cutselselect)), /**< cut selection method */
SCIP_CUTSELDATA* cutseldata /**< cut selector data */
);
/** Creates a cut selector and includes it in SCIP with its most fundamental callbacks.
*
* All non-fundamental (or optional) callbacks as, e.g., init and exit callbacks, will be set to NULL. Optional
* callbacks can be set via specific setter functions, see SCIPsetCutselCopy(), SCIPsetCutselFree(),
* SCIPsetCutselInit(), SCIPsetCutselExit(), SCIPsetCutselInitsol(), and SCIPsetCutselExitsol()
*
* @note if you want to set all callbacks with a single method call, consider using SCIPincludeCutsel() instead
*/
SCIP_EXPORT
SCIP_RETCODE SCIPincludeCutselBasic(
SCIP* scip, /**< SCIP data structure */
SCIP_CUTSEL** cutsel, /**< reference to a cut selector, or NULL */
const char* name, /**< name of cut selector */
const char* desc, /**< description of cut selector */
int priority, /**< priority of the cut selector in standard mode */
SCIP_DECL_CUTSELSELECT((*cutselselect)), /**< cut selection method */
SCIP_CUTSELDATA* cutseldata /**< cut selector data */
);
/** sets copy method of cut selector */
SCIP_EXPORT
SCIP_RETCODE SCIPsetCutselCopy(
SCIP* scip, /**< SCIP data structure */
SCIP_CUTSEL* cutsel, /**< cut selector */
SCIP_DECL_CUTSELCOPY ((*cutselcopy)) /**< copy method of cut selector or NULL if you don't want to copy your plugin into sub-SCIPs */
);
/** sets destructor method of cut selector */
SCIP_EXPORT
SCIP_RETCODE SCIPsetCutselFree(
SCIP* scip, /**< SCIP data structure */
SCIP_CUTSEL* cutsel, /**< cut selector */
SCIP_DECL_CUTSELFREE ((*cutselfree)) /**< destructor of cut selector */
);
/** sets initialization method of cut selector */
SCIP_EXPORT
SCIP_RETCODE SCIPsetCutselInit(
SCIP* scip, /**< SCIP data structure */
SCIP_CUTSEL* cutsel, /**< cut selector */
SCIP_DECL_CUTSELINIT ((*cutselinit)) /**< initialize cut selector */
);
/** sets deinitialization method of cut selector */
SCIP_EXPORT
SCIP_RETCODE SCIPsetCutselExit(
SCIP* scip, /**< SCIP data structure */
SCIP_CUTSEL* cutsel, /**< cut selector */
SCIP_DECL_CUTSELEXIT ((*cutselexit)) /**< deinitialize cut selector */
);
/** sets solving process initialization method of cut selector */
SCIP_EXPORT
SCIP_RETCODE SCIPsetCutselInitsol(
SCIP* scip, /**< SCIP data structure */
SCIP_CUTSEL* cutsel, /**< cut selector */
SCIP_DECL_CUTSELINITSOL ((*cutselinitsol))/**< solving process initialization method of cut selector */
);
/** sets solving process deinitialization method of cut selector */
SCIP_EXPORT
SCIP_RETCODE SCIPsetCutselExitsol(
SCIP* scip, /**< SCIP data structure */
SCIP_CUTSEL* cutsel, /**< cut selector */
SCIP_DECL_CUTSELEXITSOL ((*cutselexitsol))/**< solving process deinitialization method of cut selector */
);
/** returns the cut selector of the given name, or NULL if not existing */
SCIP_EXPORT
SCIP_CUTSEL* SCIPfindCutsel(
SCIP* scip, /**< SCIP data structure */
const char* name /**< name of cut selector */
);
/** returns the array of currently available cut selectors */
SCIP_EXPORT
SCIP_CUTSEL** SCIPgetCutsels(
SCIP* scip /**< SCIP data structure */
);
/** returns the number of currently available cut selectors */
SCIP_EXPORT
int SCIPgetNCutsels(
SCIP* scip /**< SCIP data structure */
);
/** sets the priority of a cut selector */
SCIP_EXPORT
SCIP_RETCODE SCIPsetCutselPriority(
SCIP* scip, /**< SCIP data structure */
SCIP_CUTSEL* cutsel, /**< cut selector */
int priority /**< new priority of the separator */
);
/** @} */
#ifdef __cplusplus
}
#endif
#endif