Displays

Detailed Description

functions for the inclusion and access of display plugins

Functions
SCIP_DISPDATA *	SCIPdispGetData (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_DISP *	SCIPfindDisp (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()

SCIP_DISPDATA * SCIPdispGetData

(

SCIP_DISP *

disp

)

gets user data of display column

Parameters

disp	display column

Definition at line 314 of file disp.c.

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

Referenced by SCIP_DECL_DISPCOPY(), SCIP_DECL_DISPEXIT(), SCIP_DECL_DISPEXITSOL(), SCIP_DECL_DISPFREE(), SCIP_DECL_DISPINIT(), SCIP_DECL_DISPINITSOL(), SCIP_DECL_DISPINITSOL(), SCIP_DECL_DISPOUTPUT(), SCIP_DECL_DISPOUTPUT(), SCIP_DECL_DISPOUTPUT(), SCIP_DECL_DISPOUTPUT(), SCIPfindObjDisp(), and SCIPgetObjDisp().

SCIPdispSetData()

void SCIPdispSetData	(	SCIP_DISP *	disp,
		SCIP_DISPDATA *	dispdata )

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

Parameters

disp	display column
dispdata	new 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

)

gets name of display column

Parameters

disp	display column

Definition at line 335 of file disp.c.

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

Referenced by SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DISPCOPY(), SCIP_DECL_DISPINITSOL(), SCIP_DECL_DISPINITSOL(), SCIP_DECL_DISPINITSOL(), 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(), 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(), 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(), 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(), SCIP_DECL_DISPOUTPUT(), SCIP_DECL_DISPOUTPUT(), SCIPdispCopyInclude(), SCIPincludeDialogDefaultFix(), and SCIPincludeDialogDefaultSet().

SCIPdispGetDesc()

const char * SCIPdispGetDesc

(

SCIP_DISP *

disp

)

gets description of display column

Parameters

disp	display 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

disp	display 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

disp	display 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

disp	display 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

disp	display 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

disp	display 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

disp	display column

Definition at line 405 of file disp.c.

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

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

messagehdlr	message handler
file	output stream
val	value to display
width	width to fit into

Definition at line 581 of file disp.c.

References ABS, assert(), decpowerchar, i, MAXDECPOWER, SCIP_Longint, SCIP_LONGINT_FORMAT, 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 )

displays an integer in decimal form fitting in a given width

Parameters

messagehdlr	message handler
file	output stream
val	value to display
width	width to fit into

Definition at line 627 of file disp.c.

References SCIP_Longint, and SCIPdispLongint().

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(), SCIP_DECL_DISPOUTPUT(), SCIP_DECL_DISPOUTPUT(), SCIP_DECL_DISPOUTPUT(), SCIP_DECL_DISPOUTPUT(), and SCIP_DECL_DISPOUTPUT().

SCIPdispTime()

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

displays a time value fitting in a given width

Parameters

messagehdlr	message handler
file	output stream
val	value in seconds to display
width	width to fit into

Definition at line 643 of file disp.c.

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

Referenced by runBenders(), SCIP_DECL_CONCSOLVEREXEC(), 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

scip	SCIP data structure
name	name of display column
desc	description of display column
header	head line of display column
dispstatus	display activation status of display column
-	copy method of display column or NULL if you don't want to copy your plugin into sub-SCIPs
-	destructor of display column
-	initialize display column
-	deinitialize display column
-	solving process initialization method of display column
-	solving process deinitialization method of display column
-	output method
dispdata	display column data
width	width of display column (no. of chars used)
priority	priority of display column
position	relative position of display column
stripline	should the column be separated with a line from its right neighbor?

Definition at line 55 of file scip_disp.c.

References FALSE, NULL, SCIP_Bool, SCIP_CALL, SCIP_DECL_DISPCOPY, SCIP_DECL_DISPEXIT, SCIP_DECL_DISPEXITSOL, SCIP_DECL_DISPFREE, SCIP_DECL_DISPINIT, SCIP_DECL_DISPINITSOL, SCIP_DECL_DISPOUTPUT, 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

scip	SCIP data structure
name	name 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

scip	SCIP 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

scip	SCIP 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

scip	SCIP 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

disp	display column
mode	the display column mode

Definition at line 145 of file scip_disp.c.

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

Referenced by SCIPincludeDispDefault().