reader_gp.h File Reference

Detailed Description

GP file reader writing decompositions to gnuplot files.

Author

Martin Bergner

Hanna Franzen

This reader can write visualizations of partialdecs to a .gp file.

Definition in file reader_gp.h.

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

Go to the source code of this file.

Typedefs
typedef enum GPOutputFormat	GP_OUTPUT_FORMAT

Enumerations
enum	GPOutputFormat {   GP_OUTPUT_FORMAT_PDF,   GP_OUTPUT_FORMAT_PNG,   GP_OUTPUT_FORMAT_SVG }

Functions
SCIP_RETCODE	SCIPincludeReaderGp (SCIP *scip)
SCIP_RETCODE	GCGwriteGpVisualizationFormat (SCIP *scip, char *filename, char *outputname, int partialdecid, GP_OUTPUT_FORMAT outputformat)
SCIP_RETCODE	GCGwriteGpVisualization (SCIP *scip, char *filename, char *outputname, int partialdecid)
SCIP_RETCODE	GCGWriteGpDecompMatrix (SCIP *scip, const char *filename, const char *workfolder, SCIP_Bool originalmatrix)

Typedef Documentation

GP_OUTPUT_FORMAT

typedef enum GPOutputFormat GP_OUTPUT_FORMAT

Definition at line 57 of file reader_gp.h.

Enumeration Type Documentation

GPOutputFormat

enum GPOutputFormat

Output format of gnuplot. Specifies the output format that gnuplot will produce.

Enumerator
GP_OUTPUT_FORMAT_PDF
GP_OUTPUT_FORMAT_PNG
GP_OUTPUT_FORMAT_SVG

Definition at line 51 of file reader_gp.h.

Function Documentation

SCIPincludeReaderGp()

SCIP_RETCODE SCIPincludeReaderGp

(

SCIP *

scip

)

Includes the gp file reader into SCIP

Returns

SCIP status

Parameters

scip	SCIP data structure

Definition at line 527 of file reader_gp.cpp.

References READER_DESC, READER_EXTENSION, and READER_NAME.

Referenced by SCIPincludeGcgPlugins().

GCGwriteGpVisualizationFormat()

SCIP_RETCODE GCGwriteGpVisualizationFormat	(	SCIP *	scip,
		char *	filename,
		char *	outputname,
		int	partialdecid,
		GP_OUTPUT_FORMAT	outputformat
	)

Parameters

scip	SCIP data structure
filename	filename (including path) to write to
outputname	filename for compiled output file
partialdecid	id of partialdec to visualize
outputformat	the output format which gnuplot should emit

Definition at line 449 of file reader_gp.cpp.

References GCGconshdlrDecompGetPartialdecFromID(), gcg::PARTIALDECOMP::getDetprobdata(), writeGpHeader(), and writeGpPartialdec().

Referenced by GCGwriteGpVisualization(), and gcg::PARTIALDECOMP::writeVisualizationFile().

GCGwriteGpVisualization()

SCIP_RETCODE GCGwriteGpVisualization	(	SCIP *	scip,
		char *	filename,
		char *	outputname,
		int	partialdecid
	)

Writes a visualization as .pdf file for the given partialdec

Returns

SCIP status

Parameters

scip	SCIP data structure
filename	filename (including path), location of the output
outputname	outputname is the name of the file for the compiled gnuplot output file
partialdecid	id of partialdec to visualize

Definition at line 483 of file reader_gp.cpp.

References GCGwriteGpVisualizationFormat(), and GP_OUTPUT_FORMAT_PDF.

Referenced by gcg::PARTIALDECOMP::exportVisualization(), GCGWriteGpDecompMatrix(), GCGwriteTexReport(), GCGwriteTexVisualization(), and SCIP_DECL_READERWRITE().

GCGWriteGpDecompMatrix()

SCIP_RETCODE GCGWriteGpDecompMatrix	(	SCIP *	scip,
		const char *	filename,
		const char *	workfolder,
		SCIP_Bool	originalmatrix
	)

Creates a block matrix and outputs its visualization as .pdf file

Returns

SCIP return code

Parameters

scip	scip data structure
filename	filename the output should be written to (including directory)
workfolder	directory in which should be worked
originalmatrix	should the original (or transformed) matrix be written

Definition at line 496 of file reader_gp.cpp.

References GCGconshdlrDecompAddMatrixPartialdec(), GCGconshdlrDecompGetPartialdecFromID(), GCGgetVisualizationFilename(), and GCGwriteGpVisualization().

Referenced by writeMatrix().