...one of the most highly
regarded and expertly designed C++ library projects in the
world.
— Herb Sutter and Andrei
Alexandrescu, C++
Coding Standards
Copyright © 2008 Howard Hinnant
Copyright © 2006, 2008 Beman Dawes
Copyright © 2009-2011 Vicente J. Botet Escriba
Distributed under the Boost Software License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
Table of Contents
]
]
“What is time, then? If nobody asks me, I know; if I have to explain it to someone who has asked me, I do not know."”
-- Augustine
This documentation makes use of the following naming and formatting conventions.
fixed width
font
and is syntax-highlighted.
italics
.
()
, as in free_function()
.
class_template<>
;
that is, it is in code font and its name is followed by <>
to indicate that it is a class template.
MACRO()
;
that is, it is uppercase in code font and its name is followed by ()
to indicate that it is a function-like
macro. Object-like macros appear without the trailing ()
.
Note | |
---|---|
In addition, notes such as this one specify non-essential information that provides additional background or rationale. |
Finally, you can mentally add the following to any code fragments in this document:
// Include all of Chrono files #include <boost/chrono.hpp>
We all deal with time every day of our lives. We've intuitively known it since birth. Thus we are all very familiar with it and believe it to be a simple matter. The modeling of time in computer programs should be similarly simple. The unfortunate truth is that this perceived simplicity is only skin deep. Fortunately, we do not need a terribly complicated solution to meet the bulk of our needs. However, overly simplistic solutions can be dangerous and inefficient, and won't adapt as the computer industry evolves.
Boost.Chrono aims to implement the new time facilities in C++0x, as proposed in N2661 - A Foundation to Sleep On. That document provides background and motivation for key design decisions and is the source of a good deal of information in this documentation.
To make the timing facilities of Boost.Chrono more generally useful, the
library provides a number of clocks that are thin wrappers around the operating
system's process time API, thereby allowing the extraction of wall clock
time, user CPU time, and system CPU time of the process. Wall clock time
is the sum of CPU time and system CPU time. (On POSIX-like systems, this
relies on times()
.
On Windows, it relies on GetProcessTimes()
.)
The Boost.Chrono library provides:
duration
class . Examples of
time durations include days, minutes
, seconds
and nanoseconds
, which can be represented
with a fixed number of clock ticks per unit. All of these units of time
duration are united with a generic interface by the duration
facility.
time_point
. A time_point
represents an epoch
plus or minus a duration
. The library leaves
epochs unspecified. A time_point
is associated with
a clock.
system_clock
, steady_clock
and high_resolution_clock
. A clock
is a pairing of a time_point
and duration
, and a function which
returns a time_point
representing now.
To make the timing facilities more generally useful, Boost.Chrono provides a number of clocks that are thin wrappers around the operating system's time APIs, thereby allowing the extraction of wall clock time, user CPU time, system CPU time spent by the process,
process_real_cpu_clock
, captures
wall clock CPU time spent by the current process.
process_user_cpu_clock
, captures
user-CPU time spent by the current process.
process_system_cpu_clock
, captures
system-CPU time spent by the current process.
process_cpu_clock
, that captures
real, user-CPU, and system-CPU process times together.
thread_clock
thread steady clock
giving the time spent by the current thread (when supported by a platform).
Lastly, Boost.Chrono includes typeof
registration for duration
and time_point
to permit using emulated
auto with C++03 compilers.
It provides I/O for duration
and time_point
. It builds on <boost/ratio/ratio_io.hpp>
to provide readable and flexible formatting and parsing for types in <boost/chrono.hpp>
.
The duration
unit names can be customized
through a new facet: duration_punct
.
A few simple rounding utility functions for working with durations.
The underlying clocks provided by operating systems are subject to many seemingly arbitrary policies and implementation irregularities. That's a polite way of saying they tend to be flakey, and each operating system or even each clock has its own cruel and unusual forms of flakiness. Don't bet the farm on their accuracy, unless you have become deeply familiar with exactly what the specific operating system is guaranteeing, which is often very little.
Last revised: June 23, 2012 at 08:49:10 GMT |