Scippy

SCIP

Solving Constraint Integer Programs

reader_gms.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_gms.h
17  * @ingroup FILEREADERS
18  * @brief GAMS file reader and writer
19  * @author Ambros Gleixner
20  *
21  * This reader writes a CIP in GAMS format.
22  * It can write all kinds of linear and nonlinear constraints (as occurring in MINLPs) and indicator constraints.
23  *
24  * If SCIP has been compiled with GAMS=true, it can also read GAMS model instances.
25  * This requires a working GAMS system.
26  */
27 
28 /*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
29 
30 #ifndef __SCIP_READER_GMS_H__
31 #define __SCIP_READER_GMS_H__
32 
33 #include "scip/def.h"
34 #include "scip/type_cons.h"
35 #include "scip/type_prob.h"
36 #include "scip/type_result.h"
37 #include "scip/type_retcode.h"
38 #include "scip/type_scip.h"
39 #include "scip/type_var.h"
40 
41 #ifdef __cplusplus
42 extern "C" {
43 #endif
44 
45 /** includes the gms file reader into SCIP
46  *
47  * @ingroup FileReaderIncludes
48  */
49 SCIP_EXPORT
51  SCIP* scip /**< SCIP data structure */
52  );
53 
54 /**@addtogroup FILEREADERS
55  *
56  * @{
57  */
58 
59 /** writes problem to file */
60 SCIP_EXPORT
62  SCIP* scip, /**< SCIP data structure */
63  FILE* file, /**< output file, or NULL if standard output should be used */
64  const char* name, /**< problem name */
65  SCIP_Bool transformed, /**< TRUE iff problem is the transformed problem */
66  SCIP_OBJSENSE objsense, /**< objective sense */
67  SCIP_Real objscale, /**< scalar applied to objective function; external objective value is
68  * extobj = objsense * objscale * (intobj + objoffset) */
69  SCIP_Real objoffset, /**< objective offset from bound shifting and fixing */
70  SCIP_VAR** vars, /**< array with active variables ordered binary, integer, implicit, continuous */
71  int nvars, /**< number of active variables in the problem */
72  int nbinvars, /**< number of binary variables */
73  int nintvars, /**< number of general integer variables */
74  int nimplvars, /**< number of implicit integer variables */
75  int ncontvars, /**< number of continuous variables */
76  SCIP_CONS** conss, /**< array with constraints of the problem */
77  int nconss, /**< number of constraints in the problem */
78  SCIP_RESULT* result /**< pointer to store the result of the file writing call */
79  );
80 
81 /** @} */
82 
83 #ifdef __cplusplus
84 }
85 #endif
86 
87 #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 SCIPwriteGms(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_CONS **conss, int nconss, SCIP_RESULT *result)
Definition: reader_gms.c:1320
SCIP_RETCODE SCIPincludeReaderGms(SCIP *scip)
Definition: reader_gms.c:1281
type definitions for SCIP&#39;s main datastructure
type definitions for problem variables
#define SCIP_Bool
Definition: def.h:84
enum SCIP_Objsense SCIP_OBJSENSE
Definition: type_prob.h:41
type definitions for storing and manipulating the main problem
#define SCIP_Real
Definition: def.h:177
result codes for SCIP callback methods
common defines and data types used in all packages of SCIP
type definitions for constraints and constraint handlers