|
|
Boost-Commit : |
Subject: [Boost-commit] svn:boost r65291 - in sandbox/chrono/libs/stopwatches/doc: . html html/boost_stopwatches html/boost_stopwatches/appendices html/boost_stopwatches/reference html/boost_stopwatches/users_guide
From: vicente.botet_at_[hidden]
Date: 2010-09-05 06:51:01
Author: viboes
Date: 2010-09-05 06:51:00 EDT (Sun, 05 Sep 2010)
New Revision: 65291
URL: http://svn.boost.org/trac/boost/changeset/65291
Log:
update doc: Suspendible clocks are now on Stopwatches lib
Text files modified:
sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/appendices/faq.html | 8
sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/appendices/perf.html | 4
sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/appendices/rationale.html | 2
sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/appendices/todo.html | 2
sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/reference.html | 24 +++-
sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/reference/reporters.html | 4
sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/reference/stopwatches.html | 49 --------
sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/users_guide/getting_started.html | 18 ++-
sandbox/chrono/libs/stopwatches/doc/html/index.html | 7 +
sandbox/chrono/libs/stopwatches/doc/html/standalone_HTML.manifest | 3
sandbox/chrono/libs/stopwatches/doc/stopwatches.qbk | 215 +++++++++++++++++++++++++++++++++++++--
11 files changed, 254 insertions(+), 82 deletions(-)
Modified: sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/appendices/faq.html
==============================================================================
--- sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/appendices/faq.html (original)
+++ sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/appendices/faq.html 2010-09-05 06:51:00 EDT (Sun, 05 Sep 2010)
@@ -29,7 +29,7 @@
<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="id5048911"></a>
+<a name="id5051696"></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>
@@ -40,7 +40,7 @@
dangerously.
</p>
<a name="boost_stopwatches.appendices.faq.why_does_stopwatch_reporter_sometimes_report_more_cpu_seconds_than_real_seconds_"></a><h4>
-<a name="id5048952"></a>
+<a name="id5051737"></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>
@@ -50,7 +50,7 @@
be reporting at times.
</p>
<a name="boost_stopwatches.appendices.faq.can_i_obtain_statistics_of_the_time_elapsed_between_calls_to_a_function_"></a><h4>
-<a name="id5048984"></a>
+<a name="id5051770"></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>
@@ -58,7 +58,7 @@
The library do not provides this feature.
</p>
<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="id5049012"></a>
+<a name="id5051797"></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>
Modified: sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/appendices/perf.html
==============================================================================
--- sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/appendices/perf.html (original)
+++ sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/appendices/perf.html 2010-09-05 06:51:00 EDT (Sun, 05 Sep 2010)
@@ -70,7 +70,7 @@
with a variable lifetime.
</p>
<a name="boost_stopwatches.appendices.perf.single_threaded_recursive_function"></a><h4>
-<a name="id5051544"></a>
+<a name="id5054329"></a>
<a href="perf.html#boost_stopwatches.appendices.perf.single_threaded_recursive_function">Single-Threaded
Recursive function</a>
</h4>
@@ -93,7 +93,7 @@
and thread_clock.
</p>
<a name="boost_stopwatches.appendices.perf.multi_threaded_recursive_function"></a><h4>
-<a name="id5051593"></a>
+<a name="id5054378"></a>
<a href="perf.html#boost_stopwatches.appendices.perf.multi_threaded_recursive_function">Multi-Threaded
Recursive function</a>
</h4>
Modified: sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/appendices/rationale.html
==============================================================================
--- sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/appendices/rationale.html (original)
+++ sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/appendices/rationale.html 2010-09-05 06:51:00 EDT (Sun, 05 Sep 2010)
@@ -31,7 +31,7 @@
Rationale</a>
</h3></div></div></div>
<a name="boost_stopwatches.appendices.rationale.how_reliable_are_these_measures_"></a><h4>
-<a name="id5048583"></a>
+<a name="id5051361"></a>
<a href="rationale.html#boost_stopwatches.appendices.rationale.how_reliable_are_these_measures_">How
reliable are these measures?</a>
</h4>
Modified: sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/appendices/todo.html
==============================================================================
--- sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/appendices/todo.html (original)
+++ sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/appendices/todo.html 2010-09-05 06:51:00 EDT (Sun, 05 Sep 2010)
@@ -29,7 +29,7 @@
plans</a>
</h3></div></div></div>
<a name="boost_stopwatches.appendices.todo.tasks_to_do"></a><h4>
-<a name="id5051660"></a>
+<a name="id5054445"></a>
<a href="todo.html#boost_stopwatches.appendices.todo.tasks_to_do">Tasks to do</a>
</h4>
<div class="itemizedlist"><ul type="disc">
Modified: sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/reference.html
==============================================================================
--- sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/reference.html (original)
+++ sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/reference.html 2010-09-05 06:51:00 EDT (Sun, 05 Sep 2010)
@@ -7,7 +7,8 @@
<link rel="start" href="../index.html" title="Boost.Stopwatches">
<link rel="up" href="../index.html" title="Boost.Stopwatches">
<link rel="prev" href="users_guide/examples.html" title="Examples">
-<link rel="next" href="reference/stopwatches.html" title=" Stopwatches">
+<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>
@@ -20,19 +21,28 @@
</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.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
+<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><span class="section"><a href="reference/stopwatches_hpp.html"> Header
+ <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">stopwatches</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code></a></span></dt>
+<dt><span class="section"><a href="reference/chrono_stopwatches_hpp.html">
+ Header <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">stopwatches</span><span class="special">/</span><span class="identifier">stopwatches</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code></a></span></dt>
+<dt><span class="section"> Other clocks</span></dt>
+<dd><dl>
+<dt><span class="section"><a href="reference/other_clocks.html#boost_stopwatches.reference.other_clocks.suspendible_clock_req">
+ <code class="computeroutput"><span class="identifier">SuspendibleClock</span></code> Requirements</a></span></dt>
+<dt><span class="section"><a href="reference/other_clocks.html#boost_stopwatches.reference.other_clocks.scoped_suspend_hpp">
+ Header <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">stopwatches</span><span class="special">/</span><span class="identifier">scoped_suspend</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code></a></span></dt>
+<dt><span class="section"><a href="reference/other_clocks.html#boost_stopwatches.reference.other_clocks.suspendible_clock_hpp">
+ Header <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">stopwatches</span><span class="special">/</span><span class="identifier">suspendible_clock</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code></a></span></dt>
+</dl></dd>
<dt><span class="section"> Stopwatches</span></dt>
<dd><dl>
-<dt><span class="section"><a href="reference/stopwatches.html#boost_stopwatches.reference.stopwatches.stopwatches_hpp">
- Header <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">stopwatches</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code></a></span></dt>
-<dt><span class="section"><a href="reference/stopwatches.html#boost_stopwatches.reference.stopwatches.chrono_stopwatches_hpp">
- Header <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">stopwatches</span><span class="special">/</span><span class="identifier">stopwatches</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code></a></span></dt>
<dt><span class="section"><a href="reference/stopwatches.html#boost_stopwatches.reference.stopwatches.stopwatch_req">
<code class="computeroutput"><span class="identifier">Stopwatch</span></code> Requirements</a></span></dt>
<dt><span class="section"><a href="reference/stopwatches.html#boost_stopwatches.reference.stopwatches.lightweight_stopwatch_hpp">
@@ -85,7 +95,7 @@
</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.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
+<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>
Modified: sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/reference/reporters.html
==============================================================================
--- sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/reference/reporters.html (original)
+++ sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/reference/reporters.html 2010-09-05 06:51:00 EDT (Sun, 05 Sep 2010)
@@ -98,7 +98,7 @@
ec is a system::error_code
</p>
<div class="table">
-<a name="boost_stopwatches.reference.reporters.formatter_req.formatter_requirements"></a><p class="title"><b>Table 2. Formatter Requirements</b></p>
+<a name="boost_stopwatches.reference.reporters.formatter_req.formatter_requirements"></a><p class="title"><b>Table 3. Formatter Requirements</b></p>
<table class="table" summary="Formatter Requirements">
<colgroup>
<col>
@@ -1070,7 +1070,7 @@
<span class="special">}</span>
</pre>
<a name="boost_stopwatches.reference.reporters.scoped_stopclock_hpp.scoped_stopclock.synopsis"></a><h6>
-<a name="id5035445"></a>
+<a name="id5038222"></a>
<a href="reporters.html#boost_stopwatches.reference.reporters.scoped_stopclock_hpp.scoped_stopclock.synopsis">Synopsis</a>
</h6>
<pre class="programlisting"><span class="keyword">template</span> <span class="special"><</span> <span class="keyword">class</span> <span class="identifier">Clock</span><span class="special">=</span><span class="identifier">process_cpu_clock</span>
Modified: sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/reference/stopwatches.html
==============================================================================
--- sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/reference/stopwatches.html (original)
+++ sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/reference/stopwatches.html 2010-09-05 06:51:00 EDT (Sun, 05 Sep 2010)
@@ -6,7 +6,7 @@
<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
<link rel="start" href="../../index.html" title="Boost.Stopwatches">
<link rel="up" href="../reference.html" title=" Reference ">
-<link rel="prev" 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">
@@ -20,17 +20,13 @@
</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="reporters.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
+<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><span class="section"><a href="stopwatches.html#boost_stopwatches.reference.stopwatches.stopwatches_hpp">
- Header <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">stopwatches</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code></a></span></dt>
-<dt><span class="section"><a href="stopwatches.html#boost_stopwatches.reference.stopwatches.chrono_stopwatches_hpp">
- Header <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">stopwatches</span><span class="special">/</span><span class="identifier">stopwatches</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code></a></span></dt>
<dt><span class="section"><a href="stopwatches.html#boost_stopwatches.reference.stopwatches.stopwatch_req">
<code class="computeroutput"><span class="identifier">Stopwatch</span></code> Requirements</a></span></dt>
<dd><dl>
@@ -89,43 +85,6 @@
</dl></div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h4 class="title">
-<a name="boost_stopwatches.reference.stopwatches.stopwatches_hpp"></a><a href="stopwatches.html#boost_stopwatches.reference.stopwatches.stopwatches_hpp" title="
- Header <boost/stopwatches.hpp>">
- Header <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">stopwatches</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code></a>
-</h4></div></div></div>
-<p>
- This file include all the stopwatches related files
- </p>
-<pre class="programlisting"><span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">stopwatches</span><span class="special">/</span><span class="identifier">stopwatches</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span>
-</pre>
-</div>
-<div class="section" lang="en">
-<div class="titlepage"><div><div><h4 class="title">
-<a name="boost_stopwatches.reference.stopwatches.chrono_stopwatches_hpp"></a><a href="stopwatches.html#boost_stopwatches.reference.stopwatches.chrono_stopwatches_hpp" title="
- Header <boost/stopwatches/stopwatches.hpp>">
- Header <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">stopwatches</span><span class="special">/</span><span class="identifier">stopwatches</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code></a>
-</h4></div></div></div>
-<p>
- This file include all the stopwatches related files
- </p>
-<pre class="programlisting"><span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">stopwatches</span><span class="special">/</span><span class="identifier">scoped_stopclock</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span>
-<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">stopwatches</span><span class="special">/</span><span class="identifier">process_cpu_clocks</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span>
-<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">stopwatches</span><span class="special">/</span><span class="identifier">stopclock</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span>
-<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">stopwatches</span><span class="special">/</span><span class="identifier">stopclock_accumulator</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span>
-<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">stopwatches</span><span class="special">/</span><span class="identifier">stopwatch</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span>
-<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">stopwatches</span><span class="special">/</span><span class="identifier">stopwatch_accumulator</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span>
-<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">stopwatches</span><span class="special">/</span><span class="identifier">stopwatch_accumulator_formatter</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span>
-<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">stopwatches</span><span class="special">/</span><span class="identifier">stopwatch_accumulator_time_formatter</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span>
-<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">stopwatches</span><span class="special">/</span><span class="identifier">stopwatch_formatter</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span>
-<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">stopwatches</span><span class="special">/</span><span class="identifier">stopwatch_reporter</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span>
-<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">stopwatches</span><span class="special">/</span><span class="identifier">stopwatch_scoped</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span>
-<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">stopwatches</span><span class="special">/</span><span class="identifier">time_formatter</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span>
-<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">stopwatches</span><span class="special">/</span><span class="identifier">t24_hours</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span>
-<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">stopwatches</span><span class="special">/</span><span class="identifier">t24_hours_formatter</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span>
-</pre>
-</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"><span class="identifier">Stopwatch</span></code> Requirements</a>
@@ -154,7 +113,7 @@
is an instance of <code class="computeroutput"><span class="identifier">S</span></code>.
</p>
<div class="table">
-<a name="boost_stopwatches.reference.stopwatches.stopwatch_req.stopwatch_requirements"></a><p class="title"><b>Table 1. Stopwatch Requirements</b></p>
+<a name="boost_stopwatches.reference.stopwatches.stopwatch_req.stopwatch_requirements"></a><p class="title"><b>Table 2. Stopwatch Requirements</b></p>
<table class="table" summary="Stopwatch Requirements">
<colgroup>
<col>
@@ -1143,7 +1102,7 @@
</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="reporters.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
+<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>
Modified: sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/users_guide/getting_started.html
==============================================================================
--- sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/users_guide/getting_started.html (original)
+++ sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/users_guide/getting_started.html 2010-09-05 06:51:00 EDT (Sun, 05 Sep 2010)
@@ -141,6 +141,10 @@
<div class="variablelist">
<p class="title"><b></b></p>
<dl>
+<dt><span class="term">Boost.Thread</span></dt>
+<dd><p>
+ for thread_specific_ptr when suspendible_clock.hpp is included
+ </p></dd>
<dt><span class="term">Boost.Accumulator</span></dt>
<dd><p>
for accumulator_set, and statistics features when stopwatch_accumulator.hpp
@@ -149,18 +153,18 @@
</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="id4942395"></a>
+<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 <span class="bold"><strong>Boost.Stopwatches</strong></span>
</a>
</h5>
<p>
- In addition to link with the Boost Chrono library you need also to link
- with the Boost System library. If you use Suspendibles clocks you will
- need also with Boos Thread.
+ 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.
</p>
<a name="boost_stopwatches.users_guide.getting_started.install.exceptions_safety_"></a><h5>
-<a name="id4942433"></a>
+<a name="id4942454"></a>
<a href="getting_started.html#boost_stopwatches.users_guide.getting_started.install.exceptions_safety_">Exceptions
safety </a>
</h5>
@@ -169,7 +173,7 @@
of exception safety as long as the underlying parameters provide it.
</p>
<a name="boost_stopwatches.users_guide.getting_started.install.thread_safety_"></a><h5>
-<a name="id4942461"></a>
+<a name="id4942482"></a>
<a href="getting_started.html#boost_stopwatches.users_guide.getting_started.install.thread_safety_">Thread
safety </a>
</h5>
@@ -177,7 +181,7 @@
All functions in the library are thread-unsafe except when noted explicitly.
</p>
<a name="boost_stopwatches.users_guide.getting_started.install.tested_compilers_"></a><h5>
-<a name="id4942486"></a>
+<a name="id4942508"></a>
<a href="getting_started.html#boost_stopwatches.users_guide.getting_started.install.tested_compilers_">Tested
compilers </a>
</h5>
Modified: sandbox/chrono/libs/stopwatches/doc/html/index.html
==============================================================================
--- sandbox/chrono/libs/stopwatches/doc/html/index.html (original)
+++ sandbox/chrono/libs/stopwatches/doc/html/index.html 2010-09-05 06:51:00 EDT (Sun, 05 Sep 2010)
@@ -53,6 +53,11 @@
</dl></dd>
<dt><span class="section"> Reference </span></dt>
<dd><dl>
+<dt><span class="section"><a href="boost_stopwatches/reference/stopwatches_hpp.html"> Header
+ <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">stopwatches</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code></a></span></dt>
+<dt><span class="section"><a href="boost_stopwatches/reference/chrono_stopwatches_hpp.html">
+ Header <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">stopwatches</span><span class="special">/</span><span class="identifier">stopwatches</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code></a></span></dt>
+<dt><span class="section"> Other clocks</span></dt>
<dt><span class="section"> Stopwatches</span></dt>
<dt><span class="section"> Stopwatch Reporters</span></dt>
<dt><span class="section"> Stopwatch Formatters</span></dt>
@@ -86,7 +91,7 @@
</table></div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
-<td align="left"><p><small>Last revised: September 04, 2010 at 12:18:04 GMT</small></p></td>
+<td align="left"><p><small>Last revised: September 05, 2010 at 10:42:38 GMT</small></p></td>
<td align="right"><div class="copyright-footer"></div></td>
</tr></table>
<hr>
Modified: sandbox/chrono/libs/stopwatches/doc/html/standalone_HTML.manifest
==============================================================================
--- sandbox/chrono/libs/stopwatches/doc/html/standalone_HTML.manifest (original)
+++ sandbox/chrono/libs/stopwatches/doc/html/standalone_HTML.manifest 2010-09-05 06:51:00 EDT (Sun, 05 Sep 2010)
@@ -7,6 +7,9 @@
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/chrono_stopwatches_hpp.html
+boost_stopwatches/reference/other_clocks.html
boost_stopwatches/reference/stopwatches.html
boost_stopwatches/reference/reporters.html
boost_stopwatches/reference/formatters.html
Modified: sandbox/chrono/libs/stopwatches/doc/stopwatches.qbk
==============================================================================
--- sandbox/chrono/libs/stopwatches/doc/stopwatches.qbk (original)
+++ sandbox/chrono/libs/stopwatches/doc/stopwatches.qbk 2010-09-05 06:51:00 EDT (Sun, 05 Sep 2010)
@@ -197,7 +197,7 @@
[def __thread_clock__ `thread_clock`]
-[def __suspendible_clock__ `suspendible_clock`]
+[def __suspendible_clock__ [link boost_stopwatches.reference.other_clocks.suspendible_clock_hpp.suspendible_clock `suspendible_clock`]]
[def __stopwatch_accumulator_formatter__ [link boost_stopwatches.reference.formatters.stopwatch_accumulator_formatter_hpp.basic_stopwatch_accumulator_formatter `stopwatch_accumulator_formatter`]]
@@ -305,6 +305,13 @@
* __stopwatch_reporter__, convenient reporting to an output stream (including wide char streams) of the elapsed time of models of __Stopwatch__ results.
* __stopclock_clock__ shortcut of `__stopwatch_reporter__<__stopwatch__<Clock>>`
+[/
+
+* Suspendible clock
+ * __SuspendibleClock__ concept
+ * scope_suspend which do suspend/resume if the __Clock__ is a model of __SuspendibleClock__ concept, and nothing otherwise.
+ * template class __suspendible_clock__
+]
[endsect]
@@ -388,6 +395,9 @@
[variablelist
[
+ [[@http://www.boost.org/libs/thread [*Boost.Thread]]] [for thread_specific_ptr when suspendible_clock.hpp is included]
+]
+[
[[@http://www.boost.org/libs/accumulator [*Boost.Accumulator]]] [for accumulator_set, and statistics features when stopwatch_accumulator.hpp is included]
]
]
@@ -397,7 +407,7 @@
[heading Building an executable that uses __Boost_Stopwatches__ ]
[/=========================================================]
-In addition to link with the Boost Chrono library you need also to link with the Boost System library. If you use Suspendibles clocks you will need also with Boos Thread.
+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.
[/=========================]
[heading Exceptions safety ]
@@ -530,6 +540,48 @@
0.011s
0.017s
+[/
+[section How reliable are these measures?]
+
+[note this section need to be reworked, the ideas are there, but ...]
+
+There are three context on which you can get unreliable measures:
+
+* precision of your clock. If the precision of your clock is 10ms you can not be able to measure the time spent by blocks of code that takes the same order of magnitude. The library provides a hig_resolution_clock that gives you the higher resolution available on your platform. Respect to the precision, nothing to do except to take the clock with the highest resolution and measures blocks of code that will spent time having more than one order of magnitude the precision of the clock.
+
+``
+#include <boost/chrono/chrono.hpp>
+ ...
+ __stopclock__<__high_resolution_clock__> _;
+``
+
+* When your application is multithreaded, and you use a process clock, the time you get is the delay during which your block has been executed, in concurrency with the other threads of execution. If what you want is the time spent by this specific thread another clock is needed. The library provide a __thread_clock__ that returns the time spent by the thread on platforms providing this kind of data. It can be used as follows
+
+``
+#include <boost/chrono/thread_clock.hpp>
+...
+#if defined(__BOOST_CHRONO_HAS_THREAD_CLOCK)
+ __stopclock__<__thread_clock__> _;
+#else
+ __stopclock__<__process_real_cpu_clock__> _;
+#endif
+``
+
+* 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?
+
+Some measures let us think that most of the time spent by the __stopclock__ mechanism is associated to the logging part. There are two things we can do to make the difference :
+
+* Avoid expensive operations as logging while doing the measures. Note that reporting in itself is not too expensive as far as we don't need to flush the buffer. This can be achieved either using a __stopclock_accumulator__, 'i.e. don't report until all the measures have been compiled and then report some statistics or using an asynchronous stream.
+
+* Introduce some cheap mechanism that allows us to make the difference between the application time and the intrinsic __stopclock__ time. When the precision of the clock is enough, we can suspend the counting of the Clock while we are spending time reporting the measures, and resume it once the work is done. The library provide a Clock wrapper __suspendible_clock__ that make the resulting clock suspendible. The __stopwatch_reporter__ is able to detect if the __Clock__ is Suspendible and then `suspend`/`resume` the __Clock__ while doing the report.
+
+ __stopclock__<__suspendible_clock__<Clock> > _;
+
+
+See the performances section for more deep details.
+
+[endsect]
+]
[section Stopwatches accumulation and statistics]
@@ -939,7 +991,7 @@
[endsect]
[endsect]
-[endsect]
+
[/
@@ -982,21 +1034,16 @@
]
[endsect]
+[endsect]
[/=================]
[section:reference Reference ]
[/=================]
-
-
-[/==================================================]
-[section:stopwatches Stopwatches]
-[/==================================================]
[/=============================================]
[section:stopwatches_hpp Header `<boost/stopwatches.hpp>`]
[/=============================================]
-This file include all the stopwatches related files
#include <boost/stopwatches/stopwatches.hpp>
@@ -1006,10 +1053,9 @@
[section:chrono_stopwatches_hpp Header `<boost/stopwatches/stopwatches.hpp>`]
[/=============================================]
-This file include all the stopwatches related files
+This file include all the stopwatches related files except the suspendible related files.
#include <boost/stopwatches/scoped_stopclock.hpp>
- #include <boost/stopwatches/process_cpu_clocks.hpp>
#include <boost/stopwatches/stopclock.hpp>
#include <boost/stopwatches/stopclock_accumulator.hpp>
#include <boost/stopwatches/stopwatch.hpp>
@@ -1025,6 +1071,152 @@
[endsect]
+[section:other_clocks Other clocks]
+
+[section:suspendible_clock_req `SuspendibleClock` Requirements]
+
+A `SuspendibleClock` is a Clock that in addition supports `suspend`/`resume` operations.
+
+A `SuspendibleClock` must meet the requirements in the following Table.
+
+In this table `C` denote `clock` types.
+
+[table SuspendibleClock Requirements
+ [[expression] [return type] [operational semantics]]
+ [[`C::suspend()`] [`void`] [Suspends the time counting of the clock C.]]
+ [[`C::resume()`] [`void`] [Resumes the time counting of the clock C.]]
+ [[`C::suspended()`] [__duration__] [Returns the delay(duration during which the clock has been suspended.]]
+]
+
+[section:SuspendibleClock_suspend Static Member Function `suspend()`]
+
+ void suspend( system::error_code & ec = system::throws );
+
+[*Effect:] Suspends the SuspendibleClock.
+
+[*Throw:] Any exception the `Clock::now(ec)` function can throw. Otherwise `ec` is set with the correspoding error code set by `Clock::now(ec)`.
+
+[endsect]
+[section:SuspendibleClock_resume Static Member Function `resume()`]
+
+ void resume( system::error_code & ec = system::throws );
+
+[*Effect:] Resumes the `SuspendibleClock`.
+
+[*Throw:] Any exception the `Clock::now(ec)` can throw. Otherwise `ec` is set with the correspoding error code set by `Clock::now(ec)`.
+
+[endsect]
+
+[section:SuspendibleClock_suspended Static Member Function `suspended()`]
+
+ duration suspended( system::error_code & ec = system::throws );
+
+[*Returns:] the cumalative elapsed duration during which the `SuspendibleClock` has been suspendeed.
+
+[*Throw:] Any exception the Clock::now function can throw if `ec == system::throws`. Otherwise `ec` is set with the correspoding error code set by `Clock::now(ec)`.
+
+[endsect]
+
+Models of `SuspendibleClock`:
+
+* __suspendible_clock__]
+
+
+[endsect]
+
+
+[/==================================================================]
+[section:scoped_suspend_hpp Header `<boost/stopwatches/scoped_suspend.hpp>`]
+[/==================================================================]
+
+ namespace boost { namespace stopwatches {
+ template <class Clock> struct is_suspendible;
+ template <class Clock> class scoped_suspend;
+ }}
+
+[section:is_suspendible Meta Function Class `is_suspendible`]
+
+ template <class Clock>
+ struct is_suspendible : mpl:: false_ {};
+
+[endsect]
+
+[section:scoped_suspend Template Class `scoped_suspend`]
+
+ 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;
+ };
+
+[endsect]
+
+[endsect]
+
+
+[/==================================================================]
+[section:suspendible_clock_hpp Header `<boost/stopwatches/suspendible_clock.hpp>`]
+[/==================================================================]
+
+ 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> >;
+
+ }}
+
+[section:suspendible_clock Template Class `suspendible_clock<>`]
+
+Given a __Clock__, __suspendible_clock__ <__Clock__> is a model of __SuspendibleClock__.
+
+ template < class Clock >
+ class suspendible_clock {
+ public:
+ typedef typename Clock::duration duration;
+ typedef typename Clock::rep rep;
+ typedef typename Clock::period period;
+ typedef chrono::__time_point__<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);
+ };
+
+[section `scoped_suspend` specialization for `suspendible_clock<>`]
+
+ template <class Clock>
+ class scoped_suspend<suspendible_clock<Clock> > {
+ public:
+ scoped_suspend(system::error_code & ec = system::throws);
+ ~scoped_suspend();
+ };
+
+[endsect]
+
+[endsect]
+
+[endsect]
+
+[endsect]
+
+[/==================================================]
+[section:stopwatches Stopwatches]
+[/==================================================]
+
[section:stopwatch_req `Stopwatch` Requirements]
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.
@@ -2698,7 +2890,6 @@
[endsect]
-
[/=================]
[section Appendices]
[/=================]
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