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