Scippy

SCIP

Solving Constraint Integer Programs

dialog_default.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 dialog_default.h
17  * @ingroup DIALOGS
18  * @brief default user interface dialog
19  * @author Tobias Achterberg
20  */
21 
22 /*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
23 
24 #ifndef __SCIP_DIALOG_DEFAULT_H__
25 #define __SCIP_DIALOG_DEFAULT_H__
26 
27 #include "scip/def.h"
28 #include "scip/type_dialog.h"
29 #include "scip/type_retcode.h"
30 #include "scip/type_scip.h"
31 
32 #ifdef __cplusplus
33 extern "C" {
34 #endif
35 
36 
37 /**@addtogroup DIALOGS
38  *
39  * @{
40  */
41 
42 /** standard menu dialog execution method, that displays it's help screen if the remaining command line is empty */
43 SCIP_EXPORT
44 SCIP_DECL_DIALOGEXEC(SCIPdialogExecMenu);
45 
46 /** standard menu dialog execution method, that doesn't display it's help screen */
47 SCIP_EXPORT
48 SCIP_DECL_DIALOGEXEC(SCIPdialogExecMenuLazy);
49 
50 /** dialog execution method for the change add constraint */
51 SCIP_EXPORT
52 SCIP_DECL_DIALOGEXEC(SCIPdialogExecChangeAddCons);
53 
54 /** dialog execution method for the change bounds command */
55 SCIP_EXPORT
56 SCIP_DECL_DIALOGEXEC(SCIPdialogExecChangeBounds);
57 
58 /** dialog execution method for the freetransproblem command */
59 SCIP_EXPORT
60 SCIP_DECL_DIALOGEXEC(SCIPdialogExecChangeFreetransproblem);
61 
62 /** dialog execution method for the changing the objective sense */
63 SCIP_EXPORT
64 SCIP_DECL_DIALOGEXEC(SCIPdialogExecChangeObjSense);
65 
66 /** dialog execution method for the checksol command */
67 SCIP_EXPORT
68 SCIP_DECL_DIALOGEXEC(SCIPdialogExecChecksol);
69 
70 /** dialog execution method for the cliquegraph command */
71 SCIP_EXPORT
72 SCIP_DECL_DIALOGEXEC(SCIPdialogExecCliquegraph);
73 
74 /** dialog execution method for the display benders command */
75 SCIP_EXPORT
76 SCIP_DECL_DIALOGEXEC(SCIPdialogExecDisplayBenders);
77 
78 /** dialog execution method for the display branching command */
79 SCIP_EXPORT
80 SCIP_DECL_DIALOGEXEC(SCIPdialogExecDisplayBranching);
81 
82 /** dialog execution method for the display compression command */
83 SCIP_EXPORT
84 SCIP_DECL_DIALOGEXEC(SCIPdialogExecDisplayCompression);
85 
86 /** dialog execution method for the display conflict command */
87 SCIP_EXPORT
88 SCIP_DECL_DIALOGEXEC(SCIPdialogExecDisplayConflict);
89 
90 /** dialog execution method for the display conshdlrs command */
91 SCIP_EXPORT
92 SCIP_DECL_DIALOGEXEC(SCIPdialogExecDisplayConshdlrs);
93 
94 /** dialog execution method for the display displaycols command */
95 SCIP_EXPORT
96 SCIP_DECL_DIALOGEXEC(SCIPdialogExecDisplayDisplaycols);
97 
98 /** dialog execution method for the display exprhdlrs command */
99 SCIP_EXPORT
100 SCIP_DECL_DIALOGEXEC(SCIPdialogExecDisplayExprhdlrs);
101 
102 /** dialog execution method for the display cutselectors command */
103 SCIP_EXPORT
104 SCIP_DECL_DIALOGEXEC(SCIPdialogExecDisplayCutselectors);
105 
106 /** dialog execution method for the display heuristics command */
107 SCIP_EXPORT
108 SCIP_DECL_DIALOGEXEC(SCIPdialogExecDisplayHeuristics);
109 
110 /** dialog execution method for the display memory command */
111 SCIP_EXPORT
112 SCIP_DECL_DIALOGEXEC(SCIPdialogExecDisplayMemory);
113 
114 /** dialog execution method for the display nodeselectors command */
115 SCIP_EXPORT
116 SCIP_DECL_DIALOGEXEC(SCIPdialogExecDisplayNodeselectors);
117 
118 /** dialog execution method for the display nlpi command */
119 SCIP_EXPORT
120 SCIP_DECL_DIALOGEXEC(SCIPdialogExecDisplayNlpi);
121 
122 /** dialog execution method for the display parameters command */
123 SCIP_EXPORT
124 SCIP_DECL_DIALOGEXEC(SCIPdialogExecDisplayParameters);
125 
126 /** dialog execution method for the display presolvers command */
127 SCIP_EXPORT
128 SCIP_DECL_DIALOGEXEC(SCIPdialogExecDisplayPresolvers);
129 
130 /** dialog execution method for the display pricer command */
131 SCIP_EXPORT
132 SCIP_DECL_DIALOGEXEC(SCIPdialogExecDisplayPricers);
133 
134 /** dialog execution method for the display problem command */
135 SCIP_EXPORT
136 SCIP_DECL_DIALOGEXEC(SCIPdialogExecDisplayProblem);
137 
138 /** dialog execution method for the display propagators command */
139 SCIP_EXPORT
140 SCIP_DECL_DIALOGEXEC(SCIPdialogExecDisplayPropagators);
141 
142 /** dialog execution method for the display readers command */
143 SCIP_EXPORT
144 SCIP_DECL_DIALOGEXEC(SCIPdialogExecDisplayReaders);
145 
146 /** dialog execution method for the display relaxators command */
147 SCIP_EXPORT
148 SCIP_DECL_DIALOGEXEC(SCIPdialogExecDisplayRelaxators);
149 
150 /** dialog execution method for the display separators command */
151 SCIP_EXPORT
152 SCIP_DECL_DIALOGEXEC(SCIPdialogExecDisplaySeparators);
153 
154 /** dialog execution method for the display solution command */
155 SCIP_EXPORT
156 SCIP_DECL_DIALOGEXEC(SCIPdialogExecDisplaySolution);
157 
158 /** dialog execution method for the display finitesolution command */
159 SCIP_EXPORT
160 SCIP_DECL_DIALOGEXEC(SCIPdialogExecDisplayFiniteSolution);
161 
162 /** dialog execution method for the display dual solution command */
163 SCIP_EXPORT
164 SCIP_DECL_DIALOGEXEC(SCIPdialogExecDisplayDualSolution);
165 
166 /** dialog execution method for the display of solutions in the pool command */
167 SCIP_EXPORT
168 SCIP_DECL_DIALOGEXEC(SCIPdialogExecDisplaySolutionPool);
169 
170 /** dialog execution method for the display subproblem command */
171 SCIP_EXPORT
172 SCIP_DECL_DIALOGEXEC(SCIPdialogExecDisplaySubproblem);
173 
174 /** dialog execution method for the display subsolution command */
175 SCIP_EXPORT
176 SCIP_DECL_DIALOGEXEC(SCIPdialogExecDisplaySubSolution);
177 
178 /** dialog execution method for the display statistics command */
179 SCIP_EXPORT
180 SCIP_DECL_DIALOGEXEC(SCIPdialogExecDisplayStatistics);
181 
182 /** dialog execution method for the display reoptstatistics command */
183 SCIP_EXPORT
184 SCIP_DECL_DIALOGEXEC(SCIPdialogExecDisplayReoptStatistics);
185 
186 /** dialog execution method for the display transproblem command */
187 SCIP_EXPORT
188 SCIP_DECL_DIALOGEXEC(SCIPdialogExecDisplayTransproblem);
189 
190 /** dialog execution method for the display value command */
191 SCIP_EXPORT
192 SCIP_DECL_DIALOGEXEC(SCIPdialogExecDisplayValue);
193 
194 /** dialog execution method for the display varbranchstatistics command */
195 SCIP_EXPORT
196 SCIP_DECL_DIALOGEXEC(SCIPdialogExecDisplayVarbranchstatistics);
197 
198 /** dialog execution method for the display LP solution quality command */
199 SCIP_DECL_DIALOGEXEC(SCIPdialogExecDisplayLPSolutionQuality);
200 
201 /** dialog execution method for the display transsolution command */
202 SCIP_EXPORT
203 SCIP_DECL_DIALOGEXEC(SCIPdialogExecDisplayTranssolution);
204 
205 /** dialog execution method for the help command */
206 SCIP_EXPORT
207 SCIP_DECL_DIALOGEXEC(SCIPdialogExecHelp);
208 
209 /** dialog execution method for the free command */
210 SCIP_EXPORT
211 SCIP_DECL_DIALOGEXEC(SCIPdialogExecFree);
212 
213 /** dialog execution method for the newstart command */
214 SCIP_EXPORT
215 SCIP_DECL_DIALOGEXEC(SCIPdialogExecNewstart);
216 
217 /** dialog execution method for the transform command */
218 SCIP_EXPORT
219 SCIP_DECL_DIALOGEXEC(SCIPdialogExecTransform);
220 
221 /** dialog execution method for the optimize command */
222 SCIP_EXPORT
223 SCIP_DECL_DIALOGEXEC(SCIPdialogExecOptimize);
224 
225 /** dialog execution method for the parallelopt command */
226 SCIP_EXPORT
227 SCIP_DECL_DIALOGEXEC(SCIPdialogExecConcurrentOpt);
228 
229 /** dialog execution method for the presolve command */
230 SCIP_EXPORT
231 SCIP_DECL_DIALOGEXEC(SCIPdialogExecPresolve);
232 
233 /** dialog execution method for the quit command */
234 SCIP_EXPORT
235 SCIP_DECL_DIALOGEXEC(SCIPdialogExecQuit);
236 
237 /** dialog execution method for the read command */
238 SCIP_EXPORT
239 SCIP_DECL_DIALOGEXEC(SCIPdialogExecRead);
240 
241 /** dialog execution method for the set default command */
242 SCIP_EXPORT
243 SCIP_DECL_DIALOGEXEC(SCIPdialogExecSetDefault);
244 
245 /** dialog execution method for the set load command */
246 SCIP_EXPORT
247 SCIP_DECL_DIALOGEXEC(SCIPdialogExecSetLoad);
248 
249 /** dialog execution method for the set save command */
250 SCIP_EXPORT
251 SCIP_DECL_DIALOGEXEC(SCIPdialogExecSetSave);
252 
253 /** dialog execution method for the set diffsave command */
254 SCIP_EXPORT
255 SCIP_DECL_DIALOGEXEC(SCIPdialogExecSetDiffsave);
256 
257 /** dialog execution method for the set parameter command */
258 SCIP_EXPORT
259 SCIP_DECL_DIALOGEXEC(SCIPdialogExecSetParam);
260 
261 /** dialog description method for the set parameter command */
262 SCIP_EXPORT
263 SCIP_DECL_DIALOGDESC(SCIPdialogDescSetParam);
264 
265 /** dialog execution method for the fix parameter command */
266 SCIP_EXPORT
267 SCIP_DECL_DIALOGEXEC(SCIPdialogExecFixParam);
268 
269 /** dialog description method for the fix parameter command */
270 SCIP_EXPORT
271 SCIP_DECL_DIALOGDESC(SCIPdialogDescFixParam);
272 
273 /** dialog execution method for the set branching direction command */
274 SCIP_EXPORT
275 SCIP_DECL_DIALOGEXEC(SCIPdialogExecSetBranchingDirection);
276 
277 /** dialog execution method for the set branching priority command */
278 SCIP_EXPORT
279 SCIP_DECL_DIALOGEXEC(SCIPdialogExecSetBranchingPriority);
280 
281 /** dialog execution method for the set heuristics aggressive command */
282 SCIP_EXPORT
283 SCIP_DECL_DIALOGEXEC(SCIPdialogExecSetHeuristicsAggressive);
284 
285 /** dialog execution method for the set heuristics default command */
286 SCIP_EXPORT
287 SCIP_DECL_DIALOGEXEC(SCIPdialogExecSetHeuristicsDefault);
288 
289 /** dialog execution method for the set heuristics fast command */
290 SCIP_EXPORT
291 SCIP_DECL_DIALOGEXEC(SCIPdialogExecSetHeuristicsFast);
292 
293 /** dialog execution method for the set heuristics off command */
294 SCIP_EXPORT
295 SCIP_DECL_DIALOGEXEC(SCIPdialogExecSetHeuristicsOff);
296 
297 /** dialog execution method for the set presolving aggressive command */
298 SCIP_EXPORT
299 SCIP_DECL_DIALOGEXEC(SCIPdialogExecSetPresolvingAggressive);
300 
301 /** dialog execution method for the set presolving default command */
302 SCIP_EXPORT
303 SCIP_DECL_DIALOGEXEC(SCIPdialogExecSetPresolvingDefault);
304 
305 /** dialog execution method for the set presolving fast command */
306 SCIP_EXPORT
307 SCIP_DECL_DIALOGEXEC(SCIPdialogExecSetPresolvingFast);
308 
309 /** dialog execution method for the set presolving off command */
310 SCIP_EXPORT
311 SCIP_DECL_DIALOGEXEC(SCIPdialogExecSetPresolvingOff);
312 
313 /** dialog execution method for the set separating aggressive command */
314 SCIP_EXPORT
315 SCIP_DECL_DIALOGEXEC(SCIPdialogExecSetSeparatingAggressive);
316 
317 /** dialog execution method for the set separating default command */
318 SCIP_EXPORT
319 SCIP_DECL_DIALOGEXEC(SCIPdialogExecSetSeparatingDefault);
320 
321 /** dialog execution method for the set separating fast command */
322 SCIP_EXPORT
323 SCIP_DECL_DIALOGEXEC(SCIPdialogExecSetSeparatingFast);
324 
325 /** dialog execution method for the set separating off command */
326 SCIP_EXPORT
327 SCIP_DECL_DIALOGEXEC(SCIPdialogExecSetSeparatingOff);
328 
329 /** dialog execution method for the set emphasis counter command */
330 SCIP_EXPORT
331 SCIP_DECL_DIALOGEXEC(SCIPdialogExecSetEmphasisCounter);
332 
333 /** dialog execution method for the set emphasis cpsolver command */
334 SCIP_EXPORT
335 SCIP_DECL_DIALOGEXEC(SCIPdialogExecSetEmphasisCpsolver);
336 
337 /** dialog execution method for the set emphasis easy CIP command */
338 SCIP_EXPORT
339 SCIP_DECL_DIALOGEXEC(SCIPdialogExecSetEmphasisEasycip);
340 
341 /** dialog execution method for the set emphasis feasibility command */
342 SCIP_EXPORT
343 SCIP_DECL_DIALOGEXEC(SCIPdialogExecSetEmphasisFeasibility);
344 
345 /** dialog execution method for the set emphasis hard LP command */
346 SCIP_EXPORT
347 SCIP_DECL_DIALOGEXEC(SCIPdialogExecSetEmphasisHardlp);
348 
349 /** dialog execution method for the set emphasis optimality command */
350 SCIP_EXPORT
351 SCIP_DECL_DIALOGEXEC(SCIPdialogExecSetEmphasisOptimality);
352 
353 /** dialog execution method for the set emphasis numerics command */
354 SCIP_EXPORT
355 SCIP_DECL_DIALOGEXEC(SCIPdialogExecSetEmphasisNumerics);
356 
357 /** dialog execution method for the set emphasis benchmark command */
358 SCIP_EXPORT
359 SCIP_DECL_DIALOGEXEC(SCIPdialogExecSetEmphasisBenchmark);
360 
361 /** dialog execution method for the set limits objective command */
362 SCIP_EXPORT
363 SCIP_DECL_DIALOGEXEC(SCIPdialogExecSetLimitsObjective);
364 
365 /** dialog execution method for linear constraint type classification */
366 SCIP_EXPORT
367 SCIP_DECL_DIALOGEXEC(SCIPdialogExecDisplayLinearConsClassification);
368 
369 /** creates a root dialog */
370 SCIP_EXPORT
371 SCIP_RETCODE SCIPcreateRootDialog(
372  SCIP* scip, /**< SCIP data structure */
373  SCIP_DIALOG** root /**< pointer to store the root dialog */
374  );
375 
376 /** @} */
377 
378 /**@addtogroup DialogIncludes
379  *
380  * @{
381  */
382 
383 /** includes or updates the default dialog menus in SCIP except for menus "fix" and "set" */
384 SCIP_EXPORT
385 SCIP_RETCODE SCIPincludeDialogDefaultBasic(
386  SCIP* scip /**< SCIP data structure */
387  );
388 
389 /** includes or updates the "set" menu for each available parameter setting */
390 SCIP_EXPORT
391 SCIP_RETCODE SCIPincludeDialogDefaultSet(
392  SCIP* scip /**< SCIP data structure */
393  );
394 
395 /** includes or updates the "fix" menu for each available parameter setting */
396 SCIP_EXPORT
397 SCIP_RETCODE SCIPincludeDialogDefaultFix(
398  SCIP* scip /**< SCIP data structure */
399  );
400 
401 /** @} */
402 
403 #ifdef __cplusplus
404 }
405 #endif
406 
407 #endif
SCIP_DECL_DIALOGDESC
SCIP_DECL_DIALOGDESC(SCIPdialogDescSetParam)
Definition: dialog_default.c:2730
SCIP_Dialog
Definition: struct_dialog.h:36
SCIP_RETCODE
enum SCIP_Retcode SCIP_RETCODE
Definition: type_retcode.h:54
type_retcode.h
type definitions for return codes for SCIP methods
SCIPincludeDialogDefaultBasic
SCIP_RETCODE SCIPincludeDialogDefaultBasic(SCIP *scip)
Definition: dialog_default.c:4013
SCIPincludeDialogDefaultFix
SCIP_RETCODE SCIPincludeDialogDefaultFix(SCIP *scip)
Definition: dialog_default.c:5908
type_scip.h
type definitions for SCIP&#39;s main datastructure
SCIPcreateRootDialog
SCIP_RETCODE SCIPcreateRootDialog(SCIP *scip, SCIP_DIALOG **root)
Definition: dialog_default.c:3994
SCIPincludeDialogDefaultSet
SCIP_RETCODE SCIPincludeDialogDefaultSet(SCIP *scip)
Definition: dialog_default.c:5025
SCIP_DECL_DIALOGEXEC
SCIP_DECL_DIALOGEXEC(SCIPdialogExecMenu)
Definition: dialog_default.c:337
type_dialog.h
type definitions for user interface dialog
def.h
common defines and data types used in all packages of SCIP