Scippy

SCIP

Solving Constraint Integer Programs

reader_pbm.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-2022 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 scipopt.org. */
13 /* */
14 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
15 
16 /**@file reader_pbm.h
17  * @ingroup FILEREADERS
18  * @brief file writer for portable bitmap file format (PBM), open with common graphic viewer programs (e.g. xview)
19  * @author Alexandra Kraft
20  */
21 
22 /*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
23 
24 #ifndef __SCIP_READER_PBM_H__
25 #define __SCIP_READER_PBM_H__
26 
27 #include "scip/def.h"
28 #include "scip/type_cons.h"
29 #include "scip/type_reader.h"
30 #include "scip/type_result.h"
31 #include "scip/type_retcode.h"
32 #include "scip/type_scip.h"
33 
34 #ifdef __cplusplus
35 extern "C" {
36 #endif
37 
38 /** includes the pbm file reader into SCIP
39  *
40  * @ingroup FileReaderIncludes
41  */
42 SCIP_EXPORT
44  SCIP* scip /**< SCIP data structure */
45  );
46 
47 /**@addtogroup FILEREADERS
48  *
49  * @{
50  */
51 
52 /* writes picture of matrix structure to file */
53 SCIP_EXPORT
55  SCIP* scip, /**< SCIP data structure */
56  FILE* file, /**< output file, or NULL if standard output should be used */
57  const char* name, /**< problem name */
58  SCIP_READERDATA* readerdata, /**< information for reader */
59  SCIP_Bool transformed, /**< TRUE iff problem is the transformed problem */
60  int nvars, /**< number of active variables in the problem */
61  SCIP_CONS** conss, /**< array with constraints of the problem */
62  int nconss, /**< number of constraints in the problem */
63  SCIP_RESULT* result /**< pointer to store the result of the file writing call */
64  );
65 
66 /** @} */
67 
68 #ifdef __cplusplus
69 }
70 #endif
71 
72 #endif
enum SCIP_Result SCIP_RESULT
Definition: type_result.h:52
enum SCIP_Retcode SCIP_RETCODE
Definition: type_retcode.h:54
type definitions for return codes for SCIP methods
SCIP_RETCODE SCIPincludeReaderPbm(SCIP *scip)
Definition: reader_pbm.c:446
type definitions for SCIP&#39;s main datastructure
struct SCIP_ReaderData SCIP_READERDATA
Definition: type_reader.h:44
#define SCIP_Bool
Definition: def.h:84
type definitions for input file readers
SCIP_RETCODE SCIPwritePbm(SCIP *scip, FILE *file, const char *name, SCIP_READERDATA *readerdata, SCIP_Bool transformed, int nvars, SCIP_CONS **conss, int nconss, SCIP_RESULT *result)
Definition: reader_pbm.c:474
result codes for SCIP callback methods
common defines and data types used in all packages of SCIP
type definitions for constraints and constraint handlers