doc/html/boost/mpi/wait_all.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Function wait_all</title>
   5 <link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
   7 <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
   8 <link rel="up" href="../../mpi/reference.html#header.boost.mpi.nonblocking_hpp" title="Header &lt;boost/mpi/nonblocking.hpp&gt;">
   9 <link rel="prev" href="test_any.html" title="Function template test_any">
  10 <link rel="next" href="test_all.html" title="Function test_all">
  11 </head>
  12 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  13 <table cellpadding="2" width="100%"><tr>
  14 <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td>
  15 <td align="center"><a href="../../../../index.html">Home</a></td>
  16 <td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
  17 <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
  18 <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
  19 <td align="center"><a href="../../../../more/index.htm">More</a></td>
  20 </tr></table>
  21 <hr>
  22 <div class="spirit-nav">
  23 <a accesskey="p" href="test_any.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="test_all.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="refentry">
  26 <a name="boost.mpi.wait_all"></a><div class="titlepage"></div>
  27 <div class="refnamediv">
  28 <h2><span class="refentrytitle">Function wait_all</span></h2>
  29 <p>boost::mpi::wait_all &#8212; Wait until all non-blocking requests have completed. </p>
  30 </div>
  31 <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
  32 <div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: &lt;<a class="link" href="../../mpi/reference.html#header.boost.mpi.nonblocking_hpp" title="Header &lt;boost/mpi/nonblocking.hpp&gt;">boost/mpi/nonblocking.hpp</a>&gt;
  33
  34 </span>
  35 <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> ForwardIterator<span class="special">,</span> <span class="keyword">typename</span> OutputIterator<span class="special">&gt;</span>
  36   <span class="identifier">OutputIterator</span>
  37   <span class="identifier">wait_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>
  38 <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> ForwardIterator<span class="special">&gt;</span>
  39   <span class="keyword">void</span> <span class="identifier">wait_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>
  40 <div class="refsect1">
  41 <a name="idp341004144"></a><h2>Description</h2>
  42 <p>This routine takes in a set of requests stored in the iterator range <code class="computeroutput"></code>[first,last) and waits until all of these requests have been completed. It provides functionality equivalent to <code class="computeroutput">MPI_Waitall</code>.</p>
  43 <p>
  44
  45 </p>
  46 <div class="variablelist"><table border="0" class="variablelist compact">
  47 <colgroup>
  48 <col align="left" valign="top">
  49 <col>
  50 </colgroup>
  51 <tbody>
  52 <tr>
  53 <td><p><span class="term">Parameters:</span></p></td>
  54 <td><div class="variablelist"><table border="0" class="variablelist compact">
  55 <colgroup>
  56 <col align="left" valign="top">
  57 <col>
  58 </colgroup>
  59 <tbody>
  60 <tr>
  61 <td><p><span class="term"><code class="computeroutput">first</code></span></p></td>
  62 <td><p>The iterator that denotes the beginning of the sequence of request objects.</p></td>
  63 </tr>
  64 <tr>
  65 <td><p><span class="term"><code class="computeroutput">last</code></span></p></td>
  66 <td><p>The iterator that denotes the end of the sequence of request objects.</p></td>
  67 </tr>
  68 <tr>
  69 <td><p><span class="term"><code class="computeroutput">out</code></span></p></td>
  70 <td><p>If provided, 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>
  71 </tr>
  72 </tbody>
  73 </table></div></td>
  74 </tr>
  75 <tr>
  76 <td><p><span class="term">Returns:</span></p></td>
  77 <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. </p></td>
  78 </tr>
  79 </tbody>
  80 </table></div>
  81 </div>
  82 </div>
  83 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  84 <td align="left"></td>
  85 <td align="right"><div class="copyright-footer">Copyright &#169; 2005-2007 Douglas Gregor,
  86       Matthias Troyer, Trustees of Indiana University<p>
  87         Distributed under the Boost Software License, Version 1.0. (See accompanying
  88         file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">
  89         http://www.boost.org/LICENSE_1_0.txt </a>)
  90       </p>
  91 </div></td>
  92 </tr></table>
  93 <hr>
  94 <div class="spirit-nav">
  95 <a accesskey="p" href="test_any.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="test_all.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
  96 </div>
  97 </body>
  98 </html>