Scippy

SCIP

Solving Constraint Integer Programs

reader_opb.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-2015 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 email to scip@zib.de. */
13 /* */
14 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
15 
16 /**@file reader_opb.h
17  * @ingroup FILEREADERS
18  * @brief pseudo-Boolean file reader (opb format)
19  * @author Stefan Heinz
20  * @author Michael Winkler
21  *
22  * This file reader parses the @a opb format and is also used by the @a wbo reader for the @a wbo format. For a
23  * detailed description of this format see http://www.cril.univ-artois.fr/PB10/format.pdf .
24  */
25 
26 /*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
27 
28 #ifndef __SCIP_READER_OPB_H__
29 #define __SCIP_READER_OPB_H__
30 
31 #include "scip/scip.h"
32 
33 #ifdef __cplusplus
34 extern "C" {
35 #endif
36 
37 /** includes the opb file reader into SCIP */
38 extern
40  SCIP* scip /**< SCIP data structure */
41  );
42 
43 /** reads problem from file */
44 extern
46  SCIP* scip, /**< SCIP data structure */
47  SCIP_READER* reader, /**< the file reader itself */
48  const char* filename, /**< full path and name of file to read, or NULL if stdin should be used */
49  SCIP_RESULT* result /**< pointer to store the result of the file reading call */
50  );
51 
52 /** writes problem to file */
53 extern
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_Bool transformed, /**< TRUE iff problem is the transformed problem */
59  SCIP_OBJSENSE objsense, /**< objective sense */
60  SCIP_Real objscale, /**< scalar applied to objective function; external objective value is
61  extobj = objsense * objscale * (intobj + objoffset) */
62  SCIP_Real objoffset, /**< objective offset from bound shifting and fixing */
63  SCIP_VAR** vars, /**< array with active variables ordered binary, integer, implicit, continuous */
64  int nvars, /**< number of active variables in the problem */
65  int nbinvars, /**< number of binary variables */
66  int nintvars, /**< number of general integer variables */
67  int nimplvars, /**< number of implicit integer variables */
68  int ncontvars, /**< number of continuous variables */
69  SCIP_VAR** fixedvars, /**< array with fixed variables */
70  int nfixedvars, /**< number of fixed and aggregated variables in the problem */
71  SCIP_CONS** conss, /**< array with constraints of the problem */
72  int nconss, /**< number of constraints in the problem */
73  SCIP_Bool genericnames, /**< should generic variable and constraint names be used */
74  SCIP_RESULT* result /**< pointer to store the result of the file writing call */
75  );
76 
77 #ifdef __cplusplus
78 }
79 #endif
80 
81 #endif
enum SCIP_Result SCIP_RESULT
Definition: type_result.h:51
struct SCIP_Cons SCIP_CONS
Definition: type_cons.h:48
enum SCIP_Retcode SCIP_RETCODE
Definition: type_retcode.h:53
SCIP_RETCODE SCIPwriteOpb(SCIP *scip, FILE *file, const char *name, SCIP_Bool transformed, SCIP_OBJSENSE objsense, SCIP_Real objscale, SCIP_Real objoffset, SCIP_VAR **vars, int nvars, int nbinvars, int nintvars, int nimplvars, int ncontvars, SCIP_VAR **fixedvars, int nfixedvars, SCIP_CONS **conss, int nconss, SCIP_Bool genericnames, SCIP_RESULT *result)
SCIP_RETCODE SCIPincludeReaderOpb(SCIP *scip)
struct SCIP_Reader SCIP_READER
Definition: type_reader.h:36
struct Scip SCIP
Definition: type_scip.h:30
#define SCIP_Bool
Definition: def.h:50
enum SCIP_Objsense SCIP_OBJSENSE
Definition: type_prob.h:41
struct SCIP_Var SCIP_VAR
Definition: type_var.h:95
SCIP_RETCODE SCIPreadOpb(SCIP *scip, SCIP_READER *reader, const char *filename, SCIP_RESULT *result)
#define SCIP_Real
Definition: def.h:124
SCIP callable library.