Scippy

SCIP

Solving Constraint Integer Programs

reader_ppm.h
Go to the documentation of this file.
1 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
2 /* */
3 /* This file is part of the program and library */
4 /* SCIP --- Solving Constraint Integer Programs */
5 /* */
6 /* Copyright (C) 2002-2019 Konrad-Zuse-Zentrum */
7 /* fuer Informationstechnik Berlin */
8 /* */
9 /* SCIP is distributed under the terms of the ZIB Academic License. */
10 /* */
11 /* You should have received a copy of the ZIB Academic License */
12 /* along with SCIP; see the file COPYING. If not visit scip.zib.de. */
13 /* */
14 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
15 
16 /**@file reader_ppm.h
17  * @ingroup FILEREADERS
18  * @brief file writer for portable pixmap file format (PPM), open with common graphic viewer programs (e.g. xview)
19  * @author Tobias Achterberg
20  * @author Michael Winkler
21  */
22 
23 /*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
24 
25 #ifndef __SCIP_READER_PPM_H__
26 #define __SCIP_READER_PPM_H__
27 
28 #include "scip/def.h"
29 #include "scip/type_cons.h"
30 #include "scip/type_reader.h"
31 #include "scip/type_result.h"
32 #include "scip/type_retcode.h"
33 #include "scip/type_scip.h"
34 #include "scip/type_var.h"
35 
36 #ifdef __cplusplus
37 extern "C" {
38 #endif
39 
40 /** includes the ppm file reader into SCIP
41  *
42  * @ingroup FileReaderIncludes
43  */
46  SCIP* scip /**< SCIP data structure */
47  );
48 
49 /**@addtogroup FILEREADERS
50  *
51  * @{
52  */
53 
54 /** writes problem to file */
57  SCIP* scip, /**< SCIP data structure */
58  FILE* file, /**< output file, or NULL if standard output should be used */
59  const char* name, /**< problem name */
60  SCIP_READERDATA* readerdata, /**< information for reader */
61  SCIP_Bool transformed, /**< TRUE iff problem is the transformed problem */
62  SCIP_VAR** vars, /**< array with active variables ordered binary, integer, implicit, continuous */
63  int nvars, /**< number of active variables in the problem */
64  SCIP_CONS** conss, /**< array with constraints of the problem */
65  int nconss, /**< number of constraints in the problem */
66  SCIP_RESULT* result /**< pointer to store the result of the file writing call */
67  );
68 
69 /* @} */
70 
71 #ifdef __cplusplus
72 }
73 #endif
74 
75 #endif
enum SCIP_Result SCIP_RESULT
Definition: type_result.h:52
SCIP_EXPORT SCIP_RETCODE SCIPwritePpm(SCIP *scip, FILE *file, const char *name, SCIP_READERDATA *readerdata, SCIP_Bool transformed, SCIP_VAR **vars, int nvars, SCIP_CONS **conss, int nconss, SCIP_RESULT *result)
Definition: reader_ppm.c:531
#define SCIP_EXPORT
Definition: def.h:98
enum SCIP_Retcode SCIP_RETCODE
Definition: type_retcode.h:53
type definitions for return codes for SCIP methods
type definitions for SCIP&#39;s main datastructure
type definitions for problem variables
SCIP_EXPORT SCIP_RETCODE SCIPincludeReaderPpm(SCIP *scip)
Definition: reader_ppm.c:489
struct SCIP_ReaderData SCIP_READERDATA
Definition: type_reader.h:39
#define SCIP_Bool
Definition: def.h:70
type definitions for input file readers
result codes for SCIP callback methods
common defines and data types used in all packages of SCIP
type definitions for constraints and constraint handlers