boost-react-native-bundle

<html> <head> <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.78.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 <boost/mpi/timer.hpp>"> <link rel="prev" href="status.html" title="Class status"> <link rel="next" href="../../mpi/python.html" title="Python Bindings"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> <table cellpadding="2" width="100%"><tr> <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> <td align="center"><a href="../../../../index.html">Home</a></td> <td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> <td align="center"><a href="../../../../more/index.htm">More</a></td> </tr></table> <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> </div> <div class="refentry"> <a name="boost.mpi.timer"></a><div class="titlepage"></div> <div class="refnamediv"> <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>> </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#idp149916224-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#idp229889088-bb">public member functions</a></span> <span class="keyword">void</span> <a class="link" href="timer.html#idp229889648-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#idp149910880-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#idp149912496-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#idp149914144-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#idp149917920-bb">public static functions</a></span> <span class="keyword">static</span> <span class="keyword">bool</span> <a class="link" href="timer.html#idp200093392-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="idp342720592"></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="idp342722112"></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="idp149916224-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" 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> </tr></tbody> </table></div> </li></ol></div> </div> <div class="refsect2"> <a name="idp342730400"></a><h3> <a name="idp229889088-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="idp229889648-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" 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> </tr></tbody> </table></div> </li> <li class="listitem"> <pre class="literallayout"><span class="keyword">double</span> <a name="idp149910880-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="idp149912496-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="idp149914144-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="idp342756192"></a><h3> <a name="idp149917920-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="idp200093392-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, 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 <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top"> http://www.boost.org/LICENSE_1_0.txt </a>) </p> </div></td> </tr></table> <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> </div> </body> </html>