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 2002-2022 Zuse Institute Berlin */
7 /* */
8 /* Licensed under the Apache License, Version 2.0 (the "License"); */
9 /* you may not use this file except in compliance with the License. */
10 /* You may obtain a copy of the License at */
11 /* */
12 /* http://www.apache.org/licenses/LICENSE-2.0 */
13 /* */
14 /* Unless required by applicable law or agreed to in writing, software */
15 /* distributed under the License is distributed on an "AS IS" BASIS, */
16 /* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. */
17 /* See the License for the specific language governing permissions and */
18 /* limitations under the License. */
19 /* */
20 /* You should have received a copy of the Apache-2.0 license */
21 /* along with SCIP; see the file LICENSE. If not visit scipopt.org. */
22 /* */
23 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
24 
25 /**@file reader_pbm.h
26  * @ingroup FILEREADERS
27  * @brief file writer for portable bitmap file format (PBM), open with common graphic viewer programs (e.g. xview)
28  * @author Alexandra Kraft
29  */
30 
31 /*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
32 
33 #ifndef __SCIP_READER_PBM_H__
34 #define __SCIP_READER_PBM_H__
35 
36 #include "scip/def.h"
37 #include "scip/type_cons.h"
38 #include "scip/type_reader.h"
39 #include "scip/type_result.h"
40 #include "scip/type_retcode.h"
41 #include "scip/type_scip.h"
42 
43 #ifdef __cplusplus
44 extern "C" {
45 #endif
46 
47 /** includes the pbm file reader into SCIP
48  *
49  * @ingroup FileReaderIncludes
50  */
51 SCIP_EXPORT
53  SCIP* scip /**< SCIP data structure */
54  );
55 
56 /**@addtogroup FILEREADERS
57  *
58  * @{
59  */
60 
61 /* writes picture of matrix structure to file */
62 SCIP_EXPORT
64  SCIP* scip, /**< SCIP data structure */
65  FILE* file, /**< output file, or NULL if standard output should be used */
66  const char* name, /**< problem name */
67  SCIP_READERDATA* readerdata, /**< information for reader */
68  SCIP_Bool transformed, /**< TRUE iff problem is the transformed problem */
69  int nvars, /**< number of active variables in the problem */
70  SCIP_CONS** conss, /**< array with constraints of the problem */
71  int nconss, /**< number of constraints in the problem */
72  SCIP_RESULT* result /**< pointer to store the result of the file writing call */
73  );
74 
75 /** @} */
76 
77 #ifdef __cplusplus
78 }
79 #endif
80 
81 #endif
enum SCIP_Result SCIP_RESULT
Definition: type_result.h:61
enum SCIP_Retcode SCIP_RETCODE
Definition: type_retcode.h:63
type definitions for return codes for SCIP methods
SCIP_RETCODE SCIPincludeReaderPbm(SCIP *scip)
Definition: reader_pbm.c:455
type definitions for SCIP&#39;s main datastructure
struct SCIP_ReaderData SCIP_READERDATA
Definition: type_reader.h:53
#define SCIP_Bool
Definition: def.h:93
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:483
result codes for SCIP callback methods
common defines and data types used in all packages of SCIP
type definitions for constraints and constraint handlers