Blame boost/timer.hpp

Packit 58578d
//  boost timer.hpp header file  ---------------------------------------------//
Packit 58578d
Packit 58578d
//  Copyright Beman Dawes 1994-99.  Distributed under the Boost
Packit 58578d
//  Software License, Version 1.0. (See accompanying file
Packit 58578d
//  LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
Packit 58578d
Packit 58578d
//  See http://www.boost.org/libs/timer for documentation.
Packit 58578d
Packit 58578d
//  Revision History
Packit 58578d
//  01 Apr 01  Modified to use new <boost/limits.hpp> header. (JMaddock)
Packit 58578d
//  12 Jan 01  Change to inline implementation to allow use without library
Packit 58578d
//             builds. See docs for more rationale. (Beman Dawes) 
Packit 58578d
//  25 Sep 99  elapsed_max() and elapsed_min() added (John Maddock)
Packit 58578d
//  16 Jul 99  Second beta
Packit 58578d
//   6 Jul 99  Initial boost version
Packit 58578d
Packit 58578d
#ifndef BOOST_TIMER_HPP
Packit 58578d
#define BOOST_TIMER_HPP
Packit 58578d
Packit 58578d
#include <boost/config.hpp>
Packit 58578d
#include <ctime>
Packit 58578d
#include <boost/limits.hpp>
Packit 58578d
Packit 58578d
# ifdef BOOST_NO_STDC_NAMESPACE
Packit 58578d
    namespace std { using ::clock_t; using ::clock; }
Packit 58578d
# endif
Packit 58578d
Packit 58578d
Packit 58578d
namespace boost {
Packit 58578d
Packit 58578d
//  timer  -------------------------------------------------------------------//
Packit 58578d
Packit 58578d
//  A timer object measures elapsed time.
Packit 58578d
Packit 58578d
//  It is recommended that implementations measure wall clock rather than CPU
Packit 58578d
//  time since the intended use is performance measurement on systems where
Packit 58578d
//  total elapsed time is more important than just process or CPU time.
Packit 58578d
Packit 58578d
//  Warnings: The maximum measurable elapsed time may well be only 596.5+ hours
Packit 58578d
//  due to implementation limitations.  The accuracy of timings depends on the
Packit 58578d
//  accuracy of timing information provided by the underlying platform, and
Packit 58578d
//  this varies a great deal from platform to platform.
Packit 58578d
Packit 58578d
class timer
Packit 58578d
{
Packit 58578d
 public:
Packit 58578d
         timer() { _start_time = std::clock(); } // postcondition: elapsed()==0
Packit 58578d
//         timer( const timer& src );      // post: elapsed()==src.elapsed()
Packit 58578d
//        ~timer(){}
Packit 58578d
//  timer& operator=( const timer& src );  // post: elapsed()==src.elapsed()
Packit 58578d
  void   restart() { _start_time = std::clock(); } // post: elapsed()==0
Packit 58578d
  double elapsed() const                  // return elapsed time in seconds
Packit 58578d
    { return  double(std::clock() - _start_time) / CLOCKS_PER_SEC; }
Packit 58578d
Packit 58578d
  double elapsed_max() const   // return estimated maximum value for elapsed()
Packit 58578d
  // Portability warning: elapsed_max() may return too high a value on systems
Packit 58578d
  // where std::clock_t overflows or resets at surprising values.
Packit 58578d
  {
Packit 58578d
    return (double((std::numeric_limits<std::clock_t>::max)())
Packit 58578d
       - double(_start_time)) / double(CLOCKS_PER_SEC); 
Packit 58578d
  }
Packit 58578d
Packit 58578d
  double elapsed_min() const            // return minimum value for elapsed()
Packit 58578d
   { return double(1)/double(CLOCKS_PER_SEC); }
Packit 58578d
Packit 58578d
 private:
Packit 58578d
  std::clock_t _start_time;
Packit 58578d
}; // timer
Packit 58578d
Packit 58578d
} // namespace boost
Packit 58578d
Packit 58578d
#endif  // BOOST_TIMER_HPP