Boost-Commit :

Date view	Thread view	Subject view	Author view

Subject: [Boost-commit] svn:boost r65340 - in sandbox/chrono/libs/stopwatches/doc/html: . boost_stopwatches boost_stopwatches/appendices boost_stopwatches/overview boost_stopwatches/reference boost_stopwatches/users_guide
From: vicente.botet_at_[hidden]
Date: 2010-09-07 13:07:10

Next message: dsaritz_at_[hidden]: "[Boost-commit] svn:boost r65341 - sandbox/gil/boost/gil/extension/io2/detail"
Previous message: vicente.botet_at_[hidden]: "[Boost-commit] svn:boost r65339 - sandbox/chrono/libs/stopwatches/doc/html"

Author: viboes
Date: 2010-09-07 13:07:01 EDT (Tue, 07 Sep 2010)
New Revision: 65340
URL: http://svn.boost.org/trac/boost/changeset/65340

Log:
update doc
Added:
   sandbox/chrono/libs/stopwatches/doc/html/
   sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/
   sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/appendices/
   sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/appendices.html (contents, props changed)
   sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/appendices/acknowledgements.html (contents, props changed)
   sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/appendices/faq.html (contents, props changed)
   sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/appendices/history.html (contents, props changed)
   sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/appendices/implementation.html (contents, props changed)
   sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/appendices/perf.html (contents, props changed)
   sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/appendices/rationale.html (contents, props changed)
   sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/appendices/tests.html (contents, props changed)
   sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/appendices/tickets.html (contents, props changed)
   sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/appendices/todo.html (contents, props changed)
   sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/overview/
   sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/overview.html (contents, props changed)
   sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/overview/description.html (contents, props changed)
   sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/overview/motivation.html (contents, props changed)
   sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/reference/
   sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/reference.html (contents, props changed)
   sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/reference/formatters.html (contents, props changed)
   sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/reference/other_clocks.html (contents, props changed)
   sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/reference/reporters.html (contents, props changed)
   sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/reference/stopwatches.html (contents, props changed)
   sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/reference/stopwatches_hpp.html (contents, props changed)
   sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/users_guide/
   sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/users_guide.html (contents, props changed)
   sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/users_guide/examples.html (contents, props changed)
   sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/users_guide/getting_started.html (contents, props changed)
   sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/users_guide/tutorial.html (contents, props changed)
   sandbox/chrono/libs/stopwatches/doc/html/index.html (contents, props changed)
   sandbox/chrono/libs/stopwatches/doc/html/standalone_HTML.manifest (contents, props changed)

Added: sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/appendices.html
==============================================================================
--- (empty file)
+++ sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/appendices.html 2010-09-07 13:07:01 EDT (Tue, 07 Sep 2010)
@@ -0,0 +1,60 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>Appendices</title>
+<link rel="stylesheet" href="../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
+<link rel="start" href="../index.html" title="Boost.Stopwatches 0.1.0">
+<link rel="up" href="../index.html" title="Boost.Stopwatches 0.1.0">
+<link rel="prev" href="reference/formatters.html" title=" Stopwatch Formatters">
+<link rel="next" href="appendices/history.html" title=" Appendix A: History">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td>
+<td align="center">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="reference/formatters.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="appendices/history.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h2 class="title" style="clear: both">
+<a name="boost_stopwatches.appendices"></a>Appendices
+</h2></div></div></div>
+<div class="toc"><dl>
+<dt> Appendix A: History</dt>
+<dd><dl><dt>Version 0.1.0, September 7, 2010 </dt></dl></dd>
+<dt><a href="appendices/rationale.html"> Appendix B:
+ Rationale</a></dt>
+<dt><a href="appendices/implementation.html"> Appendix
+ C: Implementation Notes</a></dt>
+<dt> Appendix D: FAQ</dt>
+<dt><a href="appendices/acknowledgements.html"> Appendix
+ E: Acknowledgements</a></dt>
+<dt> Appendix F: Tests</dt>
+<dd><dl><dt>stopwatch</dt></dl></dd>
+<dt> Appendix G: Tickets</dt>
+<dt> Appendix H: Performances</dt>
+<dt><a href="appendices/todo.html"> Appendix I: Future
+ plans</a></dt>
+</dl></div>
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer">Copyright © 2009 -2010 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)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="reference/formatters.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="appendices/history.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/appendices/acknowledgements.html
==============================================================================
--- (empty file)
+++ sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/appendices/acknowledgements.html 2010-09-07 13:07:01 EDT (Tue, 07 Sep 2010)
@@ -0,0 +1,69 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title> Appendix
+ E: Acknowledgements</title>
+<link rel="stylesheet" href="../../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
+<link rel="start" href="../../index.html" title="Boost.Stopwatches 0.1.0">
+<link rel="up" href="../appendices.html" title="Appendices">
+<link rel="prev" href="faq.html" title=" Appendix D: FAQ">
+<link rel="next" href="tests.html" title=" Appendix F: Tests">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td>
+<td align="center">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="faq.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../appendices.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="tests.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="boost_stopwatches.appendices.acknowledgements"></a><a href="acknowledgements.html" title=" Appendix
+ E: Acknowledgements"> Appendix
+ E: Acknowledgements</a>
+</h3></div></div></div>
+
+ The library's started from the Beman Dawes <code class="computeroutput">timer<></code>, <code class="computeroutput">process_clock</code>,
+ <code class="computeroutput">process_timer</code>, <code class="computeroutput">run_timer</code> classes which are now deprecated
+ and replaced by the <a href="../reference/stopwatches.html#boost_stopwatches.reference.stopwatches.stopwatch_hpp.stopwatch" title="
+ Template Class stopwatch<>"><code class="computeroutput">stopwatch</code></a>, <code class="computeroutput">process_cpu_clock</code>
+ and <code class="computeroutput">stopclock</code> classes.
+ 
+
+ Thanks to Adrew Chinoff for its multiple suggestion on <a href="../reference/stopwatches.html#boost_stopwatches.reference.stopwatches.stopwatch_accumulator_hpp.stopwatch_accumulator" title="
+ Template Class stopwatch_accumulator<>"><code class="computeroutput">stopwatch_accumulator</code></a>, and helping
+ me to polish the documentation.
+ 
+
+ Thanks to Tom Tan for reporting some compiler issues with MSVC V10 beta and
+ MinGW-gcc-4.4.0 and for the many suggestion he did concerning the <a href="../reference/stopwatches.html#boost_stopwatches.reference.stopwatches.stopwatch_hpp.stopwatch" title="
+ Template Class stopwatch<>"><code class="computeroutput">stopwatch</code></a>, __lightweightstopwatch_, and <a href="../reference/reporters.html#boost_stopwatches.reference.reporters.stopclock_hpp.stopclock" title="
+ Template Class stopclock<>"><code class="computeroutput">stopclock</code></a> classes and a deep help
+ with wide characters implementation.
+ 
+
+ Thanks to Ronald Bock for reporting Valgind issues and for the many suggestion
+ he did concerning the documentation.
+ 
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer">Copyright © 2009 -2010 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)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="faq.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../appendices.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="tests.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/appendices/faq.html
==============================================================================
--- (empty file)
+++ sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/appendices/faq.html 2010-09-07 13:07:01 EDT (Tue, 07 Sep 2010)
@@ -0,0 +1,80 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title> Appendix D: FAQ</title>
+<link rel="stylesheet" href="../../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
+<link rel="start" href="../../index.html" title="Boost.Stopwatches 0.1.0">
+<link rel="up" href="../appendices.html" title="Appendices">
+<link rel="prev" href="implementation.html" title=" Appendix
+ C: Implementation Notes">
+<link rel="next" href="acknowledgements.html" title=" Appendix
+ E: Acknowledgements">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td>
+<td align="center">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="implementation.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../appendices.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="acknowledgements.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="boost_stopwatches.appendices.faq"></a> Appendix D: FAQ
+</h3></div></div></div>
+<a name="boost_stopwatches.appendices.faq.why_does_stopwatch_reporter_only_display_millisecond_place_precision_when_the_underlying_clock_has_nanosecond_precision_"></a><h4>
+<a name="id5047742"></a>
+ <a href="faq.html#boost_stopwatches.appendices.faq.why_does_stopwatch_reporter_only_display_millisecond_place_precision_when_the_underlying_clock_has_nanosecond_precision_">Why
+ does stopwatch_reporter only display millisecond place precision when the
+ underlying Clock has nanosecond precision?</a>
+ </h4>
+
+ To avoid giving the impression of precision where none exists. See Caveat
+ emptor. You can always specify additional decimal places if you want to live
+ dangerously.
+ 
+<a name="boost_stopwatches.appendices.faq.why_does_stopwatch_reporter_sometimes_report_more_cpu_seconds_than_real_seconds_"></a><h4>
+<a name="id5047781"></a>
+ <a href="faq.html#boost_stopwatches.appendices.faq.why_does_stopwatch_reporter_sometimes_report_more_cpu_seconds_than_real_seconds_">Why
+ does stopwatch_reporter sometimes report more cpu seconds than real seconds?</a>
+ </h4>
+
+ Ask your operating system supplier. The results have been inspected with
+ a debugger, and both for Windows and Linux, that's what the OS appears to
+ be reporting at times.
+ 
+<a name="boost_stopwatches.appendices.faq.can_i_obtain_statistics_of_the_time_elapsed_between_calls_to_a_function_"></a><h4>
+<a name="id5047814"></a>
+ <a href="faq.html#boost_stopwatches.appendices.faq.can_i_obtain_statistics_of_the_time_elapsed_between_calls_to_a_function_">Can
+ I obtain statistics of the time elapsed between calls to a function?</a>
+ </h4>
+
+ The library does not provides this feature.
+ 
+<a name="boost_stopwatches.appendices.faq.what_happens_if_i_press_ctrl_c_and_program_terminates__what_log_would_boost_stopwatches_output_"></a><h4>
+<a name="id5047842"></a>
+ <a href="faq.html#boost_stopwatches.appendices.faq.what_happens_if_i_press_ctrl_c_and_program_terminates__what_log_would_boost_stopwatches_output_">What
+ happens if I press Ctrl+C and program terminates? What log would Boost.Stopwatches
+ output?</a>
+ </h4>
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer">Copyright © 2009 -2010 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)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="implementation.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../appendices.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="acknowledgements.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/appendices/history.html
==============================================================================
--- (empty file)
+++ sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/appendices/history.html 2010-09-07 13:07:01 EDT (Tue, 07 Sep 2010)
@@ -0,0 +1,56 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title> Appendix A: History</title>
+<link rel="stylesheet" href="../../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
+<link rel="start" href="../../index.html" title="Boost.Stopwatches 0.1.0">
+<link rel="up" href="../appendices.html" title="Appendices">
+<link rel="prev" href="../appendices.html" title="Appendices">
+<link rel="next" href="rationale.html" title=" Appendix B:
+ Rationale">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td>
+<td align="center">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="../appendices.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../appendices.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="rationale.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="boost_stopwatches.appendices.history"></a> Appendix A: History
+</h3></div></div></div>
+<div class="toc"><dl><dt>Version 0.1.0, September 7, 2010 </dt></dl></div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="boost_stopwatches.appendices.history.__version_0_1_0__september_7__2010__"></a>Version 0.1.0, September 7, 2010
+</h4></div></div></div>
+
+ Features:
+ 
+<div class="itemizedlist"><ul type="disc"><li>
+ Extraction from Boost.Chrono of Boost.Stopwatches
+ </li></ul></div>
+</div>
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer">Copyright © 2009 -2010 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)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="../appendices.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../appendices.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="rationale.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/appendices/implementation.html
==============================================================================
--- (empty file)
+++ sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/appendices/implementation.html 2010-09-07 13:07:01 EDT (Tue, 07 Sep 2010)
@@ -0,0 +1,45 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title> Appendix
+ C: Implementation Notes</title>
+<link rel="stylesheet" href="../../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
+<link rel="start" href="../../index.html" title="Boost.Stopwatches 0.1.0">
+<link rel="up" href="../appendices.html" title="Appendices">
+<link rel="prev" href="rationale.html" title=" Appendix B:
+ Rationale">
+<link rel="next" href="faq.html" title=" Appendix D: FAQ">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td>
+<td align="center">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="rationale.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../appendices.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="faq.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
+</div>
+<div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title">
+<a name="boost_stopwatches.appendices.implementation"></a><a href="implementation.html" title=" Appendix
+ C: Implementation Notes"> Appendix
+ C: Implementation Notes</a>
+</h3></div></div></div></div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer">Copyright © 2009 -2010 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)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="rationale.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../appendices.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="faq.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/appendices/perf.html
==============================================================================
--- (empty file)
+++ sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/appendices/perf.html 2010-09-07 13:07:01 EDT (Tue, 07 Sep 2010)
@@ -0,0 +1,132 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title> Appendix H: Performances</title>
+<link rel="stylesheet" href="../../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
+<link rel="start" href="../../index.html" title="Boost.Stopwatches 0.1.0">
+<link rel="up" href="../appendices.html" title="Appendices">
+<link rel="prev" href="tickets.html" title=" Appendix G: Tickets">
+<link rel="next" href="todo.html" title=" Appendix I: Future
+ plans">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td>
+<td align="center">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="tickets.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../appendices.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="todo.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="boost_stopwatches.appendices.perf"></a> Appendix H: Performances
+</h3></div></div></div>
+
+ We have run some program changing how the reporting is done.
+ 
+
+ NONE: no report is done on the inner function HIGH: every call to the recursive
+ function is reported using an stopclock SUSPEND: every call to the recursive
+ function is reported using a using an stopclock on a suspendible clock ACCU:
+ every call to the recursive function is tracked using a stopclock_accumulator
+ 
+
+ We have run the programm with two different clocks, high_resolution_clock
+ and thread_clock.
+ 
+
+ The programs are either single-threaded or multi-threaded.
+ 
+
+ Two kind of inner functions are used: recursive or non recursive. In order
+ to test the influence of nesting reports, the non recursive functions use
+ up to 10 nesting levels, depending on its parameter.
+ 
+
+ the function at level n is defined as follows
+ 
+<pre class="programlisting">void fn(long v) {
+ // reporting or not
+ stopclock<> _;
+ // burn some time
+ for ( long i = 0; i < v; ++i )
+ res+=std::sqrt( res+123.456L+i ); // burn some time
+ if (v==0) return;
+
+ if (v%(n-1)==0) fn-1(v-1);
+ if (v%(n-2)==0) fn-2(v-1);
+ ...
+ f1(v-1);
+}
+</pre>
+
+ This gives a variable number in nesting reporting depending on the parameter,
+ with a variable lifetime.
+ 
+<a name="boost_stopwatches.appendices.perf.single_threaded_recursive_function"></a><h4>
+<a name="id5049648"></a>
+ <a href="perf.html#boost_stopwatches.appendices.perf.single_threaded_recursive_function">Single-Threaded
+ Recursive function</a>
+ </h4>
+
+ We have run the same program and changed how the reporting is done.
+ 
+
+ The programm creates two thread of execution. the thread entry point calls
+ a function which makes some calculation depending on its parameter and call
+ recursivelly itself decreasing the parameter.
+ 
+
+ NONE: no report is done on the inner function HIGH: every call to the recursive
+ function is reported using an stopclock SUSPEND: every call to the recursive
+ function is reported using a using an stopclock on a suspendible clock ACCU:
+ every call to the recursive function is tracked using a stopclock_accumulator
+ 
+
+ We have run the programm with two different clocks, high_resolution_clock
+ and thread_clock.
+ 
+<a name="boost_stopwatches.appendices.perf.multi_threaded_recursive_function"></a><h4>
+<a name="id5049697"></a>
+ <a href="perf.html#boost_stopwatches.appendices.perf.multi_threaded_recursive_function">Multi-Threaded
+ Recursive function</a>
+ </h4>
+
+ We have run the same program and changed how the reporting is done.
+ 
+
+ The programm creates two thread of execution. the thread entry point calls
+ a function which makes some calculation depending on its parameter and call
+ recursivelly itself decreasing the parameter.
+ 
+
+ NONE: no report is done on the inner function HIGH: every call to the recursive
+ function is reported using an stopclock SUSPEND: every call to the recursive
+ function is reported using a using an stopclock on a suspendible clock ACCU:
+ every call to the recursive function is tracked using a stopclock_accumulator
+ 
+
+ We have run the programm with two different clocks, high_resolution_clock
+ and thread_clock.
+ 
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer">Copyright © 2009 -2010 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)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="tickets.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../appendices.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="todo.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/appendices/rationale.html
==============================================================================
--- (empty file)
+++ sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/appendices/rationale.html 2010-09-07 13:07:01 EDT (Tue, 07 Sep 2010)
@@ -0,0 +1,121 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title> Appendix B:
+ Rationale</title>
+<link rel="stylesheet" href="../../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
+<link rel="start" href="../../index.html" title="Boost.Stopwatches 0.1.0">
+<link rel="up" href="../appendices.html" title="Appendices">
+<link rel="prev" href="history.html" title=" Appendix A: History">
+<link rel="next" href="implementation.html" title=" Appendix
+ C: Implementation Notes">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td>
+<td align="center">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="history.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../appendices.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="implementation.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="boost_stopwatches.appendices.rationale"></a><a href="rationale.html" title=" Appendix B:
+ Rationale"> Appendix B:
+ Rationale</a>
+</h3></div></div></div>
+<a name="boost_stopwatches.appendices.rationale.how_reliable_are_these_measures_"></a><h4>
+<a name="id5047406"></a>
+ <a href="rationale.html#boost_stopwatches.appendices.rationale.how_reliable_are_these_measures_">How
+ reliable are these measures?</a>
+ </h4>
+
+ There are three cases which can lead to get unreliable measures:
+ 
+<div class="itemizedlist"><ul type="disc"><li>
+ It is not possible to measure events that transpire at rates of the same
+ order of magnitude as the clock's precision with any reliability. For
+ example, a 10ms clock cannot be used reliably to measure elapsed times
+ of tens of milliseconds. The library provides a [high_resolution_clock]
+ that gives you the highest resolution time available on your platform.
+ That will give the best precision, but can only be used for reliable
+ measurement of events that elapse about an order of magnitude slower
+ than that clock's precision.
+ </li></ul></div>
+
+
+
+<pre class="programlisting">#include <boost/chrono/chrono.hpp>
+ ...
+ <a href="../reference/reporters.html#boost_stopwatches.reference.reporters.stopclock_hpp.stopclock" title="
+ Template Class stopclock<>"><code class="computeroutput">stopclock</code></a>< <code class="computeroutput">high_resolution_clock</code>> _;
+</pre>
+
+ 
+<div class="itemizedlist"><ul type="disc">
+<li>
+ Using a process clock in a multithreaded application will give elapsed
+ time for the process as a whole, including threads other than the calling
+ thread. To get time elapsed for a specific thread, use the supplied
+ <code class="computeroutput">thread_clock</code> which returns
+ time elapsed for the calling thread only, if supported by the platform.
+ </li>
+<li>
+ When stopclocks are nested, usually from stopclocks appearing in each
+ of several nested function calls, the overhead of the stopclock processing
+ begins to be significant relative to run time of the code being measured.
+ The innermost measurements remain accurate, but those in the outermost
+ layers can measure too much overhead to be trustworthy.
+ </li>
+<li>
+ Nested stopclocks (usually nested function calls where each function
+ contains a stopclock). When the nesting is deep enough, the cumulative
+ overhead of all the stopclock functionality make the data unreliable
+ except for the inner-most trace points. The question is, how much time
+ is related to the application code we want to measure and how much to
+ the fact we are meassuring and logging in inner blocks?
+ </li>
+</ul></div>
+
+ Most of the stopclock overhead is likely due to logging. There are two things
+ we can do to make the difference :
+ 
+<div class="itemizedlist"><ul type="disc">
+<li>
+ Don't flush log information while measuring elapsed time. A <a href="../reference/stopwatches.html#boost_stopwatches.reference.stopwatches.stopwatch_accumulator_hpp.stopwatch_accumulator" title="
+ Template Class stopwatch_accumulator<>"><code class="computeroutput">stopwatch_accumulator</code></a> can make
+ that possible, because it don't report until all the measures have been
+ compiled and then report some statistics. Alternatively, an asynchronous
+ stream would permit normal logging but by a thread other than the one
+ being measured.
+ </li>
+<li>
+ Add a mechanism to track the difference between the application time
+ and stopclock time. If a <code class="computeroutput">Clock</code>
+ models <code class="computeroutput">SuspendibleClock</code>
+ and its precision is sufficiently fine, this mechanism could suspend
+ the <code class="computeroutput">Clock</code>'s counting
+ while reporting measurements and resume it thereafter.
+ </li>
+</ul></div>
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer">Copyright © 2009 -2010 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)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="history.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../appendices.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="implementation.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/appendices/tests.html
==============================================================================
--- (empty file)
+++ sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/appendices/tests.html 2010-09-07 13:07:01 EDT (Tue, 07 Sep 2010)
@@ -0,0 +1,477 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title> Appendix F: Tests</title>
+<link rel="stylesheet" href="../../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
+<link rel="start" href="../../index.html" title="Boost.Stopwatches 0.1.0">
+<link rel="up" href="../appendices.html" title="Appendices">
+<link rel="prev" href="acknowledgements.html" title=" Appendix
+ E: Acknowledgements">
+<link rel="next" href="tickets.html" title=" Appendix G: Tickets">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td>
+<td align="center">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="acknowledgements.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../appendices.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="tickets.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="boost_stopwatches.appendices.tests"></a> Appendix F: Tests
+</h3></div></div></div>
+<div class="toc"><dl><dt>stopwatch</dt></dl></div>
+
+ In order to test you need to do.
+ 
+<pre class="programlisting">bjam libs/stopwatches/test
+</pre>
+
+ You can also run a specific suite of test by doing
+ 
+<pre class="programlisting">cd libs/stopwatches/test
+bjam stopwatch
+</pre>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="boost_stopwatches.appendices.tests.stopwatch"></a>stopwatch
+</h4></div></div></div>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Name
+ 
+ </th>
+<th>
+ 
+ kind
+ 
+ </th>
+<th>
+ 
+ Description
+ 
+ </th>
+<th>
+ 
+ Result
+ 
+ </th>
+<th>
+ 
+ Ticket
+ 
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ 
+ test_min_max
+ 
+ </td>
+<td>
+ 
+ compile
+ 
+ </td>
+<td>
+ 
+ test compilation succeeds in the presence of macros min and max.
+ 
+ </td>
+<td>
+ 
+ Pass
+ 
+ </td>
+<td>
+ 
+ #
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ stopwatch_example
+ 
+ </td>
+<td>
+ 
+ run
+ 
+ </td>
+<td>
+ 
+ ...
+ 
+ </td>
+<td>
+ 
+ Pass
+ 
+ </td>
+<td>
+ 
+ #
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ scoped_stopwatch_example
+ 
+ </td>
+<td>
+ 
+ run
+ 
+ </td>
+<td>
+ 
+ ...
+ 
+ </td>
+<td>
+ 
+ Pass
+ 
+ </td>
+<td>
+ 
+ #
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ stopwatch_accumulator_example
+ 
+ </td>
+<td>
+ 
+ run
+ 
+ </td>
+<td>
+ 
+ ...
+ 
+ </td>
+<td>
+ 
+ Pass
+ 
+ </td>
+<td>
+ 
+ #
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ specific_stopwatch_accumulator_example
+ 
+ </td>
+<td>
+ 
+ run
+ 
+ </td>
+<td>
+ 
+ ...
+ 
+ </td>
+<td>
+ 
+ Pass
+ 
+ </td>
+<td>
+ 
+ #
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ stopclock_example
+ 
+ </td>
+<td>
+ 
+ run
+ 
+ </td>
+<td>
+ 
+ ...
+ 
+ </td>
+<td>
+ 
+ Pass
+ 
+ </td>
+<td>
+ 
+ #
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ stopclock_accumulator_example
+ 
+ </td>
+<td>
+ 
+ run
+ 
+ </td>
+<td>
+ 
+ ...
+ 
+ </td>
+<td>
+ 
+ Pass
+ 
+ </td>
+<td>
+ 
+ #
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ nested_stopclock_accumulator_example
+ 
+ </td>
+<td>
+ 
+ run
+ 
+ </td>
+<td>
+ 
+ ...
+ 
+ </td>
+<td>
+ 
+ Pass
+ 
+ </td>
+<td>
+ 
+ #
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ loop_stopclock_accumulator_example
+ 
+ </td>
+<td>
+ 
+ run
+ 
+ </td>
+<td>
+ 
+ ...
+ 
+ </td>
+<td>
+ 
+ Pass
+ 
+ </td>
+<td>
+ 
+ #
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ t24_hours_example
+ 
+ </td>
+<td>
+ 
+ run
+ 
+ </td>
+<td>
+ 
+ ...
+ 
+ </td>
+<td>
+ 
+ Pass
+ 
+ </td>
+<td>
+ 
+ #
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ scoped_stopclock_example
+ 
+ </td>
+<td>
+ 
+ run
+ 
+ </td>
+<td>
+ 
+ ...
+ 
+ </td>
+<td>
+ 
+ Pass
+ 
+ </td>
+<td>
+ 
+ #
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ timex
+ 
+ </td>
+<td>
+ 
+ link
+ 
+ </td>
+<td>
+ 
+ ...
+ 
+ </td>
+<td>
+ 
+ Pass
+ 
+ </td>
+<td>
+ 
+ #
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ stopclock_constructor_overload_test
+ 
+ </td>
+<td>
+ 
+ run
+ 
+ </td>
+<td>
+ 
+ ...
+ 
+ </td>
+<td>
+ 
+ Pass
+ 
+ </td>
+<td>
+ 
+ #
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ wstopclock_constructor_overload_test
+ 
+ </td>
+<td>
+ 
+ run
+ 
+ </td>
+<td>
+ 
+ ...
+ 
+ </td>
+<td>
+ 
+ Pass
+ 
+ </td>
+<td>
+ 
+ #
+ 
+ </td>
+</tr>
+</tbody>
+</table></div>
+</div>
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer">Copyright © 2009 -2010 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)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="acknowledgements.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../appendices.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="tickets.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/appendices/tickets.html
==============================================================================
--- (empty file)
+++ sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/appendices/tickets.html 2010-09-07 13:07:01 EDT (Tue, 07 Sep 2010)
@@ -0,0 +1,250 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title> Appendix G: Tickets</title>
+<link rel="stylesheet" href="../../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
+<link rel="start" href="../../index.html" title="Boost.Stopwatches 0.1.0">
+<link rel="up" href="../appendices.html" title="Appendices">
+<link rel="prev" href="tests.html" title=" Appendix F: Tests">
+<link rel="next" href="perf.html" title=" Appendix H: Performances">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td>
+<td align="center">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="tests.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../appendices.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="perf.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="boost_stopwatches.appendices.tickets"></a> Appendix G: Tickets
+</h3></div></div></div>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Ticket
+ 
+ </th>
+<th>
+ 
+ Description
+ 
+ </th>
+<th>
+ 
+ Resolution
+ 
+ </th>
+<th>
+ 
+ State
+ 
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ 
+ 1
+ 
+ </td>
+<td>
+ 
+ suspend doesn't works: partial_ not initialized
+ 
+ </td>
+<td>
+ 
+ initialize with duration::zero()
+ 
+ </td>
+<td>
+ 
+ Closed
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ 2
+ 
+ </td>
+<td>
+ 
+ suspend doesn't works: elapsed doesn't take care of partial_
+ 
+ </td>
+<td>
+ 
+ take care of partial
+ 
+ </td>
+<td>
+ 
+ Closed
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ 3
+ 
+ </td>
+<td>
+ 
+ suspend doesn't works: bad use of system::error_code & ec
+ 
+ </td>
+<td>
+ 
+ replace by system::error_code ec
+ 
+ </td>
+<td>
+ 
+ Closed
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ 4
+ 
+ </td>
+<td>
+ 
+ Use of Specific formatters doesn't works
+ 
+ </td>
+<td>
+ </td>
+<td>
+ 
+ Closed
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ 5
+ 
+ </td>
+<td>
+ 
+ boost/chrono/scoped_suspend.hpp(31) : warning C4520: 'boost::chrono::scoped_suspend<Clock>'
+ : multiple default constructors specified
+ 
+ </td>
+<td>
+ 
+ Remove the default constructor deletion
+ 
+ </td>
+<td>
+ 
+ Closed
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ 6
+ 
+ </td>
+<td>
+ 
+ suspendible_clock_test doesn't works in my mingw environement
+ 
+ </td>
+<td>
+ 
+ (issue with tss)
+ 
+ </td>
+<td>
+ 
+ Open
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ 7
+ 
+ </td>
+<td>
+ 
+ error_code not initialized
+ 
+ </td>
+<td>
+ 
+ Use ec.clear() before throwing a exception.
+ 
+ </td>
+<td>
+ 
+ Closed
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ 8
+ 
+ </td>
+<td>
+ 
+ Valgrind issue: Conditional jump or move depends on uninitialised
+ value(s)
+ 
+ </td>
+<td>
+ 
+ Replace the test
+ 
+ </td>
+<td>
+ 
+ Closed
+ 
+ </td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer">Copyright © 2009 -2010 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)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="tests.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../appendices.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="perf.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/appendices/todo.html
==============================================================================
--- (empty file)
+++ sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/appendices/todo.html 2010-09-07 13:07:01 EDT (Tue, 07 Sep 2010)
@@ -0,0 +1,60 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title> Appendix I: Future
+ plans</title>
+<link rel="stylesheet" href="../../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
+<link rel="start" href="../../index.html" title="Boost.Stopwatches 0.1.0">
+<link rel="up" href="../appendices.html" title="Appendices">
+<link rel="prev" href="perf.html" title=" Appendix H: Performances">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td>
+<td align="center">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="perf.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../appendices.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="boost_stopwatches.appendices.todo"></a><a href="todo.html" title=" Appendix I: Future
+ plans"> Appendix I: Future
+ plans</a>
+</h3></div></div></div>
+<a name="boost_stopwatches.appendices.todo.tasks_to_do"></a><h4>
+<a name="id4941971"></a>
+ Tasks to do
+ </h4>
+<div class="itemizedlist"><ul type="disc">
+<li>
+ Complete documentation
+ </li>
+<li>
+ Fully implement error handling, with test cases.
+ </li>
+<li>
+ Fix open isues.
+ </li>
+</ul></div>
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer">Copyright © 2009 -2010 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)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="perf.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../appendices.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a>
+</div>
+</body>
+</html>

Added: sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/overview.html
==============================================================================
--- (empty file)
+++ sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/overview.html 2010-09-07 13:07:01 EDT (Tue, 07 Sep 2010)
@@ -0,0 +1,100 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>Overview</title>
+<link rel="stylesheet" href="../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
+<link rel="start" href="../index.html" title="Boost.Stopwatches 0.1.0">
+<link rel="up" href="../index.html" title="Boost.Stopwatches 0.1.0">
+<link rel="prev" href="../index.html" title="Boost.Stopwatches 0.1.0">
+<link rel="next" href="overview/motivation.html" title="Motivation">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td>
+<td align="center">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="../index.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="overview/motivation.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h2 class="title" style="clear: both">
+<a name="boost_stopwatches.overview"></a>Overview
+</h2></div></div></div>
+<div class="toc"><dl>
+<dt>Motivation</dt>
+<dt>Description</dt>
+</dl></div>
+<a name="boost_stopwatches.overview.how_to_use_this_documentation"></a><h3>
+<a name="id4986969"></a>
+ <a href="overview.html#boost_stopwatches.overview.how_to_use_this_documentation">How
+ to Use This Documentation</a>
+ </h3>
+
+ This documentation makes use of the following naming and formatting conventions.
+ 
+<div class="itemizedlist"><ul type="disc">
+<li>
+ Code is in <code class="computeroutput">fixed width
+ font</code> and is syntax-highlighted.
+ </li>
+<li>
+ Replaceable text that you will need to supply is in <code>italics</code>.
+ </li>
+<li>
+ Free functions are rendered in the code font followed by (), as in free_function().
+ </li>
+<li>
+ If a name refers to a class template, it is specified like this: <code class="computeroutput">class_template<></code>;
+ that is, it is in code font and its name is followed by <code class="computeroutput"><></code>
+ to indicate that it is a class template.
+ </li>
+<li>
+ If a name refers to a function-like macro, it is specified like this:
+ <code class="computeroutput">MACRO()</code>;
+ that is, it is uppercase in code font and its name is followed by <code class="computeroutput">()</code> to indicate that it is a function-like
+ macro. Object-like macros appear without the trailing <code class="computeroutput">()</code>.
+ </li>
+<li>
+ Names that refer to concepts in the generic programming
+ sense are specified in CamelCase.
+ </li>
+</ul></div>
+<div class="note"><table border="0" summary="Note">
+<tr>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../doc/src/images/note.png"></td>
+<th align="left">Note</th>
+</tr>
+<tr><td align="left" valign="top">
+ In addition, notes such as this one specify non-essential information that
+ provides additional background or rationale.
+ </td></tr>
+</table></div>
+
+ Finally, you can mentally add the following to any code fragments in this document:
+ 
+<pre class="programlisting">// Include all of Stopwatches files
+#include <boost/stopwatches.hpp>
+using namespace boost::chrono;
+using namespace boost::stopwatches;
+</pre>
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer">Copyright © 2009 -2010 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)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="../index.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="overview/motivation.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/overview/description.html
==============================================================================
--- (empty file)
+++ sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/overview/description.html 2010-09-07 13:07:01 EDT (Tue, 07 Sep 2010)
@@ -0,0 +1,97 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>Description</title>
+<link rel="stylesheet" href="../../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
+<link rel="start" href="../../index.html" title="Boost.Stopwatches 0.1.0">
+<link rel="up" href="../overview.html" title="Overview">
+<link rel="prev" href="motivation.html" title="Motivation">
+<link rel="next" href="../users_guide.html" title=" Users'Guide">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td>
+<td align="center">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="motivation.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../overview.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../users_guide.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="boost_stopwatches.overview.description"></a>Description
+</h3></div></div></div>
+
+ On top of the standard facilities of Boost.Chrono,
+ Boost.Stopwatches provides:
+ 
+<div class="itemizedlist"><ul type="disc">
+<li>
+ Stopwatches: A facility to measure elapsed time with the ability to start,
+ stop, suspend, or resume measurement.
+ <div class="itemizedlist"><ul type="circle">
+<li>
+ <a href="../reference/stopwatches.html#boost_stopwatches.reference.stopwatches.stopwatch_req" title="
+ Stopwatch Requirements"><code class="computeroutput">Stopwatch</code></a> concept
+ </li>
+<li>
+ Scoped helper classes allowing to pairwise start/stop operations,
+ suspend/resume and resume/suspend a <a href="../reference/stopwatches.html#boost_stopwatches.reference.stopwatches.stopwatch_req" title="
+ Stopwatch Requirements"><code class="computeroutput">Stopwatch</code></a>.
+ </li>
+<li>
+ <a href="../reference/stopwatches.html#boost_stopwatches.reference.stopwatches.stopwatch_hpp.stopwatch" title="
+ Template Class stopwatch<>"><code class="computeroutput">stopwatch</code></a>, model of <a href="../reference/stopwatches.html#boost_stopwatches.reference.stopwatches.stopwatch_req" title="
+ Stopwatch Requirements"><code class="computeroutput">Stopwatch</code></a> capturing elapsed
+ <code class="computeroutput">Clock</code> times.
+ </li>
+<li>
+ <a href="../reference/stopwatches.html#boost_stopwatches.reference.stopwatches.stopwatch_accumulator_hpp.stopwatch_accumulator" title="
+ Template Class stopwatch_accumulator<>"><code class="computeroutput">stopwatch_accumulator</code></a>,
+ model of <a href="../reference/stopwatches.html#boost_stopwatches.reference.stopwatches.stopwatch_req" title="
+ Stopwatch Requirements"><code class="computeroutput">Stopwatch</code></a> capturing cummulated
+ elapsed Clock times.
+ </li>
+</ul></div>
+ </li>
+<li>
+ Stopclocks: a complete time reporting package that can be invoked in
+ a single line of code.
+ <div class="itemizedlist"><ul type="circle">
+<li>
+ <a href="../reference/reporters.html#boost_stopwatches.reference.reporters.stopwatch_reporter_hpp.stopwatch_reporter" title="
+ Template Class stopwatch_reporter<>"><code class="computeroutput">stopwatch_reporter</code></a>, convenient
+ reporting to an output stream (including wide char streams) of
+ the elapsed time of models of <a href="../reference/stopwatches.html#boost_stopwatches.reference.stopwatches.stopwatch_req" title="
+ Stopwatch Requirements"><code class="computeroutput">Stopwatch</code></a> results.
+ </li>
+<li>
+ <a href="../reference/reporters.html#boost_stopwatches.reference.reporters.stopclock_hpp.stopclock" title="
+ Template Class stopclock<>"><code class="computeroutput">stopclock<Clock></code></a>
+ shortcut of <code class="computeroutput"><a href="../reference/reporters.html#boost_stopwatches.reference.reporters.stopwatch_reporter_hpp.stopwatch_reporter" title="
+ Template Class stopwatch_reporter<>"><code class="computeroutput">stopwatch_reporter</code></a><<a href="../reference/stopwatches.html#boost_stopwatches.reference.stopwatches.stopwatch_hpp.stopwatch" title="
+ Template Class stopwatch<>"><code class="computeroutput">stopwatch</code></a><Clock>></code>
+ </li>
+</ul></div>
+ </li>
+</ul></div>
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer">Copyright © 2009 -2010 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)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="motivation.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../overview.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../users_guide.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/overview/motivation.html
==============================================================================
--- (empty file)
+++ sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/overview/motivation.html 2010-09-07 13:07:01 EDT (Tue, 07 Sep 2010)
@@ -0,0 +1,113 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>Motivation</title>
+<link rel="stylesheet" href="../../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
+<link rel="start" href="../../index.html" title="Boost.Stopwatches 0.1.0">
+<link rel="up" href="../overview.html" title="Overview">
+<link rel="prev" href="../overview.html" title="Overview">
+<link rel="next" href="description.html" title="Description">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td>
+<td align="center">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="../overview.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../overview.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="description.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="boost_stopwatches.overview.motivation"></a>Motivation
+</h3></div></div></div>
+<a name="boost_stopwatches.overview.motivation.measuring_elapsed_time"></a><h4>
+<a name="id4948837"></a>
+ <a href="motivation.html#boost_stopwatches.overview.motivation.measuring_elapsed_time">Measuring
+ elapsed time</a>
+ </h4>
+
+ Knowing how long a program, a function or a specific code block takes to
+ execute is useful in both test and production environments. Boost.Stopwatches
+ introduces the <a href="../reference/stopwatches.html#boost_stopwatches.reference.stopwatches.stopwatch_req" title="
+ Stopwatch Requirements"><code class="computeroutput">Stopwatch</code></a> concept which is a mechanism
+ to measure the elapsed time. A Stopwatch allows to start, stop, suspend and
+ resume measuring the elapsed time. <a href="../reference/stopwatches.html#boost_stopwatches.reference.stopwatches.stopwatch_hpp.stopwatch" title="
+ Template Class stopwatch<>"><code class="computeroutput">stopwatch</code></a><code class="computeroutput"><></code>
+ is the basic model of <a href="../reference/stopwatches.html#boost_stopwatches.reference.stopwatches.stopwatch_req" title="
+ Stopwatch Requirements"><code class="computeroutput">Stopwatch</code></a>.
+ 
+<a name="boost_stopwatches.overview.motivation.reporting_elapsed_time"></a><h4>
+<a name="id4948927"></a>
+ <a href="motivation.html#boost_stopwatches.overview.motivation.reporting_elapsed_time">Reporting
+ elapsed time</a>
+ </h4>
+
+ It is often necessary to report elapsed time on a user display or in a log
+ file. <a href="../reference/reporters.html#boost_stopwatches.reference.reporters.stopwatch_reporter_hpp.stopwatch_reporter" title="
+ Template Class stopwatch_reporter<>"><code class="computeroutput">stopwatch_reporter</code></a><> provides
+ a runtime reporting mechanism for this purpose which can be invoked in just
+ one line of code.
+ 
+<pre class="programlisting">using namespace boost::chrono;
+using namespace boost::stopwatches;
+int main()
+{
+ stopwatch_reporter<stopwatch<process_cpu_clock> > _;
+ // ...
+}
+</pre>
+
+ Will produce the following output
+ 
+<pre class="programlisting">real 0.034s, cpu 0.031s (93.0%), user 0.031s, system 0.000s
+</pre>
+
+ As this is one of the expression more commonly use, the library provides
+ a stopclock shortcut so the preceding can be writen as
+ 
+<pre class="programlisting">using namespace boost::stopwatches;
+int main()
+{
+ <a href="../reference/reporters.html#boost_stopwatches.reference.reporters.stopclock_hpp.stopclock" title="
+ Template Class stopclock<>"><code class="computeroutput">stopclock</code></a><> _;
+ // ...
+}
+</pre>
+<a name="boost_stopwatches.overview.motivation.how_reliable_are_these_measures_"></a><h4>
+<a name="id4949316"></a>
+ <a href="motivation.html#boost_stopwatches.overview.motivation.how_reliable_are_these_measures_">How
+ reliable are these measures?</a>
+ </h4>
+
+ There are a number of things that can lead to unreliable measurement (see
+ <a href="../appendices/rationale.html" title=" Appendix B:
+ Rationale">here</a> for more
+ details), but they mostly amount to reporting overhead. Boost.Chrono provides
+ two ways to improve reliability of time measurements. A <a href="../reference/stopwatches.html#boost_stopwatches.reference.stopwatches.stopwatch_accumulator_hpp.stopwatch_accumulator" title="
+ Template Class stopwatch_accumulator<>"><code class="computeroutput">stopwatch_accumulator</code></a> only reports
+ statistics once all measurements have been acquired, which removes reporting
+ overhead from the measurements. The other approach is to use a <code class="computeroutput">SuspendibleClock</code> such that the reporting
+ overhead can be ignored by suspending elapsed time tracking during reporting
+ operations
+ 
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer">Copyright © 2009 -2010 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)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="../overview.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../overview.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="description.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/reference.html
==============================================================================
--- (empty file)
+++ sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/reference.html 2010-09-07 13:07:01 EDT (Tue, 07 Sep 2010)
@@ -0,0 +1,99 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title> Reference </title>
+<link rel="stylesheet" href="../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
+<link rel="start" href="../index.html" title="Boost.Stopwatches 0.1.0">
+<link rel="up" href="../index.html" title="Boost.Stopwatches 0.1.0">
+<link rel="prev" href="users_guide/examples.html" title="Examples">
+<link rel="next" href="reference/stopwatches_hpp.html" title=" Header
+ <boost/stopwatches.hpp>">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td>
+<td align="center">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="users_guide/examples.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="reference/stopwatches_hpp.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h2 class="title" style="clear: both">
+<a name="boost_stopwatches.reference"></a> Reference
+</h2></div></div></div>
+<div class="toc"><dl>
+<dt><a href="reference/stopwatches_hpp.html"> Header
+ <code class="computeroutput"><boost/stopwatches.hpp></code></a></dt>
+<dt> Other clocks</dt>
+<dd><dl>
+<dt><a href="reference/other_clocks.html#boost_stopwatches.reference.other_clocks.suspendible_clock_req">
+ <code class="computeroutput">SuspendibleClock</code> Requirements</a></dt>
+<dt><a href="reference/other_clocks.html#boost_stopwatches.reference.other_clocks.scoped_suspend_hpp">
+ Header <code class="computeroutput"><boost/stopwatches/scoped_suspend.hpp></code></a></dt>
+<dt><a href="reference/other_clocks.html#boost_stopwatches.reference.other_clocks.suspendible_clock_hpp">
+ Header <code class="computeroutput"><boost/stopwatches/suspendible_clock.hpp></code></a></dt>
+</dl></dd>
+<dt> Stopwatches</dt>
+<dd><dl>
+<dt><a href="reference/stopwatches.html#boost_stopwatches.reference.stopwatches.stopwatch_req">
+ <code class="computeroutput">Stopwatch</code> Requirements</a></dt>
+<dt><a href="reference/stopwatches.html#boost_stopwatches.reference.stopwatches.lightweight_stopwatch_hpp">
+ Header <code class="computeroutput"><boost/stopwatches/lightweight_stopwatch.hpp></code></a></dt>
+<dt><a href="reference/stopwatches.html#boost_stopwatches.reference.stopwatches.stopwatch_hpp">
+ Header <code class="computeroutput"><boost/stopwatches/stopwatch.hpp></code></a></dt>
+<dt><a href="reference/stopwatches.html#boost_stopwatches.reference.stopwatches.stopwatch_accumulator_hpp">
+ Header <code class="computeroutput"><boost/stopwatches/stopwatch_accumulator.hpp></code></a></dt>
+<dt><a href="reference/stopwatches.html#boost_stopwatches.reference.stopwatches.stopwatch_scoped_hpp">
+ Header <code class="computeroutput"><boost/stopwatches/stopwatch_scoped.hpp></code></a></dt>
+</dl></dd>
+<dt> Stopwatch Reporters</dt>
+<dd><dl>
+<dt><a href="reference/reporters.html#boost_stopwatches.reference.reporters.formatter_req">
+ <code class="computeroutput">Formatter</code> Requirements</a></dt>
+<dt>Formatter related traits</dt>
+<dt><a href="reference/reporters.html#boost_stopwatches.reference.reporters.stopwatch_reporter_hpp">
+ Header <code class="computeroutput"><boost/stopwatches/stopwatch_reporter.hpp></code></a></dt>
+<dt><a href="reference/reporters.html#boost_stopwatches.reference.reporters.stopclock_hpp">
+ Header <code class="computeroutput"><boost/stopwatches/stopclock.hpp></code></a></dt>
+<dt><a href="reference/reporters.html#boost_stopwatches.reference.reporters.stopclock_accumulator_hpp">
+ Header <code class="computeroutput"><boost/stopwatches/stopclock_accumulator.hpp></code></a></dt>
+<dt><a href="reference/reporters.html#boost_stopwatches.reference.reporters.scoped_stopclock_hpp">
+ Header <code class="computeroutput"><boost/stopwatches/scoped_stopclock.hpp></code></a></dt>
+</dl></dd>
+<dt> Stopwatch Formatters</dt>
+<dd><dl>
+<dt><a href="reference/formatters.html#boost_stopwatches.reference.formatters.stopwatch_formatter_hpp">
+ Header <code class="computeroutput"><boost/stopwatches/stopwatch_formatter.hpp></code></a></dt>
+<dt><a href="reference/formatters.html#boost_stopwatches.reference.formatters.stopwatch_accumulator_formatter_hpp">
+ Header <code class="computeroutput"><boost/stopwatches/stopwatch_accumulator_formatter.hpp></code></a></dt>
+<dt><a href="reference/formatters.html#boost_stopwatches.reference.formatters.time_formatter_hpp">
+ Header <code class="computeroutput"><boost/stopwatches/time_formatter.hpp></code></a></dt>
+<dt><a href="reference/formatters.html#boost_stopwatches.reference.formatters.stopwatch_accumulator_time_formatter_hpp">
+ Header <code class="computeroutput"><boost/stopwatches/stopwatch_accumulator_time_formatter.hpp></code></a></dt>
+<dt><a href="reference/formatters.html#boost_stopwatches.reference.formatters.t24_hours_hpp">
+ Header <code class="computeroutput"><boost/stopwatches/t24_hours.hpp></code></a></dt>
+<dt><a href="reference/formatters.html#boost_stopwatches.reference.formatters.t24_hours_formatter_hpp">
+ Header <code class="computeroutput"><boost/stopwatches/t24_hours_formatter.hpp></code></a></dt>
+</dl></dd>
+</dl></div>
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer">Copyright © 2009 -2010 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)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="users_guide/examples.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="reference/stopwatches_hpp.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/reference/formatters.html
==============================================================================
--- (empty file)
+++ sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/reference/formatters.html 2010-09-07 13:07:01 EDT (Tue, 07 Sep 2010)
@@ -0,0 +1,706 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title> Stopwatch Formatters</title>
+<link rel="stylesheet" href="../../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
+<link rel="start" href="../../index.html" title="Boost.Stopwatches 0.1.0">
+<link rel="up" href="../reference.html" title=" Reference ">
+<link rel="prev" href="reporters.html" title=" Stopwatch Reporters">
+<link rel="next" href="../appendices.html" title="Appendices">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td>
+<td align="center">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="reporters.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../appendices.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="boost_stopwatches.reference.formatters"></a> Stopwatch Formatters
+</h3></div></div></div>
+<div class="toc"><dl>
+<dt><a href="formatters.html#boost_stopwatches.reference.formatters.stopwatch_formatter_hpp">
+ Header <code class="computeroutput"><boost/stopwatches/stopwatch_formatter.hpp></code></a></dt>
+<dd><dl><dt><a href="formatters.html#boost_stopwatches.reference.formatters.stopwatch_formatter_hpp.basic_stopwatch_formatter">
+ Template Class <code class="computeroutput">basic_stopwatch_formatter<></code></a></dt></dl></dd>
+<dt><a href="formatters.html#boost_stopwatches.reference.formatters.stopwatch_accumulator_formatter_hpp">
+ Header <code class="computeroutput"><boost/stopwatches/stopwatch_accumulator_formatter.hpp></code></a></dt>
+<dd><dl>
+<dt><a href="formatters.html#boost_stopwatches.reference.formatters.stopwatch_accumulator_formatter_hpp.basic_stopwatch_accumulator_formatter">
+ Template Class <code class="computeroutput">basic_stopwatch_accumulator_formatter<></code></a></dt>
+<dt><a href="formatters.html#boost_stopwatches.reference.formatters.stopwatch_accumulator_formatter_hpp.typedefs">
+ <code class="computeroutput">basic_stopwatch_accumulator_formatter</code>
+ useful typedefs</a></dt>
+</dl></dd>
+<dt><a href="formatters.html#boost_stopwatches.reference.formatters.time_formatter_hpp">
+ Header <code class="computeroutput"><boost/stopwatches/time_formatter.hpp></code></a></dt>
+<dd><dl>
+<dt><a href="formatters.html#boost_stopwatches.reference.formatters.time_formatter_hpp.basic_time_formatter">
+ Template Class <code class="computeroutput">basic_time_formatter<></code></a></dt>
+<dt><a href="formatters.html#boost_stopwatches.reference.formatters.time_formatter_hpp.typedefs">
+ <code class="computeroutput">basic_time_formatter</code> useful
+ typedefs</a></dt>
+<dt><a href="formatters.html#boost_stopwatches.reference.formatters.time_formatter_hpp.spec">
+ <code class="computeroutput">stopwatch_reporter_default_formatter</code>
+ Specialization</a></dt>
+</dl></dd>
+<dt><a href="formatters.html#boost_stopwatches.reference.formatters.stopwatch_accumulator_time_formatter_hpp">
+ Header <code class="computeroutput"><boost/stopwatches/stopwatch_accumulator_time_formatter.hpp></code></a></dt>
+<dd><dl>
+<dt><a href="formatters.html#boost_stopwatches.reference.formatters.stopwatch_accumulator_time_formatter_hpp.basic_stopwatch_accumulator_time_formatter">
+ Template Class <code class="computeroutput">basic_stopwatch_accumulator_time_formatter<></code></a></dt>
+<dt><a href="formatters.html#boost_stopwatches.reference.formatters.stopwatch_accumulator_time_formatter_hpp.typedefs">
+ <code class="computeroutput">basic_stopwatch_accumulator_time_formatter</code>
+ useful typedefs</a></dt>
+</dl></dd>
+<dt><a href="formatters.html#boost_stopwatches.reference.formatters.t24_hours_hpp">
+ Header <code class="computeroutput"><boost/stopwatches/t24_hours.hpp></code></a></dt>
+<dd><dl><dt><a href="formatters.html#boost_stopwatches.reference.formatters.t24_hours_hpp.t24_hours">
+ Class <code class="computeroutput">t24_hours</code></a></dt></dl></dd>
+<dt><a href="formatters.html#boost_stopwatches.reference.formatters.t24_hours_formatter_hpp">
+ Header <code class="computeroutput"><boost/stopwatches/t24_hours_formatter.hpp></code></a></dt>
+<dd><dl>
+<dt><a href="formatters.html#boost_stopwatches.reference.formatters.t24_hours_formatter_hpp.basic_24_hours_formatter">
+ Template Class <code class="computeroutput">basic_24_hours_formatter<></code></a></dt>
+<dt><a href="formatters.html#boost_stopwatches.reference.formatters.t24_hours_formatter_hpp.typedefs">
+ <code class="computeroutput">basic_24_hours_formatter</code>
+ useful typedefs</a></dt>
+</dl></dd>
+</dl></div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="boost_stopwatches.reference.formatters.stopwatch_formatter_hpp"></a><a href="formatters.html#boost_stopwatches.reference.formatters.stopwatch_formatter_hpp" title="
+ Header <boost/stopwatches/stopwatch_formatter.hpp>">
+ Header <code class="computeroutput"><boost/stopwatches/stopwatch_formatter.hpp></code></a>
+</h4></div></div></div>
+<div class="toc"><dl><dt><a href="formatters.html#boost_stopwatches.reference.formatters.stopwatch_formatter_hpp.basic_stopwatch_formatter">
+ Template Class <code class="computeroutput">basic_stopwatch_formatter<></code></a></dt></dl></div>
+<pre class="programlisting">namespace boost { namespace stopwatches {
+ template <
+ typename CharT=char,
+ typename Traits=std::char_traits<CharT>,
+ class Alloc=std::allocator<CharT>
+ >
+ class basic_stopwatch_formatter;
+
+ typedef basic_stopwatch_formatter<char> stopwatch_formatter;
+ typedef basic_stopwatch_formatter<wchar_t> wstopwatch_formatter;
+}}
+</pre>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="boost_stopwatches.reference.formatters.stopwatch_formatter_hpp.basic_stopwatch_formatter"></a><a href="formatters.html#boost_stopwatches.reference.formatters.stopwatch_formatter_hpp.basic_stopwatch_formatter" title="
+ Template Class basic_stopwatch_formatter<>">
+ Template Class <code class="computeroutput">basic_stopwatch_formatter<></code></a>
+</h5></div></div></div>
+
+ <code class="computeroutput">stopwatch_formatter</code> is
+ a model of <a href="reporters.html#boost_stopwatches.reference.reporters.formatter_req" title="
+ Formatter Requirements"><code class="computeroutput">Formatter</code></a>.
+ 
+<pre class="programlisting">template <
+ typename CharT=char,
+ typename Traits=std::char_traits<CharT>,
+ class Alloc=std::allocator<CharT>
+>
+class basic_stopwatch_formatter {
+public:
+ typedef std::basic_string<CharT,Traits,Alloc> string_type;
+ typedef CharT char_type;
+ typedef std::basic_ostream<CharT,Traits> ostream_type;
+ static ostream_type & default_os();
+ static const char_type * default_format();
+ static int default_places();
+
+ template < class Stopwatch >
+ static void show_time( Stopwatch & stopwatch_, const char * format, int places,
+ std::ostream & os, system::error_code & ec);
+};
+</pre>
+
+ The default places is given by default_places and is 3.
+ 
+
+ The default format is "%ts\n", where
+ 
+<div class="itemizedlist"><ul type="disc"><li>
+ <code class="computeroutput">%d</code>
+ : the result of elapsed() when the reporting is done.
+ </li></ul></div>
+
+ The time is given using the suffix "s" following the System
+ International d'Unites Std.
+ 
+</div>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="boost_stopwatches.reference.formatters.stopwatch_accumulator_formatter_hpp"></a><a href="formatters.html#boost_stopwatches.reference.formatters.stopwatch_accumulator_formatter_hpp" title="
+ Header <boost/stopwatches/stopwatch_accumulator_formatter.hpp>">
+ Header <code class="computeroutput"><boost/stopwatches/stopwatch_accumulator_formatter.hpp></code></a>
+</h4></div></div></div>
+<div class="toc"><dl>
+<dt><a href="formatters.html#boost_stopwatches.reference.formatters.stopwatch_accumulator_formatter_hpp.basic_stopwatch_accumulator_formatter">
+ Template Class <code class="computeroutput">basic_stopwatch_accumulator_formatter<></code></a></dt>
+<dt><a href="formatters.html#boost_stopwatches.reference.formatters.stopwatch_accumulator_formatter_hpp.typedefs">
+ <code class="computeroutput">basic_stopwatch_accumulator_formatter</code>
+ useful typedefs</a></dt>
+</dl></div>
+<pre class="programlisting">namespace boost { namespace stopwatches {
+ template <
+ typename CharT=char,
+ typename Traits=std::char_traits<CharT>,
+ class Alloc=std::allocator<CharT>
+ > basic_stopwatch_accumulator_formatter;
+ typedef basic_stopwatch_accumulator_formatter<char> stopwatch_accumulator_formatter;
+ typedef basic_stopwatch_accumulator_formatter<wchar_t> wstopwatch_accumulator_formatter;
+}}
+</pre>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="boost_stopwatches.reference.formatters.stopwatch_accumulator_formatter_hpp.basic_stopwatch_accumulator_formatter"></a><a href="formatters.html#boost_stopwatches.reference.formatters.stopwatch_accumulator_formatter_hpp.basic_stopwatch_accumulator_formatter" title="
+ Template Class basic_stopwatch_accumulator_formatter<>">
+ Template Class <code class="computeroutput">basic_stopwatch_accumulator_formatter<></code></a>
+</h5></div></div></div>
+
+ <code class="computeroutput">basic_stopwatch_accumulator_formatter</code>
+ is a model of <a href="reporters.html#boost_stopwatches.reference.reporters.formatter_req" title="
+ Formatter Requirements"><code class="computeroutput">Formatter</code></a>
+ 
+<pre class="programlisting">template <
+ typename CharT=char,
+ typename Traits=std::char_traits<CharT>,
+ class Alloc=std::allocator<CharT>
+class basic_stopwatch_accumulator_formatter {
+public:
+ typedef std::basic_string<CharT,Traits,Alloc> string_type;
+ typedef CharT char_type;
+ typedef std::basic_ostream<CharT,Traits> ostream_type;
+ static ostream_type & default_os();
+ static const char_type * default_format();
+ static int default_places();
+
+ template <class Stopwatch >
+ static void show_time( Stopwatch & stopwatch_, const char * format, int places,
+ std::ostream & os, system::error_code & ec);
+};
+</pre>
+
+ The default places is given by default_places and is 3.
+ 
+
+ The default format is "%c times, sum<code class="literal">%ss, min</code>%ms,
+ max<code class="literal">%Ms, mean</code>%as, frequency<code class="literal">%fHz, lifetime</code>%ls,
+ percentage=%p%\n", where
+ 
+<div class="itemizedlist"><ul type="disc">
+<li>
+ <code class="computeroutput">%c</code>
+ : the counter of the number of times the pair srat/stop has been
+ called.
+ </li>
+<li>
+ <code class="computeroutput">%s</code>
+ : the sum of the samples of elapsed time between the call to start/stop.
+ </li>
+<li>
+ <code class="computeroutput">%m</code>
+ : the min of the samples of elapsed time between the call to start/stop.
+ </li>
+<li>
+ <code class="computeroutput">%M</code>
+ : the max of the samples of elapsed time between the call to start/stop.
+ </li>
+<li>
+ <code class="computeroutput">%a</code>
+ : the mean of the samples of elapsed time between the call to start/stop.
+ </li>
+<li>
+ <code class="computeroutput">%f</code>
+ : the frequency of calls to start.
+ </li>
+<li>
+ <code class="computeroutput">%l</code>
+ : the lifetime of the stopwatch_accumulator.
+ </li>
+<li>
+ <code class="computeroutput">%p</code>
+ : the percentage of time spent by this stopwatch respect to its lifetime.
+ </li>
+</ul></div>
+
+ The time is given using the suffix "s", the frequency is given
+ using the suffix "Hz", both following the System International
+ d'Unites Std.
+ 
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="boost_stopwatches.reference.formatters.stopwatch_accumulator_formatter_hpp.typedefs"></a><a href="formatters.html#boost_stopwatches.reference.formatters.stopwatch_accumulator_formatter_hpp.typedefs" title="
+ basic_stopwatch_accumulator_formatter
+ useful typedefs">
+ <code class="computeroutput">basic_stopwatch_accumulator_formatter</code>
+ useful typedefs</a>
+</h5></div></div></div>
+
+ The library provides basic_stopwatch_accumulator_formatter shortcuts
+ for char and wchar_t.
+ 
+<pre class="programlisting">typedef basic_stopwatch_accumulator_formatter<char>
+ stopwatch_accumulator_formatter;
+typedef basic_stopwatch_accumulator_formatter<wchar_t>
+ wstopwatch_accumulator_formatter;
+</pre>
+</div>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="boost_stopwatches.reference.formatters.time_formatter_hpp"></a><a href="formatters.html#boost_stopwatches.reference.formatters.time_formatter_hpp" title="
+ Header <boost/stopwatches/time_formatter.hpp>">
+ Header <code class="computeroutput"><boost/stopwatches/time_formatter.hpp></code></a>
+</h4></div></div></div>
+<div class="toc"><dl>
+<dt><a href="formatters.html#boost_stopwatches.reference.formatters.time_formatter_hpp.basic_time_formatter">
+ Template Class <code class="computeroutput">basic_time_formatter<></code></a></dt>
+<dt><a href="formatters.html#boost_stopwatches.reference.formatters.time_formatter_hpp.typedefs">
+ <code class="computeroutput">basic_time_formatter</code> useful
+ typedefs</a></dt>
+<dt><a href="formatters.html#boost_stopwatches.reference.formatters.time_formatter_hpp.spec">
+ <code class="computeroutput">stopwatch_reporter_default_formatter</code>
+ Specialization</a></dt>
+</dl></div>
+<pre class="programlisting">namespace boost { namespace stopwatches {
+
+ template <
+ typename CharT=char,
+ typename Traits=std::char_traits<CharT>,
+ class Alloc=std::allocator<CharT>
+ >
+ class basic_time_formatter;
+
+ typedef basic_time_formatter<char> time_formatter;
+ typedef basic_time_formatter<wchar_t> wtime_formatter;
+
+ template <>
+ struct stopwatch_reporter_default_formatter<stopwatch<process_cpu_clock> > {
+ typedef time_formatter type;
+ };
+
+} }
+</pre>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="boost_stopwatches.reference.formatters.time_formatter_hpp.basic_time_formatter"></a><a href="formatters.html#boost_stopwatches.reference.formatters.time_formatter_hpp.basic_time_formatter" title="
+ Template Class basic_time_formatter<>">
+ Template Class <code class="computeroutput">basic_time_formatter<></code></a>
+</h5></div></div></div>
+
+ <code class="computeroutput">basic_time_formatter</code>
+ is a model of <a href="reporters.html#boost_stopwatches.reference.reporters.formatter_req" title="
+ Formatter Requirements"><code class="computeroutput">Formatter</code></a>.
+ 
+<pre class="programlisting">template <typename CharT, typename Traits, class Alloc>
+class basic_time_formatter {
+public:
+ typedef std::basic_string<CharT,Traits,Alloc> string_type;
+ typedef CharT char_type;
+ typedef std::basic_ostream<CharT,Traits> ostream_type;
+ static ostream_type & default_os();
+ static const char_type * default_format();
+ static int default_places();
+
+ template <class Stopwatch >
+ static void show_time( Stopwatch & stopwatch_
+ , const char * format, int places, std::ostream & os
+ , system::error_code & ec);
+};
+</pre>
+
+ The default places is given by default_places and is 3.
+ 
+
+ The default format is "nreal %rs, cpu %cs (%p%), user %us, system
+ %ss\n", where
+ 
+<div class="itemizedlist"><ul type="disc">
+<li>
+ <code class="computeroutput">%r</code>
+ : real process clock
+ </li>
+<li>
+ <code class="computeroutput">%u</code>
+ : user process clock
+ </li>
+<li>
+ <code class="computeroutput">%s</code>
+ : system process clock
+ </li>
+<li>
+ <code class="computeroutput">%c</code>
+ : user+system process clock
+ </li>
+<li>
+ <code class="computeroutput">%p</code>
+ : percentage (user+system)/real process clock
+ </li>
+</ul></div>
+
+ All the units are given using the suffix "s" following the
+ System International d'Unites Std.
+ 
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="boost_stopwatches.reference.formatters.time_formatter_hpp.typedefs"></a><a href="formatters.html#boost_stopwatches.reference.formatters.time_formatter_hpp.typedefs" title="
+ basic_time_formatter useful
+ typedefs">
+ <code class="computeroutput">basic_time_formatter</code> useful
+ typedefs</a>
+</h5></div></div></div>
+
+ The library provides basic_time_formatter shortcuts for char and wchar_t.
+ 
+<pre class="programlisting">typedef basic_time_formatter<char> time_formatter;
+typedef basic_time_formatter<wchar_t> wtime_formatter;
+</pre>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="boost_stopwatches.reference.formatters.time_formatter_hpp.spec"></a><a href="formatters.html#boost_stopwatches.reference.formatters.time_formatter_hpp.spec" title="
+ stopwatch_reporter_default_formatter
+ Specialization">
+ <code class="computeroutput">stopwatch_reporter_default_formatter</code>
+ Specialization</a>
+</h5></div></div></div>
+<pre class="programlisting">template <>
+struct stopwatch_reporter_default_formatter<stopwatch<process_cpu_clock> > {
+ typedef time_formatter type;
+};
+</pre>
+</div>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="boost_stopwatches.reference.formatters.stopwatch_accumulator_time_formatter_hpp"></a><a href="formatters.html#boost_stopwatches.reference.formatters.stopwatch_accumulator_time_formatter_hpp" title="
+ Header <boost/stopwatches/stopwatch_accumulator_time_formatter.hpp>">
+ Header <code class="computeroutput"><boost/stopwatches/stopwatch_accumulator_time_formatter.hpp></code></a>
+</h4></div></div></div>
+<div class="toc"><dl>
+<dt><a href="formatters.html#boost_stopwatches.reference.formatters.stopwatch_accumulator_time_formatter_hpp.basic_stopwatch_accumulator_time_formatter">
+ Template Class <code class="computeroutput">basic_stopwatch_accumulator_time_formatter<></code></a></dt>
+<dt><a href="formatters.html#boost_stopwatches.reference.formatters.stopwatch_accumulator_time_formatter_hpp.typedefs">
+ <code class="computeroutput">basic_stopwatch_accumulator_time_formatter</code>
+ useful typedefs</a></dt>
+</dl></div>
+<pre class="programlisting">namespace boost { namespace stopwatches {
+ template <
+ typename CharT=char,
+ typename Traits=std::char_traits<CharT>,
+ class Alloc=std::allocator<CharT>
+ > basic_stopwatch_accumulator_time_formatter;
+ typedef basic_stopwatch_accumulator_time_formatter<char> stopwatch_accumulator_time_formatter;
+ typedef basic_stopwatch_accumulator_time_formatter<wchar_t> wstopwatch_accumulator_time_formatter;
+}}
+</pre>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="boost_stopwatches.reference.formatters.stopwatch_accumulator_time_formatter_hpp.basic_stopwatch_accumulator_time_formatter"></a><a href="formatters.html#boost_stopwatches.reference.formatters.stopwatch_accumulator_time_formatter_hpp.basic_stopwatch_accumulator_time_formatter" title="
+ Template Class basic_stopwatch_accumulator_time_formatter<>">
+ Template Class <code class="computeroutput">basic_stopwatch_accumulator_time_formatter<></code></a>
+</h5></div></div></div>
+
+ <code class="computeroutput">basic_stopwatch_accumulator_time_formatter</code>
+ is a model of <a href="reporters.html#boost_stopwatches.reference.reporters.formatter_req" title="
+ Formatter Requirements"><code class="computeroutput">Formatter</code></a>
+ 
+<pre class="programlisting">template <
+ typename CharT=char,
+ typename Traits=std::char_traits<CharT>,
+ class Alloc=std::allocator<CharT>
+class basic_stopwatch_accumulator_time_formatter {
+public:
+ typedef std::basic_string<CharT,Traits,Alloc> string_type;
+ typedef CharT char_type;
+ typedef std::basic_ostream<CharT,Traits> ostream_type;
+ static ostream_type & default_os();
+ static const char_type * default_format();
+ static int default_places();
+
+ template <class Stopwatch >
+ static void show_time( Stopwatch & stopwatch_, const char * format, int places,
+ std::ostream & os, system::error_code & ec);
+};
+</pre>
+
+ The default places is given by default_places and is 3.
+ 
+
+ The default format is "%c times, sum<code class="literal">%s, min</code>%m,
+ max<code class="literal">%M, mean</code>%a, frequency<code class="literal">%fHz, lifetime</code>%ls,
+ percentage=%p%\n|real %rs, cpu %cs (%p%), user %us, system %ss",
+ where
+ 
+
+ The part before the '|' corresponds to the accumulator format and the
+ part after corresponds to the times format, which will be used for the
+ sum, max, min and mean statistics.
+ 
+<div class="itemizedlist"><ul type="disc">
+<li>
+ <code class="computeroutput">%c</code>
+ : the counter of the number of times the pair srat/stop has been
+ called.
+ </li>
+<li>
+ <code class="computeroutput">%s</code>
+ : the sum of the samples of elapsed time between the call to start/stop.
+ </li>
+<li>
+ <code class="computeroutput">%m</code>
+ : the min of the samples of elapsed time between the call to start/stop.
+ </li>
+<li>
+ <code class="computeroutput">%M</code>
+ : the max of the samples of elapsed time between the call to start/stop.
+ </li>
+<li>
+ <code class="computeroutput">%a</code>
+ : the mean of the samples of elapsed time between the call to start/stop.
+ </li>
+<li>
+ <code class="computeroutput">%f</code>
+ : the frequency of calls to start.
+ </li>
+<li>
+ <code class="computeroutput">%l</code>
+ : the lifetime of the stopwatch_accumulator.
+ </li>
+<li>
+ <code class="computeroutput">%p</code>
+ : the percentage of time spent by this stopwatch respect to its lifetime.
+ </li>
+<li>
+ <code class="computeroutput">%r</code>
+ : real process clock
+ </li>
+<li>
+ <code class="computeroutput">%u</code>
+ : user process clock
+ </li>
+<li>
+ <code class="computeroutput">%s</code>
+ : system process clock
+ </li>
+<li>
+ <code class="computeroutput">%c</code>
+ : user+system process clock
+ </li>
+<li>
+ <code class="computeroutput">%p</code>
+ : percentage (user+system)/real process clock
+ </li>
+</ul></div>
+
+ The time is given using the suffix "s", the frequency is given
+ using the suffix "Hz", both following the System International
+ d'Unites Std.
+ 
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="boost_stopwatches.reference.formatters.stopwatch_accumulator_time_formatter_hpp.typedefs"></a><a href="formatters.html#boost_stopwatches.reference.formatters.stopwatch_accumulator_time_formatter_hpp.typedefs" title="
+ basic_stopwatch_accumulator_time_formatter
+ useful typedefs">
+ <code class="computeroutput">basic_stopwatch_accumulator_time_formatter</code>
+ useful typedefs</a>
+</h5></div></div></div>
+
+ The library provides basic_stopwatch_accumulator_time_formatter shortcuts
+ for char and wchar_t.
+ 
+<pre class="programlisting">typedef basic_stopwatch_accumulator_time_formatter<char>
+ stopwatch_accumulator_time_formatter;
+typedef basic_stopwatch_accumulator_time_formatter<wchar_t>
+ wstopwatch_accumulator_time_formatter;
+</pre>
+</div>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="boost_stopwatches.reference.formatters.t24_hours_hpp"></a><a href="formatters.html#boost_stopwatches.reference.formatters.t24_hours_hpp" title="
+ Header <boost/stopwatches/t24_hours.hpp>">
+ Header <code class="computeroutput"><boost/stopwatches/t24_hours.hpp></code></a>
+</h4></div></div></div>
+<div class="toc"><dl><dt><a href="formatters.html#boost_stopwatches.reference.formatters.t24_hours_hpp.t24_hours">
+ Class <code class="computeroutput">t24_hours</code></a></dt></dl></div>
+<pre class="programlisting">namespace boost { namespace stopwatches {
+ class t24_hours;
+}}
+</pre>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="boost_stopwatches.reference.formatters.t24_hours_hpp.t24_hours"></a><a href="formatters.html#boost_stopwatches.reference.formatters.t24_hours_hpp.t24_hours" title="
+ Class t24_hours">
+ Class <code class="computeroutput">t24_hours</code></a>
+</h5></div></div></div>
+
+ <code class="computeroutput">t24_hours</code> helper class
+ decompose a duration in days, hours, minutes, seconds and nanoseconds.
+ It can be used through its static functions or creating an instance and
+ using its fields.
+ 
+<pre class="programlisting">class t24_hours {
+public:
+ typedef boost::chrono::duration<boost::int_least32_t, <code class="computeroutput">ratio</code><24*3600> > days;
+ typedef boost::chrono::hours hours;
+ typedef boost::chrono::minutes minutes;
+ typedef boost::chrono::seconds seconds;
+ typedef boost::chrono::nanoseconds nanoseconds;
+
+ template <class Rep, class Period>
+ static days get_days(const boost::chrono::duration<Rep, Period>& d);
+
+ template <class Rep, class Period>
+ static hours get_hours(const boost::chrono::duration<Rep, Period>& d);
+
+ template <class Rep, class Period>
+ static minutes get_minutes(const boost::chrono::duration<Rep, Period>& d);
+
+ template <class Rep, class Period>
+ static seconds get_seconds(const boost::chrono::duration<Rep, Period>& d);
+
+ template <class Rep, class Period>
+ static nanoseconds get_nanoseconds(const boost::chrono::duration<Rep, Period>& d);
+
+ days days_;
+ hours hours_;
+ minutes minutes_;
+ seconds seconds_;
+ nanoseconds nanoseconds_;
+
+ template <class Rep, class Period>
+ explicit t24_hours(const boost::chrono::duration<Rep, Period>& d);
+};
+</pre>
+</div>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="boost_stopwatches.reference.formatters.t24_hours_formatter_hpp"></a><a href="formatters.html#boost_stopwatches.reference.formatters.t24_hours_formatter_hpp" title="
+ Header <boost/stopwatches/t24_hours_formatter.hpp>">
+ Header <code class="computeroutput"><boost/stopwatches/t24_hours_formatter.hpp></code></a>
+</h4></div></div></div>
+<div class="toc"><dl>
+<dt><a href="formatters.html#boost_stopwatches.reference.formatters.t24_hours_formatter_hpp.basic_24_hours_formatter">
+ Template Class <code class="computeroutput">basic_24_hours_formatter<></code></a></dt>
+<dt><a href="formatters.html#boost_stopwatches.reference.formatters.t24_hours_formatter_hpp.typedefs">
+ <code class="computeroutput">basic_24_hours_formatter</code>
+ useful typedefs</a></dt>
+</dl></div>
+<pre class="programlisting">namespace boost { namespace stopwatches {
+
+ template <
+ typename CharT=char,
+ typename Traits=std::char_traits<CharT>,
+ class Alloc=std::allocator<CharT>
+ >
+ class basic_24_hours_formatter;
+
+ typedef basic_24_hours_formatter<char> t24_hours_formatter;
+ typedef basic_24_hours_formatter<wchar_t> wt24_hours_formatter;
+
+} }
+</pre>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="boost_stopwatches.reference.formatters.t24_hours_formatter_hpp.basic_24_hours_formatter"></a><a href="formatters.html#boost_stopwatches.reference.formatters.t24_hours_formatter_hpp.basic_24_hours_formatter" title="
+ Template Class basic_24_hours_formatter<>">
+ Template Class <code class="computeroutput">basic_24_hours_formatter<></code></a>
+</h5></div></div></div>
+
+ <code class="computeroutput">basic_24_hours_formatter</code>
+ is a model of <a href="reporters.html#boost_stopwatches.reference.reporters.formatter_req" title="
+ Formatter Requirements"><code class="computeroutput">Formatter</code></a>.
+ 
+<pre class="programlisting">template <typename CharT, typename Traits, class Alloc>
+class basic_24_hours_formatter {
+public:
+ static std::ostream & default_os();
+ static const char * default_format();
+ static int default_places();
+
+ template <class Stopwatch >
+ static void show_time( Stopwatch & stopwatch_
+ , const char * format, int places, std::ostream & os
+ , system::error_code & ec);
+};
+</pre>
+
+ The default places is given by default_places and is 3.
+ 
+
+ The default format is "%d days(s) %h:%m:%s.%n\n", where
+ 
+<div class="itemizedlist"><ul type="disc">
+<li>
+ <code class="computeroutput">%d</code>
+ : days
+ </li>
+<li>
+ <code class="computeroutput">%h</code>
+ : hours
+ </li>
+<li>
+ <code class="computeroutput">%m</code>
+ : minutes
+ </li>
+<li>
+ <code class="computeroutput">%s</code>
+ : seconds
+ </li>
+<li>
+ <code class="computeroutput">%n</code>
+ : nanoseconds
+ </li>
+</ul></div>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="boost_stopwatches.reference.formatters.t24_hours_formatter_hpp.typedefs"></a><a href="formatters.html#boost_stopwatches.reference.formatters.t24_hours_formatter_hpp.typedefs" title="
+ basic_24_hours_formatter
+ useful typedefs">
+ <code class="computeroutput">basic_24_hours_formatter</code>
+ useful typedefs</a>
+</h5></div></div></div>
+
+ The library provides basic_24_hours_formatter shortcuts for char and
+ wchar_t.
+ 
+<pre class="programlisting">typedef basic_24_hours_formatter<char> t24_hours_formatter;
+typedef basic_24_hours_formatter<wchar_t> wt24_hours_formatter;
+</pre>
+</div>
+</div>
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer">Copyright © 2009 -2010 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)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="reporters.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../appendices.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/reference/other_clocks.html
==============================================================================
--- (empty file)
+++ sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/reference/other_clocks.html 2010-09-07 13:07:01 EDT (Tue, 07 Sep 2010)
@@ -0,0 +1,347 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title> Other clocks</title>
+<link rel="stylesheet" href="../../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
+<link rel="start" href="../../index.html" title="Boost.Stopwatches 0.1.0">
+<link rel="up" href="../reference.html" title=" Reference ">
+<link rel="prev" href="stopwatches_hpp.html" title=" Header
+ <boost/stopwatches.hpp>">
+<link rel="next" href="stopwatches.html" title=" Stopwatches">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td>
+<td align="center">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="stopwatches_hpp.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="stopwatches.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="boost_stopwatches.reference.other_clocks"></a> Other clocks
+</h3></div></div></div>
+<div class="toc"><dl>
+<dt><a href="other_clocks.html#boost_stopwatches.reference.other_clocks.suspendible_clock_req">
+ <code class="computeroutput">SuspendibleClock</code> Requirements</a></dt>
+<dd><dl>
+<dt><a href="other_clocks.html#boost_stopwatches.reference.other_clocks.suspendible_clock_req.SuspendibleClock_suspend">
+ Static Member Function <code class="computeroutput">suspend()</code></a></dt>
+<dt><a href="other_clocks.html#boost_stopwatches.reference.other_clocks.suspendible_clock_req.SuspendibleClock_resume">
+ Static Member Function <code class="computeroutput">resume()</code></a></dt>
+<dt><a href="other_clocks.html#boost_stopwatches.reference.other_clocks.suspendible_clock_req.SuspendibleClock_suspended">
+ Static Member Function <code class="computeroutput">suspended()</code></a></dt>
+</dl></dd>
+<dt><a href="other_clocks.html#boost_stopwatches.reference.other_clocks.scoped_suspend_hpp">
+ Header <code class="computeroutput"><boost/stopwatches/scoped_suspend.hpp></code></a></dt>
+<dd><dl>
+<dt><a href="other_clocks.html#boost_stopwatches.reference.other_clocks.scoped_suspend_hpp.is_suspendible">
+ Meta Function Class <code class="computeroutput">is_suspendible</code></a></dt>
+<dt><a href="other_clocks.html#boost_stopwatches.reference.other_clocks.scoped_suspend_hpp.scoped_suspend">
+ Template Class <code class="computeroutput">scoped_suspend</code></a></dt>
+</dl></dd>
+<dt><a href="other_clocks.html#boost_stopwatches.reference.other_clocks.suspendible_clock_hpp">
+ Header <code class="computeroutput"><boost/stopwatches/suspendible_clock.hpp></code></a></dt>
+<dd><dl><dt><a href="other_clocks.html#boost_stopwatches.reference.other_clocks.suspendible_clock_hpp.suspendible_clock">
+ Template Class <code class="computeroutput">suspendible_clock<></code></a></dt></dl></dd>
+</dl></div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="boost_stopwatches.reference.other_clocks.suspendible_clock_req"></a><a href="other_clocks.html#boost_stopwatches.reference.other_clocks.suspendible_clock_req" title="
+ SuspendibleClock Requirements">
+ <code class="computeroutput">SuspendibleClock</code> Requirements</a>
+</h4></div></div></div>
+<div class="toc"><dl>
+<dt><a href="other_clocks.html#boost_stopwatches.reference.other_clocks.suspendible_clock_req.SuspendibleClock_suspend">
+ Static Member Function <code class="computeroutput">suspend()</code></a></dt>
+<dt><a href="other_clocks.html#boost_stopwatches.reference.other_clocks.suspendible_clock_req.SuspendibleClock_resume">
+ Static Member Function <code class="computeroutput">resume()</code></a></dt>
+<dt><a href="other_clocks.html#boost_stopwatches.reference.other_clocks.suspendible_clock_req.SuspendibleClock_suspended">
+ Static Member Function <code class="computeroutput">suspended()</code></a></dt>
+</dl></div>
+
+ A <code class="computeroutput">SuspendibleClock</code> is a
+ Clock that in addition supports <code class="computeroutput">suspend</code>/<code class="computeroutput">resume</code> operations.
+ 
+
+ A <code class="computeroutput">SuspendibleClock</code> must
+ meet the requirements in the following Table.
+ 
+
+ In this table <code class="computeroutput">C</code> denote
+ <code class="computeroutput">clock</code> types.
+ 
+<div class="table">
+<a name="boost_stopwatches.reference.other_clocks.suspendible_clock_req.suspendibleclock_requirements"></a>Table 1. SuspendibleClock Requirements
+<table class="table" summary="SuspendibleClock Requirements">
+<colgroup>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ expression
+ 
+ </th>
+<th>
+ 
+ return type
+ 
+ </th>
+<th>
+ 
+ operational semantics
+ 
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ 
+ <code class="computeroutput">C::suspend()</code>
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">void</code>
+ 
+ </td>
+<td>
+ 
+ Suspends the time counting of the clock C.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">C::resume()</code>
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">void</code>
+ 
+ </td>
+<td>
+ 
+ Resumes the time counting of the clock C.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">C::suspended()</code>
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">duration</code>
+ 
+ </td>
+<td>
+ 
+ Returns the delay(duration during which the clock has been suspended.
+ 
+ </td>
+</tr>
+</tbody>
+</table>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="boost_stopwatches.reference.other_clocks.suspendible_clock_req.SuspendibleClock_suspend"></a><a href="other_clocks.html#boost_stopwatches.reference.other_clocks.suspendible_clock_req.SuspendibleClock_suspend" title="
+ Static Member Function suspend()">
+ Static Member Function <code class="computeroutput">suspend()</code></a>
+</h5></div></div></div>
+<pre class="programlisting">void suspend( system::error_code & ec = system::throws );
+</pre>
+
+ Effect: Suspends the SuspendibleClock.
+ 
+
+ Throw: Any exception the <code class="computeroutput">Clock::now(ec)</code>
+ function can throw. Otherwise <code class="computeroutput">ec</code>
+ is set with the correspoding error code set by <code class="computeroutput">Clock::now(ec)</code>.
+ 
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="boost_stopwatches.reference.other_clocks.suspendible_clock_req.SuspendibleClock_resume"></a><a href="other_clocks.html#boost_stopwatches.reference.other_clocks.suspendible_clock_req.SuspendibleClock_resume" title="
+ Static Member Function resume()">
+ Static Member Function <code class="computeroutput">resume()</code></a>
+</h5></div></div></div>
+<pre class="programlisting">void resume( system::error_code & ec = system::throws );
+</pre>
+
+ Effect: Resumes the <code class="computeroutput">SuspendibleClock</code>.
+ 
+
+ Throw: Any exception the <code class="computeroutput">Clock::now(ec)</code>
+ can throw. Otherwise <code class="computeroutput">ec</code>
+ is set with the correspoding error code set by <code class="computeroutput">Clock::now(ec)</code>.
+ 
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="boost_stopwatches.reference.other_clocks.suspendible_clock_req.SuspendibleClock_suspended"></a><a href="other_clocks.html#boost_stopwatches.reference.other_clocks.suspendible_clock_req.SuspendibleClock_suspended" title="
+ Static Member Function suspended()">
+ Static Member Function <code class="computeroutput">suspended()</code></a>
+</h5></div></div></div>
+<pre class="programlisting">duration suspended( system::error_code & ec = system::throws );
+</pre>
+
+ Returns: the cumalative elapsed duration
+ during which the <code class="computeroutput">SuspendibleClock</code>
+ has been suspendeed.
+ 
+
+ Throw: Any exception the Clock::now
+ function can throw if <code class="computeroutput">ec == system::throws</code>.
+ Otherwise <code class="computeroutput">ec</code> is set with
+ the correspoding error code set by <code class="computeroutput">Clock::now(ec)</code>.
+ 
+</div>
+
+ Models of <code class="computeroutput">SuspendibleClock</code>:
+ 
+<div class="itemizedlist"><ul type="disc"><li>
+ <a href="other_clocks.html#boost_stopwatches.reference.other_clocks.suspendible_clock_hpp.suspendible_clock" title="
+ Template Class suspendible_clock<>"><code class="computeroutput">suspendible_clock</code></a>]
+ </li></ul></div>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="boost_stopwatches.reference.other_clocks.scoped_suspend_hpp"></a><a href="other_clocks.html#boost_stopwatches.reference.other_clocks.scoped_suspend_hpp" title="
+ Header <boost/stopwatches/scoped_suspend.hpp>">
+ Header <code class="computeroutput"><boost/stopwatches/scoped_suspend.hpp></code></a>
+</h4></div></div></div>
+<div class="toc"><dl>
+<dt><a href="other_clocks.html#boost_stopwatches.reference.other_clocks.scoped_suspend_hpp.is_suspendible">
+ Meta Function Class <code class="computeroutput">is_suspendible</code></a></dt>
+<dt><a href="other_clocks.html#boost_stopwatches.reference.other_clocks.scoped_suspend_hpp.scoped_suspend">
+ Template Class <code class="computeroutput">scoped_suspend</code></a></dt>
+</dl></div>
+<pre class="programlisting">namespace boost { namespace stopwatches {
+ template <class Clock> struct is_suspendible;
+ template <class Clock> class scoped_suspend;
+}}
+</pre>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="boost_stopwatches.reference.other_clocks.scoped_suspend_hpp.is_suspendible"></a><a href="other_clocks.html#boost_stopwatches.reference.other_clocks.scoped_suspend_hpp.is_suspendible" title="
+ Meta Function Class is_suspendible">
+ Meta Function Class <code class="computeroutput">is_suspendible</code></a>
+</h5></div></div></div>
+<pre class="programlisting">template <class Clock>
+struct is_suspendible : mpl:: false_ {};
+</pre>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="boost_stopwatches.reference.other_clocks.scoped_suspend_hpp.scoped_suspend"></a><a href="other_clocks.html#boost_stopwatches.reference.other_clocks.scoped_suspend_hpp.scoped_suspend" title="
+ Template Class scoped_suspend">
+ Template Class <code class="computeroutput">scoped_suspend</code></a>
+</h5></div></div></div>
+<pre class="programlisting">template <class Clock>
+class scoped_suspend {
+public:
+ scoped_suspend(system::error_code & ec = system::throws) {}
+ ~scoped_suspend() {}
+private:
+ scoped_suspend(); // = delete;
+ scoped_suspend(const scoped_suspend&); // = delete;
+ scoped_suspend& operator=(const scoped_suspend&); // = delete;
+};
+</pre>
+</div>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="boost_stopwatches.reference.other_clocks.suspendible_clock_hpp"></a><a href="other_clocks.html#boost_stopwatches.reference.other_clocks.suspendible_clock_hpp" title="
+ Header <boost/stopwatches/suspendible_clock.hpp>">
+ Header <code class="computeroutput"><boost/stopwatches/suspendible_clock.hpp></code></a>
+</h4></div></div></div>
+<div class="toc"><dl><dt><a href="other_clocks.html#boost_stopwatches.reference.other_clocks.suspendible_clock_hpp.suspendible_clock">
+ Template Class <code class="computeroutput">suspendible_clock<></code></a></dt></dl></div>
+<pre class="programlisting">namespace boost { namespace stopwatches {
+
+ template <class Clock>
+ class suspendible_clock;
+
+ template <class Clock>
+ struct is_suspendible<suspendible_clock<Clock> > : mpl:: true_ {};
+
+ template <class Clock>
+ class scoped_suspend<suspendible_clock<Clock> >;
+
+}}
+</pre>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="boost_stopwatches.reference.other_clocks.suspendible_clock_hpp.suspendible_clock"></a><a href="other_clocks.html#boost_stopwatches.reference.other_clocks.suspendible_clock_hpp.suspendible_clock" title="
+ Template Class suspendible_clock<>">
+ Template Class <code class="computeroutput">suspendible_clock<></code></a>
+</h5></div></div></div>
+<div class="toc"><dl><dt><a href="other_clocks.html#boost_stopwatches.reference.other_clocks.suspendible_clock_hpp.suspendible_clock._scoped_suspend__specialization_for__suspendible_clock___"><code class="computeroutput">scoped_suspend</code> specialization for
+ <code class="computeroutput">suspendible_clock<></code></a></dt></dl></div>
+
+ Given a <code class="computeroutput">Clock</code>, <a href="other_clocks.html#boost_stopwatches.reference.other_clocks.suspendible_clock_hpp.suspendible_clock" title="
+ Template Class suspendible_clock<>"><code class="computeroutput">suspendible_clock</code></a> < <code class="computeroutput">Clock</code>> is a model of <code class="computeroutput">SuspendibleClock</code>.
+ 
+<pre class="programlisting">template < class Clock >
+class suspendible_clock {
+public:
+ typedef typename Clock::duration duration;
+ typedef typename Clock::rep rep;
+ typedef typename Clock::period period;
+ typedef chrono:: <code class="computeroutput">time_point</code><suspendible_clock<Clock> > time_point;
+ static const bool is_monotonic = true;
+
+ static time_point now( system::error_code & ec = system::throws );
+
+ static void suspend( system::error_code & ec = system::throws );
+ static void resume( system::error_code & ec = system::throws );
+ static duration suspended(system::error_code & ec = system::throws);
+};
+</pre>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="boost_stopwatches.reference.other_clocks.suspendible_clock_hpp.suspendible_clock._scoped_suspend__specialization_for__suspendible_clock___"></a><a href="other_clocks.html#boost_stopwatches.reference.other_clocks.suspendible_clock_hpp.suspendible_clock._scoped_suspend__specialization_for__suspendible_clock___" title="scoped_suspend specialization for
+ suspendible_clock<>"><code class="computeroutput">scoped_suspend</code> specialization for
+ <code class="computeroutput">suspendible_clock<></code></a>
+</h6></div></div></div>
+<pre class="programlisting">template <class Clock>
+class scoped_suspend<suspendible_clock<Clock> > {
+public:
+ scoped_suspend(system::error_code & ec = system::throws);
+ ~scoped_suspend();
+};
+</pre>
+</div>
+</div>
+</div>
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer">Copyright © 2009 -2010 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)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="stopwatches_hpp.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="stopwatches.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/reference/reporters.html
==============================================================================
--- (empty file)
+++ sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/reference/reporters.html 2010-09-07 13:07:01 EDT (Tue, 07 Sep 2010)
@@ -0,0 +1,1142 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title> Stopwatch Reporters</title>
+<link rel="stylesheet" href="../../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
+<link rel="start" href="../../index.html" title="Boost.Stopwatches 0.1.0">
+<link rel="up" href="../reference.html" title=" Reference ">
+<link rel="prev" href="stopwatches.html" title=" Stopwatches">
+<link rel="next" href="formatters.html" title=" Stopwatch Formatters">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td>
+<td align="center">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="stopwatches.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="formatters.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="boost_stopwatches.reference.reporters"></a> Stopwatch Reporters
+</h3></div></div></div>
+<div class="toc"><dl>
+<dt><a href="reporters.html#boost_stopwatches.reference.reporters.formatter_req">
+ <code class="computeroutput">Formatter</code> Requirements</a></dt>
+<dt>Formatter related traits</dt>
+<dt><a href="reporters.html#boost_stopwatches.reference.reporters.stopwatch_reporter_hpp">
+ Header <code class="computeroutput"><boost/stopwatches/stopwatch_reporter.hpp></code></a></dt>
+<dd><dl>
+<dt><a href="reporters.html#boost_stopwatches.reference.reporters.stopwatch_reporter_hpp.basic_stopwatch_reporter">
+ Template Class <code class="computeroutput">basic_stopwatch_reporter<></code></a></dt>
+<dt><a href="reporters.html#boost_stopwatches.reference.reporters.stopwatch_reporter_hpp.stopwatch_reporter">
+ Template Class <code class="computeroutput">stopwatch_reporter<></code></a></dt>
+<dt><a href="reporters.html#boost_stopwatches.reference.reporters.stopwatch_reporter_hpp.wstopwatch_reporter">
+ Template Class <code class="computeroutput">wstopwatch_reporter<></code></a></dt>
+</dl></dd>
+<dt><a href="reporters.html#boost_stopwatches.reference.reporters.stopclock_hpp">
+ Header <code class="computeroutput"><boost/stopwatches/stopclock.hpp></code></a></dt>
+<dd><dl>
+<dt><a href="reporters.html#boost_stopwatches.reference.reporters.stopclock_hpp.basic_stopclock">
+ Template Class <code class="computeroutput">basic_stopclock<></code></a></dt>
+<dt><a href="reporters.html#boost_stopwatches.reference.reporters.stopclock_hpp.stopclock">
+ Template Class <code class="computeroutput">stopclock<></code></a></dt>
+<dt><a href="reporters.html#boost_stopwatches.reference.reporters.stopclock_hpp.stopclock_typedefs">
+ <code class="computeroutput">stopclock</code> useful typedefs</a></dt>
+<dt><a href="reporters.html#boost_stopwatches.reference.reporters.stopclock_hpp.wstopclock">
+ Template Class <code class="computeroutput">wstopclock<></code></a></dt>
+<dt><a href="reporters.html#boost_stopwatches.reference.reporters.stopclock_hpp.wstopclock_typedefs">
+ <code class="computeroutput">wstopclock</code> useful typedefs</a></dt>
+</dl></dd>
+<dt><a href="reporters.html#boost_stopwatches.reference.reporters.stopclock_accumulator_hpp">
+ Header <code class="computeroutput"><boost/stopwatches/stopclock_accumulator.hpp></code></a></dt>
+<dd><dl>
+<dt><a href="reporters.html#boost_stopwatches.reference.reporters.stopclock_accumulator_hpp.basic_stopclock_accumulator">
+ Template Class <code class="computeroutput">basic_stopclock_accumulator<></code></a></dt>
+<dt><a href="reporters.html#boost_stopwatches.reference.reporters.stopclock_accumulator_hpp.stopclock_accumulator">
+ Template Class <code class="computeroutput">stopclock_accumulator<></code></a></dt>
+<dt><a href="reporters.html#boost_stopwatches.reference.reporters.stopclock_accumulator_hpp.stopclock_accumulator_typedefs">
+ <code class="computeroutput">stopclock_accumulator</code> useful
+ typedefs</a></dt>
+<dt><a href="reporters.html#boost_stopwatches.reference.reporters.stopclock_accumulator_hpp.wstopclock_accumulator">
+ Template Class <code class="computeroutput">wstopclock_accumulator<></code></a></dt>
+<dt><a href="reporters.html#boost_stopwatches.reference.reporters.stopclock_accumulator_hpp.wstopclock_accumulator_typedefs">
+ <code class="computeroutput">wstopclock_accumulator</code>
+ useful typedefs</a></dt>
+</dl></dd>
+<dt><a href="reporters.html#boost_stopwatches.reference.reporters.scoped_stopclock_hpp">
+ Header <code class="computeroutput"><boost/stopwatches/scoped_stopclock.hpp></code></a></dt>
+<dd><dl><dt><a href="reporters.html#boost_stopwatches.reference.reporters.scoped_stopclock_hpp.scoped_stopclock">
+ Template Class <code class="computeroutput">scoped_stopclock<></code></a></dt></dl></dd>
+</dl></div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="boost_stopwatches.reference.reporters.formatter_req"></a><a href="reporters.html#boost_stopwatches.reference.reporters.formatter_req" title="
+ Formatter Requirements">
+ <code class="computeroutput">Formatter</code> Requirements</a>
+</h4></div></div></div>
+
+ A Formatter outputs on a given ostream a formatted string combining informations
+ from a Stopwatch and the format and the double precision.
+ 
+
+ A Formatter must meet the requirements in the following Table.
+ 
+
+ In this table <code class="computeroutput">F</code> denote
+ a Formatter type, <code class="computeroutput">S</code> is
+ a Stopwatch and <code class="computeroutput">s</code> is an
+ instance of <code class="computeroutput">S</code>, <code class="computeroutput">f</code> is <code class="computeroutput">const
+ char *</code>
+ , <code class="computeroutput">p</code> is and int, and <code class="computeroutput">os</code> is a <code class="computeroutput">std::ostream</code>,
+ ec is a system::error_code
+ 
+<div class="table">
+<a name="boost_stopwatches.reference.reporters.formatter_req.formatter_requirements"></a>Table 3. Formatter Requirements
+<table class="table" summary="Formatter Requirements">
+<colgroup>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ expression
+ 
+ </th>
+<th>
+ 
+ return type
+ 
+ </th>
+<th>
+ 
+ operational semantics
+ 
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ 
+ <code class="computeroutput">F::default_os()</code>
+ 
+ </td>
+<td>
+ 
+ std::otream&
+ 
+ </td>
+<td>
+ 
+ The output stream.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">F::default_places()</code>
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">std::size_t</code>
+ 
+ </td>
+<td>
+ 
+ The precision when displaying a double.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">F::default_format()</code>
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">const char*</code>
+ 
+ </td>
+<td>
+ 
+ The default format.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">F::show_time(s,f,p,os,ec)</code>
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">S::time_point</code>
+ 
+ </td>
+<td>
+ 
+ outputs on <code class="computeroutput">os</code>
+ a formatted string combining informations from the Stopwatch
+ <code class="computeroutput">s</code>, the format
+ <code class="computeroutput">f</code> and the double
+ precision <code class="computeroutput">p</code>.
+ 
+ </td>
+</tr>
+</tbody>
+</table>
+</div>
+
+ Models of <code class="computeroutput">Formatter</code>:
+ 
+<div class="itemizedlist"><ul type="disc">
+<li>
+ <a href="formatters.html#boost_stopwatches.reference.formatters.stopwatch_formatter_hpp.basic_stopwatch_formatter" title="
+ Template Class basic_stopwatch_formatter<>"><code class="computeroutput">stopwatch_accumulator_formatter</code></a>
+ </li>
+<li>
+ <a href="formatters.html#boost_stopwatches.reference.formatters.stopwatch_accumulator_formatter_hpp.basic_stopwatch_accumulator_formatter" title="
+ Template Class basic_stopwatch_accumulator_formatter<>"><code class="computeroutput">stopwatch_accumulator_formatter</code></a>
+ </li>
+<li>
+ <a href="formatters.html#boost_stopwatches.reference.formatters.t24_hours_formatter_hpp.basic_24_hours_formatter" title="
+ Template Class basic_24_hours_formatter<>"><code class="computeroutput">basic_24_hours_formatter</code></a>
+ </li>
+</ul></div>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="boost_stopwatches.reference.reporters._formatter__related_traits"></a>Formatter related traits
+</h4></div></div></div>
+<pre class="programlisting">template <class Stopwatch>
+struct stopwatch_reporter_default_formatter {
+ typedef <see below> type;
+};
+</pre>
+
+ The nested typedef <code class="computeroutput">type</code>
+ defines the default formatter used by the <a href="reporters.html#boost_stopwatches.reference.reporters.stopwatch_reporter_hpp.stopwatch_reporter" title="
+ Template Class stopwatch_reporter<>"><code class="computeroutput">stopwatch_reporter</code></a> class when
+ the <code class="computeroutput">Formatter</code> parameter
+ is not explicit.
+ 
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="boost_stopwatches.reference.reporters.stopwatch_reporter_hpp"></a><a href="reporters.html#boost_stopwatches.reference.reporters.stopwatch_reporter_hpp" title="
+ Header <boost/stopwatches/stopwatch_reporter.hpp>">
+ Header <code class="computeroutput"><boost/stopwatches/stopwatch_reporter.hpp></code></a>
+</h4></div></div></div>
+<div class="toc"><dl>
+<dt><a href="reporters.html#boost_stopwatches.reference.reporters.stopwatch_reporter_hpp.basic_stopwatch_reporter">
+ Template Class <code class="computeroutput">basic_stopwatch_reporter<></code></a></dt>
+<dt><a href="reporters.html#boost_stopwatches.reference.reporters.stopwatch_reporter_hpp.stopwatch_reporter">
+ Template Class <code class="computeroutput">stopwatch_reporter<></code></a></dt>
+<dt><a href="reporters.html#boost_stopwatches.reference.reporters.stopwatch_reporter_hpp.wstopwatch_reporter">
+ Template Class <code class="computeroutput">wstopwatch_reporter<></code></a></dt>
+</dl></div>
+<pre class="programlisting">namespace boost { namespace stopwatches {
+ template <class Stopwatch, class Formatter>
+ class basic_stopwatch_reporter;
+
+ template <class Stopwatch>
+ struct stopwatch_reporter_default_formatter;
+
+ template <class Stopwatch,
+ class Formatter=typename stopwatch_reporter_default_formatter<Stopwatch>::type>
+ class <a href="reporters.html#boost_stopwatches.reference.reporters.stopwatch_reporter_hpp.stopwatch_reporter" title="
+ Template Class stopwatch_reporter<>"><code class="computeroutput">stopwatch_reporter</code></a>;
+
+ template <class Stopwatch>
+ struct wstopwatch_reporter_default_formatter;
+
+ template <class Stopwatch,
+ class Formatter=typename wstopwatch_reporter_default_formatter<Stopwatch>::type>
+ class wstopwatch_reporter;
+}}
+</pre>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="boost_stopwatches.reference.reporters.stopwatch_reporter_hpp.basic_stopwatch_reporter"></a><a href="reporters.html#boost_stopwatches.reference.reporters.stopwatch_reporter_hpp.basic_stopwatch_reporter" title="
+ Template Class basic_stopwatch_reporter<>">
+ Template Class <code class="computeroutput">basic_stopwatch_reporter<></code></a>
+</h5></div></div></div>
+
+ class <code class="computeroutput">basic_stopwatch_reporter</code>
+ provides everything a <code class="computeroutput">Stopwatch</code>
+ provides and it adds reporting capabilities that can be invoked in a
+ single line of code. The reporting is controleed by two parameters:
+ 
+<div class="itemizedlist"><ul type="disc">
+<li>
+ format : The output format
+ </li>
+<li>
+ places(precision): the number of decimal placess used.
+ </li>
+</ul></div>
+
+ The default places is given by Formatter::default_places().
+ 
+
+ The default format is given by Formatter::default_format().
+ 
+<pre class="programlisting">template <class Stopwatch, class Formatter>
+class basic_stopwatch_reporter : public Stopwatch {
+public:
+ typedef typename Stopwatch::clock clock;
+ typedef Stopwatch stopwatch;
+ typedef Formatter formatter;
+
+ explicit basic_stopwatch_reporter( system::error_code & ec = system::throws );
+ explicit basic_stopwatch_reporter( std::ostream & os,
+ system::error_code & ec = system::throws );
+
+ explicit basic_stopwatch_reporter( const std::string & format,
+ system::error_code & ec = system::throws );
+ explicit basic_stopwatch_reporter( std::ostream & os, const std::string & format,
+ system::error_code & ec = system::throws );
+
+ explicit basic_stopwatch_reporter( const std::string & format, int places,
+ system::error_code & ec = system::throws );
+ explicit basic_stopwatch_reporter( std::ostream & os, const std::string & format, int places,
+ system::error_code & ec = system::throws );
+
+ explicit basic_stopwatch_reporter( int places,
+ system::error_code & ec = system::throws );
+ explicit basic_stopwatch_reporter( std::ostream & os, int places,
+ system::error_code & ec = system::throws );
+
+ explicit basic_stopwatch_reporter( int places, const std::string & format,
+ system::error_code & ec = system::throws );
+ explicit basic_stopwatch_reporter( std::ostream & os, int places, const std::string & format,
+ system::error_code & ec = system::throws );
+
+ ~basic_stopwatch_reporter();
+
+ void report( system::error_code & ec = system::throws );
+ bool reported() const;
+
+
+ typedef stopwatch_runner<basic_stopwatch_reporter<Stopwatch> > scoped_run;
+ typedef stopwatch_suspender<basic_stopwatch_reporter<Stopwatch> > scoped_suspend;
+ typedef stopwatch_resumer<basic_stopwatch_reporter<Stopwatch> > scoped_resume;
+};
+</pre>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="boost_stopwatches.reference.reporters.stopwatch_reporter_hpp.stopwatch_reporter"></a><a href="reporters.html#boost_stopwatches.reference.reporters.stopwatch_reporter_hpp.stopwatch_reporter" title="
+ Template Class stopwatch_reporter<>">
+ Template Class <code class="computeroutput">stopwatch_reporter<></code></a>
+</h5></div></div></div>
+
+ class <a href="reporters.html#boost_stopwatches.reference.reporters.stopwatch_reporter_hpp.stopwatch_reporter" title="
+ Template Class stopwatch_reporter<>"><code class="computeroutput">stopwatch_reporter</code></a> provides
+ a everything a <code class="computeroutput">Stopwatch</code>
+ provides and it adds reporting capabilities that can be invoked in a
+ single line of code. The reporting is controleed by two parameters:
+ 
+<div class="itemizedlist"><ul type="disc">
+<li>
+ format : The output format
+ </li>
+<li>
+ places(precision): the number of decimal placess used.
+ </li>
+</ul></div>
+
+ The default places is given by Formatter::default_places().
+ 
+
+ The default format is given by Formatter::default_format().
+ 
+<pre class="programlisting">template <class Stopwatch, class Formatter>
+class stopwatch_reporter : public basic_stopwatch_reporter<Stopwatch,Formatter> {
+public:
+ typedef typename Stopwatch::clock clock;
+ typedef Stopwatch stopwatch;
+ typedef Formatter formatter;
+
+ explicit stopwatch_reporter( system::error_code & ec = system::throws );
+ explicit stopwatch_reporter( std::ostream & os,
+ system::error_code & ec = system::throws );
+
+ explicit stopwatch_reporter( const std::string & format,
+ system::error_code & ec = system::throws );
+ explicit stopwatch_reporter( std::ostream & os, const std::string & format,
+ system::error_code & ec = system::throws );
+
+ explicit stopwatch_reporter( const std::string & format, int places,
+ system::error_code & ec = system::throws );
+ explicit stopwatch_reporter( std::ostream & os, const std::string & format, int places,
+ system::error_code & ec = system::throws );
+
+ explicit stopwatch_reporter( int places,
+ system::error_code & ec = system::throws );
+ explicit stopwatch_reporter( std::ostream & os, int places,
+ system::error_code & ec = system::throws );
+
+ explicit stopwatch_reporter( int places, const std::string & format,
+ system::error_code & ec = system::throws );
+ explicit stopwatch_reporter( std::ostream & os, int places, const std::string & format,
+ system::error_code & ec = system::throws );
+
+ ~stopwatch_reporter();
+
+ void report( system::error_code & ec = system::throws );
+ bool reported() const;
+
+
+ typedef stopwatch_runner<stopwatch_reporter<Stopwatch> > scoped_run;
+ typedef stopwatch_suspender<stopwatch_reporter<Stopwatch> > scoped_suspend;
+ typedef stopwatch_resumer<stopwatch_reporter<Stopwatch> > scoped_resume;
+};
+</pre>
+
+ Usage
+ 
+<pre class="programlisting">void f1()
+{
+ typedef stopwatch_reporter<stopwatch_accumulator<> > accumulator;
+ static accumulator t;
+ accumulator::scoped_run _(t);
+ // ...
+
+ // call to some function we don't want to measure
+ {
+ accumulator::scoped_suspend _(t);
+ external_function();
+ }
+}
+</pre>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="boost_stopwatches.reference.reporters.stopwatch_reporter_hpp.wstopwatch_reporter"></a><a href="reporters.html#boost_stopwatches.reference.reporters.stopwatch_reporter_hpp.wstopwatch_reporter" title="
+ Template Class wstopwatch_reporter<>">
+ Template Class <code class="computeroutput">wstopwatch_reporter<></code></a>
+</h5></div></div></div>
+
+ class <code class="computeroutput">wstopwatch_reporter</code>
+ provides a everything a <code class="computeroutput">Stopwatch</code>
+ provides and it adds reporting capabilities that can be invoked in a
+ single line of code. The reporting is controleed by two parameters:
+ 
+<div class="itemizedlist"><ul type="disc">
+<li>
+ format : The output format
+ </li>
+<li>
+ places(precision): the number of decimal placess used.
+ </li>
+</ul></div>
+
+ The default places is given by Formatter::default_places().
+ 
+
+ The default format is given by Formatter::default_format().
+ 
+<pre class="programlisting">template <class Stopwatch, class Formatter>
+class wstopwatch_reporter : public basic_wstopwatch_reporter<Stopwatch,Formatter> {
+public:
+ typedef typename Stopwatch::clock clock;
+ typedef Stopwatch stopwatch;
+ typedef Formatter formatter;
+
+ explicit wstopwatch_reporter( system::error_code & ec = system::throws );
+ explicit wstopwatch_reporter( std::ostream & os,
+ system::error_code & ec = system::throws );
+
+ explicit wstopwatch_reporter( const std::string & format,
+ system::error_code & ec = system::throws );
+ explicit wstopwatch_reporter( std::ostream & os, const std::string & format,
+ system::error_code & ec = system::throws );
+
+ explicit wstopwatch_reporter( const std::string & format, int places,
+ system::error_code & ec = system::throws );
+ explicit wstopwatch_reporter( std::ostream & os, const std::string & format, int places,
+ system::error_code & ec = system::throws );
+
+ explicit wstopwatch_reporter( int places,
+ system::error_code & ec = system::throws );
+ explicit wstopwatch_reporter( std::ostream & os, int places,
+ system::error_code & ec = system::throws );
+
+ explicit wstopwatch_reporter( int places, const std::string & format,
+ system::error_code & ec = system::throws );
+ explicit wstopwatch_reporter( std::ostream & os, int places, const std::string & format,
+ system::error_code & ec = system::throws );
+
+ ~wstopwatch_reporter();
+
+ void report( system::error_code & ec = system::throws );
+ bool reported() const;
+
+
+ typedef stopwatch_runner<wstopwatch_reporter<Stopwatch> > scoped_run;
+ typedef stopwatch_suspender<wstopwatch_reporter<Stopwatch> > scoped_suspend;
+ typedef stopwatch_resumer<wstopwatch_reporter<Stopwatch> > scoped_resume;
+};
+</pre>
+
+ Usage
+ 
+<pre class="programlisting">void f1()
+{
+ typedef wstopwatch_reporter<stopwatch_accumulator<> > accumulator;
+ static accumulator t;
+ accumulator::scoped_run _(t);
+ // ...
+
+ // call to some function we don't want to measure
+ {
+ accumulator::scoped_suspend _(t);
+ external_function();
+ }
+}
+</pre>
+</div>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="boost_stopwatches.reference.reporters.stopclock_hpp"></a><a href="reporters.html#boost_stopwatches.reference.reporters.stopclock_hpp" title="
+ Header <boost/stopwatches/stopclock.hpp>">
+ Header <code class="computeroutput"><boost/stopwatches/stopclock.hpp></code></a>
+</h4></div></div></div>
+<div class="toc"><dl>
+<dt><a href="reporters.html#boost_stopwatches.reference.reporters.stopclock_hpp.basic_stopclock">
+ Template Class <code class="computeroutput">basic_stopclock<></code></a></dt>
+<dt><a href="reporters.html#boost_stopwatches.reference.reporters.stopclock_hpp.stopclock">
+ Template Class <code class="computeroutput">stopclock<></code></a></dt>
+<dt><a href="reporters.html#boost_stopwatches.reference.reporters.stopclock_hpp.stopclock_typedefs">
+ <code class="computeroutput">stopclock</code> useful typedefs</a></dt>
+<dt><a href="reporters.html#boost_stopwatches.reference.reporters.stopclock_hpp.wstopclock">
+ Template Class <code class="computeroutput">wstopclock<></code></a></dt>
+<dt><a href="reporters.html#boost_stopwatches.reference.reporters.stopclock_hpp.wstopclock_typedefs">
+ <code class="computeroutput">wstopclock</code> useful typedefs</a></dt>
+</dl></div>
+<pre class="programlisting">namespace boost { namespace stopwatches {
+ template < class Clock, class Formatter > class basic_stopclock;
+ template < class Clock, class Formatter > class <a href="reporters.html#boost_stopwatches.reference.reporters.stopclock_hpp.stopclock" title="
+ Template Class stopclock<>"><code class="computeroutput">stopclock</code></a>;
+ template < class Clock, class Formatter > class wstopclock;
+
+ typedef <see above> system_stopclock;
+ #ifdef <code class="computeroutput">BOOST_CHRONO_HAS_CLOCK_MONOTONIC</code>
+ typedef <see above> monotonic_stopclock;
+ #endif
+ typedef <see above> high_resolution_stopclock;
+ typedef <see above> process_real_cpu_stopclock;
+ typedef <see above> process_user_cpu_stopclock;
+ typedef <see above> process_system_cpu_stopclock;
+
+ typedef <see above> system_wstopclock;
+ #ifdef <code class="computeroutput">BOOST_CHRONO_HAS_CLOCK_MONOTONIC</code>
+ typedef <see above> monotonic_wstopclock;
+ #endif
+ typedef <see above> high_resolution_wstopclock;
+ typedef <see above> process_real_cpu_wstopclock;
+ typedef <see above> process_user_cpu_wstopclock;
+ typedef <see above> process_system_cpu_wstopclock;
+}}
+</pre>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="boost_stopwatches.reference.reporters.stopclock_hpp.basic_stopclock"></a><a href="reporters.html#boost_stopwatches.reference.reporters.stopclock_hpp.basic_stopclock" title="
+ Template Class basic_stopclock<>">
+ Template Class <code class="computeroutput">basic_stopclock<></code></a>
+</h5></div></div></div>
+
+ <code class="computeroutput">basic_stopclock<Clock,Formatter></code>
+ template class is a shortcut of <code class="computeroutput">basic_stopwatch_reporter<stopwatch<Clock,Formatter>></code>
+ 
+<pre class="programlisting">template< class Clock, class Formatter>
+class basic_stopclock : public basic_stopwatch_reporter<stopwatch<Clock>, Formatter> {
+public:
+ typedef Clock clock;
+ typedef stopwatch<Clock> stopwatch;
+ typedef Formatter formatter;
+ typedef typename Formatter::string_type string_type;
+ typedef typename Formatter::char_type char_type;
+ typedef typename Formatter::ostream_type ostream_type;
+
+ explicit basic_stopclock( system::error_code & ec = system::throws );
+ explicit basic_stopclock( ostream_type & os,
+ system::error_code & ec = system::throws );
+ explicit basic_stopclock( const string_type & format,
+ system::error_code & ec = system::throws );
+ explicit basic_stopclock( int places,
+ system::error_code & ec = system::throws );
+
+ basic_stopclock( ostream_type & os, const string_type & format,
+ system::error_code & ec = system::throws );
+ basic_stopclock( const string_type & format, int places,
+ system::error_code & ec = system::throws );
+ basic_stopclock( ostream_type & os, int places,
+ system::error_code & ec = system::throws );
+ basic_stopclock( int places, const string_type & format,
+ system::error_code & ec = system::throws );
+
+ basic_stopclock( ostream_type & os, const string_type & format, int places,
+ system::error_code & ec = system::throws );
+ basic_stopclock( ostream_type & os, int places, const string_type & format,
+ system::error_code & ec = system::throws );
+
+
+ typedef typename base_type::scoped_run scoped_run;
+ typedef typename base_type::scoped_suspend scoped_suspend;
+ typedef typename base_type::scoped_resume scoped_resume;
+};
+</pre>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="boost_stopwatches.reference.reporters.stopclock_hpp.stopclock"></a><a href="reporters.html#boost_stopwatches.reference.reporters.stopclock_hpp.stopclock" title="
+ Template Class stopclock<>">
+ Template Class <code class="computeroutput">stopclock<></code></a>
+</h5></div></div></div>
+
+ A stopclock is a stopwatch with the ability to report elapsed time on
+ an output stream. <code class="computeroutput">stopclock<Clock></code> template class is a shortcut of
+ <code class="computeroutput">basic_stopclock<Clock, typename stopwatch_reporter_default_formatter<stopwatch<Clock>>::type></code> with a specific default formatter.
+ 
+<pre class="programlisting">template
+ < class Clock=process_cpu_clock
+ , class Formatter=typename stopwatch_reporter_default_formatter<stopwatch<Clock>>::type
+> class stopclock : public basic_stopclock<Clock, Formatter> {
+public:
+ typedef Clock clock;
+ typedef stopwatch<Clock> stopwatch;
+ typedef Formatter formatter;
+ typedef typename Formatter::string_type string_type;
+ typedef typename Formatter::char_type char_type;
+ typedef typename Formatter::ostream_type ostream_type;
+
+ explicit stopclock( system::error_code & ec = system::throws );
+ explicit stopclock( ostream_type & os,
+ system::error_code & ec = system::throws );
+ explicit stopclock( const string_type & format,
+ system::error_code & ec = system::throws );
+ explicit stopclock( int places,
+ system::error_code & ec = system::throws );
+
+ stopclock( ostream_type & os, const string_type & format,
+ system::error_code & ec = system::throws );
+ stopclock( const string_type & format, int places,
+ system::error_code & ec = system::throws );
+ stopclock( ostream_type & os, int places,
+ system::error_code & ec = system::throws );
+ stopclock( int places, const string_type & format,
+ system::error_code & ec = system::throws );
+
+ stopclock( ostream_type & os, const string_type & format, int places,
+ system::error_code & ec = system::throws );
+ stopclock( ostream_type & os, int places, const string_type & format,
+ system::error_code & ec = system::throws );
+
+
+ typedef typename base_type::scoped_run scoped_run;
+ typedef typename base_type::scoped_suspend scoped_suspend;
+ typedef typename base_type::scoped_resume scoped_resume;
+};
+</pre>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="boost_stopwatches.reference.reporters.stopclock_hpp.stopclock_typedefs"></a><a href="reporters.html#boost_stopwatches.reference.reporters.stopclock_hpp.stopclock_typedefs" title="
+ stopclock useful typedefs">
+ <code class="computeroutput">stopclock</code> useful typedefs</a>
+</h5></div></div></div>
+
+ The library provides stopclock shortcuts for all the models of <code class="computeroutput">Clock</code>, replacing clock by stopclock.
+ 
+<pre class="programlisting">typedef boost::stopwatches::stopclock< boost::chrono::system_clock >
+ system_stopwatch_stopclock;
+#ifdef <code class="computeroutput">BOOST_CHRONO_HAS_CLOCK_MONOTONIC</code>
+typedef boost::stopwatches::stopclock< boost::chrono::monotonic_clock >
+ monotonic_stopwatch_stopclock;
+#endif
+typedef boost::stopwatches::stopclock< boost::chrono::high_resolution_clock >
+ high_resolution_stopclock;
+typedef boost::stopwatches::stopclock< boost::chrono::process_real_cpu_clock >
+ process_real_cpu_stopclock;
+typedef boost::stopwatches::stopclock< boost::chrono::process_user_cpu_clock >
+ process_user_cpu_stopclock;
+typedef boost::stopwatches::stopclock< boost::chrono::process_system_cpu_clock >
+ process_system_cpu_stopclock;
+</pre>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="boost_stopwatches.reference.reporters.stopclock_hpp.wstopclock"></a><a href="reporters.html#boost_stopwatches.reference.reporters.stopclock_hpp.wstopclock" title="
+ Template Class wstopclock<>">
+ Template Class <code class="computeroutput">wstopclock<></code></a>
+</h5></div></div></div>
+
+ <code class="computeroutput">wstopclock<Clock></code>
+ template class is a shortcut of <code class="computeroutput">basic_wstopclock<Clock, typename stopwatch_reporter_default_formatter<stopwatch<Clock>>::type></code> with a specific default formatter.
+ 
+<pre class="programlisting">template
+ < class Clock=process_cpu_clock
+ , class Formatter=typename stopwatch_reporter_default_formatter<stopwatch<Clock>>::type
+> class wstopclock : public basic_wstopclock<Clock, Formatter> {
+public:
+ typedef Clock clock;
+ typedef stopwatch<Clock> stopwatch;
+ typedef Formatter formatter;
+ typedef typename Formatter::string_type string_type;
+ typedef typename Formatter::char_type char_type;
+ typedef typename Formatter::ostream_type ostream_type;
+
+ explicit wstopclock( system::error_code & ec = system::throws );
+ explicit wstopclock( ostream_type & os,
+ system::error_code & ec = system::throws );
+ explicit wstopclock( const string_type & format,
+ system::error_code & ec = system::throws );
+ explicit wstopclock( int places,
+ system::error_code & ec = system::throws );
+
+ wstopclock( ostream_type & os, const string_type & format,
+ system::error_code & ec = system::throws );
+ wstopclock( const string_type & format, int places,
+ system::error_code & ec = system::throws );
+ wstopclock( ostream_type & os, int places,
+ system::error_code & ec = system::throws );
+ wstopclock( int places, const string_type & format,
+ system::error_code & ec = system::throws );
+
+ wstopclock( ostream_type & os, const string_type & format, int places,
+ system::error_code & ec = system::throws );
+ wstopclock( ostream_type & os, int places, const string_type & format,
+ system::error_code & ec = system::throws );
+
+
+ typedef typename base_type::scoped_run scoped_run;
+ typedef typename base_type::scoped_suspend scoped_suspend;
+ typedef typename base_type::scoped_resume scoped_resume;
+};
+</pre>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="boost_stopwatches.reference.reporters.stopclock_hpp.wstopclock_typedefs"></a><a href="reporters.html#boost_stopwatches.reference.reporters.stopclock_hpp.wstopclock_typedefs" title="
+ wstopclock useful typedefs">
+ <code class="computeroutput">wstopclock</code> useful typedefs</a>
+</h5></div></div></div>
+
+ The library provides wstopclock shortcuts for all the models of <code class="computeroutput">Clock</code>, replacing clock by wstopclock.
+ 
+<pre class="programlisting">typedef boost::stopwatches::wstopclock< boost::chrono::system_clock >
+ system_wstopclock;
+#ifdef <code class="computeroutput">BOOST_CHRONO_HAS_CLOCK_MONOTONIC</code>
+typedef boost::stopwatches::wstopclock< boost::chrono::monotonic_clock >
+ monotonic_wstopclock;
+#endif
+typedef boost::stopwatches::wstopclock< boost::chrono::high_resolution_clock >
+ high_resolution_wstopclock;
+typedef boost::stopwatches::wstopclock< boost::chrono::process_real_cpu_clock >
+ process_real_cpu_wstopclock;
+typedef boost::stopwatches::wstopclock< boost::chrono::process_user_cpu_clock >
+ process_user_cpu_wstopclock;
+typedef boost::stopwatches::wstopclock< boost::chrono::process_system_cpu_clock >
+ process_system_cpu_wstopclock;
+</pre>
+</div>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="boost_stopwatches.reference.reporters.stopclock_accumulator_hpp"></a><a href="reporters.html#boost_stopwatches.reference.reporters.stopclock_accumulator_hpp" title="
+ Header <boost/stopwatches/stopclock_accumulator.hpp>">
+ Header <code class="computeroutput"><boost/stopwatches/stopclock_accumulator.hpp></code></a>
+</h4></div></div></div>
+<div class="toc"><dl>
+<dt><a href="reporters.html#boost_stopwatches.reference.reporters.stopclock_accumulator_hpp.basic_stopclock_accumulator">
+ Template Class <code class="computeroutput">basic_stopclock_accumulator<></code></a></dt>
+<dt><a href="reporters.html#boost_stopwatches.reference.reporters.stopclock_accumulator_hpp.stopclock_accumulator">
+ Template Class <code class="computeroutput">stopclock_accumulator<></code></a></dt>
+<dt><a href="reporters.html#boost_stopwatches.reference.reporters.stopclock_accumulator_hpp.stopclock_accumulator_typedefs">
+ <code class="computeroutput">stopclock_accumulator</code> useful
+ typedefs</a></dt>
+<dt><a href="reporters.html#boost_stopwatches.reference.reporters.stopclock_accumulator_hpp.wstopclock_accumulator">
+ Template Class <code class="computeroutput">wstopclock_accumulator<></code></a></dt>
+<dt><a href="reporters.html#boost_stopwatches.reference.reporters.stopclock_accumulator_hpp.wstopclock_accumulator_typedefs">
+ <code class="computeroutput">wstopclock_accumulator</code>
+ useful typedefs</a></dt>
+</dl></div>
+<pre class="programlisting">namespace boost { namespace stopwatches {
+ template < class Clock, class Formatter >
+ class basic_stopclock_accumulator;
+ template < class Clock, class Formatter >
+ class <a href="reporters.html#boost_stopwatches.reference.reporters.stopclock_accumulator_hpp.stopclock_accumulator" title="
+ Template Class stopclock_accumulator<>"><code class="computeroutput">stopclock_accumulator</code></a>;
+ template < class Clock, class Formatter >
+ class wstopclock_accumulator;
+
+ typedef <see above> system_stopclock_accumulator;
+ #ifdef <code class="computeroutput">BOOST_CHRONO_HAS_CLOCK_MONOTONIC</code>
+ typedef <see above> monotonic_stopclock_accumulator;
+ #endif
+ typedef <see above> high_resolution_stopclock_accumulator;
+ typedef <see above> process_real_cpu_stopclock_accumulator;
+ typedef <see above> process_user_cpu_stopclock_accumulator;
+ typedef <see above> process_system_cpu_stopclock_accumulator;
+
+ typedef <see above> system_wstopclock_accumulator;
+ #ifdef <code class="computeroutput">BOOST_CHRONO_HAS_CLOCK_MONOTONIC</code>
+ typedef <see above> monotonic_wstopclock_accumulator;
+ #endif
+ typedef <see above> high_resolution_wstopclock_accumulator;
+ typedef <see above> process_real_cpu_wstopclock_accumulator;
+ typedef <see above> process_user_cpu_wstopclock_accumulator;
+ typedef <see above> process_system_cpu_wstopclock_accumulator;
+}}
+</pre>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="boost_stopwatches.reference.reporters.stopclock_accumulator_hpp.basic_stopclock_accumulator"></a><a href="reporters.html#boost_stopwatches.reference.reporters.stopclock_accumulator_hpp.basic_stopclock_accumulator" title="
+ Template Class basic_stopclock_accumulator<>">
+ Template Class <code class="computeroutput">basic_stopclock_accumulator<></code></a>
+</h5></div></div></div>
+
+ <code class="computeroutput">basic_stopclock_accumulator<Clock></code> template class is a shortcut of
+ <code class="computeroutput">basic_stopwatch_reporter<stopwatch_accumulator<Clock>, typename
+ stopwatch_reporter_default_formatter<stopwatch_accumulator<Clock>>::type></code>
+ 
+<pre class="programlisting">template
+ < class Clock=high_resolution_clock
+ , class Formatter=
+ typename stopwatch_reporter_default_formatter<stopwatch_accumulator<Clock>>::type
+> class basic_stopclock_accumulator
+ : public basic_stopwatch_reporter<stopwatch_accumulator<Clock>, Formatter> {
+public:
+ typedef Clock clock;
+ typedef stopwatch_accumulator<Clock> stopwatch;
+ typedef Formatter formatter;
+ typedef typename Formatter::string_type string_type;
+ typedef typename Formatter::char_type char_type;
+ typedef typename Formatter::ostream_type ostream_type;
+
+ explicit basic_stopclock_accumulator( system::error_code & ec = system::throws );
+ explicit basic_stopclock_accumulator( ostream_type & os,
+ system::error_code & ec = system::throws );
+ explicit basic_stopclock_accumulator( const string_type & format,
+ system::error_code & ec = system::throws );
+ explicit basic_stopclock_accumulator( int places,
+ system::error_code & ec = system::throws );
+
+ basic_stopclock_accumulator( ostream_type & os, const string_type & format,
+ system::error_code & ec = system::throws );
+ basic_stopclock_accumulator( const string_type & format, int places,
+ system::error_code & ec = system::throws );
+ basic_stopclock_accumulator( ostream_type & os, int places,
+ system::error_code & ec = system::throws );
+ basic_stopclock_accumulator( int places, const string_type & format,
+ system::error_code & ec = system::throws );
+
+ basic_stopclock_accumulator( ostream_type & os, const string_type & format, int places,
+ system::error_code & ec = system::throws );
+ basic_stopclock_accumulator( ostream_type & os, int places, const string_type & format,
+ system::error_code & ec = system::throws );
+
+
+ typedef typename base_type::scoped_run scoped_run;
+ typedef typename base_type::scoped_suspend scoped_suspend;
+ typedef typename base_type::scoped_resume scoped_resume;
+};
+</pre>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="boost_stopwatches.reference.reporters.stopclock_accumulator_hpp.stopclock_accumulator"></a><a href="reporters.html#boost_stopwatches.reference.reporters.stopclock_accumulator_hpp.stopclock_accumulator" title="
+ Template Class stopclock_accumulator<>">
+ Template Class <code class="computeroutput">stopclock_accumulator<></code></a>
+</h5></div></div></div>
+
+ <code class="computeroutput">stopclock_accumulator<Clock></code> template class is a shortcut of
+ <code class="computeroutput">stopwatch_reporter<stopwatch<Clock>></code>
+ with a specific formatter.
+ 
+<pre class="programlisting">template
+ < class Clock=high_resolution_clock
+ , class Formatter=
+ typename stopwatch_reporter_default_formatter<stopwatch_accumulator<Clock>>::type
+> class stopclock_accumulator
+ : public basic_stopclock_accumulator<Clock, Formatter> {
+public:
+ typedef Clock clock;
+ typedef stopwatch_accumulator<Clock> stopwatch;
+ typedef Formatter formatter;
+ typedef typename Formatter::string_type string_type;
+ typedef typename Formatter::char_type char_type;
+ typedef typename Formatter::ostream_type ostream_type;
+
+ explicit stopclock_accumulator( system::error_code & ec = system::throws );
+ explicit stopclock_accumulator( ostream_type & os,
+ system::error_code & ec = system::throws );
+ explicit stopclock_accumulator( const string_type & format,
+ system::error_code & ec = system::throws );
+ explicit stopclock_accumulator( int places,
+ system::error_code & ec = system::throws );
+
+ stopclock_accumulator( ostream_type & os, const string_type & format,
+ system::error_code & ec = system::throws );
+ stopclock_accumulator( const string_type & format, int places,
+ system::error_code & ec = system::throws );
+ stopclock_accumulator( ostream_type & os, int places,
+ system::error_code & ec = system::throws );
+ stopclock_accumulator( int places, const string_type & format,
+ system::error_code & ec = system::throws );
+
+ stopclock_accumulator( ostream_type & os, const string_type & format, int places,
+ system::error_code & ec = system::throws );
+ stopclock_accumulator( ostream_type & os, int places, const string_type & format,
+ system::error_code & ec = system::throws );
+
+
+ typedef typename base_type::scoped_run scoped_run;
+ typedef typename base_type::scoped_suspend scoped_suspend;
+ typedef typename base_type::scoped_resume scoped_resume;
+};
+</pre>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="boost_stopwatches.reference.reporters.stopclock_accumulator_hpp.stopclock_accumulator_typedefs"></a><a href="reporters.html#boost_stopwatches.reference.reporters.stopclock_accumulator_hpp.stopclock_accumulator_typedefs" title="
+ stopclock_accumulator useful
+ typedefs">
+ <code class="computeroutput">stopclock_accumulator</code> useful
+ typedefs</a>
+</h5></div></div></div>
+
+ The library provides stopclock_accumulator shortcuts for all the models
+ of <code class="computeroutput">Clock</code>, replacing clock
+ by stopclock_accumulator.
+ 
+<pre class="programlisting">typedef boost::stopwatches::stopclock_accumulator< boost::chrono::system_clock >
+ system_stopclock_accumulator;
+#ifdef <code class="computeroutput">BOOST_CHRONO_HAS_CLOCK_MONOTONIC</code>
+typedef boost::stopwatches::stopclock_accumulator< boost::chrono::monotonic_clock >
+ monotonic_stopclock_accumulator;
+#endif
+typedef boost::stopwatches::stopclock_accumulator< boost::chrono::high_resolution_clock >
+ high_resolution_stopclock_accumulator;
+typedef boost::stopwatches::stopclock_accumulator< boost::chrono::process_real_cpu_clock >
+ process_real_cpu_stopclock_accumulator;
+typedef boost::stopwatches::stopclock_accumulator< boost::chrono::process_user_cpu_clock >
+ process_user_cpu_stopclock_accumulator;
+typedef boost::stopwatches::stopclock_accumulator< boost::chrono::process_system_cpu_clock >
+ process_system_cpu_stopclock_accumulator;
+</pre>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="boost_stopwatches.reference.reporters.stopclock_accumulator_hpp.wstopclock_accumulator"></a><a href="reporters.html#boost_stopwatches.reference.reporters.stopclock_accumulator_hpp.wstopclock_accumulator" title="
+ Template Class wstopclock_accumulator<>">
+ Template Class <code class="computeroutput">wstopclock_accumulator<></code></a>
+</h5></div></div></div>
+
+ <code class="computeroutput">wstopclock_accumulator<Clock></code> template class is a shortcut of
+ <code class="computeroutput">stopwatch_reporter<stopwatch<Clock>></code>
+ with a specific formatter.
+ 
+<pre class="programlisting">template
+ < class Clock=high_resolution_clock
+ , class Formatter=
+ typename stopwatch_reporter_default_formatter<stopwatch_accumulator<Clock>>::type
+> class wstopclock_accumulator
+ : public basic_wstopclock_accumulator<Clock, Formatter> {
+public:
+ typedef Clock clock;
+ typedef stopwatch_accumulator<Clock> stopwatch;
+ typedef Formatter formatter;
+ typedef typename Formatter::string_type string_type;
+ typedef typename Formatter::char_type char_type;
+ typedef typename Formatter::ostream_type ostream_type;
+
+ explicit wstopclock_accumulator( system::error_code & ec = system::throws );
+ explicit wstopclock_accumulator( ostream_type & os,
+ system::error_code & ec = system::throws );
+ explicit wstopclock_accumulator( const string_type & format,
+ system::error_code & ec = system::throws );
+ explicit wstopclock_accumulator( int places,
+ system::error_code & ec = system::throws );
+
+ wstopclock_accumulator( ostream_type & os, const string_type & format,
+ system::error_code & ec = system::throws );
+ wstopclock_accumulator( const string_type & format, int places,
+ system::error_code & ec = system::throws );
+ wstopclock_accumulator( ostream_type & os, int places,
+ system::error_code & ec = system::throws );
+ wstopclock_accumulator( int places, const string_type & format,
+ system::error_code & ec = system::throws );
+
+ wstopclock_accumulator( ostream_type & os, const string_type & format, int places,
+ system::error_code & ec = system::throws );
+ wstopclock_accumulator( ostream_type & os, int places, const string_type & format,
+ system::error_code & ec = system::throws );
+
+
+ typedef typename base_type::scoped_run scoped_run;
+ typedef typename base_type::scoped_suspend scoped_suspend;
+ typedef typename base_type::scoped_resume scoped_resume;
+};
+</pre>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="boost_stopwatches.reference.reporters.stopclock_accumulator_hpp.wstopclock_accumulator_typedefs"></a><a href="reporters.html#boost_stopwatches.reference.reporters.stopclock_accumulator_hpp.wstopclock_accumulator_typedefs" title="
+ wstopclock_accumulator
+ useful typedefs">
+ <code class="computeroutput">wstopclock_accumulator</code>
+ useful typedefs</a>
+</h5></div></div></div>
+
+ The library provides wstopclock_accumulator shortcuts for all the models
+ of <code class="computeroutput">Clock</code>, replacing clock
+ by wstopclock_accumulator.
+ 
+<pre class="programlisting">typedef boost::stopwatches::wstopclock_accumulator< boost::chrono::system_clock >
+ system_wstopclock_accumulator;
+#ifdef <code class="computeroutput">BOOST_CHRONO_HAS_CLOCK_MONOTONIC</code>
+typedef boost::stopwatches::wstopclock_accumulator< boost::chrono::monotonic_clock >
+ monotonic_wstopclock_accumulator;
+#endif
+typedef boost::stopwatches::wstopclock_accumulator< boost::chrono::high_resolution_clock >
+ high_resolution_wstopclock_accumulator;
+typedef boost::stopwatches::wstopclock_accumulator< boost::chrono::process_real_cpu_clock >
+ process_real_cpu_wstopclock_accumulator;
+typedef boost::stopwatches::wstopclock_accumulator< boost::chrono::process_user_cpu_clock >
+ process_user_cpu_wstopclock_accumulator;
+typedef boost::stopwatches::wstopclock_accumulator< boost::chrono::process_system_cpu_clock >
+ process_system_cpu_wstopclock_accumulator;
+</pre>
+</div>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="boost_stopwatches.reference.reporters.scoped_stopclock_hpp"></a><a href="reporters.html#boost_stopwatches.reference.reporters.scoped_stopclock_hpp" title="
+ Header <boost/stopwatches/scoped_stopclock.hpp>">
+ Header <code class="computeroutput"><boost/stopwatches/scoped_stopclock.hpp></code></a>
+</h4></div></div></div>
+<div class="toc"><dl><dt><a href="reporters.html#boost_stopwatches.reference.reporters.scoped_stopclock_hpp.scoped_stopclock">
+ Template Class <code class="computeroutput">scoped_stopclock<></code></a></dt></dl></div>
+<pre class="programlisting">namespace boost { namespace stopwatches {
+ template < class Clock, class Formatter > class scoped_stopclock;
+}}
+</pre>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="boost_stopwatches.reference.reporters.scoped_stopclock_hpp.scoped_stopclock"></a><a href="reporters.html#boost_stopwatches.reference.reporters.scoped_stopclock_hpp.scoped_stopclock" title="
+ Template Class scoped_stopclock<>">
+ Template Class <code class="computeroutput">scoped_stopclock<></code></a>
+</h5></div></div></div>
+
+ <code class="computeroutput">scoped_stopclock<></code>is
+ like a <code class="computeroutput">stopclock<></code>
+ but that in addition will output a scoped trace. At construction time
+ it will output
+ 
+<pre class="programlisting">{{{ <string>
+</pre>
+
+ and at destruction time
+ 
+<pre class="programlisting">}}} <string> <output of stopwatch_reporter>
+</pre>
+
+ A typical ussage of this class is
+ 
+<pre class="programlisting">int f1(long j)
+{
+ scoped_stopclock<> _(BOOST_CURRENT_FUNCTION);
+
+ for ( long i = 0; i < j; ++i )
+ std::sqrt( 123.456L ); // burn some time
+
+ return 0;
+}
+</pre>
+<a name="boost_stopwatches.reference.reporters.scoped_stopclock_hpp.scoped_stopclock.synopsis"></a><h6>
+<a name="id5038110"></a>
+ Synopsis
+ </h6>
+<pre class="programlisting">template < class Clock=process_cpu_clock
+ , class Formatter=typename stopwatch_reporter_default_formatter<stopwatch<Clock>>::type
+> class scoped_stopclock
+ : public stopwatch_reporter<stopwatch<Clock>, Formatter> {
+public:
+ typedef Clock clock;
+ typedef Stopwatch stopwatch;
+ typedef Formatter formatter;
+ typedef typename Formatter::string_type string_type;
+ typedef typename Formatter::char_type char_type;
+ typedef typename Formatter::ostream_type ostream_type;
+
+ explicit scoped_stopclock( const std::string& func,
+ system::error_code & ec = system::throws );
+ scoped_stopclock( const std::string& func, ostream_type & os,
+ system::error_code & ec = system::throws );
+
+ scoped_stopclock( const std::string& func, const string_type & format,
+ system::error_code & ec = system::throws );
+
+ scoped_stopclock( const std::string& func, int places,
+ system::error_code & ec = system::throws );
+
+ scoped_stopclock( const std::string& func, ostream_type & os,
+ const string_type & format,
+ system::error_code & ec = system::throws );
+
+ scoped_stopclock( const std::string& func, const string_type & format,
+ int places, system::error_code & ec = system::throws );
+
+ scoped_stopclock( const std::string& func, ostream_type & os, int places,
+ system::error_code & ec = system::throws );
+
+ scoped_stopclock( const std::string& func, int places,
+ const string_type & format, system::error_code & ec = system::throws );
+
+ scoped_stopclock( const std::string& func, ostream_type & os,
+ const string_type & format, int places,
+ system::error_code & ec = system::throws );
+
+ scoped_stopclock( const std::string& func, ostream_type & os, int places,
+ const string_type & format, system::error_code & ec = system::throws );
+
+ ~scoped_stopclock();
+
+ typedef typename base_type::scoped_run scoped_run;
+ typedef typename base_type::scoped_suspend scoped_suspend;
+ typedef typename base_type::scoped_resume scoped_resume;
+};
+</pre>
+</div>
+</div>
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer">Copyright © 2009 -2010 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)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="stopwatches.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="formatters.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/reference/stopwatches.html
==============================================================================
--- (empty file)
+++ sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/reference/stopwatches.html 2010-09-07 13:07:01 EDT (Tue, 07 Sep 2010)
@@ -0,0 +1,1108 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title> Stopwatches</title>
+<link rel="stylesheet" href="../../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
+<link rel="start" href="../../index.html" title="Boost.Stopwatches 0.1.0">
+<link rel="up" href="../reference.html" title=" Reference ">
+<link rel="prev" href="other_clocks.html" title=" Other clocks">
+<link rel="next" href="reporters.html" title=" Stopwatch Reporters">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td>
+<td align="center">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="other_clocks.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="reporters.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="boost_stopwatches.reference.stopwatches"></a> Stopwatches
+</h3></div></div></div>
+<div class="toc"><dl>
+<dt><a href="stopwatches.html#boost_stopwatches.reference.stopwatches.stopwatch_req">
+ <code class="computeroutput">Stopwatch</code> Requirements</a></dt>
+<dd><dl>
+<dt><a href="stopwatches.html#boost_stopwatches.reference.stopwatches.stopwatch_req.stopwatch_start">
+ Member Function <code class="computeroutput">start()</code></a></dt>
+<dt><a href="stopwatches.html#boost_stopwatches.reference.stopwatches.stopwatch_req.stopwatch_stop">
+ Member Function <code class="computeroutput">stop()</code></a></dt>
+<dt><a href="stopwatches.html#boost_stopwatches.reference.stopwatches.stopwatch_req.stopwatch_suspend">
+ Member Function <code class="computeroutput">suspend()</code></a></dt>
+<dt><a href="stopwatches.html#boost_stopwatches.reference.stopwatches.stopwatch_req.stopwatch_resume">
+ Member Function <code class="computeroutput">resume()</code></a></dt>
+<dt><a href="stopwatches.html#boost_stopwatches.reference.stopwatches.stopwatch_req.stopwatch_restart">
+ Member Function <code class="computeroutput">restart()</code></a></dt>
+</dl></dd>
+<dt><a href="stopwatches.html#boost_stopwatches.reference.stopwatches.lightweight_stopwatch_hpp">
+ Header <code class="computeroutput"><boost/stopwatches/lightweight_stopwatch.hpp></code></a></dt>
+<dd><dl>
+<dt><a href="stopwatches.html#boost_stopwatches.reference.stopwatches.lightweight_stopwatch_hpp.dont_start_t">
+ Class <code class="computeroutput">dont_start_t</code></a></dt>
+<dt><a href="stopwatches.html#boost_stopwatches.reference.stopwatches.lightweight_stopwatch_hpp.lightweight_stopwatch">
+ Template Class <code class="computeroutput">lightweight_stopwatch<></code></a></dt>
+</dl></dd>
+<dt><a href="stopwatches.html#boost_stopwatches.reference.stopwatches.stopwatch_hpp">
+ Header <code class="computeroutput"><boost/stopwatches/stopwatch.hpp></code></a></dt>
+<dd><dl>
+<dt><a href="stopwatches.html#boost_stopwatches.reference.stopwatches.stopwatch_hpp.stopwatch">
+ Template Class <code class="computeroutput">stopwatch<></code></a></dt>
+<dt><a href="stopwatches.html#boost_stopwatches.reference.stopwatches.stopwatch_hpp.spec">
+ <code class="computeroutput">stopwatch_reporter_default_formatter</code>
+ Specialization</a></dt>
+<dt><a href="stopwatches.html#boost_stopwatches.reference.stopwatches.stopwatch_hpp.stopwatch_typedefs">
+ <code class="computeroutput">stopwatch</code> useful typedefs</a></dt>
+</dl></dd>
+<dt><a href="stopwatches.html#boost_stopwatches.reference.stopwatches.stopwatch_accumulator_hpp">
+ Header <code class="computeroutput"><boost/stopwatches/stopwatch_accumulator.hpp></code></a></dt>
+<dd><dl>
+<dt><a href="stopwatches.html#boost_stopwatches.reference.stopwatches.stopwatch_accumulator_hpp.stopwatch_accumulator">
+ Template Class <code class="computeroutput">stopwatch_accumulator<></code></a></dt>
+<dt><a href="stopwatches.html#boost_stopwatches.reference.stopwatches.stopwatch_accumulator_hpp.spec">
+ <code class="computeroutput">stopwatch_reporter_default_formatter</code>
+ Specialization</a></dt>
+<dt><a href="stopwatches.html#boost_stopwatches.reference.stopwatches.stopwatch_accumulator_hpp.stopwatch_accumulator_typedefs">
+ <code class="computeroutput">stopwatch_accumulator</code> useful
+ typedefs</a></dt>
+</dl></dd>
+<dt><a href="stopwatches.html#boost_stopwatches.reference.stopwatches.stopwatch_scoped_hpp">
+ Header <code class="computeroutput"><boost/stopwatches/stopwatch_scoped.hpp></code></a></dt>
+<dd><dl>
+<dt><a href="stopwatches.html#boost_stopwatches.reference.stopwatches.stopwatch_scoped_hpp.stopwatch_runner">
+ Template Class <code class="computeroutput">stopwatch_runner<></code></a></dt>
+<dt><a href="stopwatches.html#boost_stopwatches.reference.stopwatches.stopwatch_scoped_hpp.stopwatch_suspender">
+ Template Class <code class="computeroutput">stopwatch_suspender<></code></a></dt>
+<dt><a href="stopwatches.html#boost_stopwatches.reference.stopwatches.stopwatch_scoped_hpp.stopwatch_resumer">
+ Template Class <code class="computeroutput">stopwatch_resumer<></code></a></dt>
+</dl></dd>
+</dl></div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="boost_stopwatches.reference.stopwatches.stopwatch_req"></a><a href="stopwatches.html#boost_stopwatches.reference.stopwatches.stopwatch_req" title="
+ Stopwatch Requirements">
+ <code class="computeroutput">Stopwatch</code> Requirements</a>
+</h4></div></div></div>
+<div class="toc"><dl>
+<dt><a href="stopwatches.html#boost_stopwatches.reference.stopwatches.stopwatch_req.stopwatch_start">
+ Member Function <code class="computeroutput">start()</code></a></dt>
+<dt><a href="stopwatches.html#boost_stopwatches.reference.stopwatches.stopwatch_req.stopwatch_stop">
+ Member Function <code class="computeroutput">stop()</code></a></dt>
+<dt><a href="stopwatches.html#boost_stopwatches.reference.stopwatches.stopwatch_req.stopwatch_suspend">
+ Member Function <code class="computeroutput">suspend()</code></a></dt>
+<dt><a href="stopwatches.html#boost_stopwatches.reference.stopwatches.stopwatch_req.stopwatch_resume">
+ Member Function <code class="computeroutput">resume()</code></a></dt>
+<dt><a href="stopwatches.html#boost_stopwatches.reference.stopwatches.stopwatch_req.stopwatch_restart">
+ Member Function <code class="computeroutput">restart()</code></a></dt>
+</dl></div>
+
+ A Stopwatch measure the amount of time elapsed from a start point in time
+ to the stop point time or the accumulation of them. Stopwatches can in
+ addition be restarted, suspended and resumed.
+ 
+
+ A Stopwatch must meet the requirements in the following table. In this
+ table <code class="computeroutput">S</code>, <code class="computeroutput">S1</code> and <code class="computeroutput">S2</code>
+ denote stopwatches types. <code class="computeroutput">s</code>
+ is an instance of <code class="computeroutput">S</code>.
+ 
+<div class="table">
+<a name="boost_stopwatches.reference.stopwatches.stopwatch_req.stopwatch_requirements"></a>Table 2. Stopwatch Requirements
+<table class="table" summary="Stopwatch Requirements">
+<colgroup>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ expression
+ 
+ </th>
+<th>
+ 
+ return type
+ 
+ </th>
+<th>
+ 
+ operational semantics
+ 
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ 
+ <code class="computeroutput">S::clock</code>
+ 
+ </td>
+<td>
+ 
+ A model of <code class="computeroutput">Clock</code>.
+ 
+ </td>
+<td>
+ 
+ The clock associated to this Stopwatch.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">S::duration</code>
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">S::clock::duration</code>
+ 
+ </td>
+<td>
+ 
+ The <code class="computeroutput">duration</code>
+ type of the <code class="computeroutput">clock</code>.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">S::time_point</code>
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">S::clock::time_point</code>
+ 
+ </td>
+<td>
+ 
+ The <code class="computeroutput">time_point</code>
+ type of the <code class="computeroutput">clock</code>.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">S::scoped_run</code>
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">stopwatch_runner<stopwatch<Clock> ></code>
+ 
+ </td>
+<td>
+ 
+ RAI which <code class="computeroutput">start</code>/<code class="computeroutput">stop</code> the <code class="computeroutput">stopwatch</code>.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">S::scoped_suspend</code>
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">stopwatch_suspender<stopwatch<Clock> ></code>
+ 
+ </td>
+<td>
+ 
+ RAI which <code class="computeroutput">suspend</code>/<code class="computeroutput">resume</code> the <code class="computeroutput">stopwatch</code>.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">S::scoped_resume</code>
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">stopwatch_resumer<stopwatch<Clock> ></code>
+ 
+ </td>
+<td>
+ 
+ RAI which <code class="computeroutput">resume</code>/<code class="computeroutput">suspend</code> the <code class="computeroutput">stopwatch</code>.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">s.start()</code>
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">S::time_point</code>
+ 
+ </td>
+<td>
+ 
+ starts a Stopwatch.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">s.restart()</code>
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">std::pair<S::duration,S::time_point></code>
+ 
+ </td>
+<td>
+ 
+ restarts a Stopwatch.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">s.stop()</code>
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">S::duration</code>
+ 
+ </td>
+<td>
+ 
+ stops a Stopwatch.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">s.resume()</code>
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">S::time_point</code>
+ 
+ </td>
+<td>
+ 
+ resume a Stopwatch.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">s.suspend()</code>
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">S::duration</code>
+ 
+ </td>
+<td>
+ 
+ suspends a Stopwatch.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">s.elapsed()</code>
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">S::duration</code>
+ 
+ </td>
+<td>
+ 
+ the elapsed time while the Stopwatch was running.
+ 
+ </td>
+</tr>
+</tbody>
+</table>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="boost_stopwatches.reference.stopwatches.stopwatch_req.stopwatch_start"></a><a href="stopwatches.html#boost_stopwatches.reference.stopwatches.stopwatch_req.stopwatch_start" title="
+ Member Function start()">
+ Member Function <code class="computeroutput">start()</code></a>
+</h5></div></div></div>
+<pre class="programlisting">time_point start( system::error_code & ec = system::throws );
+</pre>
+
+ Effect: Starts running the stopwatch.
+ 
+
+ Returns: the starting time point.
+ 
+
+ Throw: Any exception the <code class="computeroutput">Clock::now</code> function can throw when <code class="computeroutput">ec</code> is <code class="computeroutput">system::throws</code>
+ 
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="boost_stopwatches.reference.stopwatches.stopwatch_req.stopwatch_stop"></a><a href="stopwatches.html#boost_stopwatches.reference.stopwatches.stopwatch_req.stopwatch_stop" title="
+ Member Function stop()">
+ Member Function <code class="computeroutput">stop()</code></a>
+</h5></div></div></div>
+<pre class="programlisting">duration stop( system::error_code & ec = system::throws );
+</pre>
+
+ Effect: Stops running the stopwatch.
+ 
+
+ Returns: The cummulated elapsed time.
+ 
+
+ Throw: Any exception the <code class="computeroutput">Clock::now</code> function can throw when <code class="computeroutput">ec</code> is <code class="computeroutput">system::throws</code>
+ 
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="boost_stopwatches.reference.stopwatches.stopwatch_req.stopwatch_suspend"></a><a href="stopwatches.html#boost_stopwatches.reference.stopwatches.stopwatch_req.stopwatch_suspend" title="
+ Member Function suspend()">
+ Member Function <code class="computeroutput">suspend()</code></a>
+</h5></div></div></div>
+<pre class="programlisting">duration suspend( system::error_code & ec = system::throws );
+</pre>
+
+ Effect: Suspends the stopwatch.
+ 
+
+ Throw: Any exception the <code class="computeroutput">Clock::now</code> function can throw when <code class="computeroutput">ec</code> is <code class="computeroutput">system::throws</code>
+ 
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="boost_stopwatches.reference.stopwatches.stopwatch_req.stopwatch_resume"></a><a href="stopwatches.html#boost_stopwatches.reference.stopwatches.stopwatch_req.stopwatch_resume" title="
+ Member Function resume()">
+ Member Function <code class="computeroutput">resume()</code></a>
+</h5></div></div></div>
+<pre class="programlisting">time_point resume( system::error_code & ec = system::throws );
+</pre>
+
+ Effect: Resumes the stopwatch.
+ 
+
+ Returns: the starting time point.
+ 
+
+ Throw: Any exception the Clock::now
+ function can throw.
+ 
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="boost_stopwatches.reference.stopwatches.stopwatch_req.stopwatch_restart"></a><a href="stopwatches.html#boost_stopwatches.reference.stopwatches.stopwatch_req.stopwatch_restart" title="
+ Member Function restart()">
+ Member Function <code class="computeroutput">restart()</code></a>
+</h5></div></div></div>
+<pre class="programlisting">time_point restart( system::error_code & ec = system::throws );
+</pre>
+
+ Effect: <code class="computeroutput">stop</code>/<code class="computeroutput">start</code> the stopwatch.
+ 
+
+ Returns: the starting time point.
+ 
+
+ Throw: Any exception the <code class="computeroutput">Clock::now</code> function can throw when <code class="computeroutput">ec</code> is <code class="computeroutput">system::throws</code>
+ 
+</div>
+
+ Models of <code class="computeroutput">Stopwatch</code>:
+ 
+<div class="itemizedlist"><ul type="disc">
+<li>
+ <a href="stopwatches.html#boost_stopwatches.reference.stopwatches.stopwatch_hpp.stopwatch" title="
+ Template Class stopwatch<>"><code class="computeroutput">stopwatch</code></a>
+ </li>
+<li>
+ <a href="stopwatches.html#boost_stopwatches.reference.stopwatches.stopwatch_accumulator_hpp.stopwatch_accumulator" title="
+ Template Class stopwatch_accumulator<>"><code class="computeroutput">stopwatch_accumulator</code></a>
+ </li>
+</ul></div>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="boost_stopwatches.reference.stopwatches.lightweight_stopwatch_hpp"></a><a href="stopwatches.html#boost_stopwatches.reference.stopwatches.lightweight_stopwatch_hpp" title="
+ Header <boost/stopwatches/lightweight_stopwatch.hpp>">
+ Header <code class="computeroutput"><boost/stopwatches/lightweight_stopwatch.hpp></code></a>
+</h4></div></div></div>
+<div class="toc"><dl>
+<dt><a href="stopwatches.html#boost_stopwatches.reference.stopwatches.lightweight_stopwatch_hpp.dont_start_t">
+ Class <code class="computeroutput">dont_start_t</code></a></dt>
+<dt><a href="stopwatches.html#boost_stopwatches.reference.stopwatches.lightweight_stopwatch_hpp.lightweight_stopwatch">
+ Template Class <code class="computeroutput">lightweight_stopwatch<></code></a></dt>
+</dl></div>
+<pre class="programlisting">namespace boost { namespace stopwatches {
+ struct dont_start_t;
+ static const dont_start_t dont_start;
+
+ template <class Clock=high_resolution_clock,
+ typename Features=void,
+ typename Weight=void
+ > class __lightweight_stopwatch__;
+
+ typedef <see above> system_lightweight_stopwatch;
+ #ifdef <code class="computeroutput">BOOST_CHRONO_HAS_CLOCK_MONOTONIC</code>
+ typedef <see above> monotonic_lightweight_stopwatch;
+ #endif
+ typedef <see above> high_resolution_lightweight_stopwatch;
+}}
+</pre>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="boost_stopwatches.reference.stopwatches.lightweight_stopwatch_hpp.dont_start_t"></a><a href="stopwatches.html#boost_stopwatches.reference.stopwatches.lightweight_stopwatch_hpp.dont_start_t" title="
+ Class dont_start_t">
+ Class <code class="computeroutput">dont_start_t</code></a>
+</h5></div></div></div>
+
+ Structure used to don't start a <code class="computeroutput">lightweight_stopwatch</code>
+ at construction time.
+ 
+<pre class="programlisting">struct dont_start_t;
+static const dont_start_t dont_start;
+</pre>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="boost_stopwatches.reference.stopwatches.lightweight_stopwatch_hpp.lightweight_stopwatch"></a><a href="stopwatches.html#boost_stopwatches.reference.stopwatches.lightweight_stopwatch_hpp.lightweight_stopwatch" title="
+ Template Class lightweight_stopwatch<>">
+ Template Class <code class="computeroutput">lightweight_stopwatch<></code></a>
+</h5></div></div></div>
+<div class="toc"><dl>
+<dt><a href="stopwatches.html#boost_stopwatches.reference.stopwatches.lightweight_stopwatch_hpp.lightweight_stopwatch.c1">
+ Constructor <code class="computeroutput">lightweight_stopwatch( storage&, system::error_code
+ &)</code></a></dt>
+<dt><a href="stopwatches.html#boost_stopwatches.reference.stopwatches.lightweight_stopwatch_hpp.lightweight_stopwatch.c2">
+ Constructor <code class="computeroutput">lightweight_stopwatch( storage&, dont_start_t
+ &)</code></a></dt>
+<dt><a href="stopwatches.html#boost_stopwatches.reference.stopwatches.lightweight_stopwatch_hpp.lightweight_stopwatch.lightweight_stopwatch_elapsed">
+ Member Function <code class="computeroutput">elapsed()</code></a></dt>
+<dt><a href="stopwatches.html#boost_stopwatches.reference.stopwatches.lightweight_stopwatch_hpp.lightweight_stopwatch.stopwatch_accumulator_accumulated">
+ Member Function <code class="computeroutput">accumulated()</code></a></dt>
+<dt><a href="stopwatches.html#boost_stopwatches.reference.stopwatches.lightweight_stopwatch_hpp.lightweight_stopwatch.stopwatch_accumulator_reset">
+ Member Function <code class="computeroutput">reset()</code></a></dt>
+</dl></div>
+
+ <code class="computeroutput">lightweight_stopwatch<></code> is a model of a __lightweight_stopwatchconcept_.
+ 
+
+ Knowing how long a part of a program takes to execute is useful in both
+ test and production environments. A __lightweightstopwatch_
+ object measures elapsed time. It is recommended to use it with clocks
+ that measure wall clock rather than CPU time since the intended use is
+ performance measurement on systems where total elapsed time is more important
+ than just process or CPU time.
+ 
+
+ The maximum measurable elapsed time depends on the Clock parameter. The
+ accuracy of timings depends on the accuracy of timing information provided
+ the Clock, and this coudl varies a great deal from one clock to another.
+ 
+<pre class="programlisting">template <class Clock, typename Features, typename Weight>
+class lightweight_stopwatch {
+public:
+ typedef Clock clock;
+ typedef typename Clock::duration duration;
+ typedef typename Clock::time_point time_point;
+ typedef <see below> storage;
+
+ explicit lightweight_stopwatch( storage& st, system::error_code & ec = system::throws );
+ lightweight_stopwatch( storage& st, const dont_start_t& t );
+
+ ~lightweight_stopwatch();
+
+ time_point start( system::error_code & ec = system::throws );
+ duration stop( system::error_code & ec = system::throws );
+ std::pair<duration,time_point> restart( system::error_code & ec = system::throws );
+
+ duration suspend( system::error_code & ec = system::throws );
+ time_point resume( system::error_code & ec = system::throws );
+
+ duration elapsed( system::error_code & ec = system::throws );
+
+ time_point now( system::error_code & ec = system::throws );
+
+ void reset( system::error_code & ec = system::throws );
+
+ storage& get_storage( );
+
+ duration lifetime( system::error_code & ec = system::throws );
+
+ typedef lightweight_stopwatch_runner<lightweight_stopwatch<Clock> > scoped_run;
+ typedef lightweight_stopwatch_suspender<lightweight_stopwatch<Clock> > scoped_suspend;
+ typedef lightweight_stopwatch_resumer<lightweight_stopwatch<Clock> > scoped_resume;
+ typedef lightweight_stopwatch_reporter<lightweight_stopwatch<Clock> > reporter;
+
+};
+</pre>
+
+ <code class="computeroutput">storage</code> is either <code class="computeroutput">Clock::duration</code> if Features and Weight are
+ void and <code class="computeroutput">accumulators::accumulator_set<typename
+ Clock::duration::rep, Features,
+ Weight></code>
+ otherwise.
+ 
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="boost_stopwatches.reference.stopwatches.lightweight_stopwatch_hpp.lightweight_stopwatch.c1"></a><a href="stopwatches.html#boost_stopwatches.reference.stopwatches.lightweight_stopwatch_hpp.lightweight_stopwatch.c1" title="
+ Constructor lightweight_stopwatch( storage&, system::error_code
+ &)">
+ Constructor <code class="computeroutput">lightweight_stopwatch( storage&, system::error_code
+ &)</code></a>
+</h6></div></div></div>
+<pre class="programlisting">explicit lightweight_stopwatch( storage& st, system::error_code & ec = system::throws );
+</pre>
+
+ Effect: constructs and starts the
+ lightweight_stopwatch.
+ 
+
+ Throw: Any exception the <code class="computeroutput">Clock::now</code> function can throw when <code class="computeroutput">ec</code> is <code class="computeroutput">system::throws</code>
+ 
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="boost_stopwatches.reference.stopwatches.lightweight_stopwatch_hpp.lightweight_stopwatch.c2"></a><a href="stopwatches.html#boost_stopwatches.reference.stopwatches.lightweight_stopwatch_hpp.lightweight_stopwatch.c2" title="
+ Constructor lightweight_stopwatch( storage&, dont_start_t
+ &)">
+ Constructor <code class="computeroutput">lightweight_stopwatch( storage&, dont_start_t
+ &)</code></a>
+</h6></div></div></div>
+<pre class="programlisting">explicit lightweight_stopwatch( storage& st, const dont_start_t& t );
+</pre>
+
+ Effect: constructs the lightweight_stopwatch
+ without starting it.
+ 
+
+ Throw: Nothing.
+ 
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="boost_stopwatches.reference.stopwatches.lightweight_stopwatch_hpp.lightweight_stopwatch.lightweight_stopwatch_elapsed"></a><a href="stopwatches.html#boost_stopwatches.reference.stopwatches.lightweight_stopwatch_hpp.lightweight_stopwatch.lightweight_stopwatch_elapsed" title="
+ Member Function elapsed()">
+ Member Function <code class="computeroutput">elapsed()</code></a>
+</h6></div></div></div>
+<pre class="programlisting">duration elapsed(system::error_code & ec = system::throws) const;
+</pre>
+
+ Returns: the cumulated elapsed time.
+ 
+
+ Throw: Any exception the <code class="computeroutput">Clock::now</code> function can throw when <code class="computeroutput">ec</code> is <code class="computeroutput">system::throws</code>
+ 
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="boost_stopwatches.reference.stopwatches.lightweight_stopwatch_hpp.lightweight_stopwatch.stopwatch_accumulator_accumulated"></a><a href="stopwatches.html#boost_stopwatches.reference.stopwatches.lightweight_stopwatch_hpp.lightweight_stopwatch.stopwatch_accumulator_accumulated" title="
+ Member Function accumulated()">
+ Member Function <code class="computeroutput">accumulated()</code></a>
+</h6></div></div></div>
+<pre class="programlisting">storage& get_storage();
+</pre>
+
+ Returns: the assocaited storage reference.
+ 
+
+ Throw: Nothing.
+ 
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="boost_stopwatches.reference.stopwatches.lightweight_stopwatch_hpp.lightweight_stopwatch.stopwatch_accumulator_reset"></a><a href="stopwatches.html#boost_stopwatches.reference.stopwatches.lightweight_stopwatch_hpp.lightweight_stopwatch.stopwatch_accumulator_reset" title="
+ Member Function reset()">
+ Member Function <code class="computeroutput">reset()</code></a>
+</h6></div></div></div>
+<pre class="programlisting">void reset( );
+</pre>
+
+ Effect: Stop the lightweight_stopwatch
+ and reinit the storage.
+ 
+
+ Throw: Nothing.
+ 
+</div>
+</div>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="boost_stopwatches.reference.stopwatches.stopwatch_hpp"></a><a href="stopwatches.html#boost_stopwatches.reference.stopwatches.stopwatch_hpp" title="
+ Header <boost/stopwatches/stopwatch.hpp>">
+ Header <code class="computeroutput"><boost/stopwatches/stopwatch.hpp></code></a>
+</h4></div></div></div>
+<div class="toc"><dl>
+<dt><a href="stopwatches.html#boost_stopwatches.reference.stopwatches.stopwatch_hpp.stopwatch">
+ Template Class <code class="computeroutput">stopwatch<></code></a></dt>
+<dt><a href="stopwatches.html#boost_stopwatches.reference.stopwatches.stopwatch_hpp.spec">
+ <code class="computeroutput">stopwatch_reporter_default_formatter</code>
+ Specialization</a></dt>
+<dt><a href="stopwatches.html#boost_stopwatches.reference.stopwatches.stopwatch_hpp.stopwatch_typedefs">
+ <code class="computeroutput">stopwatch</code> useful typedefs</a></dt>
+</dl></div>
+<pre class="programlisting">namespace boost { namespace stopwatches {
+ template <class Clock=high_resolution_clock> class <a href="stopwatches.html#boost_stopwatches.reference.stopwatches.stopwatch_hpp.stopwatch" title="
+ Template Class stopwatch<>"><code class="computeroutput">stopwatch</code></a>;
+
+ template <class Clock>
+ struct stopwatch_reporter_default_formatter<stopwatch<Clock> > {
+ typedef stopwatch_formatter type;
+ };
+
+ template <class Clock>
+ struct wstopwatch_reporter_default_formatter<stopwatch<Clock> > {
+ typedef wstopwatch_formatter type;
+ };
+
+ typedef <see above> system_stopwatch;
+ #ifdef <code class="computeroutput">BOOST_CHRONO_HAS_CLOCK_MONOTONIC</code>
+ typedef <see above> monotonic_stopwatch;
+ #endif
+ typedef <see above> high_resolution_stopwatch;
+}}
+</pre>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="boost_stopwatches.reference.stopwatches.stopwatch_hpp.stopwatch"></a><a href="stopwatches.html#boost_stopwatches.reference.stopwatches.stopwatch_hpp.stopwatch" title="
+ Template Class stopwatch<>">
+ Template Class <code class="computeroutput">stopwatch<></code></a>
+</h5></div></div></div>
+<div class="toc"><dl>
+<dt><a href="stopwatches.html#boost_stopwatches.reference.stopwatches.stopwatch_hpp.stopwatch.c1">
+ Constructor <code class="computeroutput">stopwatch( system::error_code
+ &)</code></a></dt>
+<dt><a href="stopwatches.html#boost_stopwatches.reference.stopwatches.stopwatch_hpp.stopwatch.c2">
+ Constructor <code class="computeroutput">stopwatch( dont_start_t
+ &)</code></a></dt>
+</dl></div>
+
+ <code class="computeroutput">stopwatch<></code>
+ is a model of a <a href="stopwatches.html#boost_stopwatches.reference.stopwatches.stopwatch_req" title="
+ Stopwatch Requirements"><code class="computeroutput">Stopwatch</code> concept</a>.
+ 
+
+ Knowing how long a part of a program takes to execute is useful in both
+ test and production environments. A <a href="stopwatches.html#boost_stopwatches.reference.stopwatches.stopwatch_hpp.stopwatch" title="
+ Template Class stopwatch<>"><code class="computeroutput">stopwatch</code></a> object measures elapsed
+ time. It is recommended to use it with clocks that measure wall clock
+ rather than CPU time since the intended use is performance measurement
+ on systems where total elapsed time is more important than just process
+ or CPU time.
+ 
+
+ The maximum measurable elapsed time depends on the Clock parameter. The
+ accuracy of timings depends on the accuracy of timing information provided
+ the Clock, and this coudl varies a great deal from one clock to another.
+ 
+<pre class="programlisting">template <class Clock>
+class stopwatch : private base_from_member<typename Clock::duration>, public lightweight_stopwatch<Clock>
+{
+public:
+ explicit stopwatch( system::error_code & ec = system::throws );
+ explicit stopwatch( const dont_start_t& t );
+
+};
+</pre>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="boost_stopwatches.reference.stopwatches.stopwatch_hpp.stopwatch.c1"></a><a href="stopwatches.html#boost_stopwatches.reference.stopwatches.stopwatch_hpp.stopwatch.c1" title="
+ Constructor stopwatch( system::error_code
+ &)">
+ Constructor <code class="computeroutput">stopwatch( system::error_code
+ &)</code></a>
+</h6></div></div></div>
+<pre class="programlisting">explicit stopwatch( system::error_code & ec = system::throws );
+</pre>
+
+ Effect: constructs and starts the
+ stopwatch.
+ 
+
+ Throw: Any exception the <code class="computeroutput">Clock::now</code> function can throw when <code class="computeroutput">ec</code> is <code class="computeroutput">system::throws</code>
+ 
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="boost_stopwatches.reference.stopwatches.stopwatch_hpp.stopwatch.c2"></a><a href="stopwatches.html#boost_stopwatches.reference.stopwatches.stopwatch_hpp.stopwatch.c2" title="
+ Constructor stopwatch( dont_start_t
+ &)">
+ Constructor <code class="computeroutput">stopwatch( dont_start_t
+ &)</code></a>
+</h6></div></div></div>
+<pre class="programlisting">explicit stopwatch( const dont_start_t& t );
+</pre>
+
+ Effect: constructs the stopwatch without
+ starting it.
+ 
+
+ Throw: Nothing.
+ 
+</div>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="boost_stopwatches.reference.stopwatches.stopwatch_hpp.spec"></a><a href="stopwatches.html#boost_stopwatches.reference.stopwatches.stopwatch_hpp.spec" title="
+ stopwatch_reporter_default_formatter
+ Specialization">
+ <code class="computeroutput">stopwatch_reporter_default_formatter</code>
+ Specialization</a>
+</h5></div></div></div>
+
+ The <code class="computeroutput">stopwatch_reporter_default_formatter</code>
+ of a <code class="computeroutput">stopwatch<Clock></code>
+ is a <code class="computeroutput">stopwatch_formatter</code>.
+ 
+<pre class="programlisting">template <class Clock>
+struct stopwatch_reporter_default_formatter<stopwatch<Clock> > {
+ typedef stopwatch_formatter type;
+};
+</pre>
+
+ The <code class="computeroutput">wstopwatch_reporter_default_formatter</code>
+ of a <code class="computeroutput">stopwatch<Clock></code>
+ is a <code class="computeroutput">wstopwatch_formatter</code>.
+ 
+<pre class="programlisting">template <class Clock>
+struct wstopwatch_reporter_default_formatter<stopwatch<Clock> > {
+ typedef wstopwatch_formatter type;
+};
+</pre>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="boost_stopwatches.reference.stopwatches.stopwatch_hpp.stopwatch_typedefs"></a><a href="stopwatches.html#boost_stopwatches.reference.stopwatches.stopwatch_hpp.stopwatch_typedefs" title="
+ stopwatch useful typedefs">
+ <code class="computeroutput">stopwatch</code> useful typedefs</a>
+</h5></div></div></div>
+
+ The library provides stopwatch short cuts for all the models of <code class="computeroutput">Clock</code>, replacing clock by stopwatch.
+ 
+<pre class="programlisting">typedef boost::stopwatches::stopwatch< boost::chrono::system_clock >
+ system_stopwatch;
+#ifdef <code class="computeroutput">BOOST_CHRONO_HAS_CLOCK_MONOTONIC</code>
+typedef boost::stopwatches::stopwatch< boost::chrono::monotonic_clock >
+ monotonic_stopwatch;
+#endif
+typedef boost::stopwatches::stopwatch< boost::chrono::high_resolution_clock >
+ high_resolution_stopwatch;
+</pre>
+</div>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="boost_stopwatches.reference.stopwatches.stopwatch_accumulator_hpp"></a><a href="stopwatches.html#boost_stopwatches.reference.stopwatches.stopwatch_accumulator_hpp" title="
+ Header <boost/stopwatches/stopwatch_accumulator.hpp>">
+ Header <code class="computeroutput"><boost/stopwatches/stopwatch_accumulator.hpp></code></a>
+</h4></div></div></div>
+<div class="toc"><dl>
+<dt><a href="stopwatches.html#boost_stopwatches.reference.stopwatches.stopwatch_accumulator_hpp.stopwatch_accumulator">
+ Template Class <code class="computeroutput">stopwatch_accumulator<></code></a></dt>
+<dt><a href="stopwatches.html#boost_stopwatches.reference.stopwatches.stopwatch_accumulator_hpp.spec">
+ <code class="computeroutput">stopwatch_reporter_default_formatter</code>
+ Specialization</a></dt>
+<dt><a href="stopwatches.html#boost_stopwatches.reference.stopwatches.stopwatch_accumulator_hpp.stopwatch_accumulator_typedefs">
+ <code class="computeroutput">stopwatch_accumulator</code> useful
+ typedefs</a></dt>
+</dl></div>
+<pre class="programlisting">namespace boost { namespace stopwatches {
+ template <class Clock,
+ typename Features=accumulators::features<
+ accumulators::tag::count,
+ accumulators::tag::sum,
+ accumulators::tag::min,
+ accumulators::tag::max,
+ accumulators::tag::mean >,
+ typename Weight=void
+ > class <a href="stopwatches.html#boost_stopwatches.reference.stopwatches.stopwatch_accumulator_hpp.stopwatch_accumulator" title="
+ Template Class stopwatch_accumulator<>"><code class="computeroutput">stopwatch_accumulator</code></a>;
+
+ template <class Clock, class Accumulator>
+ struct stopwatch_reporter_default_formatter<stopwatch_accumulator<Clock, Accumulator> > {
+ typedef stopwatch_accumulator_formatter type;
+ };
+
+ template <class Clock, class Accumulator>
+ struct wstopwatch_reporter_default_formatter<stopwatch_accumulator<Clock, Accumulator> > {
+ typedef wstopwatch_accumulator_formatter type;
+ };
+
+ typedef <see below> system_stopwatch_accumulator;
+#ifdef <code class="computeroutput">BOOST_CHRONO_HAS_CLOCK_MONOTONIC</code>
+ typedef <see below> monotonic_stopwatch_accumulator;
+#endif
+ typedef <see below> high_resolution_stopwatch_accumulator;
+
+}}
+</pre>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="boost_stopwatches.reference.stopwatches.stopwatch_accumulator_hpp.stopwatch_accumulator"></a><a href="stopwatches.html#boost_stopwatches.reference.stopwatches.stopwatch_accumulator_hpp.stopwatch_accumulator" title="
+ Template Class stopwatch_accumulator<>">
+ Template Class <code class="computeroutput">stopwatch_accumulator<></code></a>
+</h5></div></div></div>
+<div class="toc"><dl><dt><a href="stopwatches.html#boost_stopwatches.reference.stopwatches.stopwatch_accumulator_hpp.stopwatch_accumulator.stopwatch_accumulator_c">
+ Constructor <code class="computeroutput">stopwatch_accumulator()</code></a></dt></dl></div>
+
+ A <code class="computeroutput">stopwatch_accumulator<></code> is a model of a <a href="stopwatches.html#boost_stopwatches.reference.stopwatches.stopwatch_req" title="
+ Stopwatch Requirements"><code class="computeroutput">Stopwatch</code> concept</a> that allows
+ to accumulate the time in several times instead of at once as it is the
+ case of the class <a href="stopwatches.html#boost_stopwatches.reference.stopwatches.stopwatch_hpp.stopwatch" title="
+ Template Class stopwatch<>"><code class="computeroutput">stopwatch</code></a><code class="computeroutput"><></code>.
+ 
+<pre class="programlisting">template <class Clock, typename Features, typename Weight>
+class stopwatch_accumulator
+ : private base_from_member<typename accumulators::accumulator_set<typename Clock::duration::rep, Features, Weight> >,
+ public lightweight_stopwatch<Clock,Features,Weight>
+{
+public:
+ stopwatch_accumulator( );
+};
+</pre>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="boost_stopwatches.reference.stopwatches.stopwatch_accumulator_hpp.stopwatch_accumulator.stopwatch_accumulator_c"></a><a href="stopwatches.html#boost_stopwatches.reference.stopwatches.stopwatch_accumulator_hpp.stopwatch_accumulator.stopwatch_accumulator_c" title="
+ Constructor stopwatch_accumulator()">
+ Constructor <code class="computeroutput">stopwatch_accumulator()</code></a>
+</h6></div></div></div>
+<pre class="programlisting">stopwatch_accumulator();
+</pre>
+
+ Effect: Initialize the elapsed duration
+ and the times counter to 0.
+ 
+</div>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="boost_stopwatches.reference.stopwatches.stopwatch_accumulator_hpp.spec"></a><a href="stopwatches.html#boost_stopwatches.reference.stopwatches.stopwatch_accumulator_hpp.spec" title="
+ stopwatch_reporter_default_formatter
+ Specialization">
+ <code class="computeroutput">stopwatch_reporter_default_formatter</code>
+ Specialization</a>
+</h5></div></div></div>
+
+ The <code class="computeroutput">stopwatch_reporter_default_formatter</code>
+ of a <code class="computeroutput">stopwatch_accumulator<Clock></code> is a <code class="computeroutput">stopwatch_accumulator_formatter</code>.
+ 
+<pre class="programlisting">template <class Clock, class Accumulator>
+struct stopwatch_reporter_default_formatter<stopwatch_accumulator<Clock, Accumulator> > {
+ typedef stopwatch_accumulator_formatter type;
+};
+</pre>
+
+ The <code class="computeroutput">wstopwatch_reporter_default_formatter</code>
+ of a <code class="computeroutput">stopwatch_accumulator<Clock></code> is a <code class="computeroutput">wstopwatch_accumulator_formatter</code>.
+ 
+<pre class="programlisting">template <class Clock, class Accumulator>
+struct wstopwatch_reporter_default_formatter<stopwatch_accumulator<Clock, Accumulator> > {
+ typedef wstopwatch_accumulator_formatter type;
+};
+</pre>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="boost_stopwatches.reference.stopwatches.stopwatch_accumulator_hpp.stopwatch_accumulator_typedefs"></a><a href="stopwatches.html#boost_stopwatches.reference.stopwatches.stopwatch_accumulator_hpp.stopwatch_accumulator_typedefs" title="
+ stopwatch_accumulator useful
+ typedefs">
+ <code class="computeroutput">stopwatch_accumulator</code> useful
+ typedefs</a>
+</h5></div></div></div>
+
+ The library provides stopwatch_accumulator shortcuts for all the models
+ of <code class="computeroutput">Clock</code>, replacing clock
+ by stopwatch_accumulator.
+ 
+<pre class="programlisting">typedef boost::stopwatches::stopwatch_accumulator< boost::chrono::system_clock >
+ system_stopwatch_accumulator;
+#ifdef <code class="computeroutput">BOOST_CHRONO_HAS_CLOCK_MONOTONIC</code>
+typedef boost::stopwatches::stopwatch_accumulator< boost::chrono::monotonic_clock >
+ monotonic_stopwatch_accumulator;
+#endif
+typedef boost::stopwatches::stopwatch_accumulator< boost::chrono::high_resolution_clock >
+ high_resolution_stopwatch_accumulator;
+</pre>
+</div>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="boost_stopwatches.reference.stopwatches.stopwatch_scoped_hpp"></a><a href="stopwatches.html#boost_stopwatches.reference.stopwatches.stopwatch_scoped_hpp" title="
+ Header <boost/stopwatches/stopwatch_scoped.hpp>">
+ Header <code class="computeroutput"><boost/stopwatches/stopwatch_scoped.hpp></code></a>
+</h4></div></div></div>
+<div class="toc"><dl>
+<dt><a href="stopwatches.html#boost_stopwatches.reference.stopwatches.stopwatch_scoped_hpp.stopwatch_runner">
+ Template Class <code class="computeroutput">stopwatch_runner<></code></a></dt>
+<dt><a href="stopwatches.html#boost_stopwatches.reference.stopwatches.stopwatch_scoped_hpp.stopwatch_suspender">
+ Template Class <code class="computeroutput">stopwatch_suspender<></code></a></dt>
+<dt><a href="stopwatches.html#boost_stopwatches.reference.stopwatches.stopwatch_scoped_hpp.stopwatch_resumer">
+ Template Class <code class="computeroutput">stopwatch_resumer<></code></a></dt>
+</dl></div>
+<pre class="programlisting">namespace boost { namespace stopwatches {
+ template <class Stopwatch> class stopwatch_runner;
+ template <class Stopwatch> class stopwatch_suspender;
+ template <class Stopwatch> class stopwatch_resumer;
+}}
+</pre>
+
+ Boost.Chrono provides some helper classes ensuring pairwised operations
+ (start/stop, suspend/resume, resule/suspend).
+ 
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="boost_stopwatches.reference.stopwatches.stopwatch_scoped_hpp.stopwatch_runner"></a><a href="stopwatches.html#boost_stopwatches.reference.stopwatches.stopwatch_scoped_hpp.stopwatch_runner" title="
+ Template Class stopwatch_runner<>">
+ Template Class <code class="computeroutput">stopwatch_runner<></code></a>
+</h5></div></div></div>
+
+ This helper class ensures that the start/stop are pairwised. Start the
+ associated accumulator at construction time, and stop it at destruction
+ time.
+ 
+<pre class="programlisting">template <class Stopwatch> class stopwatch_runner {
+public:
+ typedef Stopwatch stopwatch;
+ stopwatch_runner(stopwatch & a, system::error_code & ec = system::throws);
+ ~stopwatch_runner();
+ stopwatch_runner() = delete;
+ stopwatch_runner(const stopwatch_runner&) = delete;
+ stopwatch_runner& operator=(const stopwatch_runner&) = delete;
+};
+</pre>
+
+ Usage
+ 
+<pre class="programlisting">void f1()
+{
+ static stopwatch_accumulator<> t;
+ stopwatch_runner<stopwatch_accumulator<> > _(t);
+ // ...
+}
+</pre>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="boost_stopwatches.reference.stopwatches.stopwatch_scoped_hpp.stopwatch_suspender"></a><a href="stopwatches.html#boost_stopwatches.reference.stopwatches.stopwatch_scoped_hpp.stopwatch_suspender" title="
+ Template Class stopwatch_suspender<>">
+ Template Class <code class="computeroutput">stopwatch_suspender<></code></a>
+</h5></div></div></div>
+
+ This helper class ensures that the suspend/resume are pairwised. Suspend
+ the associated accumulator at construction time, and resume it at destruction
+ time.
+ 
+<pre class="programlisting">template <class Stopwatch> class stopwatch_suspender {
+public:
+ typedef Stopwatch stopwatch;
+ stopwatch_suspender(stopwatch & a, system::error_code & ec = system::throws);
+ ~stopwatch_suspender();
+ stopwatch_suspender() = delete;
+ stopwatch_suspender(const stopwatch_suspender&) = delete;
+ stopwatch_suspender& operator=(const stopwatch_suspender&) = delete;
+}
+</pre>
+
+ Usage
+ 
+<pre class="programlisting">void f1()
+{
+ static stopwatch_accumulator<> t;
+ stopwatch_runner<stopwatch_accumulator<> > _(t);
+ // ...
+
+ // call to some function we don't want to measure
+ {
+ stopwatch_suspender<stopwatch_accumulator<> > _(t);
+ external_function();
+ }
+}
+</pre>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="boost_stopwatches.reference.stopwatches.stopwatch_scoped_hpp.stopwatch_resumer"></a><a href="stopwatches.html#boost_stopwatches.reference.stopwatches.stopwatch_scoped_hpp.stopwatch_resumer" title="
+ Template Class stopwatch_resumer<>">
+ Template Class <code class="computeroutput">stopwatch_resumer<></code></a>
+</h5></div></div></div>
+
+ This helper class ensures that the resume/suspend are pairwised. Resume
+ the associated accumulator at construction time, and suspecd it at destruction
+ time.
+ 
+<pre class="programlisting">template <class Stopwatch> class stopwatch_resumer {
+public:
+ typedef Stopwatch stopwatch;
+ stopwatch_resumer(stopwatch & a, system::error_code & ec = system::throws);
+ ~stopwatch_resumer();
+ stopwatch_resumer() = delete;
+ stopwatch_resumer(const stopwatch_resumer&) = delete;
+ stopwatch_resumer& operator=(const stopwatch_resumer&) = delete;
+}
+</pre>
+
+ Usage
+ 
+<pre class="programlisting">void f1()
+{
+ static stopwatch_accumulator<> t;
+ stopwatch_runner<stopwatch_accumulator<> > _(t);
+ // ...
+
+ // call to some function we don't want to measure
+ {
+ stopwatch_suspender<stopwatch_accumulator<> > _(t);
+
+ {
+ stopwatch_resumer<stopwatch_accumulator<> > _(t);
+
+ }
+ }
+}
+</pre>
+</div>
+</div>
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer">Copyright © 2009 -2010 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)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="other_clocks.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="reporters.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/reference/stopwatches_hpp.html
==============================================================================
--- (empty file)
+++ sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/reference/stopwatches_hpp.html 2010-09-07 13:07:01 EDT (Tue, 07 Sep 2010)
@@ -0,0 +1,64 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title> Header
+ <boost/stopwatches.hpp></title>
+<link rel="stylesheet" href="../../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
+<link rel="start" href="../../index.html" title="Boost.Stopwatches 0.1.0">
+<link rel="up" href="../reference.html" title=" Reference ">
+<link rel="prev" href="../reference.html" title=" Reference ">
+<link rel="next" href="other_clocks.html" title=" Other clocks">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td>
+<td align="center">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="../reference.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="other_clocks.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="boost_stopwatches.reference.stopwatches_hpp"></a><a href="stopwatches_hpp.html" title=" Header
+ <boost/stopwatches.hpp>"> Header
+ <code class="computeroutput"><boost/stopwatches.hpp></code></a>
+</h3></div></div></div>
+
+ This file include all the stopwatches related files except the suspendible
+ related files.
+ 
+<pre class="programlisting">#include <boost/stopwatches/scoped_stopclock.hpp>
+#include <boost/stopwatches/stopclock.hpp>
+#include <boost/stopwatches/stopclock_accumulator.hpp>
+#include <boost/stopwatches/stopwatch.hpp>
+#include <boost/stopwatches/stopwatch_accumulator.hpp>
+#include <boost/stopwatches/stopwatch_accumulator_formatter.hpp>
+#include <boost/stopwatches/stopwatch_accumulator_time_formatter.hpp>
+#include <boost/stopwatches/stopwatch_formatter.hpp>
+#include <boost/stopwatches/stopwatch_reporter.hpp>
+#include <boost/stopwatches/stopwatch_scoped.hpp>
+#include <boost/stopwatches/time_formatter.hpp>
+#include <boost/stopwatches/t24_hours.hpp>
+#include <boost/stopwatches/t24_hours_formatter.hpp>
+</pre>
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer">Copyright © 2009 -2010 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)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="../reference.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="other_clocks.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/users_guide.html
==============================================================================
--- (empty file)
+++ sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/users_guide.html 2010-09-07 13:07:01 EDT (Tue, 07 Sep 2010)
@@ -0,0 +1,62 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title> Users'Guide</title>
+<link rel="stylesheet" href="../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
+<link rel="start" href="../index.html" title="Boost.Stopwatches 0.1.0">
+<link rel="up" href="../index.html" title="Boost.Stopwatches 0.1.0">
+<link rel="prev" href="overview/description.html" title="Description">
+<link rel="next" href="users_guide/getting_started.html" title=" Getting
+ Started">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td>
+<td align="center">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="overview/description.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="users_guide/getting_started.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h2 class="title" style="clear: both">
+<a name="boost_stopwatches.users_guide"></a> Users'Guide
+</h2></div></div></div>
+<div class="toc"><dl>
+<dt><a href="users_guide/getting_started.html"> Getting
+ Started</a></dt>
+<dd><dl>
+<dt><a href="users_guide/getting_started.html#boost_stopwatches.users_guide.getting_started.install">
+ Installing Boost.Stopwatches</a></dt>
+<dt><a href="users_guide/getting_started.html#boost_stopwatches.users_guide.getting_started.hello_world__">Hello
+ World! </a></dt>
+</dl></dd>
+<dt>Tutorial</dt>
+<dd><dl>
+<dt><a href="users_guide/tutorial.html#boost_stopwatches.users_guide.tutorial.stopwatches_and_stopclocks">Stopwatches
+ and Stopclocks</a></dt>
+<dt>Formatters</dt>
+</dl></dd>
+<dt>Examples</dt>
+<dd><dl><dt>Reporting</dt></dl></dd>
+</dl></div>
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer">Copyright © 2009 -2010 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)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="overview/description.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="users_guide/getting_started.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/users_guide/examples.html
==============================================================================
--- (empty file)
+++ sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/users_guide/examples.html 2010-09-07 13:07:01 EDT (Tue, 07 Sep 2010)
@@ -0,0 +1,201 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>Examples</title>
+<link rel="stylesheet" href="../../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
+<link rel="start" href="../../index.html" title="Boost.Stopwatches 0.1.0">
+<link rel="up" href="../users_guide.html" title=" Users'Guide">
+<link rel="prev" href="tutorial.html" title="Tutorial">
+<link rel="next" href="../reference.html" title=" Reference ">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td>
+<td align="center">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="tutorial.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../users_guide.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../reference.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="boost_stopwatches.users_guide.examples"></a>Examples
+</h3></div></div></div>
+<div class="toc"><dl>
+<dt>Reporting</dt>
+<dd><dl>
+<dt>stopclock_example.cpp</dt>
+<dt>stopclock_example2.cpp</dt>
+<dt><a href="examples.html#boost_stopwatches.users_guide.examples.reporting.time_command">time
+ command</a></dt>
+</dl></dd>
+</dl></div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="boost_stopwatches.users_guide.examples.reporting"></a>Reporting
+</h4></div></div></div>
+<div class="toc"><dl>
+<dt>stopclock_example.cpp</dt>
+<dt>stopclock_example2.cpp</dt>
+<dt><a href="examples.html#boost_stopwatches.users_guide.examples.reporting.time_command">time
+ command</a></dt>
+</dl></div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="boost_stopwatches.users_guide.examples.reporting.stopclock_example_cpp"></a>stopclock_example.cpp
+</h5></div></div></div>
+
+ Here is the stopclock_example.cpp program supplied with the Boost Chrono
+ library:
+ 
+
+ When the <code class="computeroutput">stopclock<>
+ t</code> object is created, it starts
+ timing. When it is destroyed at the end of the program, its destructor
+ stops the time counting and displays timing information on cout.
+ 
+<pre class="programlisting">#include <boost/stopwatches/stopclock.hpp>
+#include <cmath>
+
+int main()
+{
+ boost::stopwatches::<a href="../reference/reporters.html#boost_stopwatches.reference.reporters.stopclock_hpp.stopclock" title="
+ Template Class stopclock<>"><code class="computeroutput">stopclock</code></a><> t;
+
+ for ( long i = 0; i < 10000000; ++i )
+ std::sqrt( 123.456L ); // burn some time
+
+ return 0;
+}
+</pre>
+
+ The output of this program run looks like this:
+ 
+<pre class="programlisting">wall 0.42 s, user 0.41 s + system 0.00 s = total cpu 0.41 s, (96.3%)
+</pre>
+
+ In other words, this program ran in 0.42 seconds as would be measured
+ by a clock on the wall, the operating system charged it for 0.41 seconds
+ of user CPU time and 0 seconds of system CPU time, the total of these
+ two was 0.41, and that represented 96.3 percent of the wall clock time.
+ 
+
+ See the source file example/stopclock_example.cpp
+ 
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="boost_stopwatches.users_guide.examples.reporting.stopclock_example2_cpp"></a>stopclock_example2.cpp
+</h5></div></div></div>
+
+ The stopclock_example2.cpp program is the same, except that it supplies
+ additional constructor arguments from the command line:
+ 
+<pre class="programlisting">#include <boost/stopwatches/stopclock.hpp>
+#include <cmath>
+
+int main( int argc, char * argv[] )
+{
+ const char * format = argc > 1 ? argv[1] : "%t cpu seconds\n";
+ int places = argc > 2 ? std::atoi( argv[2] ) : 2;
+
+ boost::stopwatches::<a href="../reference/reporters.html#boost_stopwatches.reference.reporters.stopclock_hpp.stopclock" title="
+ Template Class stopclock<>"><code class="computeroutput">stopclock</code></a><> t( format, places );
+
+ for ( long i = 0; i < 10000000; ++i )
+ std::sqrt( 123.456L ); // burn some time
+
+ return 0;
+}
+</pre>
+
+ Here is the output for this program for several sets of command line
+ arguments:
+ 
+<pre class="programlisting">stopclock_example2
+0.42 cpu seconds
+
+stopclock_example2 "%w wall clock seconds\n"
+0.41 wall clock seconds
+
+stopclock_example2 "%w wall clock seconds\n" 6
+0.421875 wall clock seconds
+
+stopclock_example2 "%t total CPU seconds\n" 3
+0.422 total CPU seconds
+</pre>
+
+ See the source file example/stopclock_example2.cpp
+ 
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="boost_stopwatches.users_guide.examples.reporting.time_command"></a><a href="examples.html#boost_stopwatches.users_guide.examples.reporting.time_command" title="time
+ command">time
+ command</a>
+</h5></div></div></div>
+<pre class="programlisting">#include <boost/stopwatches/stopclock.hpp>
+#include <cstdlib>
+#include <string>
+#include <iostream>
+
+int main( int argc, char * argv[] )
+{
+ if ( argc == 1 )
+ {
+ std::cout << "invoke: timex [-v] command [args...]\n"
+ " command will be executed and timings displayed\n"
+ " -v option causes command and args to be displayed\n";
+ return 1;
+ }
+
+ std::string s;
+
+ bool verbose = false;
+ if ( argc > 1 && *argv[1] == '-' && *(argv[1]+1) == 'v' )
+ {
+ verbose = true;
+ ++argv;
+ --argc;
+ }
+
+ for ( int i = 1; i < argc; ++i )
+ {
+ if ( i > 1 ) s += ' ';
+ s += argv[i];
+ }
+
+ if ( verbose )
+ { std::cout << "command: \"" << s.c_str() << "\"\n"; }
+
+ boost::stopwatches::<a href="../reference/reporters.html#boost_stopwatches.reference.reporters.stopclock_hpp.stopclock" title="
+ Template Class stopclock<>"><code class="computeroutput">stopclock</code></a><> t;
+
+ return std::system( s.c_str() );
+}
+</pre>
+
+ See the source file example/timex.cpp
+ 
+</div>
+</div>
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer">Copyright © 2009 -2010 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)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="tutorial.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../users_guide.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../reference.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/users_guide/getting_started.html
==============================================================================
--- (empty file)
+++ sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/users_guide/getting_started.html 2010-09-07 13:07:01 EDT (Tue, 07 Sep 2010)
@@ -0,0 +1,320 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title> Getting
+ Started</title>
+<link rel="stylesheet" href="../../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
+<link rel="start" href="../../index.html" title="Boost.Stopwatches 0.1.0">
+<link rel="up" href="../users_guide.html" title=" Users'Guide">
+<link rel="prev" href="../users_guide.html" title=" Users'Guide">
+<link rel="next" href="tutorial.html" title="Tutorial">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td>
+<td align="center">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="../users_guide.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../users_guide.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="tutorial.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="boost_stopwatches.users_guide.getting_started"></a><a href="getting_started.html" title=" Getting
+ Started"> Getting
+ Started</a>
+</h3></div></div></div>
+<div class="toc"><dl>
+<dt><a href="getting_started.html#boost_stopwatches.users_guide.getting_started.install">
+ Installing Boost.Stopwatches</a></dt>
+<dt><a href="getting_started.html#boost_stopwatches.users_guide.getting_started.hello_world__">Hello
+ World! </a></dt>
+</dl></div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="boost_stopwatches.users_guide.getting_started.install"></a><a href="getting_started.html#boost_stopwatches.users_guide.getting_started.install" title="
+ Installing Boost.Stopwatches">
+ Installing Boost.Stopwatches</a>
+</h4></div></div></div>
+<a name="boost_stopwatches.users_guide.getting_started.install.getting__emphasis_role__bold__boost_stopwatches__emphasis__"></a><h5>
+<a name="id4949766"></a>
+ <a href="getting_started.html#boost_stopwatches.users_guide.getting_started.install.getting__emphasis_role__bold__boost_stopwatches__emphasis__">Getting
+ Boost.Stopwatches </a>
+ </h5>
+
+ You can get the last stable release of Boost.Stopwatches
+ by downloading <code class="literal">chrono.zip</code> from the <a href="http://www.boost-consulting.com/vault/index.php?directory=System" target="_top">Boost
+ Vault</a>, directories boost/stopwatches and libs/stopwatches.
+ 
+
+ You can also access the latest (unstable?) state from the <a href="http://svn.boost.org/svn/boost/sandbox/chrono" target="_top">Boost
+ Sandbox</a>, directories boost/stopwatches and libs/stopwatches. Just
+ go to here
+ and follow the instructions there for anonymous SVN access.
+ 
+<a name="boost_stopwatches.users_guide.getting_started.install.where_to_install__emphasis_role__bold__boost_stopwatches__emphasis___"></a><h5>
+<a name="id4949839"></a>
+ <a href="getting_started.html#boost_stopwatches.users_guide.getting_started.install.where_to_install__emphasis_role__bold__boost_stopwatches__emphasis___">Where
+ to install Boost.Stopwatches? </a>
+ </h5>
+
+ The simple way is to decompress (or checkout from SVN) the file in your
+ BOOST_ROOT directory.
+ 
+
+ Othesewise, if you decompress in a different directory, you will need to
+ comment some lines, and uncomment and change others in the build/Jamfile
+ and test/Jamfile. Sorry for this, but I have not reached yet to write a
+ Jamfile that is able to work in both environements and use the BOOST_ROOT
+ variable. Any help is welcome.
+ 
+<a name="boost_stopwatches.users_guide.getting_started.install.building__emphasis_role__bold__boost_stopwatches__emphasis__"></a><h5>
+<a name="id4942081"></a>
+ <a href="getting_started.html#boost_stopwatches.users_guide.getting_started.install.building__emphasis_role__bold__boost_stopwatches__emphasis__">Building
+ Boost.Stopwatches </a>
+ </h5>
+
+ Boost.Stopwatches is a header only library.
+ 
+<a name="boost_stopwatches.users_guide.getting_started.install.requirements"></a><h5>
+<a name="id4942117"></a>
+ Requirements
+ </h5>
+
+ Boost.Stopwatches depends on some Boost
+ libraries. For these specific parts you must use either Boost version 1.44.0
+ or the version in SVN trunk (even if older versions should works also).
+ 
+
+ In particular, Boost.Stopwatches depends
+ on:
+ 
+<div class="variablelist">
+
+<dl>
+<dt>Boost.Chrono</dt>
+<dd>
+ for duration, time_point and clocks, ...
+ </dd>
+<dt>Boost.Config</dt>
+<dd>
+ for configuration purposes, ...
+ </dd>
+<dt>Boost.Exception</dt>
+<dd>
+ for throw_exception, ...
+ </dd>
+<dt>Boost.MPL</dt>
+<dd>
+ for MPL Assert and bool, ...
+ </dd>
+<dt>Boost.System</dt>
+<dd>
+ for error_code, ...
+ </dd>
+<dt>Boost.Input/Outpu</dt>
+<dd>
+ for io_state, ...
+ </dd>
+<dt>Boost.StaticAssert</dt>
+<dd>
+ for STATIC_ASSERT, ...
+ </dd>
+<dt>Boost.TypeTraits</dt>
+<dd>
+ for is_same, ...
+ </dd>
+<dt>Boost.Utility</dt>
+<dd>
+ for base_from_memeber, ...
+ </dd>
+</dl>
+</div>
+
+ Boost.Stopwatches depends optionaly on:
+ 
+<div class="variablelist">
+
+<dl>
+<dt>Boost.Thread</dt>
+<dd>
+ for thread_specific_ptr when suspendible_clock.hpp is included
+ </dd>
+<dt>Boost.Accumulator</dt>
+<dd>
+ for accumulator_set, and statistics features when stopwatch_accumulator.hpp
+ is included
+ </dd>
+</dl>
+</div>
+<a name="boost_stopwatches.users_guide.getting_started.install.building_an_executable_that_uses__emphasis_role__bold__boost_stopwatches__emphasis__"></a><h5>
+<a name="id4942417"></a>
+ <a href="getting_started.html#boost_stopwatches.users_guide.getting_started.install.building_an_executable_that_uses__emphasis_role__bold__boost_stopwatches__emphasis__">Building
+ an executable that uses Boost.Stopwatches
+ </a>
+ </h5>
+
+ In addition to linking with the Boost.Chrono library you need also to link
+ with the Boost.System library. If you use Suspendible clocks you will need
+ also with Boost.Thread.
+ 
+<a name="boost_stopwatches.users_guide.getting_started.install.exceptions_safety_"></a><h5>
+<a name="id4942454"></a>
+ <a href="getting_started.html#boost_stopwatches.users_guide.getting_started.install.exceptions_safety_">Exceptions
+ safety </a>
+ </h5>
+
+ All functions in the library are exception-neutral and provide strong guarantee
+ of exception safety as long as the underlying parameters provide it.
+ 
+<a name="boost_stopwatches.users_guide.getting_started.install.thread_safety_"></a><h5>
+<a name="id4942482"></a>
+ <a href="getting_started.html#boost_stopwatches.users_guide.getting_started.install.thread_safety_">Thread
+ safety </a>
+ </h5>
+
+ All functions in the library are thread-unsafe except when noted explicitly.
+ 
+<a name="boost_stopwatches.users_guide.getting_started.install.tested_compilers_"></a><h5>
+<a name="id4942508"></a>
+ <a href="getting_started.html#boost_stopwatches.users_guide.getting_started.install.tested_compilers_">Tested
+ compilers </a>
+ </h5>
+
+ The implementation will eventually work with most C++03 conforming compilers.
+ Current version has been tested on:
+ 
+
+ Windows with
+ 
+<div class="itemizedlist"><ul type="disc">
+<li>
+ MSVC 10.0
+ </li>
+<li>
+ MSVC 9.0 Express
+ </li>
+<li>
+ MSVC 8.0
+ </li>
+</ul></div>
+
+ Scientific Linux with
+ 
+<div class="itemizedlist"><ul type="disc"><li>
+ GCC 4.1.2
+ </li></ul></div>
+
+ Cygwin with
+ 
+<div class="itemizedlist"><ul type="disc">
+<li>
+ GCC 3.4.4
+ </li>
+<li>
+ GCC 4.3.2
+ </li>
+</ul></div>
+
+ MinGW with
+ 
+<div class="itemizedlist"><ul type="disc"><li>
+ GCC 4.4.0
+ </li></ul></div>
+
+ Initial version was tested on:
+ 
+
+ MacOS with GCC 4.2.4
+ 
+
+ Ubuntu Linux with GCC 4.2.4
+ 
+<div class="note"><table border="0" summary="Note">
+<tr>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../../doc/src/images/note.png"></td>
+<th align="left">Note</th>
+</tr>
+<tr><td align="left" valign="top">
+ Please let us know how this works on other platforms/compilers.
+ </td></tr>
+</table></div>
+<div class="note"><table border="0" summary="Note">
+<tr>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../../doc/src/images/note.png"></td>
+<th align="left">Note</th>
+</tr>
+<tr><td align="left" valign="top">
+ Please send any questions, comments and bug reports to boost <at>
+ lists <dot> boost <dot> org.
+ </td></tr>
+</table></div>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="boost_stopwatches.users_guide.getting_started.hello_world__"></a><a href="getting_started.html#boost_stopwatches.users_guide.getting_started.hello_world__" title="Hello
+ World! ">Hello
+ World! </a>
+</h4></div></div></div>
+
+ If all you want to do is to time a program's execution:
+ 
+<pre class="programlisting">#include <boost/stopwatches/stopclock.hpp>
+
+...
+
+// add this in the scope you want to time,
+// at the point you want the timer to start.
+boost::stopwatches::<a href="../reference/reporters.html#boost_stopwatches.reference.reporters.stopclock_hpp.stopclock" title="
+ Template Class stopclock<>"><code class="computeroutput">stopclock</code></a><> rt;
+</pre>
+
+ Here is a complete program (stopclock_example.cpp):
+ 
+<pre class="programlisting">#include <boost/stopwatches/stopclock.hpp>
+#include <cmath>
+
+int main()
+{
+ boost::stopwatches::<a href="../reference/reporters.html#boost_stopwatches.reference.reporters.stopclock_hpp.stopclock" title="
+ Template Class stopclock<>"><code class="computeroutput">stopclock</code></a><> t;
+
+ for ( long i = 0; i < 10000000; ++i )
+ std::sqrt( 123.456L ); // burn some time
+
+ return 0;
+}
+</pre>
+
+ Debug build output was:
+ 
+<pre class="programlisting">real 0.832s, cpu 0.813s (97.7%), user 0.813s, system 0.000s
+</pre>
+
+ In other words, the program took 0.832 real-time (i.e. wall clock) seconds
+ to execute, while the operating system (Windows in this case) charged 0.813
+ seconds of CPU time to the user and 0 seconds to the system. The total
+ CPU time reported was 0.813 seconds, and that represented utilization of
+ 97.7% of the real-time seconds.
+ 
+</div>
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer">Copyright © 2009 -2010 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)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="../users_guide.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../users_guide.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="tutorial.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/users_guide/tutorial.html
==============================================================================
--- (empty file)
+++ sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/users_guide/tutorial.html 2010-09-07 13:07:01 EDT (Tue, 07 Sep 2010)
@@ -0,0 +1,504 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>Tutorial</title>
+<link rel="stylesheet" href="../../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
+<link rel="start" href="../../index.html" title="Boost.Stopwatches 0.1.0">
+<link rel="up" href="../users_guide.html" title=" Users'Guide">
+<link rel="prev" href="getting_started.html" title=" Getting
+ Started">
+<link rel="next" href="examples.html" title="Examples">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td>
+<td align="center">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="getting_started.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../users_guide.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="examples.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="boost_stopwatches.users_guide.tutorial"></a>Tutorial
+</h3></div></div></div>
+<div class="toc"><dl>
+<dt><a href="tutorial.html#boost_stopwatches.users_guide.tutorial.stopwatches_and_stopclocks">Stopwatches
+ and Stopclocks</a></dt>
+<dd><dl>
+<dt><a href="tutorial.html#boost_stopwatches.users_guide.tutorial.stopwatches_and_stopclocks.stopwatches_accumulation_and_statistics">Stopwatches
+ accumulation and statistics</a></dt>
+<dt><a href="tutorial.html#boost_stopwatches.users_guide.tutorial.stopwatches_and_stopclocks.how_can_i_prefix_each_report_with__boost_current_function__function_signature_">How
+ can I prefix each report with <code class="computeroutput">BOOST_CURRENT_FUNCTION</code>
+ function signature?</a></dt>
+<dt><a href="tutorial.html#boost_stopwatches.users_guide.tutorial.stopwatches_and_stopclocks.how_can_i_prefix_each_report_with____file_____line_____pattern_">How
+ can I prefix each report with <code class="computeroutput">__FILE__[__LINE__]</code> pattern?</a></dt>
+<dt><a href="tutorial.html#boost_stopwatches.users_guide.tutorial.stopwatches_and_stopclocks.can_i_use_an_stopclock_accumulator_which_is_not_static_">Can
+ I use an stopclock accumulator which is not static?</a></dt>
+<dt><a href="tutorial.html#boost_stopwatches.users_guide.tutorial.stopwatches_and_stopclocks.how_can_i_suspend_a_stopwatch_">How
+ can I suspend a stopwatch?</a></dt>
+<dt><a href="tutorial.html#boost_stopwatches.users_guide.tutorial.stopwatches_and_stopclocks.how_to_get_specific_statistics_from_stopwatches_accumulator_">How
+ to get specific statistics from stopwatches accumulator?</a></dt>
+</dl></dd>
+<dt>Formatters</dt>
+<dd><dl><dt><a href="tutorial.html#boost_stopwatches.users_guide.tutorial.formatters.how_can_i_make_a_specific_formatter_when_the_default_do_not_satisfy_my_expectations">How
+ can I make a specific formatter when the default do not satisfy my expectations</a></dt></dl></dd>
+</dl></div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="boost_stopwatches.users_guide.tutorial.stopwatches_and_stopclocks"></a><a href="tutorial.html#boost_stopwatches.users_guide.tutorial.stopwatches_and_stopclocks" title="Stopwatches
+ and Stopclocks">Stopwatches
+ and Stopclocks</a>
+</h4></div></div></div>
+<div class="toc"><dl>
+<dt><a href="tutorial.html#boost_stopwatches.users_guide.tutorial.stopwatches_and_stopclocks.stopwatches_accumulation_and_statistics">Stopwatches
+ accumulation and statistics</a></dt>
+<dt><a href="tutorial.html#boost_stopwatches.users_guide.tutorial.stopwatches_and_stopclocks.how_can_i_prefix_each_report_with__boost_current_function__function_signature_">How
+ can I prefix each report with <code class="computeroutput">BOOST_CURRENT_FUNCTION</code>
+ function signature?</a></dt>
+<dt><a href="tutorial.html#boost_stopwatches.users_guide.tutorial.stopwatches_and_stopclocks.how_can_i_prefix_each_report_with____file_____line_____pattern_">How
+ can I prefix each report with <code class="computeroutput">__FILE__[__LINE__]</code> pattern?</a></dt>
+<dt><a href="tutorial.html#boost_stopwatches.users_guide.tutorial.stopwatches_and_stopclocks.can_i_use_an_stopclock_accumulator_which_is_not_static_">Can
+ I use an stopclock accumulator which is not static?</a></dt>
+<dt><a href="tutorial.html#boost_stopwatches.users_guide.tutorial.stopwatches_and_stopclocks.how_can_i_suspend_a_stopwatch_">How
+ can I suspend a stopwatch?</a></dt>
+<dt><a href="tutorial.html#boost_stopwatches.users_guide.tutorial.stopwatches_and_stopclocks.how_to_get_specific_statistics_from_stopwatches_accumulator_">How
+ to get specific statistics from stopwatches accumulator?</a></dt>
+</dl></div>
+
+ Knowing how long a program, a function or a specific block takes to execute
+ is useful in both test and production environments. Boost.Stopwatches
+ introduces the <a href="../reference/stopwatches.html#boost_stopwatches.reference.stopwatches.stopwatch_req" title="
+ Stopwatch Requirements"><code class="computeroutput">Stopwatch</code></a> concept which captures
+ the mechanism to measure the elapsed time. A <a href="../reference/stopwatches.html#boost_stopwatches.reference.stopwatches.stopwatch_req" title="
+ Stopwatch Requirements"><code class="computeroutput">Stopwatch</code></a> allows to <code class="computeroutput">start</code>, <code class="computeroutput">stop</code>,
+ <code class="computeroutput">suspend</code> and <code class="computeroutput">resume</code> measuring the elapsed time. <a href="../reference/stopwatches.html#boost_stopwatches.reference.stopwatches.stopwatch_hpp.stopwatch" title="
+ Template Class stopwatch<>"><code class="computeroutput">stopwatch</code></a><code class="computeroutput"><></code>
+ is the basic model of <a href="../reference/stopwatches.html#boost_stopwatches.reference.stopwatches.stopwatch_req" title="
+ Stopwatch Requirements"><code class="computeroutput">Stopwatch</code></a> allowing to make a single
+ measure.
+ 
+
+ At the user level, the main use case of measuring the elapsed time is to
+ report these measures on the display. <a href="../reference/reporters.html#boost_stopwatches.reference.reporters.stopwatch_reporter_hpp.stopwatch_reporter" title="
+ Template Class stopwatch_reporter<>"><code class="computeroutput">stopwatch_reporter</code></a><code class="computeroutput"><></code> provides a run time reporting package
+ that can be invoked in a single line of code to report the usage of a
+ <code class="computeroutput">Clock</code>. For example
+ 
+<pre class="programlisting">using namespace boost::chrono;
+using namespace boost::stopwatches;
+
+int f1(long j) {
+ <a href="../reference/reporters.html#boost_stopwatches.reference.reporters.stopwatch_reporter_hpp.stopwatch_reporter" title="
+ Template Class stopwatch_reporter<>"><code class="computeroutput">stopwatch_reporter</code></a><<a href="../reference/stopwatches.html#boost_stopwatches.reference.stopwatches.stopwatch_hpp.stopwatch" title="
+ Template Class stopwatch<>"><code class="computeroutput">stopwatch</code></a><> > _;
+
+ for ( long i = 0; i < j; ++i )
+ std::sqrt( 123.456L ); // burn some time
+
+ return 0;
+}
+int main() {
+ f1(100000);
+ f1(200000);
+ f1(300000);
+ return 0;
+}
+</pre>
+
+ Will produce the following output
+ 
+<pre class="programlisting">0.006s
+0.011s
+0.017s
+</pre>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="boost_stopwatches.users_guide.tutorial.stopwatches_and_stopclocks.stopwatches_accumulation_and_statistics"></a><a href="tutorial.html#boost_stopwatches.users_guide.tutorial.stopwatches_and_stopclocks.stopwatches_accumulation_and_statistics" title="Stopwatches
+ accumulation and statistics">Stopwatches
+ accumulation and statistics</a>
+</h5></div></div></div>
+
+ The preceding stopwatch manage only with a measure. It is also interesting
+ to have an statisitical view of these times, for example the sum, min,
+ max and mean. <a href="../reference/stopwatches.html#boost_stopwatches.reference.stopwatches.stopwatch_accumulator_hpp.stopwatch_accumulator" title="
+ Template Class stopwatch_accumulator<>"><code class="computeroutput">stopwatch_accumulator</code></a><code class="computeroutput"><></code> associates an accumulator with
+ a <a href="../reference/stopwatches.html#boost_stopwatches.reference.stopwatches.stopwatch_hpp.stopwatch" title="
+ Template Class stopwatch<>"><code class="computeroutput">stopwatch</code></a>, so we are able to
+ retrieve any statistical feature Boost.Accumulator provides.
+ 
+
+ For example
+ 
+<pre class="programlisting">using namespace boost::stopwatches;
+
+int f1(long j) {
+ static <a href="../reference/reporters.html#boost_stopwatches.reference.reporters.stopwatch_reporter_hpp.stopwatch_reporter" title="
+ Template Class stopwatch_reporter<>"><code class="computeroutput">stopwatch_reporter</code></a><<a href="../reference/stopwatches.html#boost_stopwatches.reference.stopwatches.stopwatch_accumulator_hpp.stopwatch_accumulator" title="
+ Template Class stopwatch_accumulator<>"><code class="computeroutput">stopwatch_accumulator</code></a><> > sw;
+ <a href="../reference/reporters.html#boost_stopwatches.reference.reporters.stopwatch_reporter_hpp.stopwatch_reporter" title="
+ Template Class stopwatch_reporter<>"><code class="computeroutput">stopwatch_reporter</code></a><<a href="../reference/stopwatches.html#boost_stopwatches.reference.stopwatches.stopwatch_accumulator_hpp.stopwatch_accumulator" title="
+ Template Class stopwatch_accumulator<>"><code class="computeroutput">stopwatch_accumulator</code></a><> >::scoped_run _(sw);
+
+ for ( long i = 0; i < j; ++i )
+ std::sqrt( 123.456L ); // burn some time
+
+ return 0;
+}
+int main() {
+ f1(100000);
+ f1(200000);
+ f1(300000);
+ return 0;
+}
+</pre>
+
+ Will produce the following output
+ 
+<pre class="programlisting">3 times, sum=0.034s, min=0.006s, max=0.017s, mean=0.011s
+</pre>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="boost_stopwatches.users_guide.tutorial.stopwatches_and_stopclocks.how_can_i_prefix_each_report_with__boost_current_function__function_signature_"></a><a href="tutorial.html#boost_stopwatches.users_guide.tutorial.stopwatches_and_stopclocks.how_can_i_prefix_each_report_with__boost_current_function__function_signature_" title="How
+ can I prefix each report with BOOST_CURRENT_FUNCTION
+ function signature?">How
+ can I prefix each report with <code class="computeroutput">BOOST_CURRENT_FUNCTION</code>
+ function signature?</a>
+</h5></div></div></div>
+
+ You will need to give a specific format to your <a href="../reference/reporters.html#boost_stopwatches.reference.reporters.stopclock_hpp.stopclock" title="
+ Template Class stopclock<>"><code class="computeroutput">stopclock</code></a>. You just need to
+ concatenate your specific pattern to the default_format of the formatter.
+ 
+
+ For example, for a <a href="../reference/reporters.html#boost_stopwatches.reference.reporters.stopclock_accumulator_hpp.stopclock_accumulator" title="
+ Template Class stopclock_accumulator<>"><code class="computeroutput">stopclock_accumulator</code></a> the default
+ formatter is <a href="../reference/formatters.html#boost_stopwatches.reference.formatters.stopwatch_accumulator_formatter_hpp.basic_stopwatch_accumulator_formatter" title="
+ Template Class basic_stopwatch_accumulator_formatter<>"><code class="computeroutput">stopwatch_accumulator_formatter</code></a>,
+ you will need to do something like:
+ 
+<pre class="programlisting">static <a href="../reference/reporters.html#boost_stopwatches.reference.reporters.stopclock_accumulator_hpp.stopclock_accumulator" title="
+ Template Class stopclock_accumulator<>"><code class="computeroutput">stopclock_accumulator</code></a><> acc(
+ std::string(BOOST_CURRENT_FUNCTION) + ": "
+ + <a href="../reference/formatters.html#boost_stopwatches.reference.formatters.stopwatch_accumulator_formatter_hpp.basic_stopwatch_accumulator_formatter" title="
+ Template Class basic_stopwatch_accumulator_formatter<>"><code class="computeroutput">stopwatch_accumulator_formatter</code></a>::default_format()
+);
+<a href="../reference/reporters.html#boost_stopwatches.reference.reporters.stopclock_accumulator_hpp.stopclock_accumulator" title="
+ Template Class stopclock_accumulator<>"><code class="computeroutput">stopclock_accumulator</code></a><>::scoped_run _(acc);
+</pre>
+
+ Some of you will say that this is too long to type just to get the a
+ report. You can of course define your own macro as
+ 
+<pre class="programlisting">#define REPORT_FUNCTION_ACCUMULATED_LIFETIME\
+ static boost::stopwatches::<a href="../reference/reporters.html#boost_stopwatches.reference.reporters.stopclock_accumulator_hpp.stopclock_accumulator" title="
+ Template Class stopclock_accumulator<>"><code class="computeroutput">stopclock_accumulator</code></a><> \
+ BOOST_JOIN(_accumulator_, __LINE__)_
+ ( std::string(BOOST_CURRENT_FUNCTION) + ": " + \
+ boost::stopwatches::<a href="../reference/formatters.html#boost_stopwatches.reference.formatters.stopwatch_accumulator_formatter_hpp.basic_stopwatch_accumulator_formatter" title="
+ Template Class basic_stopwatch_accumulator_formatter<>"><code class="computeroutput">stopwatch_accumulator_formatter</code></a>::default_format() \
+ ); \
+ boost::stopwatches::<a href="../reference/reporters.html#boost_stopwatches.reference.reporters.stopclock_accumulator_hpp.stopclock_accumulator" title="
+ Template Class stopclock_accumulator<>"><code class="computeroutput">stopclock_accumulator</code></a><>::scoped_run \
+ BOOST_JOIN(_accumulator_run_, __LINE__) \
+ (BOOST_JOIN(_accumulator_, __LINE__))
+</pre>
+
+ With this macro you will just have to write
+ 
+<pre class="programlisting">void foo()
+{
+ REPORT_FUNCTION_ACCUMULATED_LIFETIME() ;
+ boost::this_thread::sleep(boost::posix_time::milliseconds(100));
+ // ...
+}
+</pre>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="boost_stopwatches.users_guide.tutorial.stopwatches_and_stopclocks.how_can_i_prefix_each_report_with____file_____line_____pattern_"></a><a href="tutorial.html#boost_stopwatches.users_guide.tutorial.stopwatches_and_stopclocks.how_can_i_prefix_each_report_with____file_____line_____pattern_" title="How
+ can I prefix each report with __FILE__[__LINE__] pattern?">How
+ can I prefix each report with <code class="computeroutput">__FILE__[__LINE__]</code> pattern?</a>
+</h5></div></div></div>
+
+ When you want to prefix with the <code class="computeroutput">__FILE__[__LINE__]</code> pattern you can follow the same technique
+ as described below:
+ 
+<pre class="programlisting">#define REPORT_LINE_ACCUMULATED_LIFETIME \
+ static <a href="../reference/reporters.html#boost_stopwatches.reference.reporters.stopclock_accumulator_hpp.stopclock_accumulator" title="
+ Template Class stopclock_accumulator<>"><code class="computeroutput">stopclock_accumulator</code></a><>
+ BOOST_JOIN(_accumulator_, __LINE__) \
+ ( std::string(__FILE__) + "[" + BOOST_STRINGIZE(__LINE__) + "] "
+ + <a href="../reference/formatters.html#boost_stopwatches.reference.formatters.stopwatch_accumulator_formatter_hpp.basic_stopwatch_accumulator_formatter" title="
+ Template Class basic_stopwatch_accumulator_formatter<>"><code class="computeroutput">stopwatch_accumulator_formatter</code></a>::default_format() \
+ ); \
+ <a href="../reference/reporters.html#boost_stopwatches.reference.reporters.stopclock_accumulator_hpp.stopclock_accumulator" title="
+ Template Class stopclock_accumulator<>"><code class="computeroutput">stopclock_accumulator</code></a><>::scoped_run \
+ BOOST_JOIN(_accumulator_run_, __LINE__)
+ (BOOST_JOIN(_accumulator_, __LINE__))
+</pre>
+
+ Now you can mix fcntion and line reports as follows
+ 
+<pre class="programlisting">void foo()
+{
+ REPORT_FUNCTION_ACCUMULATED_LIFETIME;
+ boost::this_thread::sleep(boost::posix_time::milliseconds(100));
+ {
+ REPORT_LINE_ACCUMULATED_LIFETIME;
+ boost::this_thread::sleep(boost::posix_time::milliseconds(200));
+ }
+
+}
+</pre>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="boost_stopwatches.users_guide.tutorial.stopwatches_and_stopclocks.can_i_use_an_stopclock_accumulator_which_is_not_static_"></a><a href="tutorial.html#boost_stopwatches.users_guide.tutorial.stopwatches_and_stopclocks.can_i_use_an_stopclock_accumulator_which_is_not_static_" title="Can
+ I use an stopclock accumulator which is not static?">Can
+ I use an stopclock accumulator which is not static?</a>
+</h5></div></div></div>
+
+ The typical example of stopclock_accumulator is to get statistical measures
+ of the time a function takes for each one of its calls. You can also
+ use <a href="../reference/reporters.html#boost_stopwatches.reference.reporters.stopclock_accumulator_hpp.stopclock_accumulator" title="
+ Template Class stopclock_accumulator<>"><code class="computeroutput">stopclock_accumulator</code></a> to get
+ statistical measures of the time a given loop takes for each one of its
+ laps.
+ 
+<pre class="programlisting"><a href="../reference/reporters.html#boost_stopwatches.reference.reporters.stopclock_accumulator_hpp.stopclock_accumulator" title="
+ Template Class stopclock_accumulator<>"><code class="computeroutput">stopclock_accumulator</code></a><> acc(
+ std::string(__FILE__) + "[" + BOOST_STRINGIZE(__LINE__) + "] "
+ + <a href="../reference/formatters.html#boost_stopwatches.reference.formatters.stopwatch_accumulator_formatter_hpp.basic_stopwatch_accumulator_formatter" title="
+ Template Class basic_stopwatch_accumulator_formatter<>"><code class="computeroutput">stopwatch_accumulator_formatter</code></a>::default_format()
+);
+for (int i=0; i<N; i++) {
+ <a href="../reference/reporters.html#boost_stopwatches.reference.reporters.stopclock_accumulator_hpp.stopclock_accumulator" title="
+ Template Class stopclock_accumulator<>"><code class="computeroutput">stopclock_accumulator</code></a><>::scoped_run _(acc);
+ // ...
+}
+</pre>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="boost_stopwatches.users_guide.tutorial.stopwatches_and_stopclocks.how_can_i_suspend_a_stopwatch_"></a><a href="tutorial.html#boost_stopwatches.users_guide.tutorial.stopwatches_and_stopclocks.how_can_i_suspend_a_stopwatch_" title="How
+ can I suspend a stopwatch?">How
+ can I suspend a stopwatch?</a>
+</h5></div></div></div>
+<pre class="programlisting">#include <boost/stopwatches/stopwatch.hpp>
+#include <cmath>
+#include <boost/thread.hpp>
+
+
+using namespace boost::stopwatches;
+double res;
+void f1(long j)
+{
+ <a href="../reference/reporters.html#boost_stopwatches.reference.reporters.stopwatch_reporter_hpp.stopwatch_reporter" title="
+ Template Class stopwatch_reporter<>"><code class="computeroutput">stopwatch_reporter</code></a><<a href="../reference/stopwatches.html#boost_stopwatches.reference.stopwatches.stopwatch_hpp.stopwatch" title="
+ Template Class stopwatch<>"><code class="computeroutput">stopwatch</code></a><> >:: _(BOOST_STOPWATCHES_STOPWATCH_FUNCTION_FORMAT);
+ for (long i =0; i< j; i+=1)
+ res+=std::sqrt( res+123.456L+i ); // burn some time
+ <a href="../reference/reporters.html#boost_stopwatches.reference.reporters.stopwatch_reporter_hpp.stopwatch_reporter" title="
+ Template Class stopwatch_reporter<>"><code class="computeroutput">stopwatch_reporter</code></a><<a href="../reference/stopwatches.html#boost_stopwatches.reference.stopwatches.stopwatch_hpp.stopwatch" title="
+ Template Class stopwatch<>"><code class="computeroutput">stopwatch</code></a><> >::scoped_suspend s(_);
+ boost::this_thread::sleep(boost::posix_time::milliseconds(200));
+}
+</pre>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="boost_stopwatches.users_guide.tutorial.stopwatches_and_stopclocks.how_to_get_specific_statistics_from_stopwatches_accumulator_"></a><a href="tutorial.html#boost_stopwatches.users_guide.tutorial.stopwatches_and_stopclocks.how_to_get_specific_statistics_from_stopwatches_accumulator_" title="How
+ to get specific statistics from stopwatches accumulator?">How
+ to get specific statistics from stopwatches accumulator?</a>
+</h5></div></div></div>
+
+ There are two use cases that coul need to change the statistics associated
+ to a stopwatches accumulator:
+ 
+<div class="orderedlist"><ol type="1">
+<li>
+ We want to reduce the default reporting and we preffer to adapt the
+ statistics to the reporting
+ </li>
+<li>
+ We want to report other statistics of the samples
+ </li>
+</ol></div>
+
+ For the first case we just need to change the accumulator_set and the
+ format we want to get. Imagin we want to get only the count, sam and
+ mean statistics, no need to calculate the min neither the max.
+ 
+<pre class="programlisting">using namespace boost::accumulators;
+
+typedef <a href="../reference/reporters.html#boost_stopwatches.reference.reporters.stopwatch_reporter_hpp.stopwatch_reporter" title="
+ Template Class stopwatch_reporter<>"><code class="computeroutput">stopwatch_reporter</code></a><<a href="../reference/stopwatches.html#boost_stopwatches.reference.stopwatches.stopwatch_accumulator_hpp.stopwatch_accumulator" title="
+ Template Class stopwatch_accumulator<>"><code class="computeroutput">stopwatch_accumulator</code></a><<code class="computeroutput">process_real_cpu_clock</code>,
+ accumulator_set<<code class="computeroutput">process_real_cpu_clock</code>::rep,
+ features<
+ tag::count,
+ tag::sum,
+ tag::mean
+ >
+ >
+ > my_stopwatch_accumulator_reporter;
+
+int f1(long j)
+{
+ static my_stopwatch_accumulator_reporter acc("%c times, sum=%ss, mean=%as\n");
+ my_stopwatch_accumulator_reporter::scoped_run _(acc);
+
+ for ( long i = 0; i < j; ++i )
+ std::sqrt( 123.456L ); // burn some time
+
+ return 0;
+}
+</pre>
+
+ But what would hapend if we haven't forced the format:
+ 
+<pre class="programlisting">static my_stopwatch_accumulator_reporter acc;
+my_stopwatch_accumulator_reporter::scoped_run _(acc);
+</pre>
+
+ Unfortunately there is no error at compile time. Fortunately, the run-time
+ execution is not undefined and will return 0 for the missing statistics.
+ 
+</div>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="boost_stopwatches.users_guide.tutorial.formatters"></a>Formatters
+</h4></div></div></div>
+<div class="toc"><dl><dt><a href="tutorial.html#boost_stopwatches.users_guide.tutorial.formatters.how_can_i_make_a_specific_formatter_when_the_default_do_not_satisfy_my_expectations">How
+ can I make a specific formatter when the default do not satisfy my expectations</a></dt></dl></div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="boost_stopwatches.users_guide.tutorial.formatters.how_can_i_make_a_specific_formatter_when_the_default_do_not_satisfy_my_expectations"></a><a href="tutorial.html#boost_stopwatches.users_guide.tutorial.formatters.how_can_i_make_a_specific_formatter_when_the_default_do_not_satisfy_my_expectations" title="How
+ can I make a specific formatter when the default do not satisfy my expectations">How
+ can I make a specific formatter when the default do not satisfy my expectations</a>
+</h5></div></div></div>
+
+ Imagine then that we want to report the <code class="computeroutput">tag::variance(lazy)</code>. We will need to include the specific
+ accumulator file
+ 
+<pre class="programlisting">...
+#include <boost/accumulators/statistics/variance.hpp>
+...
+typedef <a href="../reference/reporters.html#boost_stopwatches.reference.reporters.stopwatch_reporter_hpp.stopwatch_reporter" title="
+ Template Class stopwatch_reporter<>"><code class="computeroutput">stopwatch_reporter</code></a><<a href="../reference/stopwatches.html#boost_stopwatches.reference.stopwatches.stopwatch_accumulator_hpp.stopwatch_accumulator" title="
+ Template Class stopwatch_accumulator<>"><code class="computeroutput">stopwatch_accumulator</code></a><<code class="computeroutput">process_real_cpu_clock</code>,
+ accumulator_set<<code class="computeroutput">process_real_cpu_clock</code>::rep,
+ features<
+ tag::count,
+ tag::sum,
+ tag::mean,
+ tag::variance(lazy)
+ >
+ >
+> my_stopwatch_accumulator_reporter;
+</pre>
+
+ But what happens if we add new statistics to the accumulator_set that
+ are not taken in account by the default formatter? These statistics will
+ simply be ignored. So we will need to define our own accumulator formatter.
+ 
+<pre class="programlisting">typedef <a href="../reference/reporters.html#boost_stopwatches.reference.reporters.stopwatch_reporter_hpp.stopwatch_reporter" title="
+ Template Class stopwatch_reporter<>"><code class="computeroutput">stopwatch_reporter</code></a><<a href="../reference/stopwatches.html#boost_stopwatches.reference.stopwatches.stopwatch_accumulator_hpp.stopwatch_accumulator" title="
+ Template Class stopwatch_accumulator<>"><code class="computeroutput">stopwatch_accumulator</code></a><<code class="computeroutput">process_real_cpu_clock</code>,
+ accumulator_set<<code class="computeroutput">process_real_cpu_clock</code>::rep,
+ features<
+ tag::count,
+ tag::sum,
+ tag::mean,
+ tag::variance(lazy)
+ >
+ >,
+ my_stopwatch_accumulator_formatter
+> my_stopwatch_accumulator_reporter;
+</pre>
+
+ Next follow the definition of a formatter taking care of count, sum,
+ mean and variance
+ 
+<pre class="programlisting">class my_stopwatch_accumulator_formatter {
+public:
+ typedef std::string string_type;
+ typedef char char_type;
+ typedef std::ostream ostream_type;
+
+ static ostream_type & default_os() {return std::cout;}
+ static const char_type* default_format() {
+ return "%c times, sum=%ss, mean=%as, variance=%vs\n";
+ }
+ static int default_places() { return 3; }
+
+ template <class Stopwatch >
+ static void show_time( Stopwatch & stopwatch_, const char_type* format,
+ int places, ostream_type & os, system::error_code & ec)
+ {
+ typedef typename Stopwatch::duration duration_t;
+ typename Stopwatch::accumulator accumulator& acc = stopwatch_.accumulated();
+
+ boost::io::ios_flags_saver ifs( os );
+ os.setf( std::ios_base::fixed, std::ios_base::floatfield );
+ boost::io::ios_precision_saver ips( os );
+ os.precision( places );
+
+ for ( ; *format; ++format ) {
+ if ( *format != '%' || !*(format+1) || !std::strchr("acsv", *(format+1)) ) {
+ os << *format;
+ } else {
+ ++format;
+ switch ( *format ) {
+ case 's':
+ os << boost::chrono::duration<double>(
+ duration_t(accumulators::sum(acc))).count();
+ break;
+ case 'a':
+ os << (accumulators::count(acc)>0)
+ ? boost::chrono:: <code class="computeroutput">duration</code><double>(duration_t(
+ duration_t::rep(accumulators::mean(acc)))).count()
+ : 0;
+ break;
+ case 'c':
+ os << accumulators::count(acc);
+ break;
+ case 'v':
+ os << (accumulators::count(acc)>0)
+ ? boost::chrono:: <code class="computeroutput">duration</code><double>(duration_t(
+ duration_t::rep(accumulators::variance(acc)))).count()
+ : 0;
+ break;
+ default:
+ assert(0 && "my_stopwatch_accumulator_formatter internal logic error");
+ }
+ }
+ }
+ }
+};
+</pre>
+</div>
+</div>
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer">Copyright © 2009 -2010 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)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="getting_started.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../users_guide.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="examples.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: sandbox/chrono/libs/stopwatches/doc/html/index.html
==============================================================================
--- (empty file)
+++ sandbox/chrono/libs/stopwatches/doc/html/index.html 2010-09-07 13:07:01 EDT (Tue, 07 Sep 2010)
@@ -0,0 +1,98 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>Boost.Stopwatches 0.1.0</title>
+<link rel="stylesheet" href="../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
+<link rel="start" href="index.html" title="Boost.Stopwatches 0.1.0">
+<link rel="next" href="boost_stopwatches/overview.html" title="Overview">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td>
+<td align="center">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav"><a accesskey="n" href="boost_stopwatches/overview.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a></div>
+<div class="article" lang="en">
+<div class="titlepage">
+<div>
+<div><h2 class="title">
+<a name="boost_stopwatches"></a>Boost.Stopwatches 0.1.0</h2></div>
+<div><div class="authorgroup"><div class="author"><h3 class="author">
+Vicente J. Botet Escriba
+</h3></div></div></div>
+<div>Copyright © 2009 -2010 Vicente J. Botet Escriba</div>
+<div><div class="legalnotice">
+<a name="id4987065"></a>
+ 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)
+ 
+</div></div>
+</div>
+<hr>
+</div>
+<div class="toc">
+Table of Contents
+<dl>
+<dt>Overview</dt>
+<dd><dl>
+<dt>Motivation</dt>
+<dt>Description</dt>
+</dl></dd>
+<dt> Users'Guide</dt>
+<dd><dl>
+<dt><a href="boost_stopwatches/users_guide/getting_started.html"> Getting
+ Started</a></dt>
+<dt>Tutorial</dt>
+<dt>Examples</dt>
+</dl></dd>
+<dt> Reference </dt>
+<dd><dl>
+<dt><a href="boost_stopwatches/reference/stopwatches_hpp.html"> Header
+ <code class="computeroutput"><boost/stopwatches.hpp></code></a></dt>
+<dt> Other clocks</dt>
+<dt> Stopwatches</dt>
+<dt> Stopwatch Reporters</dt>
+<dt> Stopwatch Formatters</dt>
+</dl></dd>
+<dt>Appendices</dt>
+<dd><dl>
+<dt> Appendix A: History</dt>
+<dt><a href="boost_stopwatches/appendices/rationale.html"> Appendix B:
+ Rationale</a></dt>
+<dt><a href="boost_stopwatches/appendices/implementation.html"> Appendix
+ C: Implementation Notes</a></dt>
+<dt> Appendix D: FAQ</dt>
+<dt><a href="boost_stopwatches/appendices/acknowledgements.html"> Appendix
+ E: Acknowledgements</a></dt>
+<dt> Appendix F: Tests</dt>
+<dt> Appendix G: Tickets</dt>
+<dt> Appendix H: Performances</dt>
+<dt><a href="boost_stopwatches/appendices/todo.html"> Appendix I: Future
+ plans</a></dt>
+</dl></dd>
+</dl>
+</div>
+<div class="warning"><table border="0" summary="Warning">
+<tr>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Warning]" src="../../../../doc/src/images/warning.png"></td>
+<th align="left">Warning</th>
+</tr>
+<tr><td align="left" valign="top">
+ Stopwatches is not part of the Boost libraries.
+ </td></tr>
+</table></div>
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left">Last revised: September 07, 2010 at 16:45:23 GMT</td>
+<td align="right"><div class="copyright-footer"></div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav"><a accesskey="n" href="boost_stopwatches/overview.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a></div>
+</body>
+</html>

Added: sandbox/chrono/libs/stopwatches/doc/html/standalone_HTML.manifest
==============================================================================
--- (empty file)
+++ sandbox/chrono/libs/stopwatches/doc/html/standalone_HTML.manifest 2010-09-07 13:07:01 EDT (Tue, 07 Sep 2010)
@@ -0,0 +1,24 @@
+index.html
+boost_stopwatches/overview.html
+boost_stopwatches/overview/motivation.html
+boost_stopwatches/overview/description.html
+boost_stopwatches/users_guide.html
+boost_stopwatches/users_guide/getting_started.html
+boost_stopwatches/users_guide/tutorial.html
+boost_stopwatches/users_guide/examples.html
+boost_stopwatches/reference.html
+boost_stopwatches/reference/stopwatches_hpp.html
+boost_stopwatches/reference/other_clocks.html
+boost_stopwatches/reference/stopwatches.html
+boost_stopwatches/reference/reporters.html
+boost_stopwatches/reference/formatters.html
+boost_stopwatches/appendices.html
+boost_stopwatches/appendices/history.html
+boost_stopwatches/appendices/rationale.html
+boost_stopwatches/appendices/implementation.html
+boost_stopwatches/appendices/faq.html
+boost_stopwatches/appendices/acknowledgements.html
+boost_stopwatches/appendices/tests.html
+boost_stopwatches/appendices/tickets.html
+boost_stopwatches/appendices/perf.html
+boost_stopwatches/appendices/todo.html

Next message: dsaritz_at_[hidden]: "[Boost-commit] svn:boost r65341 - sandbox/gil/boost/gil/extension/io2/detail"
Previous message: vicente.botet_at_[hidden]: "[Boost-commit] svn:boost r65339 - sandbox/chrono/libs/stopwatches/doc/html"

Date view	Thread view	Subject view	Author view

Boost-Commit list run by bdawes at acm.org, david.abrahams at rcn.com, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk