Boost-Commit :

Date view	Thread view	Subject view	Author view

Subject: [Boost-commit] svn:boost r68850 - in sandbox/chrono/libs/stopwatches/doc: . html html/boost_stopwatches html/boost_stopwatches/appendices html/boost_stopwatches/overview html/boost_stopwatches/reference html/boost_stopwatches/users_guide
From: vicente.botet_at_[hidden]
Date: 2011-02-13 15:04:35

Author: viboes
Date: 2011-02-13 15:04:28 EST (Sun, 13 Feb 2011)
New Revision: 68850
URL: http://svn.boost.org/trac/boost/changeset/68850

Log:
Stopwatches: Update doc
Binary files modified:
   sandbox/chrono/libs/stopwatches/doc/stopwatches.pdf
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/overview.html | 2
   sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/overview/motivation.html | 8
   sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/reference.html | 1
   sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/reference/reporters.html | 507 +++++++++++++++++++++++++++++++++++++++
   sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/reference/stopwatches.html | 28 +-
   sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/users_guide/getting_started.html | 16
   sandbox/chrono/libs/stopwatches/doc/html/index.html | 4
   sandbox/chrono/libs/stopwatches/doc/stopwatches.qbk | 98 +++++++
   12 files changed, 635 insertions(+), 45 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 2011-02-13 15:04:28 EST (Sun, 13 Feb 2011)
@@ -27,7 +27,7 @@
<a name="boost_stopwatches.appendices.faq"></a><a class="link" href="faq.html" title="Appendix D: FAQ">Appendix D: FAQ</a>
</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><h5>
-<a name="id3330569"></a>
+<a name="id3008821"></a>
 <a class="link" 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>
@@ -38,7 +38,7 @@
 dangerously.
 
<a name="boost_stopwatches.appendices.faq.why_does_stopwatch_reporter_sometimes_report_more_cpu_seconds_than_real_seconds_"></a><h5>
-<a name="id3330608"></a>
+<a name="id3008860"></a>
 <a class="link" 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>
 </h5>
@@ -48,7 +48,7 @@
 be reporting at times.
 
<a name="boost_stopwatches.appendices.faq.can_i_obtain_statistics_of_the_time_elapsed_between_calls_to_a_function_"></a><h5>
-<a name="id3330640"></a>
+<a name="id3008893"></a>
 <a class="link" 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>
 </h5>
@@ -56,7 +56,7 @@
 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><h5>
-<a name="id3330668"></a>
+<a name="id3008921"></a>
 <a class="link" 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 2011-02-13 15:04:28 EST (Sun, 13 Feb 2011)
@@ -69,7 +69,7 @@
 with a variable lifetime.
 
<a name="boost_stopwatches.appendices.perf.single_threaded_recursive_function"></a><h5>
-<a name="id3332486"></a>
+<a name="id3010739"></a>
 <a class="link" href="perf.html#boost_stopwatches.appendices.perf.single_threaded_recursive_function">Single-Threaded
 Recursive function</a>
 </h5>
@@ -92,7 +92,7 @@
 and thread_clock.
 
<a name="boost_stopwatches.appendices.perf.multi_threaded_recursive_function"></a><h5>
-<a name="id3332536"></a>
+<a name="id3010788"></a>
 <a class="link" href="perf.html#boost_stopwatches.appendices.perf.multi_threaded_recursive_function">Multi-Threaded
 Recursive function</a>
 </h5>

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 2011-02-13 15:04:28 EST (Sun, 13 Feb 2011)
@@ -27,7 +27,7 @@
<a name="boost_stopwatches.appendices.rationale"></a><a class="link" 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><h5>
-<a name="id3330098"></a>
+<a name="id3008487"></a>
 <a class="link" href="rationale.html#boost_stopwatches.appendices.rationale.how_reliable_are_these_measures_">How
 reliable are these measures?</a>
 </h5>

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 2011-02-13 15:04:28 EST (Sun, 13 Feb 2011)
@@ -27,7 +27,7 @@
 plans</a>
</h3></div></div></div>
<a name="boost_stopwatches.appendices.todo.tasks_to_do"></a><h5>
-<a name="id3332602"></a>
+<a name="id3010854"></a>
 <a class="link" href="todo.html#boost_stopwatches.appendices.todo.tasks_to_do">Tasks to do</a>
 </h5>
<div class="itemizedlist"><ul class="itemizedlist" type="disc">

Modified: sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/overview.html
==============================================================================
--- sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/overview.html (original)
+++ sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/overview.html 2011-02-13 15:04:28 EST (Sun, 13 Feb 2011)
@@ -31,7 +31,7 @@
<dt>Description</dt>
</dl></div>
<a name="boost_stopwatches.overview.how_to_use_this_documentation"></a><h4>
-<a name="id3268185"></a>
+<a name="id2944396"></a>
 <a class="link" href="overview.html#boost_stopwatches.overview.how_to_use_this_documentation">How
 to Use This Documentation</a>
 </h4>

Modified: sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/overview/motivation.html
==============================================================================
--- sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/overview/motivation.html (original)
+++ sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/overview/motivation.html 2011-02-13 15:04:28 EST (Sun, 13 Feb 2011)
@@ -27,7 +27,7 @@
<a name="boost_stopwatches.overview.motivation"></a><a class="link" href="motivation.html" title="Motivation">Motivation</a>
</h3></div></div></div>
<a name="boost_stopwatches.overview.motivation.measuring_elapsed_time"></a><h5>
-<a name="id3226850"></a>
+<a name="id2903061"></a>
 <a class="link" href="motivation.html#boost_stopwatches.overview.motivation.measuring_elapsed_time">Measuring
 elapsed time</a>
 </h5>
@@ -40,7 +40,7 @@
 is the basic model of <a class="link" 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><h5>
-<a name="id3226946"></a>
+<a name="id2903157"></a>
 <a class="link" href="motivation.html#boost_stopwatches.overview.motivation.reporting_elapsed_time">Reporting
 elapsed time</a>
 </h5>
@@ -54,7 +54,7 @@
using namespace boost::stopwatches;
int main()
{
- stopwatch_reporter<stopwatch<process_cpu_clock> > _;
+ <a class="link" 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 class="link" href="../reference/stopwatches.html#boost_stopwatches.reference.stopwatches.stopwatch_hpp.stopwatch" title="Template Class stopwatch<>"><code class="computeroutput">stopwatch</code></a><process_cpu_clock> > _;
 // ...
}
</pre>
@@ -75,7 +75,7 @@
}
</pre>
<a name="boost_stopwatches.overview.motivation.how_reliable_are_these_measures_"></a><h5>
-<a name="id3277838"></a>
+<a name="id2954068"></a>
 <a class="link" href="motivation.html#boost_stopwatches.overview.motivation.how_reliable_are_these_measures_">How
 reliable are these measures?</a>
 </h5>

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 2011-02-13 15:04:28 EST (Sun, 13 Feb 2011)
@@ -55,6 +55,7 @@
<dd><dl>
<dt>Formatter Requirements</dt>
<dt>Formatter related traits</dt>
+<dt>Reporter Requirements</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

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 2011-02-13 15:04:28 EST (Sun, 13 Feb 2011)
@@ -29,6 +29,15 @@
<div class="toc"><dl>
<dt>Formatter Requirements</dt>
<dt>Formatter related traits</dt>
+<dt>Reporter Requirements</dt>
+<dd><dl>
+<dt><a href="reporters.html#boost_stopwatches.reference.reporters.reporters_req.R">Member
+ Function <code class="computeroutput">R()</code></a></dt>
+<dt><a href="reporters.html#boost_stopwatches.reference.reporters.reporters_req.report">Member
+ Function <code class="computeroutput">report()</code></a></dt>
+<dt><a href="reporters.html#boost_stopwatches.reference.reporters.reporters_req.reported">Member
+ Function <code class="computeroutput">reported()</code></a></dt>
+</dl></dd>
<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>
@@ -222,6 +231,502 @@
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
+<a name="boost_stopwatches.reference.reporters.reporters_req"></a><a class="link" href="reporters.html#boost_stopwatches.reference.reporters.reporters_req" title="Reporter Requirements"><code class="computeroutput">Reporter</code> Requirements</a>
+</h4></div></div></div>
+<div class="toc"><dl>
+<dt><a href="reporters.html#boost_stopwatches.reference.reporters.reporters_req.R">Member
+ Function <code class="computeroutput">R()</code></a></dt>
+<dt><a href="reporters.html#boost_stopwatches.reference.reporters.reporters_req.report">Member
+ Function <code class="computeroutput">report()</code></a></dt>
+<dt><a href="reporters.html#boost_stopwatches.reference.reporters.reporters_req.reported">Member
+ Function <code class="computeroutput">reported()</code></a></dt>
+</dl></div>
+
+ A <code class="computeroutput">Reporter</code> provides everything
+ a <a class="link" href="stopwatches.html#boost_stopwatches.reference.stopwatches.stopwatch_req" title="Stopwatch Requirements"><code class="computeroutput">Stopwatch</code></a> provides and adds reporting
+ capabilities. The reporting is controleed by two parameters:
+ 
+
+ A <code class="computeroutput">Reporter</code> must meet the
+ requirements in the following table in addition of the <a class="link" href="stopwatches.html#boost_stopwatches.reference.stopwatches.stopwatch_req" title="Stopwatch Requirements"><code class="computeroutput">Stopwatch</code></a>. The reporting is controleed
+ by two parameters:
+ 
+<div class="itemizedlist"><ul class="itemizedlist" type="disc">
+<li class="listitem">
+ format : The output format
+ </li>
+<li class="listitem">
+ places(precision): the number of decimal placess used.
+ </li>
+</ul></div>
+
+ And is sent to an output stream.
+ 
+
+ In this table <code class="computeroutput">R</code> denote
+ Reporters types. <code class="computeroutput">r</code> is an
+ instance of <code class="computeroutput">R</code>, ec is a
+ system::error_code, os is an std::ostream, f is a std::string, p is an
+ int. From the library perspective a Reporter needs to satisfy the following
+ requirements.
+ 
+<div class="table">
+<a name="boost_stopwatches.reference.reporters.reporters_req.reporter_requirements"></a>Table 4. Reporter Requirements
+<div class="table-contents"><table class="table" summary="Reporter 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">R::stopwatch</code>
+ 
+ </td>
+<td>
+ 
+ A model of <a class="link" href="stopwatches.html#boost_stopwatches.reference.stopwatches.stopwatch_req" title="Stopwatch Requirements"><code class="computeroutput">Stopwatch</code></a>.
+ 
+ </td>
+<td>
+ 
+ The Stopwatch associated to this Reporter.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">r.report()</code>
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">void</code>
+ 
+ </td>
+<td>
+ 
+ Creates a report.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">r.report(ec)</code>
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">void</code>
+ 
+ </td>
+<td>
+ 
+ Creates a report.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">r.reported()</code>
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">bool</code>
+ 
+ </td>
+<td>
+ 
+ The reporting has been done.
+ 
+ </td>
+</tr>
+</tbody>
+</table></div>
+</div>
+ 
+ From the user point of view, the reporter provides often construction with
+ any of the parameters controleed the reporting.
+ 
+<div class="table">
+<a name="boost_stopwatches.reference.reporters.reporters_req.open_reporter_requirements"></a>Table 5. Open Reporter Requirements
+<div class="table-contents"><table class="table" summary="Open Reporter 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">R r</code>
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">R</code>
+ 
+ </td>
+<td>
+ 
+ Creates a Reporter.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">R r(ec)</code>
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">R</code>
+ 
+ </td>
+<td>
+ 
+ Creates a Reporter.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">R r(os)</code>
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">R</code>
+ 
+ </td>
+<td>
+ 
+ Creates a Reporter.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">R r(os,ec)</code>
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">R</code>
+ 
+ </td>
+<td>
+ 
+ Creates a Reporter.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">R r(os,f)</code>
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">R</code>
+ 
+ </td>
+<td>
+ 
+ Creates a Reporter.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">R r(os,f,ec)</code>
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">R</code>
+ 
+ </td>
+<td>
+ 
+ Creates a Reporter.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">R r(os,f,p)</code>
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">R</code>
+ 
+ </td>
+<td>
+ 
+ Creates a Reporter.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">R r(os,f,p,ec)</code>
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">R</code>
+ 
+ </td>
+<td>
+ 
+ Creates a Reporter.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">R r(os,p)</code>
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">R</code>
+ 
+ </td>
+<td>
+ 
+ Creates a Reporter.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">R r(os,p,ec)</code>
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">R</code>
+ 
+ </td>
+<td>
+ 
+ Creates a Reporter.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">R r(f)</code>
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">R</code>
+ 
+ </td>
+<td>
+ 
+ Creates a Reporter.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">R r(f,ec)</code>
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">R</code>
+ 
+ </td>
+<td>
+ 
+ Creates a Reporter.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">R r(f,p)</code>
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">R</code>
+ 
+ </td>
+<td>
+ 
+ Creates a Reporter.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">R r(f,p,ec)</code>
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">R</code>
+ 
+ </td>
+<td>
+ 
+ Creates a Reporter.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">R r(p)</code>
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">R</code>
+ 
+ </td>
+<td>
+ 
+ Creates a Reporter.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">R r(p,ec)</code>
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">R</code>
+ 
+ </td>
+<td>
+ 
+ Creates a Reporter.
+ 
+ </td>
+</tr>
+</tbody>
+</table></div>
+</div>
+ <div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="boost_stopwatches.reference.reporters.reporters_req.R"></a><a class="link" href="reporters.html#boost_stopwatches.reference.reporters.reporters_req.R" title="Member Function R()">Member
+ Function <code class="computeroutput">R()</code></a>
+</h5></div></div></div>
+<pre class="programlisting">void R(
+ [ std::ostream & os ]
+ [, const std::string & format]
+ [, int places]
+ [, system::error_code & ec = throws()]
+ );
+</pre>
+
+ Effect: Creates a reporter. All the
+ parameters are optional.
+ 
+
+ Throw: Nothing.
+ 
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="boost_stopwatches.reference.reporters.reporters_req.report"></a><a class="link" href="reporters.html#boost_stopwatches.reference.reporters.reporters_req.report" title="Member Function report()">Member
+ Function <code class="computeroutput">report()</code></a>
+</h5></div></div></div>
+<pre class="programlisting">void report(system::error_code & ec = throws());
+</pre>
+
+ Effect: Produce a report taking in account
+ the ostream, format and place.
+ 
+
+ Throw: Any exception the <code class="computeroutput">Formatter::show_time(*this,f,p,os,ec)</code>
+ function can throw when <code class="computeroutput">ec</code>
+ is <code class="computeroutput">throws()</code>.
+ 
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="boost_stopwatches.reference.reporters.reporters_req.reported"></a><a class="link" href="reporters.html#boost_stopwatches.reference.reporters.reporters_req.reported" title="Member Function reported()">Member
+ Function <code class="computeroutput">reported()</code></a>
+</h5></div></div></div>
+<pre class="programlisting">bool reported();
+</pre>
+
+ Returns: True if the reportes has ben
+ reported already.
+ 
+
+ Throw: Nothing.
+ 
+</div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h4 class="title">
<a name="boost_stopwatches.reference.reporters.stopwatch_reporter_hpp"></a><a class="link" 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>
@@ -1021,7 +1526,7 @@
}
</pre>
<a name="boost_stopwatches.reference.reporters.scoped_stopclock_hpp.scoped_stopclock.synopsis"></a><h6>
-<a name="id3320814"></a>
+<a name="id2999203"></a>
 <a class="link" href="reporters.html#boost_stopwatches.reference.reporters.scoped_stopclock_hpp.scoped_stopclock.synopsis">Synopsis</a>
 </h6>
<pre class="programlisting">template < class Clock=process_cpu_clock

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 2011-02-13 15:04:28 EST (Sun, 13 Feb 2011)
@@ -692,16 +692,16 @@
 accuracy of timings depends on the accuracy of timing information provided
 the Clock, and this could 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 = throws() );
- explicit stopwatch( const dont_start_t& t );
-
- };
+<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 = throws() );
+ explicit stopwatch( const dont_start_t& t );
+
+};
</pre>
<div class="section">
<div class="titlepage"><div><div><h6 class="title">
@@ -836,10 +836,10 @@
<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
- >
->,
+ typename accumulators::accumulator_set<
+ typename Clock::duration::rep, Features, Weight
+ >
+ >,
 public lightweight_stopwatch<Clock,Features,Weight>
{
public:

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 2011-02-13 15:04:28 EST (Sun, 13 Feb 2011)
@@ -39,7 +39,7 @@
 Boost.Stopwatches</a>
</h4></div></div></div>
<a name="boost_stopwatches.users_guide.getting_started.install.getting__emphasis_role__bold__boost_stopwatches__emphasis__"></a><h6>
-<a name="id3278265"></a>
+<a name="id2954494"></a>
 <a class="link" href="getting_started.html#boost_stopwatches.users_guide.getting_started.install.getting__emphasis_role__bold__boost_stopwatches__emphasis__">Getting
 Boost.Stopwatches </a>
 </h6>
@@ -55,7 +55,7 @@
 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><h6>
-<a name="id3278332"></a>
+<a name="id2954561"></a>
 <a class="link" 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>
 </h6>
@@ -71,7 +71,7 @@
 variable. Any help is welcome.
 
<a name="boost_stopwatches.users_guide.getting_started.install.building__emphasis_role__bold__boost_stopwatches__emphasis__"></a><h6>
-<a name="id3278378"></a>
+<a name="id2954607"></a>
 <a class="link" href="getting_started.html#boost_stopwatches.users_guide.getting_started.install.building__emphasis_role__bold__boost_stopwatches__emphasis__">Building
 Boost.Stopwatches </a>
 </h6>
@@ -79,7 +79,7 @@
 Boost.Stopwatches is a header only library.
 
<a name="boost_stopwatches.users_guide.getting_started.install.requirements"></a><h6>
-<a name="id3278412"></a>
+<a name="id2954642"></a>
 <a class="link" href="getting_started.html#boost_stopwatches.users_guide.getting_started.install.requirements">Requirements</a>
 </h6>

@@ -150,7 +150,7 @@
</dl>
</div>
<a name="boost_stopwatches.users_guide.getting_started.install.building_an_executable_that_uses__emphasis_role__bold__boost_stopwatches__emphasis__"></a><h6>
-<a name="id3278701"></a>
+<a name="id2954930"></a>
 <a class="link" 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>
@@ -161,7 +161,7 @@
 also with Boost.Thread.
 
<a name="boost_stopwatches.users_guide.getting_started.install.exceptions_safety_"></a><h6>
-<a name="id3278739"></a>
+<a name="id2954969"></a>
 <a class="link" href="getting_started.html#boost_stopwatches.users_guide.getting_started.install.exceptions_safety_">Exceptions
 safety </a>
 </h6>
@@ -170,7 +170,7 @@
 of exception safety as long as the underlying parameters provide it.
 
<a name="boost_stopwatches.users_guide.getting_started.install.thread_safety_"></a><h6>
-<a name="id3278767"></a>
+<a name="id2954996"></a>
 <a class="link" href="getting_started.html#boost_stopwatches.users_guide.getting_started.install.thread_safety_">Thread
 safety </a>
 </h6>
@@ -178,7 +178,7 @@
 All functions in the library are thread-unsafe except when noted explicitly.
 
<a name="boost_stopwatches.users_guide.getting_started.install.tested_compilers_"></a><h6>
-<a name="id3278792"></a>
+<a name="id2955021"></a>
 <a class="link" href="getting_started.html#boost_stopwatches.users_guide.getting_started.install.tested_compilers_">Tested
 compilers </a>
 </h6>

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 2011-02-13 15:04:28 EST (Sun, 13 Feb 2011)
@@ -28,7 +28,7 @@
</h3></div></div></div>
<div>Copyright © 2009 -2011 Vicente J. Botet Escriba</div>
<div><div class="legalnotice">
-<a name="id3268137"></a>
+<a name="id2944348"></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)
 
@@ -90,7 +90,7 @@
</table></div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
-<td align="left">Last revised: February 08, 2011 at 07:30:48 GMT</td>
+<td align="left">Last revised: February 09, 2011 at 18:50:50 GMT</td>
<td align="right"><div class="copyright-footer"></div></td>
</tr></table>
<hr>

Modified: sandbox/chrono/libs/stopwatches/doc/stopwatches.pdf
==============================================================================
Binary files. No diff available.

Modified: sandbox/chrono/libs/stopwatches/doc/stopwatches.qbk
==============================================================================
--- sandbox/chrono/libs/stopwatches/doc/stopwatches.qbk (original)
+++ sandbox/chrono/libs/stopwatches/doc/stopwatches.qbk 2011-02-13 15:04:28 EST (Sun, 13 Feb 2011)
@@ -260,7 +260,7 @@
 using namespace boost::stopwatches;
 int main()
 {
- stopwatch_reporter<stopwatch<process_cpu_clock> > _;
+ __stopwatch_reporter__<__stopwatch__<process_cpu_clock> > _;
 // ...
 }

@@ -1471,8 +1471,8 @@

 template <class Clock>
 class stopwatch :
- private base_from_member<typename Clock::duration>,
- public lightweight_stopwatch<Clock>
+ private base_from_member<typename Clock::duration>,
+ public lightweight_stopwatch<Clock>
 {
 public:
 explicit stopwatch( system::error_code & ec = throws() );
@@ -1577,10 +1577,10 @@
 template <class Clock, typename Features, typename Weight>
 class stopwatch_accumulator
 : private base_from_member<
- typename accumulators::accumulator_set<
- typename Clock::duration::rep, Features, Weight
- >
- >,
+ typename accumulators::accumulator_set<
+ typename Clock::duration::rep, Features, Weight
+ >
+ >,
 public lightweight_stopwatch<Clock,Features,Weight>
 {
 public:
@@ -1774,6 +1774,90 @@

[endsect]

+[section:reporters_req `Reporter` Requirements]
+
+A `Reporter` provides everything a __Stopwatch__ provides and adds reporting capabilities. The reporting is controleed by two parameters:
+
+A `Reporter` must meet the requirements in the following table in addition of the __Stopwatch__.
+The reporting is controleed by two parameters:
+
+* format : The output format
+* places(precision): the number of decimal placess used.
+
+And is sent to an output stream.
+
+In this table `R` denote Reporters types. `r` is an instance of `R`, ec is a system::error_code, os is an std::ostream, f is a std::string, p is an int. From the library perspective a Reporter needs to satisfy the following requirements.
+
+[table Reporter Requirements
+ [[expression] [return type] [operational semantics]]
+ [[`R::stopwatch`] [A model of __Stopwatch__.] [The Stopwatch associated to this Reporter.]]
+
+ [[`r.report()`] [`void`] [Creates a report.]]
+ [[`r.report(ec)`] [`void`] [Creates a report.]]
+ [[`r.reported()`] [`bool`] [The reporting has been done.]]
+]
+
+From the user point of view, the reporter provides often construction with any of the parameters controleed the reporting.
+
+[table Open Reporter Requirements
+ [[expression] [return type] [operational semantics]]
+ [[`R r`] [`R`] [Creates a Reporter.]]
+ [[`R r(ec)`] [`R`] [Creates a Reporter.]]
+
+ [[`R r(os)`] [`R`] [Creates a Reporter.]]
+ [[`R r(os,ec)`] [`R`] [Creates a Reporter.]]
+ [[`R r(os,f)`] [`R`] [Creates a Reporter.]]
+ [[`R r(os,f,ec)`] [`R`] [Creates a Reporter.]]
+ [[`R r(os,f,p)`] [`R`] [Creates a Reporter.]]
+ [[`R r(os,f,p,ec)`] [`R`] [Creates a Reporter.]]
+ [[`R r(os,p)`] [`R`] [Creates a Reporter.]]
+ [[`R r(os,p,ec)`] [`R`] [Creates a Reporter.]]
+
+ [[`R r(f)`] [`R`] [Creates a Reporter.]]
+ [[`R r(f,ec)`] [`R`] [Creates a Reporter.]]
+ [[`R r(f,p)`] [`R`] [Creates a Reporter.]]
+ [[`R r(f,p,ec)`] [`R`] [Creates a Reporter.]]
+
+ [[`R r(p)`] [`R`] [Creates a Reporter.]]
+ [[`R r(p,ec)`] [`R`] [Creates a Reporter.]]
+
+]
+
+[section:R Member Function `R()`]
+
+ void R(
+ [ std::ostream & os ]
+ [, const std::string & format]
+ [, int places]
+ [, system::error_code & ec = throws()]
+ );
+
+[*Effect:] Creates a reporter. All the parameters are optional.
+
+[*Throw:] Nothing.
+
+[endsect]
+
+[section:report Member Function `report()`]
+
+ void report(system::error_code & ec = throws());
+
+[*Effect:] Produce a report taking in account the ostream, format and place.
+
+[*Throw:] Any exception the `Formatter::show_time(*this,f,p,os,ec)` function can throw when `ec` is `throws()`.
+
+[endsect]
+[section:reported Member Function `reported()`]
+
+ bool reported();
+
+[*Returns:] True if the reportes has ben reported already.
+
+[*Throw:] Nothing.
+
+[endsect]
+[endsect]
+
[/==================================================]
[section:stopwatch_reporter_hpp Header `<boost/stopwatches/stopwatch_reporter.hpp>`]
[/==================================================]

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