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