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
// Copyright (C) 2006, 2009 International Business Machines and others.
// All Rights Reserved.
// This code is published under the Eclipse Public License.
//
// Authors: Andreas Waechter IBM 2005-09-19
#ifndef __IPTIMEDTASK_HPP__
#define __IPTIMEDTASK_HPP__
#include "IpUtils.hpp"
namespace Ipopt
{
/** This class is used to collect timing information for a particular task. */
class IPOPTLIB_EXPORT TimedTask
{
public:
/**@name Constructors/Destructors */
///@{
/** Default constructor. */
TimedTask()
:
total_cputime_(0.),
total_systime_(0.),
total_walltime_(0.),
enabled_(true),
start_called_(false),
end_called_(true)
{}
/** Default destructor */
~TimedTask()
{}
///@}
/// enable the timer
/// @since 3.14.0
void Enable()
{
enabled_ = true;
}
/// disable the timer
///
/// following calls to Start(), End(), and EndIfStarted() have no effect
/// @since 3.14.0
void Disable()
{
enabled_ = false;
}
/** Method for resetting time to zero. */
void Reset()
{
total_cputime_ = 0.;
total_systime_ = 0.;
total_walltime_ = 0.;
start_called_ = false;
end_called_ = true;
}
/** Method that is called before execution of the task. */
void Start()
{
if( !enabled_ )
{
return;
}
DBG_ASSERT(end_called_);
DBG_ASSERT(!start_called_);
end_called_ = false;
start_called_ = true;
start_cputime_ = CpuTime();
start_systime_ = SysTime();
start_walltime_ = WallclockTime();
}
/** Method that is called after execution of the task. */
void End()
{
if( !enabled_ )
{
return;
}
DBG_ASSERT(!end_called_);
DBG_ASSERT(start_called_);
end_called_ = true;
start_called_ = false;
total_cputime_ += CpuTime() - start_cputime_;
total_systime_ += SysTime() - start_systime_;
total_walltime_ += WallclockTime() - start_walltime_;
}
/** Method that is called after execution of the task for which
* timing might have been started. This only updates the timing
* if the timing has indeed been conducted. This is useful to
* stop timing after catching exceptions. */
void EndIfStarted()
{
if( !enabled_ )
{
return;
}
if( start_called_ )
{
end_called_ = true;
start_called_ = false;
total_cputime_ += CpuTime() - start_cputime_;
total_systime_ += SysTime() - start_systime_;
total_walltime_ += WallclockTime() - start_walltime_;
}
DBG_ASSERT(end_called_);
}
/** Method returning total CPU time spend for task so far. */
Number TotalCpuTime() const
{
DBG_ASSERT(end_called_);
return total_cputime_;
}
/** Method returning total system time spend for task so far. */
Number TotalSysTime() const
{
DBG_ASSERT(end_called_);
return total_systime_;
}
/** Method returning total wall clock time spend for task so far. */
Number TotalWallclockTime() const
{
DBG_ASSERT(end_called_);
return total_walltime_;
}
/** Method returning start CPU time for started task.
* @since 3.14.0
*/
Number StartCpuTime() const
{
DBG_ASSERT(start_called_);
DBG_ASSERT(!end_called_);
return start_cputime_;
}
/** Method returning start system time for started task.
* @since 3.14.0
*/
Number StartSysTime() const
{
DBG_ASSERT(start_called_);
DBG_ASSERT(!end_called_);
return start_systime_;
}
/** Method returning start wall clock time for started task.
* @since 3.14.0
*/
Number StartWallclockTime() const
{
DBG_ASSERT(start_called_);
DBG_ASSERT(!end_called_);
return start_walltime_;
}
/// @since 3.14.0
bool IsEnabled() const
{
return enabled_;
}
/// @since 3.14.0
bool IsStarted() const
{
return start_called_;
}
private:
/**@name Default Compiler Generated Methods (Hidden to avoid
* implicit creation/calling). These methods are not
* implemented and we do not want the compiler to implement them
* for us, so we declare them private and do not define
* them. This ensures that they will not be implicitly
* created/called. */
///@{
/** Copy Constructor */
TimedTask(const TimedTask&);
/** Default Assignment Operator */
void operator=(const TimedTask&);
///@}
/** CPU time at beginning of task. */
Number start_cputime_;
/** Total CPU time for task measured so far. */
Number total_cputime_;
/** System time at beginning of task. */
Number start_systime_;
/** Total system time for task measured so far. */
Number total_systime_;
/** Wall clock time at beginning of task. */
Number start_walltime_;
/** Total wall clock time for task measured so far. */
Number total_walltime_;
/** @name status fields */
///@{
bool enabled_;
bool start_called_;
bool end_called_;
///@}
};
} // namespace Ipopt
#endif