1<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> 2<html> 3<head> 4<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 5<title>Function test_all</title> 6<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> 7<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> 8<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> 9<link rel="up" href="../../mpi/reference.html#header.boost.mpi.nonblocking_hpp" title="Header <boost/mpi/nonblocking.hpp>"> 10<link rel="prev" href="wait_all.html" title="Function wait_all"> 11<link rel="next" href="wait_some.html" title="Function wait_some"> 12</head> 13<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> 14<table cellpadding="2" width="100%"><tr> 15<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> 16<td align="center"><a href="../../../../index.html">Home</a></td> 17<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> 18<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> 19<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> 20<td align="center"><a href="../../../../more/index.htm">More</a></td> 21</tr></table> 22<hr> 23<div class="spirit-nav"> 24<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> 25</div> 26<div class="refentry"> 27<a name="boost.mpi.test_all"></a><div class="titlepage"></div> 28<div class="refnamediv"> 29<h2><span class="refentrytitle">Function test_all</span></h2> 30<p>boost::mpi::test_all — Tests whether all non-blocking requests have completed. </p> 31</div> 32<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> 33<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>> 34 35</span> 36<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> 37 <span class="identifier">optional</span><span class="special"><</span> <span class="identifier">OutputIterator</span> <span class="special">></span> 38 <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> 39<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> 40 <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> 41<div class="refsect1"> 42<a name="id-1.3.27.7.17.7.4"></a><h2>Description</h2> 43<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> 44<p> 45 46</p> 47<div class="variablelist"><table border="0" class="variablelist compact"> 48<colgroup> 49<col align="left" valign="top"> 50<col> 51</colgroup> 52<tbody> 53<tr> 54<td><p><span class="term">Parameters:</span></p></td> 55<td><div class="variablelist"><table border="0" class="variablelist compact"> 56<colgroup> 57<col align="left" valign="top"> 58<col> 59</colgroup> 60<tbody> 61<tr> 62<td><p><span class="term"><code class="computeroutput">first</code></span></p></td> 63<td><p>The iterator that denotes the beginning of the sequence of request objects.</p></td> 64</tr> 65<tr> 66<td><p><span class="term"><code class="computeroutput">last</code></span></p></td> 67<td><p>The iterator that denotes the end of the sequence of request objects.</p></td> 68</tr> 69<tr> 70<td><p><span class="term"><code class="computeroutput">out</code></span></p></td> 71<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> 72</tr> 73</tbody> 74</table></div></td> 75</tr> 76<tr> 77<td><p><span class="term">Returns:</span></p></td> 78<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> 79</tr> 80</tbody> 81</table></div> 82</div> 83</div> 84<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 85<td align="left"></td> 86<td align="right"><div class="copyright-footer">Copyright © 2005-2007 Douglas Gregor, 87 Matthias Troyer, Trustees of Indiana University<p> 88 Distributed under the Boost Software License, Version 1.0. (See accompanying 89 file LICENSE_1_0.txt or copy at <ulink url="http://www.boost.org/LICENSE_1_0.txt"> 90 http://www.boost.org/LICENSE_1_0.txt </ulink>) 91 </p> 92</div></td> 93</tr></table> 94<hr> 95<div class="spirit-nav"> 96<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> 97</div> 98</body> 99</html> 100
