params_visu.h File Reference

#include "type_decomp.h"
#include "type_parameter.h"
#include "scip/scip.h"

Go to the source code of this file.

Typedefs
typedef enum Colorscheme	VISU_COLORSCHEME

Enumerations
enum	Colorscheme {   COLORSCHEME_DEFAULT = 0,   COLORSCHEME_GREY = 1,   COLORSCHEME_MANUAL = 2 }

Functions
SCIP_RETCODE	SCIPcreateParamsVisu (SCIP *scip, GCG_PARAMDATA **paramdata)
SCIP_Bool	SCIPvisuGetDraftmode (SCIP *scip)
void	SCIPvisuSetDraftmode (SCIP *scip, SCIP_Bool setmode)
VISU_COLORSCHEME	SCIPvisuGetColorscheme (SCIP *scip)
void	SCIPvisuSetColorscheme (SCIP *scip, VISU_COLORSCHEME newscheme)
void	SCIPvisuSetColorManMasterconss (SCIP *scip, const char *newcolor)
void	SCIPvisuSetColorManMastervars (SCIP *scip, const char *newcolor)
void	SCIPvisuSetColorManLinking (SCIP *scip, const char *newcolor)
void	SCIPvisuSetColorManStairlinking (SCIP *scip, const char *newcolor)
void	SCIPvisuSetColorManBlock (SCIP *scip, const char *newcolor)
void	SCIPvisuSetColorManOpen (SCIP *scip, const char *newcolor)
void	SCIPvisuSetColorManNonzero (SCIP *scip, const char *newcolor)
void	SCIPvisuSetColorManLine (SCIP *scip, const char *newcolor)
const char *	SCIPvisuGetColorMasterconss (SCIP *scip)
const char *	SCIPvisuGetColorMastervars (SCIP *scip)
const char *	SCIPvisuGetColorLinking (SCIP *scip)
const char *	SCIPvisuGetColorStairlinking (SCIP *scip)
const char *	SCIPvisuGetColorBlock (SCIP *scip)
const char *	SCIPvisuGetColorOpen (SCIP *scip)
const char *	SCIPvisuGetColorNonzero (SCIP *scip)
const char *	SCIPvisuGetColorLine (SCIP *scip)
float	SCIPvisuGetNonzeroRadius (SCIP *scip, int maxindx, int maxindy, float scalingfactor)
SCIP_Bool	GCGgetUseGp (SCIP *scip)
const char *	GCGVisuGetPdfReader (SCIP *scip)
int	GCGreportGetMaxNDecomps (SCIP *scip)
DEC_DECTYPE	GCGreportGetDecompTypeToShow (SCIP *scip)
SCIP_Bool	GCGreportGetShowTitlepage (SCIP *scip)
SCIP_Bool	GCGreportGetShowToc (SCIP *scip)
SCIP_Bool	GCGreportGetShowStatistics (SCIP *scip)
void	GCGVisuFreeParams (SCIP *scip, GCG_PARAMDATA *paramdata)

Typedef Documentation

VISU_COLORSCHEME

typedef enum Colorscheme VISU_COLORSCHEME

visualization colorscheme type

Definition at line 58 of file params_visu.h.

Enumeration Type Documentation

Colorscheme

enum Colorscheme

Colorscheme selection for the visualizations

Enumerator
COLORSCHEME_DEFAULT	default colors (supposedly eye-friendly)
COLORSCHEME_GREY	on a range from black to white
COLORSCHEME_MANUAL	take user-defined input

Definition at line 51 of file params_visu.h.

Function Documentation

SCIPcreateParamsVisu()

SCIP_RETCODE SCIPcreateParamsVisu	(	SCIP *	scip,
		GCG_PARAMDATA **	paramdata
	)

includes the visualization parameters into GCG

Returns

SCIP return code

includes the visualization parameters into GCG & initializes them

Definition at line 716 of file params_visu.c.

References DEFAULT_COLOR_BLOCK, DEFAULT_COLOR_LINE, DEFAULT_COLOR_LINKING, DEFAULT_COLOR_MASTERCONSS, DEFAULT_COLOR_MASTERVARS, DEFAULT_COLOR_NONZERO, DEFAULT_COLOR_OPEN, DEFAULT_COLOR_STAIRLINKING, DEFAULT_PDFREADER, DEFAULT_REPORT_MAXNDECOMPS, DEFAULT_REPORT_SHOWSTATISTICS, DEFAULT_REPORT_SHOWTITLEPAGE, DEFAULT_REPORT_SHOWTOC, DEFAULT_VISU_COLORSCHEME, DEFAULT_VISU_DRAFTMODE, DEFAULT_VISU_RADIUS, DEFAULT_VISU_USEGP, GREY_COLOR_BLOCK, GREY_COLOR_LINE, GREY_COLOR_LINKING, GREY_COLOR_MASTERCONS, GREY_COLOR_MASTERVARS, GREY_COLOR_NONZERO, GREY_COLOR_OPEN, and GREY_COLOR_STAIRLINKING.

Referenced by SCIPincludeRelaxGcg().

SCIPvisuGetDraftmode()

SCIP_Bool SCIPvisuGetDraftmode

(

SCIP *

scip

)

gets whether draftmode is on draftmode lets visualizations omit nonzeros

Returns

true if draftmode is on

Parameters

scip	SCIP data structure

Definition at line 155 of file params_visu.c.

References GCGgetParamsVisu(), and GCG_ParamData::visudraftmode.

Referenced by writeGpPartialdec(), and writeTexPartialdec().

SCIPvisuSetDraftmode()

void SCIPvisuSetDraftmode	(	SCIP *	scip,
		SCIP_Bool	setmode
	)

sets draftmode draftmode lets visualizations omit nonzeros

Returns

nothing

Parameters

scip	SCIP data structure
setmode	true iff draftmode should be on

Definition at line 172 of file params_visu.c.

References GCGgetParamsVisu(), and GCG_ParamData::visudraftmode.

SCIPvisuGetColorscheme()

VISU_COLORSCHEME SCIPvisuGetColorscheme

(

SCIP *

scip

)

gets the colorscheme for visualizations

Returns

current colorscheme

Definition at line 187 of file params_visu.c.

References GCGgetParamsVisu(), and GCG_ParamData::visucolorscheme.

Referenced by SCIPvisuGetColorBlock(), SCIPvisuGetColorLine(), SCIPvisuGetColorLinking(), SCIPvisuGetColorMasterconss(), SCIPvisuGetColorMastervars(), SCIPvisuGetColorNonzero(), SCIPvisuGetColorOpen(), and SCIPvisuGetColorStairlinking().

SCIPvisuSetColorscheme()

void SCIPvisuSetColorscheme	(	SCIP *	scip,
		VISU_COLORSCHEME	newscheme
	)

sets colorscheme for visualizations

Returns

nothing

Parameters

scip	SCIP data structure
newscheme	new colorscheme

Definition at line 203 of file params_visu.c.

References GCGgetParamsVisu(), and GCG_ParamData::visucolorscheme.

SCIPvisuSetColorManMasterconss()

void SCIPvisuSetColorManMasterconss	(	SCIP *	scip,
		const char *	newcolor
	)

sets color for mastercons block in current color scheme

Returns

nothing

Parameters

scip	SCIP data structure
newcolor	new color

Definition at line 434 of file params_visu.c.

References GCGgetParamsVisu(), and GCG_ParamData::mancolormasterconss.

SCIPvisuSetColorManMastervars()

void SCIPvisuSetColorManMastervars	(	SCIP *	scip,
		const char *	newcolor
	)

sets manual color for mastervar block in current color scheme

Returns

nothing

Parameters

scip	SCIP data structure
newcolor	new color

Definition at line 449 of file params_visu.c.

References GCGgetParamsVisu(), and GCG_ParamData::mancolormastervars.

SCIPvisuSetColorManLinking()

void SCIPvisuSetColorManLinking	(	SCIP *	scip,
		const char *	newcolor
	)

sets manual color for linking blocks in current color scheme

Returns

nothing

Parameters

scip	SCIP data structure
newcolor	new color

Definition at line 464 of file params_visu.c.

References GCGgetParamsVisu(), and GCG_ParamData::mancolorlinking.

SCIPvisuSetColorManStairlinking()

void SCIPvisuSetColorManStairlinking	(	SCIP *	scip,
		const char *	newcolor
	)

sets manual color for stairlinking blocks in current color scheme

Returns

nothing

Parameters

scip	SCIP data structure
newcolor	new color

Definition at line 479 of file params_visu.c.

References GCGgetParamsVisu(), and GCG_ParamData::mancolorstairlinking.

SCIPvisuSetColorManBlock()

void SCIPvisuSetColorManBlock	(	SCIP *	scip,
		const char *	newcolor
	)

sets manual color for normal decomp blocks in current color scheme

Returns

nothing

Parameters

scip	SCIP data structure
newcolor	new color

Definition at line 494 of file params_visu.c.

References GCGgetParamsVisu(), and GCG_ParamData::mancolorblock.

SCIPvisuSetColorManOpen()

void SCIPvisuSetColorManOpen	(	SCIP *	scip,
		const char *	newcolor
	)

sets manual color for open blocks in current color scheme

Returns

nothing

Parameters

scip	SCIP data structure
newcolor	new color

Definition at line 509 of file params_visu.c.

References GCGgetParamsVisu(), and GCG_ParamData::mancoloropen.

SCIPvisuSetColorManNonzero()

void SCIPvisuSetColorManNonzero	(	SCIP *	scip,
		const char *	newcolor
	)

sets manual color for non-zero points in current color scheme

Returns

nothing

Parameters

scip	SCIP data structure
newcolor	new color

Definition at line 523 of file params_visu.c.

References GCGgetParamsVisu(), and GCG_ParamData::mancolornonzero.

SCIPvisuSetColorManLine()

void SCIPvisuSetColorManLine	(	SCIP *	scip,
		const char *	newcolor
	)

sets manual color for lines in current color scheme

Returns

nothing

Parameters

scip	SCIP data structure
newcolor	new color

Definition at line 538 of file params_visu.c.

References GCGgetParamsVisu(), and GCG_ParamData::mancolorline.

SCIPvisuGetColorMasterconss()

const char* SCIPvisuGetColorMasterconss

(

SCIP *

scip

)

gets color for mastercons block in current color scheme

Returns

mastercons color

Parameters

scip	SCIP data structure

Definition at line 219 of file params_visu.c.

References COLORSCHEME_GREY, COLORSCHEME_MANUAL, DEFAULT_COLOR_MASTERCONSS, GCGgetParamsVisu(), GCG_ParamData::greycolormasterconss, GCG_ParamData::mancolormasterconss, and SCIPvisuGetColorscheme().

Referenced by writeGpPartialdec(), and writeTexHeader().

SCIPvisuGetColorMastervars()

const char* SCIPvisuGetColorMastervars

(

SCIP *

scip

)

gets color for mastervar block in current color scheme

Returns

mastervar color

Parameters

scip	SCIP data structure

Definition at line 246 of file params_visu.c.

References COLORSCHEME_GREY, COLORSCHEME_MANUAL, DEFAULT_COLOR_MASTERVARS, GCGgetParamsVisu(), GCG_ParamData::greycolormastervars, GCG_ParamData::mancolormastervars, and SCIPvisuGetColorscheme().

Referenced by writeTexHeader().

SCIPvisuGetColorLinking()

const char* SCIPvisuGetColorLinking

(

SCIP *

scip

)

gets color for linking blocks in current color scheme

Returns

linking color

Parameters

scip	SCIP data structure

Definition at line 273 of file params_visu.c.

References COLORSCHEME_GREY, COLORSCHEME_MANUAL, DEFAULT_COLOR_LINKING, GCGgetParamsVisu(), GCG_ParamData::greycolorlinking, GCG_ParamData::mancolorlinking, and SCIPvisuGetColorscheme().

Referenced by writeGpPartialdec(), and writeTexHeader().

SCIPvisuGetColorStairlinking()

const char* SCIPvisuGetColorStairlinking

(

SCIP *

scip

)

gets color for stairlinking blocks in current color scheme

Returns

stairlinking color

Parameters

scip	SCIP data structure

Definition at line 300 of file params_visu.c.

References COLORSCHEME_GREY, COLORSCHEME_MANUAL, DEFAULT_COLOR_STAIRLINKING, GCGgetParamsVisu(), GCG_ParamData::greycolorstairlinking, GCG_ParamData::mancolorstairlinking, and SCIPvisuGetColorscheme().

Referenced by writeGpPartialdec(), and writeTexHeader().

SCIPvisuGetColorBlock()

const char* SCIPvisuGetColorBlock

(

SCIP *

scip

)

gets color for normal decomp blocks in current color scheme

Returns

block color

Parameters

scip	SCIP data structure

Definition at line 327 of file params_visu.c.

References COLORSCHEME_GREY, COLORSCHEME_MANUAL, DEFAULT_COLOR_BLOCK, GCGgetParamsVisu(), GCG_ParamData::greycolorblock, GCG_ParamData::mancolorblock, and SCIPvisuGetColorscheme().

Referenced by writeGpPartialdec(), and writeTexHeader().

SCIPvisuGetColorOpen()

const char* SCIPvisuGetColorOpen

(

SCIP *

scip

)

gets color for open blocks in current color scheme

Returns

open color

Parameters

scip	SCIP data structure

Definition at line 354 of file params_visu.c.

References COLORSCHEME_GREY, COLORSCHEME_MANUAL, DEFAULT_COLOR_OPEN, GCGgetParamsVisu(), GCG_ParamData::greycoloropen, GCG_ParamData::mancoloropen, and SCIPvisuGetColorscheme().

Referenced by writeGpPartialdec(), and writeTexHeader().

SCIPvisuGetColorNonzero()

const char* SCIPvisuGetColorNonzero

(

SCIP *

scip

)

gets color for non-zero points in current color scheme

Returns

non-zero color

Parameters

scip	SCIP data structure

Definition at line 381 of file params_visu.c.

References COLORSCHEME_GREY, COLORSCHEME_MANUAL, DEFAULT_COLOR_NONZERO, GCGgetParamsVisu(), GCG_ParamData::greycolornonzero, GCG_ParamData::mancolornonzero, and SCIPvisuGetColorscheme().

Referenced by writeGpNonzeros(), and writeTexHeader().

SCIPvisuGetColorLine()

const char* SCIPvisuGetColorLine

(

SCIP *

scip

)

gets color for lines in current color scheme

Returns

line color

Parameters

scip	SCIP data structure

Definition at line 408 of file params_visu.c.

References COLORSCHEME_GREY, COLORSCHEME_MANUAL, DEFAULT_COLOR_LINE, GCGgetParamsVisu(), GCG_ParamData::greycolorline, GCG_ParamData::mancolorline, and SCIPvisuGetColorscheme().

Referenced by drawGpBox(), and writeTexHeader().

SCIPvisuGetNonzeroRadius()

float SCIPvisuGetNonzeroRadius	(	SCIP *	scip,
		int	maxindx,
		int	maxindy,
		float	scalingfactor
	)

gets appropriate radius for nonzeros needs highest indices of both axes for scaling

Returns

radius

Parameters

scip	SCIP data structure
maxindx	highest index x-axis
maxindy	highest index y-axis
scalingfactor	percentage to scale radius, 1 if no scaling

Definition at line 554 of file params_visu.c.

References GCGgetParamsVisu(), and GCG_ParamData::visuradius.

Referenced by writeGpPartialdec(), and writeTexPartialdec().

GCGgetUseGp()

SCIP_Bool GCGgetUseGp

(

SCIP *

scip

)

if true gp reader should be used for sub-visualizations, otherwise tex reader

Returns

true if gp reader should be used, false if tex reader should be used

Parameters

scip	SCIP data structure

Definition at line 592 of file params_visu.c.

References GCGgetParamsVisu(), and GCG_ParamData::visuusegp.

Referenced by reportAllDecompositions(), and writeTexHeader().

GCGVisuGetPdfReader()

const char* GCGVisuGetPdfReader

(

SCIP *

scip

)

gets the name of the pdf reader that should be used

Returns

name of pdf reader

Parameters

scip	SCIP data structure

Definition at line 609 of file params_visu.c.

References GCGgetParamsVisu(), and GCG_ParamData::pdfreader.

Referenced by gcg::PARTIALDECOMP::showVisualization().

GCGreportGetMaxNDecomps()

int GCGreportGetMaxNDecomps

(

SCIP *

scip

)

gets the max number of decomps to be included in reports

Returns

max number of decomps

Parameters

scip	SCIP data structure

Definition at line 626 of file params_visu.c.

References GCGgetParamsVisu(), and GCG_ParamData::rep_maxndecomps.

Referenced by GCGwriteTexReport().

GCGreportGetDecompTypeToShow()

DEC_DECTYPE GCGreportGetDecompTypeToShow

(

SCIP *

scip

)

gets what type of decomps to show in reports (where 0 corresponds to 'show all')

Returns

type of decomps

Parameters

scip	SCIP data structure

GCGreportGetShowTitlepage()

SCIP_Bool GCGreportGetShowTitlepage

(

SCIP *

scip

)

gets whether a titlepage should be included in reports

Returns

true iff title page should be generated

Parameters

scip	SCIP data structure

Definition at line 643 of file params_visu.c.

References GCGgetParamsVisu(), and GCG_ParamData::rep_showtitle.

Referenced by reportAllDecompositions().

GCGreportGetShowToc()

SCIP_Bool GCGreportGetShowToc

(

SCIP *

scip

)

gets whether a table of contents should be included in reports

Returns

true iff table of contents should be generated

Parameters

scip	SCIP data structure

Definition at line 660 of file params_visu.c.

References GCGgetParamsVisu(), and GCG_ParamData::rep_showtoc.

Referenced by reportAllDecompositions().

GCGreportGetShowStatistics()

SCIP_Bool GCGreportGetShowStatistics

(

SCIP *

scip

)

gets whether statistics should be included for each decomp in reports

Returns

true iff statistics for each decomp should be generated

Parameters

scip	SCIP data structure

Definition at line 677 of file params_visu.c.

References GCGgetParamsVisu(), and GCG_ParamData::rep_statistics.

Referenced by reportAllDecompositions().

GCGVisuFreeParams()

void GCGVisuFreeParams	(	SCIP *	scip,
		GCG_PARAMDATA *	paramdata
	)

frees all visualization parameters

Returns

nothing

Parameters

scip	SCIP data structure
paramdata	input empty paramdata, oputput new set of param data

Definition at line 695 of file params_visu.c.

References GCG_ParamData::greycolorblock, GCG_ParamData::greycolorline, GCG_ParamData::greycolorlinking, GCG_ParamData::greycolormasterconss, GCG_ParamData::greycolormastervars, GCG_ParamData::greycolornonzero, GCG_ParamData::greycoloropen, and GCG_ParamData::greycolorstairlinking.

Referenced by SCIP_DECL_RELAXFREE().