Scippy

GCG

Branch-and-Price & Column Generation for Everyone

reader_tex.h
Go to the documentation of this file.
1 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
2 /* */
3 /* This file is part of the program */
4 /* GCG --- Generic Column Generation */
5 /* a Dantzig-Wolfe decomposition based extension */
6 /* of the branch-cut-and-price framework */
7 /* SCIP --- Solving Constraint Integer Programs */
8 /* */
9 /* Copyright (C) 2010-2021 Operations Research, RWTH Aachen University */
10 /* Zuse Institute Berlin (ZIB) */
11 /* */
12 /* This program is free software; you can redistribute it and/or */
13 /* modify it under the terms of the GNU Lesser General Public License */
14 /* as published by the Free Software Foundation; either version 3 */
15 /* of the License, or (at your option) any later version. */
16 /* */
17 /* This program is distributed in the hope that it will be useful, */
18 /* but WITHOUT ANY WARRANTY; without even the implied warranty of */
19 /* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the */
20 /* GNU Lesser General Public License for more details. */
21 /* */
22 /* You should have received a copy of the GNU Lesser General Public License */
23 /* along with this program; if not, write to the Free Software */
24 /* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA.*/
25 /* */
26 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
27 
28 /**@file reader_tex.h
29  * @brief tex file reader for writing decomposition details to LaTeX files
30  * @author Hanna Franzen
31  * @ingroup FILEREADERS
32 
33  * This reader can write visualizations, family trees and reports of partialdecs to a .tex LaTeX file.
34  * The gp reader might be required for visualizations.
35 
36  */
37 
38 /*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
39 
40 #ifndef GCG_READER_TEX_H__
41 #define GCG_READER_TEX_H__
42 
43 #include "scip/scip.h"
44 #include "type_decomp.h"
45 #include "cons_decomp.h"
46 
47 #ifdef __cplusplus
48 extern "C" {
49 #endif
50 
51 
52 /** Includes the tex file reader into SCIP
53  *
54  * @returns SCIP status */
55 extern SCIP_RETCODE SCIPincludeReaderTex(
56  SCIP* scip /**< SCIP data structure */
57  );
58 
59 /** Writes visualization LaTeX code for the given partialdec
60  *
61  * @returns SCIP status */
62 extern SCIP_RETCODE GCGwriteTexVisualization(
63  SCIP* scip, /**< SCIP data structure */
64  FILE* file, /**< file in which to write the LaTeX code */
65  int partialdecid, /**< id of partialdec to visualize */
66  SCIP_Bool statistics, /**< additionally to picture show statistics */
67  SCIP_Bool usegp /**< true if the gp reader should be used for the image generation (instead of tikz) */
68  );
69 
70 /** Writes a report for the given partialdecs
71  *
72  * @note *npartialdecs will be set to the number of actually written decompositions.
73  * @returns SCIP status */
74 extern SCIP_RETCODE GCGwriteTexReport(
75  SCIP* scip, /**< SCIP data structure */
76  FILE* file, /**< file in which to put the LaTeX code */
77  int* partialdecids, /**< ids of partialdecs to visualize */
78  int* npartialdecs, /**< number of partialdecs to visualize */
79  SCIP_Bool titlepage, /**< true if a title page should be included in the document */
80  SCIP_Bool toc, /**< true if an interactive table of contents should be included */
81  SCIP_Bool statistics, /**< true if statistics for each partialdec should be included */
82  SCIP_Bool usegp /**< true if the gp reader should be used for the image generation */
83  );
84 
85 /** Makes a new makefile and readme for the given .tex file
86  *
87  * @returns SCIP status */
88 extern SCIP_RETCODE GCGtexWriteMakefileAndReadme(
89  SCIP* scip, /**< SCIP data structure */
90  FILE* file, /**< tex file for which the makefile & readme are generated */
91  SCIP_Bool usegp, /**< true if the gp reader was used for creation of images */
92  SCIP_Bool compiletex /**< true if there are tex files to be compiled before main document */
93  );
94 
95 #ifdef __cplusplus
96 }
97 #endif
98 
99 
100 #endif /* GCG_READER_TEX_H__ */
101 
constraint handler for structure detection
SCIP_FILE * file
Definition: reader_ref.c:79
SCIP_RETCODE GCGwriteTexVisualization(SCIP *scip, FILE *file, int partialdecid, SCIP_Bool statistics, SCIP_Bool usegp)
Definition: reader_tex.cpp:767
SCIP_RETCODE SCIPincludeReaderTex(SCIP *scip)
Definition: reader_tex.cpp:939
SCIP_RETCODE GCGtexWriteMakefileAndReadme(SCIP *scip, FILE *file, SCIP_Bool usegp, SCIP_Bool compiletex)
Definition: reader_tex.cpp:813
SCIP_RETCODE GCGwriteTexReport(SCIP *scip, FILE *file, int *partialdecids, int *npartialdecs, SCIP_Bool titlepage, SCIP_Bool toc, SCIP_Bool statistics, SCIP_Bool usegp)
Definition: reader_tex.cpp:675
type definitions for decomposition information in GCG projects