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
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
/* */
/* 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 clock.h
* @ingroup INTERNALAPI
* @brief internal methods for clocks and timing issues
* @author Tobias Achterberg
*/
/*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
#ifndef __SCIP_CLOCK_H__
#define __SCIP_CLOCK_H__
#include "scip/def.h"
#include "scip/type_retcode.h"
#include "scip/type_set.h"
#include "scip/type_clock.h"
#ifdef __cplusplus
extern "C" {
#endif
/** creates a clock and initializes it */
SCIP_RETCODE SCIPclockCreate(
SCIP_CLOCK** clck, /**< pointer to clock timer */
SCIP_CLOCKTYPE clocktype /**< type of clock */
);
/** frees a clock */
void SCIPclockFree(
SCIP_CLOCK** clck /**< pointer to clock timer */
);
/** initializes and resets a clock */
void SCIPclockInit(
SCIP_CLOCK* clck, /**< clock timer */
SCIP_CLOCKTYPE clocktype /**< type of clock */
);
/** completely stop the clock and reset the clock's counter to zero */
void SCIPclockReset(
SCIP_CLOCK* clck /**< clock timer */
);
/** enables the clock */
void SCIPclockEnable(
SCIP_CLOCK* clck /**< clock timer */
);
/** disables and resets the clock */
void SCIPclockDisable(
SCIP_CLOCK* clck /**< clock timer */
);
/** enables or disables \p clck, depending on the value of the flag */
void SCIPclockEnableOrDisable(
SCIP_CLOCK* clck, /**< the clock to be disabled/enabled */
SCIP_Bool enable /**< should the clock be enabled? */
);
/** sets the type of the clock, overriding the default clock type, and resets the clock */
void SCIPclockSetType(
SCIP_CLOCK* clck, /**< clock timer */
SCIP_CLOCKTYPE clocktype /**< type of clock */
);
/** starts measurement of time in the given clock, update the clock's type if it is bound to the default type */
void SCIPclockStart(
SCIP_CLOCK* clck, /**< clock timer */
SCIP_SET* set /**< global SCIP settings */
);
/** stops measurement of time in the given clock */
void SCIPclockStop(
SCIP_CLOCK* clck, /**< clock timer */
SCIP_SET* set /**< global SCIP settings */
);
/** returns whether the clock is currently running */
SCIP_Bool SCIPclockIsRunning(
SCIP_CLOCK* clck /**< clock timer */
);
/** gets the used time of this clock in seconds */
SCIP_Real SCIPclockGetTime(
SCIP_CLOCK* clck /**< clock timer */
);
/** gets the last validated time of this clock in seconds */
SCIP_Real SCIPclockGetLastTime(
SCIP_CLOCK* clck /**< clock timer */
);
/** sets the used time of this clock in seconds */
void SCIPclockSetTime(
SCIP_CLOCK* clck, /**< clock timer */
SCIP_Real sec /**< time in seconds to set the clock's timer to */
);
/** gets current time of day in seconds (standard time zone) */
SCIP_Real SCIPclockGetTimeOfDay(
void
);
#ifdef __cplusplus
}
#endif
#endif