SCIP Doxygen Documentation
 
Loading...
Searching...
No Matches

Detailed Description

methods for the inclusion and access of display plugins

Functions

SCIP_DISPDATASCIPdispGetData (SCIP_DISP *disp)
 
void SCIPdispSetData (SCIP_DISP *disp, SCIP_DISPDATA *dispdata)
 
const char * SCIPdispGetName (SCIP_DISP *disp)
 
const char * SCIPdispGetDesc (SCIP_DISP *disp)
 
const char * SCIPdispGetHeader (SCIP_DISP *disp)
 
int SCIPdispGetWidth (SCIP_DISP *disp)
 
int SCIPdispGetPriority (SCIP_DISP *disp)
 
int SCIPdispGetPosition (SCIP_DISP *disp)
 
SCIP_DISPSTATUS SCIPdispGetStatus (SCIP_DISP *disp)
 
SCIP_Bool SCIPdispIsInitialized (SCIP_DISP *disp)
 
void SCIPdispLongint (SCIP_MESSAGEHDLR *messagehdlr, FILE *file, SCIP_Longint val, int width)
 
void SCIPdispInt (SCIP_MESSAGEHDLR *messagehdlr, FILE *file, int val, int width)
 
void SCIPdispTime (SCIP_MESSAGEHDLR *messagehdlr, FILE *file, SCIP_Real val, int width)
 
SCIP_RETCODE SCIPincludeDisp (SCIP *scip, const char *name, const char *desc, const char *header, SCIP_DISPSTATUS dispstatus, SCIP_DECL_DISPCOPY((*dispcopy)), SCIP_DECL_DISPFREE((*dispfree)), SCIP_DECL_DISPINIT((*dispinit)), SCIP_DECL_DISPEXIT((*dispexit)), SCIP_DECL_DISPINITSOL((*dispinitsol)), SCIP_DECL_DISPEXITSOL((*dispexitsol)), SCIP_DECL_DISPOUTPUT((*dispoutput)), SCIP_DISPDATA *dispdata, int width, int priority, int position, SCIP_Bool stripline)
 
SCIP_DISPSCIPfindDisp (SCIP *scip, const char *name)
 
SCIP_DISP ** SCIPgetDisps (SCIP *scip)
 
int SCIPgetNDisps (SCIP *scip)
 
SCIP_RETCODE SCIPautoselectDisps (SCIP *scip)
 
void SCIPchgDispMode (SCIP_DISP *disp, SCIP_DISPMODE mode)
 

Function Documentation

◆ SCIPdispGetData()

◆ SCIPdispSetData()

void SCIPdispSetData ( SCIP_DISP * disp,
SCIP_DISPDATA * dispdata )

sets user data of display column; user has to free old data in advance!

Parameters
dispdisplay column
dispdatanew display column user data

Definition at line 324 of file disp.c.

References assert(), SCIP_Disp::dispdata, and NULL.

Referenced by SCIP_DECL_DISPFREE(), SCIP_DECL_DISPINITSOL(), SCIP_DECL_DISPINITSOL(), SCIP_DECL_DISPINITSOL(), SCIP_DECL_DISPOUTPUT(), and SCIP_DECL_DISPOUTPUT().

◆ SCIPdispGetName()

const char * SCIPdispGetName ( SCIP_DISP * disp)

◆ SCIPdispGetDesc()

const char * SCIPdispGetDesc ( SCIP_DISP * disp)

gets description of display column

Parameters
dispdisplay column

Definition at line 345 of file disp.c.

References assert(), SCIP_Disp::desc, and NULL.

Referenced by SCIP_DECL_DIALOGEXEC(), SCIPincludeDialogDefaultFix(), and SCIPincludeDialogDefaultSet().

◆ SCIPdispGetHeader()

const char * SCIPdispGetHeader ( SCIP_DISP * disp)

gets head line of display column

Parameters
dispdisplay column

Definition at line 355 of file disp.c.

References assert(), SCIP_Disp::header, and NULL.

Referenced by SCIP_DECL_DIALOGEXEC().

◆ SCIPdispGetWidth()

int SCIPdispGetWidth ( SCIP_DISP * disp)

gets width of display column

Parameters
dispdisplay column

Definition at line 365 of file disp.c.

References assert(), NULL, and SCIP_Disp::width.

Referenced by SCIP_DECL_DIALOGEXEC().

◆ SCIPdispGetPriority()

int SCIPdispGetPriority ( SCIP_DISP * disp)

gets priority of display column

Parameters
dispdisplay column

Definition at line 375 of file disp.c.

References assert(), NULL, and SCIP_Disp::priority.

Referenced by SCIP_DECL_DIALOGEXEC().

◆ SCIPdispGetPosition()

int SCIPdispGetPosition ( SCIP_DISP * disp)

gets position of display column

Parameters
dispdisplay column

Definition at line 385 of file disp.c.

References assert(), NULL, and SCIP_Disp::position.

Referenced by SCIP_DECL_DIALOGEXEC().

◆ SCIPdispGetStatus()

SCIP_DISPSTATUS SCIPdispGetStatus ( SCIP_DISP * disp)

gets status of display column

Parameters
dispdisplay column

Definition at line 395 of file disp.c.

References assert(), SCIP_Disp::dispstatus, and NULL.

Referenced by SCIP_DECL_DIALOGEXEC().

◆ SCIPdispIsInitialized()

SCIP_Bool SCIPdispIsInitialized ( SCIP_DISP * disp)

is display column initialized?

Parameters
dispdisplay column

Definition at line 405 of file disp.c.

References assert(), SCIP_Disp::initialized, and NULL.

◆ SCIPdispLongint()

void SCIPdispLongint ( SCIP_MESSAGEHDLR * messagehdlr,
FILE * file,
SCIP_Longint val,
int width )

displays a long integer in decimal form fitting in a given width

Parameters
messagehdlrmessage handler
fileoutput stream
valvalue to display
widthwidth to fit into

Definition at line 581 of file disp.c.

References assert(), decpowerchar, i, MAXDECPOWER, SCIP_MAXSTRLEN, SCIPmessageFPrintInfo(), and SCIPsnprintf().

Referenced by runBenders(), SCIP_DECL_DISPOUTPUT(), SCIP_DECL_DISPOUTPUT(), SCIP_DECL_DISPOUTPUT(), SCIP_DECL_DISPOUTPUT(), SCIP_DECL_DISPOUTPUT(), SCIP_DECL_DISPOUTPUT(), SCIP_DECL_DISPOUTPUT(), SCIP_DECL_DISPOUTPUT(), SCIP_DECL_DISPOUTPUT(), SCIP_DECL_DISPOUTPUT(), SCIP_DECL_DISPOUTPUT(), and SCIPdispInt().

◆ SCIPdispInt()

void SCIPdispInt ( SCIP_MESSAGEHDLR * messagehdlr,
FILE * file,
int val,
int width )

◆ SCIPdispTime()

void SCIPdispTime ( SCIP_MESSAGEHDLR * messagehdlr,
FILE * file,
SCIP_Real val,
int width )

displays a time value fitting in a given width

Parameters
messagehdlrmessage handler
fileoutput stream
valvalue in seconds to display
widthwidth to fit into

Definition at line 643 of file disp.c.

References assert(), i, MAXTIMEPOWER, REALABS, SCIP_MAXSTRLEN, SCIPmessageFPrintInfo(), SCIPsnprintf(), timepowerchar, and timepowerval.

Referenced by runBenders(), and SCIP_DECL_DISPOUTPUT().

◆ SCIPincludeDisp()

SCIP_RETCODE SCIPincludeDisp ( SCIP * scip,
const char * name,
const char * desc,
const char * header,
SCIP_DISPSTATUS dispstatus,
SCIP_DECL_DISPCOPY((*dispcopy)) ,
SCIP_DECL_DISPFREE((*dispfree)) ,
SCIP_DECL_DISPINIT((*dispinit)) ,
SCIP_DECL_DISPEXIT((*dispexit)) ,
SCIP_DECL_DISPINITSOL((*dispinitsol)) ,
SCIP_DECL_DISPEXITSOL((*dispexitsol)) ,
SCIP_DECL_DISPOUTPUT((*dispoutput)) ,
SCIP_DISPDATA * dispdata,
int width,
int priority,
int position,
SCIP_Bool stripline )

creates a display column and includes it in SCIP

Parameters
scipSCIP data structure
namename of display column
descdescription of display column
headerhead line of display column
dispstatusdisplay activation status of display column
dispdatadisplay column data
widthwidth of display column (no. of chars used)
prioritypriority of display column
positionrelative position of display column
striplineshould the column be separated with a line from its right neighbor?

Definition at line 55 of file scip_disp.c.

References FALSE, i, NULL, SCIP_CALL, SCIP_INVALIDDATA, SCIP_OKAY, SCIPcheckStage(), SCIPdispCreate(), SCIPerrorMessage, SCIPfindDisp(), SCIPsetIncludeDisp(), and TRUE.

Referenced by includeConshdlrCountsols(), SCIPincludeDispDefault(), SCIPincludeEventHdlrEstim(), SCIPincludeEventHdlrSolvingphase(), and SCIPincludeObjDisp().

◆ SCIPfindDisp()

SCIP_DISP * SCIPfindDisp ( SCIP * scip,
const char * name )

returns the display column of the given name, or NULL if not existing

Parameters
scipSCIP data structure
namename of display column

Definition at line 97 of file scip_disp.c.

References assert(), NULL, and SCIPsetFindDisp().

Referenced by SCIP_DECL_DISPCOPY(), SCIPfindObjDisp(), SCIPincludeDisp(), and SCIPincludeDispDefault().

◆ SCIPgetDisps()

SCIP_DISP ** SCIPgetDisps ( SCIP * scip)

returns the array of currently available display columns

Parameters
scipSCIP data structure

Definition at line 110 of file scip_disp.c.

References assert(), and NULL.

Referenced by SCIP_DECL_DIALOGEXEC(), SCIPincludeDialogDefaultFix(), and SCIPincludeDialogDefaultSet().

◆ SCIPgetNDisps()

int SCIPgetNDisps ( SCIP * scip)

returns the number of currently available display columns

Parameters
scipSCIP data structure

Definition at line 121 of file scip_disp.c.

References assert(), and NULL.

Referenced by SCIP_DECL_DIALOGEXEC(), SCIPincludeDialogDefaultFix(), and SCIPincludeDialogDefaultSet().

◆ SCIPautoselectDisps()

SCIP_RETCODE SCIPautoselectDisps ( SCIP * scip)

automatically selects display columns for being shown w.r.t. the display width parameter

Parameters
scipSCIP data structure

Definition at line 132 of file scip_disp.c.

References assert(), NULL, SCIP_CALL, SCIP_OKAY, and SCIPdispAutoActivate().

Referenced by SCIP_DECL_PARAMCHGD(), SCIP_DECL_PARAMCHGD(), and SCIPsyncstoreInit().

◆ SCIPchgDispMode()

void SCIPchgDispMode ( SCIP_DISP * disp,
SCIP_DISPMODE mode )

changes the display column mode

Parameters
dispdisplay column
modethe display column mode

Definition at line 145 of file scip_disp.c.

References assert(), NULL, and SCIPdispChgMode().

Referenced by SCIPincludeDispDefault().