reader_tex.h File Reference

Detailed Description

parameter settings for visualization readers

tex file reader for writing decomposition details to LaTeX files

Author

Hanna Franzen

This file provides universally used parameters for visualizations.

Author

Hanna Franzen

This reader can write visualizations, family trees and reports of partialdecs to a .tex LaTeX file. The gp reader might be required for visualizations.

Definition in file reader_tex.h.

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

Go to the source code of this file.

Functions
SCIP_RETCODE	SCIPincludeReaderTex (SCIP *scip)
SCIP_RETCODE	GCGwriteTexVisualization (SCIP *scip, FILE *file, int partialdecid, SCIP_Bool statistics, SCIP_Bool usegp)
SCIP_RETCODE	GCGwriteTexReport (SCIP *scip, FILE *file, int *partialdecids, int *npartialdecs, SCIP_Bool titlepage, SCIP_Bool toc, SCIP_Bool statistics, SCIP_Bool usegp)
SCIP_RETCODE	GCGtexWriteMakefileAndReadme (SCIP *scip, FILE *file, SCIP_Bool usegp, SCIP_Bool compiletex)

Function Documentation

SCIPincludeReaderTex()

SCIP_RETCODE SCIPincludeReaderTex

(

SCIP *

scip

)

Includes the tex file reader into SCIP

Returns

SCIP status

Parameters

scip	SCIP data structure

Definition at line 939 of file reader_tex.cpp.

References READER_DESC, READER_EXTENSION, and READER_NAME.

Referenced by SCIPincludeGcgPlugins().

GCGwriteTexVisualization()

SCIP_RETCODE GCGwriteTexVisualization	(	SCIP *	scip,
		FILE *	file,
		int	partialdecid,
		SCIP_Bool	statistics,
		SCIP_Bool	usegp
	)

Writes visualization LaTeX code for the given partialdec

Returns

SCIP status

Parameters

scip	SCIP data structure
file	file in which to write the LaTeX code
partialdecid	id of partialdec to visualize
statistics	additionally to picture show statistics
usegp	true if the gp reader should be used for the image generation (instead of tikz)

Definition at line 767 of file reader_tex.cpp.

References RefInput::file, GCGconshdlrDecompGetPartialdecFromID(), GCGgetVisualizationFilename(), GCGwriteGpVisualization(), writeTexEnding(), writeTexHeader(), writeTexPartialdec(), and writeTexPartialdecStatistics().

Referenced by SCIP_DECL_READERWRITE().

GCGwriteTexReport()

SCIP_RETCODE GCGwriteTexReport	(	SCIP *	scip,
		FILE *	file,
		int *	partialdecids,
		int *	npartialdecs,
		SCIP_Bool	titlepage,
		SCIP_Bool	toc,
		SCIP_Bool	statistics,
		SCIP_Bool	usegp
	)

Writes a report for the given partialdecs

Note

*npartialdecs will be set to the number of actually written decompositions.

Returns

SCIP status

Parameters

scip	SCIP data structure
file	file in which to put the LaTeX code
partialdecids	ids of partialdecs to visualize
npartialdecs	number of partialdecs to visualize
titlepage	true if a title page should be included in the document
toc	true if an interactive table of contents should be included
statistics	true if statistics for each partialdec should be included
usegp	true if the gp reader should be used for the image generation

Definition at line 675 of file reader_tex.cpp.

References gcg::PARTIALDECOMP::buildDecChainString(), RefInput::file, GCGconshdlrDecompGetPartialdecFromID(), GCGconshdlrDecompGetScoretype(), GCGgetFilePath(), GCGgetVisualizationFilename(), GCGreportGetMaxNDecomps(), GCGtexWriteMakefileAndReadme(), GCGwriteGpVisualization(), gcg::PARTIALDECOMP::getID(), gcg::PARTIALDECOMP::getNBlocks(), writeTexEnding(), writeTexHeader(), writeTexPartialdec(), writeTexPartialdecStatistics(), writeTexTableOfContents(), and writeTexTitlepage().

Referenced by reportAllDecompositions().

GCGtexWriteMakefileAndReadme()

SCIP_RETCODE GCGtexWriteMakefileAndReadme	(	SCIP *	scip,
		FILE *	file,
		SCIP_Bool	usegp,
		SCIP_Bool	compiletex
	)

Makes a new makefile and readme for the given .tex file

Returns

SCIP status

Parameters

scip	SCIP data structure
file	tex file for which the makefile & readme are generated
usegp	true if the gp reader was used for creation of images
compiletex	true if there are tex files to be compiled before main document

Definition at line 813 of file reader_tex.cpp.

References RefInput::file, and GCGgetFilePath().

Referenced by GCGwriteTexReport().