summaryrefslogtreecommitdiff
path: root/doc/html/boost/mpi/timer.html
diff options
context:
space:
mode:
Diffstat (limited to 'doc/html/boost/mpi/timer.html')
-rw-r--r--doc/html/boost/mpi/timer.html52
1 files changed, 29 insertions, 23 deletions
diff --git a/doc/html/boost/mpi/timer.html b/doc/html/boost/mpi/timer.html
index addd3bcd23..4e3101e4a2 100644
--- a/doc/html/boost/mpi/timer.html
+++ b/doc/html/boost/mpi/timer.html
@@ -4,7 +4,7 @@
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Class timer</title>
<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
<link rel="up" href="../../mpi/reference.html#header.boost.mpi.timer_hpp" title="Header &lt;boost/mpi/timer.hpp&gt;">
<link rel="prev" href="status.html" title="Class status">
@@ -36,32 +36,35 @@
<span class="keyword">class</span> <a class="link" href="timer.html" title="Class timer">timer</a> <span class="special">{</span>
<span class="keyword">public</span><span class="special">:</span>
<span class="comment">// <a class="link" href="timer.html#boost.mpi.timerconstruct-copy-destruct">construct/copy/destruct</a></span>
- <a class="link" href="timer.html#idp87549120-bb"><span class="identifier">timer</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
+ <a class="link" href="timer.html#idm46563251722624-bb"><span class="identifier">timer</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
- <span class="comment">// <a class="link" href="timer.html#idp23365120-bb">public member functions</a></span>
- <span class="keyword">void</span> <a class="link" href="timer.html#idp23365680-bb"><span class="identifier">restart</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
- <span class="keyword">double</span> <a class="link" href="timer.html#idp23367936-bb"><span class="identifier">elapsed</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
- <span class="keyword">double</span> <a class="link" href="timer.html#idp23369552-bb"><span class="identifier">elapsed_max</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
- <span class="keyword">double</span> <a class="link" href="timer.html#idp23371200-bb"><span class="identifier">elapsed_min</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
+ <span class="comment">// <a class="link" href="timer.html#idm46563251730912-bb">public member functions</a></span>
+ <span class="keyword">void</span> <a class="link" href="timer.html#idm46563251730352-bb"><span class="identifier">restart</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
+ <span class="keyword">double</span> <a class="link" href="timer.html#idm46563251728096-bb"><span class="identifier">elapsed</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
+ <span class="keyword">double</span> <a class="link" href="timer.html#idm46563251726480-bb"><span class="identifier">elapsed_max</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
+ <span class="keyword">double</span> <a class="link" href="timer.html#idm46563251724832-bb"><span class="identifier">elapsed_min</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
- <span class="comment">// <a class="link" href="timer.html#idp87550816-bb">public static functions</a></span>
- <span class="keyword">static</span> <span class="keyword">bool</span> <a class="link" href="timer.html#idp87551376-bb"><span class="identifier">time_is_global</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
+ <span class="comment">// <a class="link" href="timer.html#idm46563251720928-bb">public static functions</a></span>
+ <span class="keyword">static</span> <span class="keyword">bool</span> <a class="link" href="timer.html#idm46563251720368-bb"><span class="identifier">time_is_global</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
<span class="special">}</span><span class="special">;</span></pre></div>
<div class="refsect1">
-<a name="idp308319520"></a><h2>Description</h2>
+<a name="idm45927875283184"></a><h2>Description</h2>
<p>The <code class="computeroutput">timer</code> class is a simple wrapper around the MPI timing facilities that mimics the interface of the Boost Timer library. </p>
<div class="refsect2">
-<a name="idp308321040"></a><h3>
+<a name="idm45927875281664"></a><h3>
<a name="boost.mpi.timerconstruct-copy-destruct"></a><code class="computeroutput">timer</code>
public
construct/copy/destruct</h3>
<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
-<pre class="literallayout"><a name="idp87549120-bb"></a><span class="identifier">timer</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
+<pre class="literallayout"><a name="idm46563251722624-bb"></a><span class="identifier">timer</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
<p>Initializes the timer</p>
<p>
</p>
-<div class="variablelist"><table border="0">
+<div class="variablelist"><table border="0" class="variablelist compact">
+<colgroup>
<col align="left" valign="top">
+<col>
+</colgroup>
<tbody><tr>
<td><p><span class="term">Postconditions:</span></p></td>
<td><p><code class="computeroutput">elapsed()</code> == 0 </p></td>
@@ -70,16 +73,19 @@
</li></ol></div>
</div>
<div class="refsect2">
-<a name="idp308329456"></a><h3>
-<a name="idp23365120-bb"></a><code class="computeroutput">timer</code> public member functions</h3>
+<a name="idm45927875273248"></a><h3>
+<a name="idm46563251730912-bb"></a><code class="computeroutput">timer</code> public member functions</h3>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem">
-<pre class="literallayout"><span class="keyword">void</span> <a name="idp23365680-bb"></a><span class="identifier">restart</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
+<pre class="literallayout"><span class="keyword">void</span> <a name="idm46563251730352-bb"></a><span class="identifier">restart</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
<p>Restart the timer.</p>
<p>
</p>
-<div class="variablelist"><table border="0">
+<div class="variablelist"><table border="0" class="variablelist compact">
+<colgroup>
<col align="left" valign="top">
+<col>
+</colgroup>
<tbody><tr>
<td><p><span class="term">Postconditions:</span></p></td>
<td><p><code class="computeroutput">elapsed()</code> == 0 </p></td>
@@ -87,24 +93,24 @@
</table></div>
</li>
<li class="listitem">
-<pre class="literallayout"><span class="keyword">double</span> <a name="idp23367936-bb"></a><span class="identifier">elapsed</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
+<pre class="literallayout"><span class="keyword">double</span> <a name="idm46563251728096-bb"></a><span class="identifier">elapsed</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
<p>Return the amount of time that has elapsed since the last construction or reset, in seconds. </p>
</li>
<li class="listitem">
-<pre class="literallayout"><span class="keyword">double</span> <a name="idp23369552-bb"></a><span class="identifier">elapsed_max</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
+<pre class="literallayout"><span class="keyword">double</span> <a name="idm46563251726480-bb"></a><span class="identifier">elapsed_max</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
<p>Return an estimate of the maximum possible value of elapsed(). Note that this routine may return too high a value on some systems. </p>
</li>
<li class="listitem">
-<pre class="literallayout"><span class="keyword">double</span> <a name="idp23371200-bb"></a><span class="identifier">elapsed_min</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
+<pre class="literallayout"><span class="keyword">double</span> <a name="idm46563251724832-bb"></a><span class="identifier">elapsed_min</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
<p>Returns the minimum non-zero value that <code class="computeroutput">elapsed()</code> may return. This is the resolution of the timer. </p>
</li>
</ol></div>
</div>
<div class="refsect2">
-<a name="idp308355376"></a><h3>
-<a name="idp87550816-bb"></a><code class="computeroutput">timer</code> public static functions</h3>
+<a name="idm45927875247456"></a><h3>
+<a name="idm46563251720928-bb"></a><code class="computeroutput">timer</code> public static functions</h3>
<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
-<pre class="literallayout"><span class="keyword">static</span> <span class="keyword">bool</span> <a name="idp87551376-bb"></a><span class="identifier">time_is_global</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
+<pre class="literallayout"><span class="keyword">static</span> <span class="keyword">bool</span> <a name="idm46563251720368-bb"></a><span class="identifier">time_is_global</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
<p>Determines whether the elapsed time values are global times or local processor times. </p>
</li></ol></div>
</div>