Scippy

SCIP

Solving Constraint Integer Programs

dialog_default.c File Reference

Detailed Description

default user interface dialog

Author
Tobias Achterberg
Timo Berthold
Gerald Gamrath

Definition in file dialog_default.c.

#include <assert.h>
#include <string.h>
#include "scip/dialog_default.h"
#include "nlpi/nlpi.h"

Go to the source code of this file.

Functions

static SCIP_RETCODE dialogExecMenu (SCIP *scip, SCIP_DIALOG *dialog, SCIP_DIALOGHDLR *dialoghdlr, SCIP_DIALOG **nextdialog)
 
static SCIP_Bool parseBoolValue (SCIP *scip, const char *valuestr, SCIP_Bool *error)
 
static void displayReaders (SCIP *scip, SCIP_Bool reader, SCIP_Bool writer)
 
static SCIP_RETCODE writeProblem (SCIP *scip, SCIP_DIALOG *dialog, SCIP_DIALOGHDLR *dialoghdlr, SCIP_DIALOG **nextdialog, SCIP_Bool transformed, SCIP_Bool genericnames)
 
static SCIP_DECL_DIALOGCOPY (dialogCopyDefault)
 
 SCIP_DECL_DIALOGEXEC (SCIPdialogExecMenu)
 
 SCIP_DECL_DIALOGEXEC (SCIPdialogExecMenuLazy)
 
 SCIP_DECL_DIALOGEXEC (SCIPdialogExecChangeAddCons)
 
 SCIP_DECL_DIALOGEXEC (SCIPdialogExecChangeBounds)
 
 SCIP_DECL_DIALOGEXEC (SCIPdialogExecChangeFreetransproblem)
 
 SCIP_DECL_DIALOGEXEC (SCIPdialogExecChangeObjSense)
 
 SCIP_DECL_DIALOGEXEC (SCIPdialogExecChecksol)
 
 SCIP_DECL_DIALOGEXEC (SCIPdialogExecCliquegraph)
 
 SCIP_DECL_DIALOGEXEC (SCIPdialogExecDisplayBranching)
 
 SCIP_DECL_DIALOGEXEC (SCIPdialogExecDisplayRelaxators)
 
 SCIP_DECL_DIALOGEXEC (SCIPdialogExecDisplayConflict)
 
 SCIP_DECL_DIALOGEXEC (SCIPdialogExecDisplayConshdlrs)
 
 SCIP_DECL_DIALOGEXEC (SCIPdialogExecDisplayDisplaycols)
 
 SCIP_DECL_DIALOGEXEC (SCIPdialogExecDisplayHeuristics)
 
 SCIP_DECL_DIALOGEXEC (SCIPdialogExecDisplayMemory)
 
 SCIP_DECL_DIALOGEXEC (SCIPdialogExecDisplayNlpi)
 
 SCIP_DECL_DIALOGEXEC (SCIPdialogExecDisplayNodeselectors)
 
 SCIP_DECL_DIALOGEXEC (SCIPdialogExecDisplayParameters)
 
 SCIP_DECL_DIALOGEXEC (SCIPdialogExecDisplayPresolvers)
 
 SCIP_DECL_DIALOGEXEC (SCIPdialogExecDisplayPricers)
 
 SCIP_DECL_DIALOGEXEC (SCIPdialogExecDisplayProblem)
 
 SCIP_DECL_DIALOGEXEC (SCIPdialogExecDisplayPropagators)
 
 SCIP_DECL_DIALOGEXEC (SCIPdialogExecDisplayReaders)
 
 SCIP_DECL_DIALOGEXEC (SCIPdialogExecDisplaySeparators)
 
 SCIP_DECL_DIALOGEXEC (SCIPdialogExecDisplaySolution)
 
 SCIP_DECL_DIALOGEXEC (SCIPdialogExecDisplayFiniteSolution)
 
 SCIP_DECL_DIALOGEXEC (SCIPdialogExecDisplayDualSolution)
 
 SCIP_DECL_DIALOGEXEC (SCIPdialogExecDisplaySolutionPool)
 
 SCIP_DECL_DIALOGEXEC (SCIPdialogExecDisplayStatistics)
 
 SCIP_DECL_DIALOGEXEC (SCIPdialogExecDisplayReoptStatistics)
 
 SCIP_DECL_DIALOGEXEC (SCIPdialogExecDisplayCompression)
 
 SCIP_DECL_DIALOGEXEC (SCIPdialogExecDisplayTransproblem)
 
 SCIP_DECL_DIALOGEXEC (SCIPdialogExecDisplayValue)
 
 SCIP_DECL_DIALOGEXEC (SCIPdialogExecDisplayVarbranchstatistics)
 
 SCIP_DECL_DIALOGEXEC (SCIPdialogExecDisplayLPSolutionQuality)
 
 SCIP_DECL_DIALOGEXEC (SCIPdialogExecHelp)
 
 SCIP_DECL_DIALOGEXEC (SCIPdialogExecDisplayTranssolution)
 
 SCIP_DECL_DIALOGEXEC (SCIPdialogExecFree)
 
 SCIP_DECL_DIALOGEXEC (SCIPdialogExecNewstart)
 
 SCIP_DECL_DIALOGEXEC (SCIPdialogExecTransform)
 
 SCIP_DECL_DIALOGEXEC (SCIPdialogExecConcurrentOpt)
 
 SCIP_DECL_DIALOGEXEC (SCIPdialogExecOptimize)
 
 SCIP_DECL_DIALOGEXEC (SCIPdialogExecPresolve)
 
 SCIP_DECL_DIALOGEXEC (SCIPdialogExecQuit)
 
 SCIP_DECL_DIALOGEXEC (SCIPdialogExecRead)
 
 SCIP_DECL_DIALOGEXEC (SCIPdialogExecSetDefault)
 
 SCIP_DECL_DIALOGEXEC (SCIPdialogExecSetLoad)
 
 SCIP_DECL_DIALOGEXEC (SCIPdialogExecSetSave)
 
 SCIP_DECL_DIALOGEXEC (SCIPdialogExecSetDiffsave)
 
 SCIP_DECL_DIALOGEXEC (SCIPdialogExecSetParam)
 
 SCIP_DECL_DIALOGDESC (SCIPdialogDescSetParam)
 
 SCIP_DECL_DIALOGEXEC (SCIPdialogExecFixParam)
 
 SCIP_DECL_DIALOGDESC (SCIPdialogDescFixParam)
 
 SCIP_DECL_DIALOGEXEC (SCIPdialogExecSetBranchingDirection)
 
 SCIP_DECL_DIALOGEXEC (SCIPdialogExecSetBranchingPriority)
 
 SCIP_DECL_DIALOGEXEC (SCIPdialogExecSetHeuristicsAggressive)
 
 SCIP_DECL_DIALOGEXEC (SCIPdialogExecSetHeuristicsDefault)
 
 SCIP_DECL_DIALOGEXEC (SCIPdialogExecSetHeuristicsFast)
 
 SCIP_DECL_DIALOGEXEC (SCIPdialogExecSetHeuristicsOff)
 
 SCIP_DECL_DIALOGEXEC (SCIPdialogExecSetPresolvingAggressive)
 
 SCIP_DECL_DIALOGEXEC (SCIPdialogExecSetPresolvingDefault)
 
 SCIP_DECL_DIALOGEXEC (SCIPdialogExecSetPresolvingFast)
 
 SCIP_DECL_DIALOGEXEC (SCIPdialogExecSetPresolvingOff)
 
 SCIP_DECL_DIALOGEXEC (SCIPdialogExecSetSeparatingAggressive)
 
 SCIP_DECL_DIALOGEXEC (SCIPdialogExecSetSeparatingDefault)
 
 SCIP_DECL_DIALOGEXEC (SCIPdialogExecSetSeparatingFast)
 
 SCIP_DECL_DIALOGEXEC (SCIPdialogExecSetSeparatingOff)
 
 SCIP_DECL_DIALOGEXEC (SCIPdialogExecSetEmphasisCounter)
 
 SCIP_DECL_DIALOGEXEC (SCIPdialogExecSetEmphasisCpsolver)
 
 SCIP_DECL_DIALOGEXEC (SCIPdialogExecSetEmphasisEasycip)
 
 SCIP_DECL_DIALOGEXEC (SCIPdialogExecSetEmphasisFeasibility)
 
 SCIP_DECL_DIALOGEXEC (SCIPdialogExecSetEmphasisHardlp)
 
 SCIP_DECL_DIALOGEXEC (SCIPdialogExecSetEmphasisOptimality)
 
 SCIP_DECL_DIALOGEXEC (SCIPdialogExecSetLimitsObjective)
 
static SCIP_DECL_DIALOGEXEC (SCIPdialogExecWriteLp)
 
static SCIP_DECL_DIALOGEXEC (SCIPdialogExecWriteMip)
 
static SCIP_DECL_DIALOGEXEC (SCIPdialogExecWriteNlp)
 
static SCIP_DECL_DIALOGEXEC (SCIPdialogExecWriteProblem)
 
static SCIP_DECL_DIALOGEXEC (SCIPdialogExecWriteGenProblem)
 
static SCIP_DECL_DIALOGEXEC (SCIPdialogExecWriteSolution)
 
static SCIP_DECL_DIALOGEXEC (SCIPdialogExecWriteMIPStart)
 
static SCIP_DECL_DIALOGEXEC (SCIPdialogExecWriteCommandHistory)
 
static SCIP_DECL_DIALOGEXEC (SCIPdialogExecWriteFiniteSolution)
 
static SCIP_DECL_DIALOGEXEC (SCIPdialogExecWriteStatistics)
 
static SCIP_DECL_DIALOGEXEC (SCIPdialogExecWriteTransproblem)
 
static SCIP_DECL_DIALOGEXEC (SCIPdialogExecWriteGenTransproblem)
 
SCIP_RETCODE SCIPcreateRootDialog (SCIP *scip, SCIP_DIALOG **root)
 
SCIP_RETCODE SCIPincludeDialogDefault (SCIP *scip)
 
static SCIP_RETCODE addSetParamDialog (SCIP *scip, SCIP_DIALOG *menu, SCIP_PARAM *param, char *paramname)
 
static SCIP_RETCODE addFixParamDialog (SCIP *scip, SCIP_DIALOG *menu, SCIP_PARAM *param, char *paramname)
 
static SCIP_RETCODE createEmphasisSubmenu (SCIP *scip, SCIP_DIALOG *root, SCIP_DIALOG **submenu)
 
SCIP_RETCODE SCIPincludeDialogDefaultSet (SCIP *scip)
 
SCIP_RETCODE SCIPincludeDialogDefaultFix (SCIP *scip)
 

Function Documentation

◆ dialogExecMenu()

static SCIP_RETCODE dialogExecMenu ( SCIP scip,
SCIP_DIALOG dialog,
SCIP_DIALOGHDLR dialoghdlr,
SCIP_DIALOG **  nextdialog 
)
static

executes a menu dialog

Parameters
scipSCIP data structure
dialogdialog menu
dialoghdlrdialog handler
nextdialogpointer to store next dialog to execute

Definition at line 35 of file dialog_default.c.

References FALSE, NULL, SCIP_Bool, SCIP_CALL, SCIP_OKAY, SCIPdialogDisplayCompletions(), SCIPdialogFindEntry(), SCIPdialogGetParent(), SCIPdialoghdlrClearBuffer(), SCIPdialoghdlrGetRoot(), SCIPdialoghdlrGetWord(), SCIPdialogMessage(), and TRUE.

Referenced by SCIP_DECL_DIALOGEXEC().

◆ parseBoolValue()

static SCIP_Bool parseBoolValue ( SCIP scip,
const char *  valuestr,
SCIP_Bool error 
)
static
Parameters
scipSCIP data structure
valuestrstring to parse
errorpointer to store the error result

Definition at line 100 of file dialog_default.c.

References FALSE, NULL, and TRUE.

Referenced by SCIP_DECL_DIALOGEXEC().

◆ displayReaders()

static void displayReaders ( SCIP scip,
SCIP_Bool  reader,
SCIP_Bool  writer 
)
static
Parameters
scipSCIP data structure
readerdisplay reader which can read
writerdisplay reader which can write

Definition at line 137 of file dialog_default.c.

References NULL, SCIPdialogMessage(), SCIPgetNReaders(), SCIPgetReaders(), SCIPreaderCanRead(), SCIPreaderCanWrite(), SCIPreaderGetDesc(), SCIPreaderGetExtension(), and SCIPreaderGetName().

Referenced by SCIP_DECL_DIALOGEXEC(), and writeProblem().

◆ writeProblem()

static SCIP_RETCODE writeProblem ( SCIP scip,
SCIP_DIALOG dialog,
SCIP_DIALOGHDLR dialoghdlr,
SCIP_DIALOG **  nextdialog,
SCIP_Bool  transformed,
SCIP_Bool  genericnames 
)
static
Parameters
scipSCIP data structure
dialogdialog menu
dialoghdlrdialog handler
nextdialogpointer to store next dialog to execute
transformedoutput the transformed problem?
genericnamesusing generic variable and constraint names?

Definition at line 174 of file dialog_default.c.

References displayReaders(), FALSE, NULL, SCIP_Bool, SCIP_CALL, SCIP_FILECREATEERROR, SCIP_OKAY, SCIP_PLUGINNOTFOUND, SCIP_WRITEERROR, SCIPdialoghdlrAddHistory(), SCIPdialoghdlrClearBuffer(), SCIPdialoghdlrGetWord(), SCIPdialogMessage(), SCIPduplicateBufferArray, SCIPfreeBufferArray, SCIPwriteOrigProblem(), SCIPwriteTransProblem(), and TRUE.

Referenced by SCIP_DECL_DIALOGEXEC().

◆ SCIP_DECL_DIALOGCOPY()

static SCIP_DECL_DIALOGCOPY ( dialogCopyDefault  )
static

copy method for dialog plugins (called when SCIP copies plugins)

Definition at line 269 of file dialog_default.c.

References NULL, SCIP_CALL, SCIP_OKAY, and SCIPincludeDialogDefault().

◆ SCIP_DECL_DIALOGEXEC() [1/12]

static SCIP_DECL_DIALOGEXEC ( SCIPdialogExecWriteLp  )
static

◆ SCIP_DECL_DIALOGEXEC() [2/12]

static SCIP_DECL_DIALOGEXEC ( SCIPdialogExecWriteMip  )
static

◆ SCIP_DECL_DIALOGEXEC() [3/12]

static SCIP_DECL_DIALOGEXEC ( SCIPdialogExecWriteNlp  )
static

◆ SCIP_DECL_DIALOGEXEC() [4/12]

static SCIP_DECL_DIALOGEXEC ( SCIPdialogExecWriteProblem  )
static

dialog execution method for the write problem command

Definition at line 2982 of file dialog_default.c.

References FALSE, NULL, SCIP_CALL, SCIP_OKAY, SCIP_STAGE_PROBLEM, SCIPdialoghdlrAddHistory(), SCIPdialoghdlrGetRoot(), SCIPdialogMessage(), SCIPgetStage(), and writeProblem().

◆ SCIP_DECL_DIALOGEXEC() [5/12]

static SCIP_DECL_DIALOGEXEC ( SCIPdialogExecWriteGenProblem  )
static

dialog execution method for the write generic problem command

Definition at line 3000 of file dialog_default.c.

References FALSE, NULL, SCIP_CALL, SCIP_OKAY, SCIP_STAGE_PROBLEM, SCIPdialoghdlrAddHistory(), SCIPdialoghdlrGetRoot(), SCIPdialogMessage(), SCIPgetStage(), TRUE, and writeProblem().

◆ SCIP_DECL_DIALOGEXEC() [6/12]

static SCIP_DECL_DIALOGEXEC ( SCIPdialogExecWriteSolution  )
static

◆ SCIP_DECL_DIALOGEXEC() [7/12]

static SCIP_DECL_DIALOGEXEC ( SCIPdialogExecWriteMIPStart  )
static

◆ SCIP_DECL_DIALOGEXEC() [8/12]

static SCIP_DECL_DIALOGEXEC ( SCIPdialogExecWriteCommandHistory  )
static

◆ SCIP_DECL_DIALOGEXEC() [9/12]

◆ SCIP_DECL_DIALOGEXEC() [10/12]

static SCIP_DECL_DIALOGEXEC ( SCIPdialogExecWriteStatistics  )
static

◆ SCIP_DECL_DIALOGEXEC() [11/12]

static SCIP_DECL_DIALOGEXEC ( SCIPdialogExecWriteTransproblem  )
static

dialog execution method for the write transproblem command

Definition at line 3282 of file dialog_default.c.

References FALSE, NULL, SCIP_CALL, SCIP_OKAY, SCIP_STAGE_TRANSFORMED, SCIPdialoghdlrAddHistory(), SCIPdialoghdlrGetRoot(), SCIPdialogMessage(), SCIPgetStage(), TRUE, and writeProblem().

◆ SCIP_DECL_DIALOGEXEC() [12/12]

static SCIP_DECL_DIALOGEXEC ( SCIPdialogExecWriteGenTransproblem  )
static

dialog execution method for the write generic transproblem command

Definition at line 3300 of file dialog_default.c.

References FALSE, NULL, SCIP_CALL, SCIP_OKAY, SCIP_STAGE_TRANSFORMED, SCIPdialoghdlrAddHistory(), SCIPdialoghdlrGetRoot(), SCIPdialogMessage(), SCIPgetStage(), TRUE, and writeProblem().

◆ addSetParamDialog()

static SCIP_RETCODE addSetParamDialog ( SCIP scip,
SCIP_DIALOG menu,
SCIP_PARAM param,
char *  paramname 
)
static

if a '/' occurs in the parameter's name, adds a sub menu dialog to the given menu and inserts the parameter dialog recursively in the sub menu; if no '/' occurs in the name, adds a parameter change dialog into the given dialog menu

Parameters
scipSCIP data structure
menudialog menu to insert the parameter into
paramparameter to add a dialog for
paramnameparameter name to parse

Definition at line 4031 of file dialog_default.c.

References FALSE, NULL, paramname, SCIP_CALL, SCIP_MAXSTRLEN, SCIP_OKAY, SCIP_PLUGINNOTFOUND, SCIPaddDialogEntry(), SCIPdialogFindEntry(), SCIPdialogHasEntry(), SCIPerrorMessage, SCIPincludeDialog(), SCIPparamGetDesc(), SCIPparamIsAdvanced(), SCIPreleaseDialog(), SCIPsnprintf(), and TRUE.

Referenced by SCIPincludeDialogDefaultSet().

◆ addFixParamDialog()

static SCIP_RETCODE addFixParamDialog ( SCIP scip,
SCIP_DIALOG menu,
SCIP_PARAM param,
char *  paramname 
)
static

if a '/' occurs in the parameter's name, adds a sub menu dialog to the given menu and inserts the parameter dialog recursively in the sub menu; if no '/' occurs in the name, adds a fix parameter dialog into the given dialog menu

Parameters
scipSCIP data structure
menudialog menu to insert the parameter into
paramparameter to add a dialog for
paramnameparameter name to parse

Definition at line 4142 of file dialog_default.c.

References FALSE, NULL, paramname, SCIP_CALL, SCIP_MAXSTRLEN, SCIP_OKAY, SCIP_PLUGINNOTFOUND, SCIPaddDialogEntry(), SCIPdialogFindEntry(), SCIPdialogHasEntry(), SCIPerrorMessage, SCIPincludeDialog(), SCIPparamGetDesc(), SCIPparamIsAdvanced(), SCIPreleaseDialog(), SCIPsnprintf(), and TRUE.

Referenced by SCIPincludeDialogDefaultFix().

◆ createEmphasisSubmenu()

static SCIP_RETCODE createEmphasisSubmenu ( SCIP scip,
SCIP_DIALOG root,
SCIP_DIALOG **  submenu 
)
static

create a "emphasis" sub menu

Parameters
scipSCIP data structure
rootthe menu to add the empty sub menu
submenupointer to store the created emphasis sub menu

Definition at line 4251 of file dialog_default.c.

References NULL, SCIP_CALL, SCIP_OKAY, SCIP_PLUGINNOTFOUND, SCIPaddDialogEntry(), SCIPdialogFindEntry(), SCIPdialogHasEntry(), SCIPerrorMessage, SCIPincludeDialog(), SCIPreleaseDialog(), and TRUE.

Referenced by SCIPincludeDialogDefaultSet().