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