• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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 template wait_any</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 &lt;boost/mpi/nonblocking.hpp&gt;">
10<link rel="prev" href="intercommunicator.html" title="Class intercommunicator">
11<link rel="next" href="test_any.html" title="Function template test_any">
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="intercommunicator.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_any.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
25</div>
26<div class="refentry">
27<a name="boost.mpi.wait_any"></a><div class="titlepage"></div>
28<div class="refnamediv">
29<h2><span class="refentrytitle">Function template wait_any</span></h2>
30<p>boost::mpi::wait_any — Wait until any non-blocking request has 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: &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;
34
35</span>
36<span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> <a class="link" href="../../ForwardIterator.html" title="Concept ForwardIterator">ForwardIterator</a><span class="special">&gt;</span>
37  <span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special">&lt;</span> <a class="link" href="status.html" title="Class status">status</a><span class="special">,</span> <span class="identifier">ForwardIterator</span> <span class="special">&gt;</span>
38  <span class="identifier">wait_any</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>
39<div class="refsect1">
40<a name="id-1.3.27.7.17.4.4"></a><h2>Description</h2>
41<p>This routine takes in a set of requests stored in the iterator range <code class="computeroutput"></code>[first,last) and waits until any of these requests has been completed. It provides functionality equivalent to <code class="computeroutput">MPI_Waitany</code>.</p>
42<p>
43
44</p>
45<div class="variablelist"><table border="0" class="variablelist compact">
46<colgroup>
47<col align="left" valign="top">
48<col>
49</colgroup>
50<tbody>
51<tr>
52<td><p><span class="term">Parameters:</span></p></td>
53<td><div class="variablelist"><table border="0" class="variablelist compact">
54<colgroup>
55<col align="left" valign="top">
56<col>
57</colgroup>
58<tbody>
59<tr>
60<td><p><span class="term"><code class="computeroutput">first</code></span></p></td>
61<td><p>The iterator that denotes the beginning of the sequence of request objects.</p></td>
62</tr>
63<tr>
64<td><p><span class="term"><code class="computeroutput">last</code></span></p></td>
65<td><p>The iterator that denotes the end of the sequence of request objects. This may not be equal to <code class="computeroutput">first</code>.</p></td>
66</tr>
67</tbody>
68</table></div></td>
69</tr>
70<tr>
71<td><p><span class="term">Returns:</span></p></td>
72<td><p>A pair containing the status object that corresponds to the completed operation and the iterator referencing the completed request. </p></td>
73</tr>
74</tbody>
75</table></div>
76</div>
77</div>
78<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
79<td align="left"></td>
80<td align="right"><div class="copyright-footer">Copyright © 2005-2007 Douglas Gregor,
81      Matthias Troyer, Trustees of Indiana University<p>
82        Distributed under the Boost Software License, Version 1.0. (See accompanying
83        file LICENSE_1_0.txt or copy at &lt;ulink url="http://www.boost.org/LICENSE_1_0.txt"&gt;
84        http://www.boost.org/LICENSE_1_0.txt &lt;/ulink&gt;)
85      </p>
86</div></td>
87</tr></table>
88<hr>
89<div class="spirit-nav">
90<a accesskey="p" href="intercommunicator.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_any.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
91</div>
92</body>
93</html>
94