pub_disp.h File Reference

Detailed Description

public methods for displaying runtime statistics

Author

Tobias Achterberg

Definition in file pub_disp.h.

#include <stdio.h>
#include "scip/def.h"
#include "scip/type_retcode.h"
#include "scip/type_disp.h"

Go to the source code of this file.

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)

Function Documentation

SCIP_DISPDATA* SCIPdispGetData

(

SCIP_DISP *

disp

)

gets user data of display column

Parameters

disp	display column

Definition at line 261 of file disp.c.

References 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_DISPOUTPUT(), SCIPfindObjDisp(), and SCIPgetObjDisp().

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 271 of file disp.c.

References SCIP_Disp::dispdata, and NULL.

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

const char* SCIPdispGetName

(

SCIP_DISP *

disp

)

gets name of display column

Parameters

disp	display column

Definition at line 282 of file disp.c.

References SCIP_Disp::name, and NULL.

Referenced by SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DISPINITSOL(), SCIP_DECL_DISPOUTPUT(), SCIPdispCopyInclude(), SCIPincludeDialogDefaultFix(), SCIPincludeDialogDefaultSet(), and SCIPsetFindDisp().

const char* SCIPdispGetDesc

(

SCIP_DISP *

disp

)

gets description of display column

Parameters

disp	display column

Definition at line 292 of file disp.c.

References SCIP_Disp::desc, and NULL.

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

const char* SCIPdispGetHeader

(

SCIP_DISP *

disp

)

gets head line of display column

Parameters

disp	display column

Definition at line 302 of file disp.c.

References SCIP_Disp::header, and NULL.

Referenced by SCIP_DECL_DIALOGEXEC().

int SCIPdispGetWidth

(

SCIP_DISP *

disp

)

gets width of display column

Parameters

disp	display column

Definition at line 312 of file disp.c.

References NULL, and SCIP_Disp::width.

Referenced by SCIP_DECL_DIALOGEXEC().

int SCIPdispGetPriority

(

SCIP_DISP *

disp

)

gets priority of display column

Parameters

disp	display column

Definition at line 322 of file disp.c.

References NULL, and SCIP_Disp::priority.

Referenced by SCIP_DECL_DIALOGEXEC().

int SCIPdispGetPosition

(

SCIP_DISP *

disp

)

gets position of display column

Parameters

disp	display column

Definition at line 332 of file disp.c.

References NULL, and SCIP_Disp::position.

Referenced by SCIP_DECL_DIALOGEXEC(), and SCIPsetIncludeDisp().

SCIP_DISPSTATUS SCIPdispGetStatus

(

SCIP_DISP *

disp

)

gets status of display column

Parameters

disp	display column

Definition at line 342 of file disp.c.

References SCIP_Disp::dispstatus, and NULL.

Referenced by SCIP_DECL_DIALOGEXEC().

SCIP_Bool SCIPdispIsInitialized

(

SCIP_DISP *

disp

)

is display column initialized?

Parameters

disp	display column

Definition at line 352 of file disp.c.

References SCIP_Disp::initialized, and NULL.

Referenced by SCIPsetIncludeDisp().

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 509 of file disp.c.

References MAXDECPOWER, SCIP_Longint, SCIP_MAXSTRLEN, SCIPmessageFPrintInfo(), and SCIPsnprintf().

Referenced by SCIP_DECL_DISPOUTPUT(), and 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 555 of file disp.c.

References SCIP_Longint, and SCIPdispLongint().

Referenced by SCIP_DECL_DISPOUTPUT().

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 572 of file disp.c.

References MAXTIMEPOWER, REALABS, SCIP_Longint, SCIP_MAXSTRLEN, SCIPmessageFPrintInfo(), and SCIPsnprintf().

Referenced by SCIP_DECL_DISPOUTPUT().