| <html> |
| <head> |
| <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> |
| <title>Function test_all</title> |
| <link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> |
| <meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> |
| <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> |
| <link rel="up" href="../../mpi/reference.html#header.boost.mpi.nonblocking_hpp" title="Header <boost/mpi/nonblocking.hpp>"> |
| <link rel="prev" href="wait_all.html" title="Function wait_all"> |
| <link rel="next" href="wait_some.html" title="Function wait_some"> |
| </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="wait_all.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../mpi/reference.html#header.boost.mpi.nonblocking_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="wait_some.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> |
| </div> |
| <div class="refentry"> |
| <a name="boost.mpi.test_all"></a><div class="titlepage"></div> |
| <div class="refnamediv"> |
| <h2><span class="refentrytitle">Function test_all</span></h2> |
| <p>boost::mpi::test_all — Tests whether all non-blocking requests have completed. </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.nonblocking_hpp" title="Header <boost/mpi/nonblocking.hpp>">boost/mpi/nonblocking.hpp</a>> |
| |
| </span> |
| <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> <a class="link" href="../../ForwardIterator.html" title="Concept ForwardIterator">ForwardIterator</a><span class="special">,</span> <span class="keyword">typename</span> <a class="link" href="../../OutputIterator.html" title="Concept OutputIterator">OutputIterator</a><span class="special">></span> |
| <span class="identifier">optional</span><span class="special"><</span> <span class="identifier">OutputIterator</span> <span class="special">></span> |
| <span class="identifier">test_all</span><span class="special">(</span><span class="identifier">ForwardIterator</span> first<span class="special">,</span> <span class="identifier">ForwardIterator</span> last<span class="special">,</span> <span class="identifier">OutputIterator</span> out<span class="special">)</span><span class="special">;</span> |
| <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> <a class="link" href="../../ForwardIterator.html" title="Concept ForwardIterator">ForwardIterator</a><span class="special">></span> |
| <span class="keyword">bool</span> <span class="identifier">test_all</span><span class="special">(</span><span class="identifier">ForwardIterator</span> first<span class="special">,</span> <span class="identifier">ForwardIterator</span> last<span class="special">)</span><span class="special">;</span></pre></div> |
| <div class="refsect1"> |
| <a name="id2057020"></a><h2>Description</h2> |
| <p>This routine takes in a set of requests stored in the iterator range <code class="computeroutput"></code>[first,last) and determines whether all of these requests have been completed. However, due to limitations of the underlying MPI implementation, if any of the requests refers to a non-blocking send or receive of a serialized data type, <code class="computeroutput">test_all</code> will always return the equivalent of <code class="computeroutput">false</code> (i.e., the requests cannot all be finished at this time). This routine performs the same functionality as <code class="computeroutput">wait_all</code>, except that this routine will not block. This routine provides functionality equivalent to <code class="computeroutput">MPI_Testall</code>.</p> |
| <p> |
| |
| </p> |
| <div class="variablelist"><table border="0"> |
| <col align="left" valign="top"> |
| <tbody> |
| <tr> |
| <td><p><span class="term">Parameters:</span></p></td> |
| <td><div class="variablelist"><table border="0"> |
| <col align="left" valign="top"> |
| <tbody> |
| <tr> |
| <td><p><span class="term"><code class="computeroutput">first</code></span></p></td> |
| <td><p>The iterator that denotes the beginning of the sequence of request objects.</p></td> |
| </tr> |
| <tr> |
| <td><p><span class="term"><code class="computeroutput">last</code></span></p></td> |
| <td><p>The iterator that denotes the end of the sequence of request objects.</p></td> |
| </tr> |
| <tr> |
| <td><p><span class="term"><code class="computeroutput">out</code></span></p></td> |
| <td><p>If provided and all requests hav been completed, an output iterator through which the status of each request will be emitted. The <code class="computeroutput">status</code> objects are emitted in the same order as the requests are retrieved from <code class="computeroutput"></code>[first,last).</p></td> |
| </tr> |
| </tbody> |
| </table></div></td> |
| </tr> |
| <tr> |
| <td><p><span class="term">Returns:</span></p></td> |
| <td><p>If an <code class="computeroutput">out</code> parameter was provided, the value <code class="computeroutput">out</code> after all of the <code class="computeroutput">status</code> objects have been emitted (if all requests were completed) or an empty <code class="computeroutput">optional<></code>. If no <code class="computeroutput">out</code> parameter was provided, returns <code class="computeroutput">true</code> if all requests have completed or <code class="computeroutput">false</code> otherwise. </p></td> |
| </tr> |
| </tbody> |
| </table></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="wait_all.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../mpi/reference.html#header.boost.mpi.nonblocking_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="wait_some.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> |
| </div> |
| </body> |
| </html> |