Scippy

SCIP

Solving Constraint Integer Programs

reader_smps.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_smps.h
17  * @ingroup FILEREADERS
18  * @brief SMPS file reader - SMPS files lists the cor, tim and sto files for a single instance to be read
19  * @author Stephen J. Maher
20  *
21  * This is a reader for the reading the core, time and stochastic files of a stochastic programming instance
22  * in SMPS format.
23  * The three files that must be listed in the smps file are:
24  * - .cor
25  * - .tim
26  * - .sto
27  * The order of the files is not important. It is just necessary that all three are provided.
28  *
29  * Details regarding the SMPS file format can be found at:
30  * Birge, J. R.; Dempster, M. A.; Gassmann, H. I.; Gunn, E.; King, A. J. & Wallace, S. W.
31  * A standard input format for multiperiod stochastic linear programs
32  * IIASA, Laxenburg, Austria, WP-87-118, 1987
33  *
34  * An example of an smps file looks as follows.
35  *
36  * @verbinclude pltexpA2_6.smps
37  */
38 
39 
40 /*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
41 
42 #ifndef __SCIP_READER_SMPS_H__
43 #define __SCIP_READER_SMPS_H__
44 
45 #include "scip/def.h"
46 #include "scip/type_retcode.h"
47 #include "scip/type_scip.h"
48 
49 #ifdef __cplusplus
50 extern "C" {
51 #endif
52 
53 /** includes the smps file reader into SCIP
54  *
55  * @ingroup FileReaderIncludes
56  */
59  SCIP* scip /**< SCIP data structure */
60  );
61 
62 #ifdef __cplusplus
63 }
64 #endif
65 
66 #endif
#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
common defines and data types used in all packages of SCIP
SCIP_EXPORT SCIP_RETCODE SCIPincludeReaderSmps(SCIP *scip)
Definition: reader_smps.c:440