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
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
/* */
/* 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 scip_timing.h
* @ingroup PUBLICCOREAPI
* @brief public methods for timing
* @author Tobias Achterberg
* @author Timo Berthold
* @author Thorsten Koch
* @author Alexander Martin
* @author Marc Pfetsch
* @author Kati Wolter
* @author Gregor Hendel
* @author Leona Gottwald
*/
/*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
#ifndef __SCIP_SCIP_TIMING_H__
#define __SCIP_SCIP_TIMING_H__
#include "scip/def.h"
#include "scip/type_clock.h"
#include "scip/type_retcode.h"
#include "scip/type_scip.h"
#ifdef __cplusplus
extern "C" {
#endif
/**@addtogroup PublicTimingMethods
*
* @{
*/
/** gets current time of day in seconds (standard time zone)
*
* @return the current time of day in seconds (standard time zone).
*/
SCIP_EXPORT
SCIP_Real SCIPgetTimeOfDay(
SCIP* scip /**< SCIP data structure */
);
/** creates a clock using the default clock type
*
* @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref
* SCIP_Retcode "SCIP_RETCODE" for a complete list of error codes.
*/
SCIP_EXPORT
SCIP_RETCODE SCIPcreateClock(
SCIP* scip, /**< SCIP data structure */
SCIP_CLOCK** clck /**< pointer to clock timer */
);
/** creates a clock counting the CPU user seconds
*
* @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref
* SCIP_Retcode "SCIP_RETCODE" for a complete list of error codes.
*/
SCIP_EXPORT
SCIP_RETCODE SCIPcreateCPUClock(
SCIP* scip, /**< SCIP data structure */
SCIP_CLOCK** clck /**< pointer to clock timer */
);
/** creates a clock counting the wall clock seconds
*
* @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref
* SCIP_Retcode "SCIP_RETCODE" for a complete list of error codes.
*/
SCIP_EXPORT
SCIP_RETCODE SCIPcreateWallClock(
SCIP* scip, /**< SCIP data structure */
SCIP_CLOCK** clck /**< pointer to clock timer */
);
/** frees a clock
*
* @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref
* SCIP_Retcode "SCIP_RETCODE" for a complete list of error codes.
*/
SCIP_EXPORT
SCIP_RETCODE SCIPfreeClock(
SCIP* scip, /**< SCIP data structure */
SCIP_CLOCK** clck /**< pointer to clock timer */
);
/** resets the time measurement of a clock to zero and completely stops the clock
*
* @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref
* SCIP_Retcode "SCIP_RETCODE" for a complete list of error codes.
*/
SCIP_EXPORT
SCIP_RETCODE SCIPresetClock(
SCIP* scip, /**< SCIP data structure */
SCIP_CLOCK* clck /**< clock timer */
);
/** starts the time measurement of a clock
*
* @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref
* SCIP_Retcode "SCIP_RETCODE" for a complete list of error codes.
*/
SCIP_EXPORT
SCIP_RETCODE SCIPstartClock(
SCIP* scip, /**< SCIP data structure */
SCIP_CLOCK* clck /**< clock timer */
);
/** stops the time measurement of a clock
*
* @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref
* SCIP_Retcode "SCIP_RETCODE" for a complete list of error codes.
*/
SCIP_EXPORT
SCIP_RETCODE SCIPstopClock(
SCIP* scip, /**< SCIP data structure */
SCIP_CLOCK* clck /**< clock timer */
);
/** enables or disables \p clck */
SCIP_EXPORT
void SCIPsetClockEnabled(
SCIP_CLOCK* clck, /**< the clock to be disabled/enabled */
SCIP_Bool enable /**< should the clock be enabled or disabled? */
);
/** enables or disables all statistic clocks of SCIP concerning plugin statistics,
* LP execution time, strong branching time, etc.
*
* Method reads the value of the parameter timing/statistictiming. In order to disable statistic timing,
* set the parameter to FALSE.
*
* @note: The (pre-)solving time clocks which are relevant for the output during (pre-)solving
* are not affected by this method
*
* @see: For completely disabling all timing of SCIP, consider setting the parameter timing/enabled to FALSE
*
* @pre This method can be called if SCIP is in one of the following stages:
* - \ref SCIP_STAGE_PROBLEM
* - \ref SCIP_STAGE_TRANSFORMING
* - \ref SCIP_STAGE_TRANSFORMED
* - \ref SCIP_STAGE_INITPRESOLVE
* - \ref SCIP_STAGE_PRESOLVING
* - \ref SCIP_STAGE_EXITPRESOLVE
* - \ref SCIP_STAGE_PRESOLVED
* - \ref SCIP_STAGE_INITSOLVE
* - \ref SCIP_STAGE_SOLVING
* - \ref SCIP_STAGE_SOLVED
* - \ref SCIP_STAGE_EXITSOLVE
* - \ref SCIP_STAGE_FREETRANS
*
* See \ref SCIP_Stage "SCIP_STAGE" for a complete list of all possible solving stages.
*/
SCIP_EXPORT
SCIP_RETCODE SCIPenableOrDisableStatisticTiming(
SCIP* scip /**< SCIP data structure */
);
/** starts the current solving time
*
* @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref
* SCIP_Retcode "SCIP_RETCODE" for a complete list of error codes.
*
* @pre This method can be called if SCIP is in one of the following stages:
* - \ref SCIP_STAGE_PROBLEM
* - \ref SCIP_STAGE_TRANSFORMING
* - \ref SCIP_STAGE_TRANSFORMED
* - \ref SCIP_STAGE_INITPRESOLVE
* - \ref SCIP_STAGE_PRESOLVING
* - \ref SCIP_STAGE_EXITPRESOLVE
* - \ref SCIP_STAGE_PRESOLVED
* - \ref SCIP_STAGE_INITSOLVE
* - \ref SCIP_STAGE_SOLVING
* - \ref SCIP_STAGE_SOLVED
* - \ref SCIP_STAGE_EXITSOLVE
* - \ref SCIP_STAGE_FREETRANS
*
* See \ref SCIP_Stage "SCIP_STAGE" for a complete list of all possible solving stages.
*/
SCIP_EXPORT
SCIP_RETCODE SCIPstartSolvingTime(
SCIP* scip /**< SCIP data structure */
);
/** stops the current solving time in seconds
*
* @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref
* SCIP_Retcode "SCIP_RETCODE" for a complete list of error codes.
*
* @pre This method can be called if SCIP is in one of the following stages:
* - \ref SCIP_STAGE_PROBLEM
* - \ref SCIP_STAGE_TRANSFORMING
* - \ref SCIP_STAGE_TRANSFORMED
* - \ref SCIP_STAGE_INITPRESOLVE
* - \ref SCIP_STAGE_PRESOLVING
* - \ref SCIP_STAGE_EXITPRESOLVE
* - \ref SCIP_STAGE_PRESOLVED
* - \ref SCIP_STAGE_INITSOLVE
* - \ref SCIP_STAGE_SOLVING
* - \ref SCIP_STAGE_SOLVED
* - \ref SCIP_STAGE_EXITSOLVE
* - \ref SCIP_STAGE_FREETRANS
*
* See \ref SCIP_Stage "SCIP_STAGE" for a complete list of all possible solving stages.
*/
SCIP_EXPORT
SCIP_RETCODE SCIPstopSolvingTime(
SCIP* scip /**< SCIP data structure */
);
/** gets the measured time of a clock in seconds
*
* @return the measured time of a clock in seconds.
*/
SCIP_EXPORT
SCIP_Real SCIPgetClockTime(
SCIP* scip, /**< SCIP data structure */
SCIP_CLOCK* clck /**< clock timer */
);
/** sets the measured time of a clock to the given value in seconds
*
* @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref
* SCIP_Retcode "SCIP_RETCODE" for a complete list of error codes.
*/
SCIP_EXPORT
SCIP_RETCODE SCIPsetClockTime(
SCIP* scip, /**< SCIP data structure */
SCIP_CLOCK* clck, /**< clock timer */
SCIP_Real sec /**< time in seconds to set the clock's timer to */
);
/** gets the current total SCIP time in seconds, possibly accumulated over several problems.
*
* @return the current total SCIP time in seconds, ie. the total time since the SCIP instance has been created
*/
SCIP_EXPORT
SCIP_Real SCIPgetTotalTime(
SCIP* scip /**< SCIP data structure */
);
/** gets the current solving time in seconds
*
* @return the current solving time in seconds.
*
* @pre This method can be called if SCIP is in one of the following stages:
* - \ref SCIP_STAGE_PROBLEM
* - \ref SCIP_STAGE_TRANSFORMING
* - \ref SCIP_STAGE_TRANSFORMED
* - \ref SCIP_STAGE_INITPRESOLVE
* - \ref SCIP_STAGE_PRESOLVING
* - \ref SCIP_STAGE_EXITPRESOLVE
* - \ref SCIP_STAGE_PRESOLVED
* - \ref SCIP_STAGE_INITSOLVE
* - \ref SCIP_STAGE_SOLVING
* - \ref SCIP_STAGE_SOLVED
*
* See \ref SCIP_Stage "SCIP_STAGE" for a complete list of all possible solving stages.
*/
SCIP_EXPORT
SCIP_Real SCIPgetSolvingTime(
SCIP* scip /**< SCIP data structure */
);
/** gets the current reading time in seconds
*
* @return the current reading time in seconds.
*
* @pre This method can be called if SCIP is in one of the following stages:
* - \ref SCIP_STAGE_PROBLEM
* - \ref SCIP_STAGE_TRANSFORMING
* - \ref SCIP_STAGE_TRANSFORMED
* - \ref SCIP_STAGE_INITPRESOLVE
* - \ref SCIP_STAGE_PRESOLVING
* - \ref SCIP_STAGE_EXITPRESOLVE
* - \ref SCIP_STAGE_PRESOLVED
* - \ref SCIP_STAGE_INITSOLVE
* - \ref SCIP_STAGE_SOLVING
* - \ref SCIP_STAGE_SOLVED
*
* See \ref SCIP_Stage "SCIP_STAGE" for a complete list of all possible solving stages.
*/
SCIP_EXPORT
SCIP_Real SCIPgetReadingTime(
SCIP* scip /**< SCIP data structure */
);
/** gets the current presolving time in seconds
*
* @return the current presolving time in seconds.
*
* @pre This method can be called if SCIP is in one of the following stages:
* - \ref SCIP_STAGE_INITPRESOLVE
* - \ref SCIP_STAGE_PRESOLVING
* - \ref SCIP_STAGE_EXITPRESOLVE
* - \ref SCIP_STAGE_PRESOLVED
* - \ref SCIP_STAGE_INITSOLVE
* - \ref SCIP_STAGE_SOLVING
* - \ref SCIP_STAGE_SOLVED
*
* See \ref SCIP_Stage "SCIP_STAGE" for a complete list of all possible solving stages.
*/
SCIP_EXPORT
SCIP_Real SCIPgetPresolvingTime(
SCIP* scip /**< SCIP data structure */
);
/** gets the time need to solve the first LP in the root node
*
* @return the solving time for the first LP in the root node in seconds.
*
* @pre This method can be called if SCIP is in one of the following stages:
* - \ref SCIP_STAGE_TRANSFORMING
* - \ref SCIP_STAGE_TRANSFORMED
* - \ref SCIP_STAGE_INITPRESOLVE
* - \ref SCIP_STAGE_PRESOLVING
* - \ref SCIP_STAGE_EXITPRESOLVE
* - \ref SCIP_STAGE_PRESOLVED
* - \ref SCIP_STAGE_INITSOLVE
* - \ref SCIP_STAGE_SOLVING
* - \ref SCIP_STAGE_SOLVED
*
* See \ref SCIP_Stage "SCIP_STAGE" for a complete list of all possible solving stages.
*/
SCIP_EXPORT
SCIP_Real SCIPgetFirstLPTime(
SCIP* scip /**< SCIP data structure */
);
/**@} */
#ifdef __cplusplus
}
#endif
#endif