/usr/include/vigra/timing.hxx is in libvigraimpex-dev 1.10.0+dfsg-3ubuntu2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 361 362 363 364 365 366 367 368 369 370 371 372 373 374 | /************************************************************************/
/* */
/* Copyright 2008-2011 by Ullrich Koethe */
/* Cognitive Systems Group, University of Hamburg, Germany */
/* */
/* This file is part of the VIGRA computer vision library. */
/* The VIGRA Website is */
/* http://kogs-www.informatik.uni-hamburg.de/~koethe/vigra/ */
/* Please direct questions, bug reports, and contributions to */
/* ullrich.koethe@iwr.uni-heidelberg.de or */
/* vigra@informatik.uni-hamburg.de */
/* */
/* Permission is hereby granted, free of charge, to any person */
/* obtaining a copy of this software and associated documentation */
/* files (the "Software"), to deal in the Software without */
/* restriction, including without limitation the rights to use, */
/* copy, modify, merge, publish, distribute, sublicense, and/or */
/* sell copies of the Software, and to permit persons to whom the */
/* Software is furnished to do so, subject to the following */
/* conditions: */
/* */
/* The above copyright notice and this permission notice shall be */
/* included in all copies or substantial portions of the */
/* Software. */
/* */
/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND */
/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES */
/* OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND */
/* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT */
/* HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, */
/* WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING */
/* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR */
/* OTHER DEALINGS IN THE SOFTWARE. */
/* */
/************************************************************************/
#ifndef VIGRA_TIMING_HXX
#define VIGRA_TIMING_HXX
#ifndef VIGRA_NO_TIMING
#include <iostream>
#include <sstream>
#include <vector>
/** \page TimingMacros Timing macros for runtime measurements
<b>\#include</b> \<vigra/timing.hxx\>
These macros allow to perform execution speed measurements. Results are reported
in <i>milliseconds</i>.
However, note that timings below 1 msec are generally subject to round-off errors.
Under LINUX, you can \#define VIGRA_HIRES_TIMING to get better
accuracy, but this requires linking against librt.
Basic usage:
\code
void time_it()
{
USETICTOC
TIC
... code to be timed
TOC
... untimed code
TIC
... other code to be timed
TOC
}
\endcode
Instead of TOC, which outputs the time difference to std::cerr,
you may use TOCN (the time difference in <i>msec</i> as a double)
or TOCS (the time difference as a std::string).
Alternatively, you can perform nested timing like so:
\code
void time_it()
{
USE_NESTED_TICTOC
TICPUSH
... code to be timed
TICPUSH
... nested code to be timed
TOC print time for nested code
... more code to be timed
TOC print total time
}
\endcode
*/
/** \file timing.hxx Timing macros for runtime measurements
This header defines timing macros for runtime measurements. See \ref TimingMacros for examples.
\def USETICTOC
Enable timing using TIC/TOC* pairs. This macro defines temporary storage for the timing data, so it needs to precede the TIC/TOC macros in their context.
\hideinitializer
\def USE_NESTED_TICTOC
Enable timing using TICPUSH/TOC* pairs. This macro defines temporary storage for the timing data, so it needs to precede the TIC/TOC macros in their context.
\hideinitializer
\def TIC
Start timing. Requires USE_TICTOC to be defined in the current context.
\hideinitializer
\def TOC
Stop timing and output result (the time difference w.r.t. the last TIC or TICPUSH
instance) to std::cerr.
\hideinitializer
\def TICPUSH
Start timing, possibly a nested block of code within some other timed code block.
Requires USE_NESTED_TICTOC to be defined once in the current context.
\hideinitializer
\def TOCN
Stop timing. This macro evaluates to the time difference (w.r.t. the last TIC
or TICPUSH) in msec as a double.
\hideinitializer
\def TOCS
Stop timing. This macro evaluates to the time difference (w.r.t. the last TIC
or TICPUSH) as a std::string (including units).
\hideinitializer
\def TICTOCLOOP_BEGIN(inner_repetitions,outer_repetitions)
Executes the code block up to TICTOCLOOP_END outer_repetitions x
inner_repetitions times. The measurement is averaged over the
inner_repetitions, and the best result of the outer_repetitions is
reported to std::cerr.
\hideinitializer
\def TICTOCLOOP_END
Ends the timing loop started with the TICTOCLOOP_BEGIN macro
and outputs the result.
\hideinitializer
*/
#ifdef _WIN32
#include "windows.h"
namespace {
inline double queryTimerUnit()
{
LARGE_INTEGER frequency;
QueryPerformanceFrequency(&frequency);
return 1000.0 / frequency.QuadPart;
}
static const double timerUnit = queryTimerUnit();
inline double tic_toc_diff_num(LARGE_INTEGER const & tic)
{
LARGE_INTEGER toc;
QueryPerformanceCounter(&toc);
return ((toc.QuadPart - tic.QuadPart) * timerUnit);
}
inline std::string tic_toc_diff_string(LARGE_INTEGER const & tic)
{
double diff = tic_toc_diff_num(tic);
std::stringstream s;
s << diff << " msec";
return s.str();
}
inline void tic_toc_diff(LARGE_INTEGER const & tic)
{
double diff = tic_toc_diff_num(tic);
std::cerr << diff << " msec" << std::endl;
}
inline double tic_toc_diff_num(std::vector<LARGE_INTEGER> & tic)
{
double res = tic_toc_diff_num(tic.back());
tic.pop_back();
return res;
}
inline std::string tic_toc_diff_string(std::vector<LARGE_INTEGER> & tic)
{
std::string res = tic_toc_diff_string(tic.back());
tic.pop_back();
return res;
}
inline void tic_toc_diff(std::vector<LARGE_INTEGER> & tic)
{
tic_toc_diff(tic.back());
tic.pop_back();
}
} // unnamed namespace
#define USETICTOC LARGE_INTEGER tic_timer;
#define USE_NESTED_TICTOC std::vector<LARGE_INTEGER> tic_timer;
#define TIC QueryPerformanceCounter(&tic_timer);
#define TICPUSH tic_timer.push_back(LARGE_INTEGER());\
QueryPerformanceCounter(&(tic_timer.back()));
#define TOC tic_toc_diff (tic_timer);
#define TOCN tic_toc_diff_num (tic_timer)
#define TOCS tic_toc_diff_string(tic_timer)
#else
#if defined(VIGRA_HIRES_TIMING) && !defined(__CYGWIN__)
// requires linking against librt
#include <time.h>
namespace {
inline double tic_toc_diff_num(timespec const & tic)
{
timespec toc;
clock_gettime(CLOCK_PROCESS_CPUTIME_ID, &toc);
return ((toc.tv_sec*1000.0 + toc.tv_nsec/1000000.0) -
(tic.tv_sec*1000.0 + tic.tv_nsec/1000000.0));
}
inline std::string tic_toc_diff_string(timespec const & tic)
{
double diff = tic_toc_diff_num(tic);
std::stringstream s;
s << diff << " msec";
return s.str();
}
inline void tic_toc_diff(timespec const & tic)
{
std::cerr << tic_toc_diff_string(tic) << std::endl;
}
inline double tic_toc_diff_num(std::vector<timespec> & tic)
{
double res = tic_toc_diff_num(tic.back());
tic.pop_back();
return res;
}
inline std::string tic_toc_diff_string(std::vector<timespec> & tic)
{
std::string res = tic_toc_diff_string(tic.back());
tic.pop_back();
return res;
}
inline void tic_toc_diff(std::vector<timespec> & tic)
{
tic_toc_diff(tic.back());
tic.pop_back();
}
} // unnamed namespace
#define USETICTOC timespec tic_timer;
#define TIC clock_gettime(CLOCK_PROCESS_CPUTIME_ID, &tic_timer);
#define TOC tic_toc_diff (tic_timer);
#define TOCN tic_toc_diff_num (tic_timer)
#define TOCS tic_toc_diff_string(tic_timer)
#define USE_NESTED_TICTOC std::vector<timespec> tic_timer;
#define TICPUSH tic_timer.push_back(timespec());\
clock_gettime(CLOCK_PROCESS_CPUTIME_ID, &(tic_timer.back()));
#else
#include <sys/time.h>
namespace {
inline double tic_toc_diff_num(timeval const & tic)
{
timeval toc;
gettimeofday(&toc, NULL);
return ((toc.tv_sec*1000.0 + toc.tv_usec/1000.0) -
(tic.tv_sec*1000.0 + tic.tv_usec/1000.0));
}
inline std::string tic_toc_diff_string(timeval const & tic)
{
double diff = tic_toc_diff_num(tic);
std::stringstream s;
s << diff << " msec";
return s.str();
}
inline void tic_toc_diff(timeval const & tic)
{
std::cerr << tic_toc_diff_string(tic)<< std::endl;
}
inline double tic_toc_diff_num(std::vector<timeval> & tic)
{
double res = tic_toc_diff_num(tic.back());
tic.pop_back();
return res;
}
inline std::string tic_toc_diff_string(std::vector<timeval> & tic)
{
std::string res = tic_toc_diff_string(tic.back());
tic.pop_back();
return res;
}
inline void tic_toc_diff(std::vector<timeval> & tic)
{
tic_toc_diff(tic.back());
tic.pop_back();
}
} // unnamed namespace
#define USETICTOC timeval tic_timer;
#define TIC gettimeofday (&tic_timer, NULL);
#define TOC tic_toc_diff (tic_timer);
#define TOCN tic_toc_diff_num (tic_timer)
#define TOCS tic_toc_diff_string(tic_timer)
#define USE_NESTED_TICTOC std::vector<timeval> tic_timer;
#define TICPUSH tic_timer.push_back(timeval());\
gettimeofday(&(tic_timer.back()), NULL);
#endif // VIGRA_HIRES_TIMING
#endif // _WIN32
// TICTOCLOOP runs the body inner_repetitions times, and minimizes the result over a number of outer_repetitions runs,
// outputting the final minimal average to std::cerr
// We enclose the loop in a dummy do { ... } while(false) in order to make this a true single statement
// (instead of just a scope).
#define TICTOCLOOP_BEGIN(inner_repetitions,outer_repetitions) \
do { \
USETICTOC \
double tictoc_best_, tictoc_inner_repetitions_=inner_repetitions; size_t tictoc_outer_repetitions_=outer_repetitions; \
for (size_t tictoccounter_=0; tictoccounter_<tictoc_outer_repetitions_; ++tictoccounter_) { \
TIC \
for (size_t tictocinnercounter_=0; tictocinnercounter_<inner_repetitions; ++tictocinnercounter_) { \
#define TICTOCLOOP_END \
} \
const double tictoc_cur_ = TOCN; \
if ((tictoccounter_==0) || (tictoc_cur_ < tictoc_best_)) \
tictoc_best_ = tictoc_cur_; \
} \
std::cerr << tictoc_best_/tictoc_inner_repetitions_ \
<< " msec (best-of-" << tictoc_outer_repetitions_ << ")" << std::endl; \
} while(false);
#else // NDEBUG
#define USETICTOC
#define TIC
#define TOC
#define TOCN 0.0
#define TICS ""
#define USE_NESTED_TICTOC
#define TICPUSH
#define TICTOCLOOP_BEGIN(inner_repetitions,outer_repetitions) do {
#define TICTOCLOOP_END } while(false);
#endif // NDEBUG
#endif // VIGRA_TIMING_HXX
|