params_visu.h File Reference
#include "type_decomp.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 SCIPincludeParamsVisu (SCIP *scip)
 
SCIP_Bool SCIPvisuGetDraftmode (void)
 
void SCIPvisuSetDraftmode (SCIP_Bool setmode)
 
VISU_COLORSCHEME SCIPvisuGetColorscheme (void)
 
void SCIPvisuSetColorscheme (VISU_COLORSCHEME newscheme)
 
void SCIPvisuSetColorManMasterconss (char *newcolor)
 
void SCIPvisuSetColorManMastervars (char *newcolor)
 
void SCIPvisuSetColorManLinking (char *newcolor)
 
void SCIPvisuSetColorManStairlinking (char *newcolor)
 
void SCIPvisuSetColorManBlock (char *newcolor)
 
void SCIPvisuSetColorManOpen (char *newcolor)
 
void SCIPvisuSetColorManNonzero (char *newcolor)
 
void SCIPvisuSetColorManLine (char *newcolor)
 
char * SCIPvisuGetColorMasterconss (void)
 
char * SCIPvisuGetColorMastervars (void)
 
char * SCIPvisuGetColorLinking (void)
 
char * SCIPvisuGetColorStairlinking (void)
 
char * SCIPvisuGetColorBlock (void)
 
char * SCIPvisuGetColorOpen (void)
 
char * SCIPvisuGetColorNonzero (void)
 
char * SCIPvisuGetColorLine (void)
 
float SCIPvisuGetNonzeroRadius (int maxindx, int maxindy, float scalingfactor)
 
SCIP_Bool GCGgetUseGp (void)
 
char * GCGVisuGetPdfReader (void)
 
int GCGreportGetMaxNDecomps (void)
 
DEC_DECTYPE GCGreportGetDecompTypeToShow (void)
 
SCIP_Bool GCGreportGetShowTitlepage (void)
 
SCIP_Bool GCGreportGetShowToc (void)
 
SCIP_Bool GCGreportGetShowStatistics (void)
 
int GCGfamtreeGetMaxNDecomps (void)
 
void GCGVisuFreeParams (SCIP *scip)
 

Typedef Documentation

visualization colorscheme type

Definition at line 56 of file params_visu.h.

Enumeration Type Documentation

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 49 of file params_visu.h.

Function Documentation

int GCGfamtreeGetMaxNDecomps ( void  )

gets the max number of finished decomps to be included in family tree

Definition at line 582 of file params_visu.c.

Referenced by writeFamilyTree().

SCIP_Bool GCGgetUseGp ( void  )

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

Definition at line 533 of file params_visu.c.

Referenced by reportAllDecompositions(), SCIPvisuGetNonzeroRadius(), and writeTexHeader().

DEC_DECTYPE GCGreportGetDecompTypeToShow ( void  )

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

Definition at line 554 of file params_visu.c.

Referenced by reportAllDecompositions().

int GCGreportGetMaxNDecomps ( void  )

gets the max number of decomps to be included in reports

Definition at line 547 of file params_visu.c.

Referenced by GCGwriteTexReport(), and reportAllDecompositions().

SCIP_Bool GCGreportGetShowStatistics ( void  )

gets whether statistics should be included for each decomp in reports

Definition at line 575 of file params_visu.c.

Referenced by reportAllDecompositions().

SCIP_Bool GCGreportGetShowTitlepage ( void  )

gets whether a titlepage should be included in reports

Definition at line 561 of file params_visu.c.

Referenced by reportAllDecompositions().

SCIP_Bool GCGreportGetShowToc ( void  )

gets whether a table of contents should be included in reports

Definition at line 568 of file params_visu.c.

Referenced by reportAllDecompositions().

void GCGVisuFreeParams ( SCIP *  scip)

frees all visualization parameters

Parameters
scipSCIP data structure

Definition at line 589 of file params_visu.c.

Referenced by SCIP_DECL_READERFREE().

char* GCGVisuGetPdfReader ( void  )

gets the name of the pdf reader that should be used

Definition at line 540 of file params_visu.c.

Referenced by gcg::Seeed::showVisualisation().

SCIP_RETCODE SCIPincludeParamsVisu ( SCIP *  scip)

includes the visualization parameters into GCG

Parameters
scipSCIP data structure

Definition at line 144 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_FAMTREE_MAXNDECOMPS, DEFAULT_PDFREADER, DEFAULT_REPORT_MAXNDECOMPS, DEFAULT_REPORT_SHOWSTATISTICS, DEFAULT_REPORT_SHOWTITLEPAGE, DEFAULT_REPORT_SHOWTOC, DEFAULT_REPORT_SHOWTYPE, DEFAULT_VISU_COLORSCHEME, DEFAULT_VISU_DRAFTMODE, DEFAULT_VISU_RADIUS, DEFAULT_VISU_USEGP, GCG_VisualizationData::fam_maxndecomps, GREY_COLOR_BLOCK, GREY_COLOR_LINE, GREY_COLOR_LINKING, GREY_COLOR_MASTERCONS, GREY_COLOR_MASTERVARS, GREY_COLOR_NONZERO, GREY_COLOR_OPEN, GREY_COLOR_STAIRLINKING, GCG_VisualizationData::greycolorblock, GCG_VisualizationData::greycolorline, GCG_VisualizationData::greycolorlinking, GCG_VisualizationData::greycolormasterconss, GCG_VisualizationData::greycolormastervars, GCG_VisualizationData::greycolornonzero, GCG_VisualizationData::greycoloropen, GCG_VisualizationData::greycolorstairlinking, GCG_VisualizationData::mancolorblock, GCG_VisualizationData::mancolorline, GCG_VisualizationData::mancolorlinking, GCG_VisualizationData::mancolormasterconss, GCG_VisualizationData::mancolormastervars, GCG_VisualizationData::mancolornonzero, GCG_VisualizationData::mancoloropen, GCG_VisualizationData::mancolorstairlinking, GCG_VisualizationData::nmaxdecompstowrite, GCG_VisualizationData::pdfreader, GCG_VisualizationData::rep_maxndecomps, GCG_VisualizationData::rep_showtitle, GCG_VisualizationData::rep_showtoc, GCG_VisualizationData::rep_showtype, GCG_VisualizationData::rep_statistics, SCIPvisuGetDraftmode(), GCG_VisualizationData::visucolorscheme, GCG_VisualizationData::visudraftmode, GCG_VisualizationData::visuradius, and GCG_VisualizationData::visuusegp.

Referenced by SCIPincludeGcgPlugins().

char* SCIPvisuGetColorBlock ( void  )
char* SCIPvisuGetColorLine ( void  )
char* SCIPvisuGetColorLinking ( void  )
char* SCIPvisuGetColorMasterconss ( void  )
char* SCIPvisuGetColorMastervars ( void  )
char* SCIPvisuGetColorNonzero ( void  )
char* SCIPvisuGetColorOpen ( void  )
VISU_COLORSCHEME SCIPvisuGetColorscheme ( void  )

gets the colorscheme for visualizations

Definition at line 289 of file params_visu.c.

Referenced by SCIPvisuSetDraftmode().

char* SCIPvisuGetColorStairlinking ( void  )
SCIP_Bool SCIPvisuGetDraftmode ( void  )

gets if draftmode is on draftmode lets visualizations omit nonzeros

Definition at line 272 of file params_visu.c.

Referenced by SCIPincludeParamsVisu(), writeFamilyTree(), writeGpSeeed(), and writeTexSeeed().

float SCIPvisuGetNonzeroRadius ( int  maxindx,
int  maxindy,
float  scalingfactor 
)

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

gets appropriate radius for nonzeros needs highest indices of both axes

Parameters
maxindxhighest index x-axis
maxindyhighest index y-axis
scalingfactorpercentage to scale radius, 1 if no scaling

Definition at line 506 of file params_visu.c.

References GCGgetUseGp(), and GCG_VisualizationData::visuradius.

Referenced by SCIPvisuSetColorManLine(), writeGpSeeed(), and writeTexSeeed().

void SCIPvisuSetColorManBlock ( char *  newcolor)

sets manual color for normal decomp blocks in current color scheme

Parameters
newcolornew color

Definition at line 469 of file params_visu.c.

References GCG_VisualizationData::mancolorblock, and SCIPvisuSetColorManOpen().

Referenced by SCIPvisuSetColorManStairlinking().

void SCIPvisuSetColorManLine ( char *  newcolor)

sets manual color for lines in current color scheme

Parameters
newcolornew color

Definition at line 496 of file params_visu.c.

References GCG_VisualizationData::mancolorline, and SCIPvisuGetNonzeroRadius().

Referenced by SCIPvisuSetColorManNonzero().

void SCIPvisuSetColorManLinking ( char *  newcolor)

sets manual color for linking blocks in current color scheme

Parameters
newcolornew color

Definition at line 451 of file params_visu.c.

References GCG_VisualizationData::mancolorlinking, and SCIPvisuSetColorManStairlinking().

Referenced by SCIPvisuSetColorManMastervars().

void SCIPvisuSetColorManMasterconss ( char *  newcolor)

sets color for mastercon block in current color scheme

Parameters
newcolornew color

Definition at line 433 of file params_visu.c.

References GCG_VisualizationData::mancolormasterconss, and SCIPvisuSetColorManMastervars().

Referenced by SCIPvisuGetColorLine().

void SCIPvisuSetColorManMastervars ( char *  newcolor)

sets manual color for mastervar block in current color scheme

Parameters
newcolornew color

Definition at line 442 of file params_visu.c.

References GCG_VisualizationData::mancolormastervars, and SCIPvisuSetColorManLinking().

Referenced by SCIPvisuSetColorManMasterconss().

void SCIPvisuSetColorManNonzero ( char *  newcolor)

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

Parameters
newcolornew color

Definition at line 487 of file params_visu.c.

References GCG_VisualizationData::mancolornonzero, and SCIPvisuSetColorManLine().

Referenced by SCIPvisuSetColorManOpen().

void SCIPvisuSetColorManOpen ( char *  newcolor)

sets manual color for open blocks in current color scheme

Parameters
newcolornew color

Definition at line 478 of file params_visu.c.

References GCG_VisualizationData::mancoloropen, and SCIPvisuSetColorManNonzero().

Referenced by SCIPvisuSetColorManBlock().

void SCIPvisuSetColorManStairlinking ( char *  newcolor)

sets manual color for stairlinking blocks in current color scheme

Parameters
newcolornew color

Definition at line 460 of file params_visu.c.

References GCG_VisualizationData::mancolorstairlinking, and SCIPvisuSetColorManBlock().

Referenced by SCIPvisuSetColorManLinking().

void SCIPvisuSetColorscheme ( VISU_COLORSCHEME  newscheme)

sets colorscheme for visualizations

Parameters
newschemenew colorscheme

Definition at line 296 of file params_visu.c.

References SCIPvisuGetColorMasterconss(), and GCG_VisualizationData::visucolorscheme.

void SCIPvisuSetDraftmode ( SCIP_Bool  setmode)

sets draftmode draftmode lets visualizations omit nonzeros

Parameters
setmodetrue iff draftmode should be on

Definition at line 280 of file params_visu.c.

References SCIPvisuGetColorscheme(), and GCG_VisualizationData::visudraftmode.