diff options
Diffstat (limited to 'doc/html/boost/mpi/timer.html')
| -rw-r--r-- | doc/html/boost/mpi/timer.html | 52 |
1 files changed, 25 insertions, 27 deletions
diff --git a/doc/html/boost/mpi/timer.html b/doc/html/boost/mpi/timer.html index a9f46c538f..d0cd76478b 100644 --- a/doc/html/boost/mpi/timer.html +++ b/doc/html/boost/mpi/timer.html @@ -9,6 +9,7 @@ <link rel="up" href="../../mpi/reference.html#header.boost.mpi.timer_hpp" title="Header <boost/mpi/timer.hpp>"> <link rel="prev" href="status.html" title="Class status"> <link rel="next" href="../../mpi/python.html" title="Python Bindings"> +<meta name="viewport" content="width=device-width, initial-scale=1"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> <table cellpadding="2" width="100%"><tr> @@ -29,34 +30,34 @@ <h2><span class="refentrytitle">Class timer</span></h2> <p>boost::mpi::timer — A simple timer that provides access to the MPI timing facilities. </p> </div> -<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> -<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../mpi/reference.html#header.boost.mpi.timer_hpp" title="Header <boost/mpi/timer.hpp>">boost/mpi/timer.hpp</a>> +<h2 class="refsynopsisdiv-title">Synopsis</h2> +<div class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../mpi/reference.html#header.boost.mpi.timer_hpp" title="Header <boost/mpi/timer.hpp>">boost/mpi/timer.hpp</a>> </span> <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#id-1_3_27_7_25_2_1_1_4-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#id-1_3_25_7_25_2_1_1_4-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#id-1_3_27_7_25_2_1_1_3-bb">public member functions</a></span> - <span class="keyword">void</span> <a class="link" href="timer.html#id-1_3_27_7_25_2_1_1_3_1-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#id-1_3_27_7_25_2_1_1_3_2-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#id-1_3_27_7_25_2_1_1_3_3-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#id-1_3_27_7_25_2_1_1_3_4-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#id-1_3_25_7_25_2_1_1_3-bb">public member functions</a></span> + <span class="keyword">void</span> <a class="link" href="timer.html#id-1_3_25_7_25_2_1_1_3_1-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#id-1_3_25_7_25_2_1_1_3_2-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#id-1_3_25_7_25_2_1_1_3_3-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#id-1_3_25_7_25_2_1_1_3_4-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#id-1_3_27_7_25_2_1_1_5-bb">public static functions</a></span> - <span class="keyword">static</span> <span class="keyword">bool</span> <a class="link" href="timer.html#id-1_3_27_7_25_2_1_1_5_1-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#id-1_3_25_7_25_2_1_1_5-bb">public static functions</a></span> + <span class="keyword">static</span> <span class="keyword">bool</span> <a class="link" href="timer.html#id-1_3_25_7_25_2_1_1_5_1-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="id-1.3.27.7.26.4.4"></a><h2>Description</h2> +<a name="id-1.3.25.7.26.4.4"></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="id-1.3.27.7.26.4.4.3"></a><h3> +<a name="id-1.3.25.7.26.4.4.3"></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="id-1_3_27_7_25_2_1_1_4-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="id-1_3_25_7_25_2_1_1_4-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> @@ -73,11 +74,11 @@ </li></ol></div> </div> <div class="refsect2"> -<a name="id-1.3.27.7.26.4.4.4"></a><h3> -<a name="id-1_3_27_7_25_2_1_1_3-bb"></a><code class="computeroutput">timer</code> public member functions</h3> +<a name="id-1.3.25.7.26.4.4.4"></a><h3> +<a name="id-1_3_25_7_25_2_1_1_3-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="id-1_3_27_7_25_2_1_1_3_1-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="id-1_3_25_7_25_2_1_1_3_1-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> @@ -93,39 +94,36 @@ </table></div> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">double</span> <a name="id-1_3_27_7_25_2_1_1_3_2-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="id-1_3_25_7_25_2_1_1_3_2-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="id-1_3_27_7_25_2_1_1_3_3-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="id-1_3_25_7_25_2_1_1_3_3-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="id-1_3_27_7_25_2_1_1_3_4-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="id-1_3_25_7_25_2_1_1_3_4-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="id-1.3.27.7.26.4.4.5"></a><h3> -<a name="id-1_3_27_7_25_2_1_1_5-bb"></a><code class="computeroutput">timer</code> public static functions</h3> +<a name="id-1.3.25.7.26.4.4.5"></a><h3> +<a name="id-1_3_25_7_25_2_1_1_5-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="id-1_3_27_7_25_2_1_1_5_1-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="id-1_3_25_7_25_2_1_1_5_1-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> </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 © 2005-2007 Douglas Gregor, +<div class="copyright-footer">Copyright © 2005-2007 Douglas Gregor, Matthias Troyer, Trustees of Indiana University<p> Distributed under the Boost Software License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at <ulink url="http://www.boost.org/LICENSE_1_0.txt"> http://www.boost.org/LICENSE_1_0.txt </ulink>) </p> -</div></td> -</tr></table> +</div> <hr> <div class="spirit-nav"> <a accesskey="p" href="status.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../mpi/reference.html#header.boost.mpi.timer_hpp"><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="../../mpi/python.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> |