1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
/* */
/* This file is part of the program and library */
/* SCIP --- Solving Constraint Integer Programs */
/* */
/* Copyright 2002-2022 Zuse Institute Berlin */
/* */
/* Licensed under the Apache License, Version 2.0 (the "License"); */
/* you may not use this file except in compliance with the License. */
/* You may obtain a copy of the License at */
/* */
/* http://www.apache.org/licenses/LICENSE-2.0 */
/* */
/* Unless required by applicable law or agreed to in writing, software */
/* distributed under the License is distributed on an "AS IS" BASIS, */
/* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. */
/* See the License for the specific language governing permissions and */
/* limitations under the License. */
/* */
/* You should have received a copy of the Apache-2.0 license */
/* along with SCIP; see the file LICENSE. If not visit scipopt.org. */
/* */
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
/**@file reader_tim.h
* @ingroup FILEREADERS
* @brief TIM file reader - the stage information for a stochastic programming instance in SMPS format
* @author Stephen J. Maher
*
* This is a reader for the time file of a stochastic programming instance in SMPS format.
* The three files that must be read are:
* - .cor
* - .tim
* - .sto
*
* Alternatively, it is possible to create a .smps file with the relative path to the .cor, .tim and .sto files.
* A file reader is available for the .smps file.
*
* Details regarding the SMPS file format can be found at:
* Birge, J. R.; Dempster, M. A.; Gassmann, H. I.; Gunn, E.; King, A. J. & Wallace, S. W.
* A standard input format for multiperiod stochastic linear programs
* IIASA, Laxenburg, Austria, WP-87-118, 1987
*
*/
/*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
#ifndef __SCIP_READER_TIM_H__
#define __SCIP_READER_TIM_H__
#include "scip/def.h"
#include "scip/type_cons.h"
#include "scip/type_reader.h"
#include "scip/type_result.h"
#include "scip/type_retcode.h"
#include "scip/type_scip.h"
#include "scip/type_var.h"
#ifdef __cplusplus
extern "C" {
#endif
/** includes the tim file reader into SCIP
*
* @ingroup FileReaderIncludes
*/
SCIP_EXPORT
SCIP_RETCODE SCIPincludeReaderTim(
SCIP* scip /**< SCIP data structure */
);
/**@addtogroup FILEREADERS
*
* @{
*/
/** reads the stage information for a stochastic programming instance in SMPS format */
SCIP_EXPORT
SCIP_RETCODE SCIPreadTim(
SCIP* scip, /**< SCIP data structure */
const char* filename, /**< full path and name of file to read, or NULL if stdin should be used */
SCIP_RESULT* result /**< pointer to store the result of the file reading call */
);
/** @} */
/*
* Interface methods for the cor and sto files
*/
/* return whether the tim file has been read */
SCIP_EXPORT
SCIP_Bool SCIPtimHasRead(
SCIP_READER* reader /**< the file reader itself */
);
/* returns the number of stages */
SCIP_EXPORT
int SCIPtimGetNStages(
SCIP* scip /**< SCIP data structure */
);
/* returns the name for a given stage */
SCIP_EXPORT
const char* SCIPtimGetStageName(
SCIP* scip, /**< SCIP data structure */
int stagenum /**< the number of the requested stage */
);
/* returns the stage name for a given constraint name */
const char* SCIPtimConsGetStageName(
SCIP* scip, /**< SCIP data structure */
const char* consname /**< the constraint to search for */
);
/* returns the number for a given stage */
SCIP_EXPORT
int SCIPtimFindStage(
SCIP* scip, /**< SCIP data structure */
const char* stage /**< the name of the requested stage */
);
/* returns the array of variables for a given stage */
SCIP_EXPORT
SCIP_VAR** SCIPtimGetStageVars(
SCIP* scip, /**< SCIP data structure */
int stagenum /**< the number of the requested stage */
);
/* returns an array of constraints for a given stage */
SCIP_EXPORT
SCIP_CONS** SCIPtimGetStageConss(
SCIP* scip, /**< SCIP data structure */
int stagenum /**< the number of the requested stage */
);
/* returns the number of variables for a given stage */
SCIP_EXPORT
int SCIPtimGetStageNVars(
SCIP* scip, /**< SCIP data structure */
int stagenum /**< the number of the requested stage */
);
/* returns the number of constraints for a given stage */
SCIP_EXPORT
int SCIPtimGetStageNConss(
SCIP* scip, /**< SCIP data structure */
int stagenum /**< the number of the requested stage */
);
#ifdef __cplusplus
}
#endif
#endif