doc/html/boost/mpi/communicator.html

   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=US-ASCII">
   5 <title>Class communicator</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.communicator_hpp" title="Header &lt;boost/mpi/communicator.hpp&gt;">
  10 <link rel="prev" href="scan.html" title="Function scan">
  11 <link rel="next" href="comm_create_kind.html" title="Type comm_create_kind">
  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="scan.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../mpi/reference.html#header.boost.mpi.communicator_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="comm_create_kind.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
  25 </div>
  26 <div class="refentry">
  27 <a name="boost.mpi.communicator"></a><div class="titlepage"></div>
  28 <div class="refnamediv">
  29 <h2><span class="refentrytitle">Class communicator</span></h2>
  30 <p>boost::mpi::communicator &#8212; A communicator that permits communication and synchronization among a set of processes. </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.communicator_hpp" title="Header &lt;boost/mpi/communicator.hpp&gt;">boost/mpi/communicator.hpp</a>&gt;
  34
  35 </span>
  36 <span class="keyword">class</span> <a class="link" href="communicator.html" title="Class communicator">communicator</a> <span class="special">{</span>
  37 <span class="keyword">public</span><span class="special">:</span>
  38   <span class="comment">// <a class="link" href="communicator.html#boost.mpi.communicatorconstruct-copy-destruct">construct/copy/destruct</a></span>
  39   <a class="link" href="communicator.html#id-1_3_27_7_6_2_1_1_4-bb"><span class="identifier">communicator</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  40   <a class="link" href="communicator.html#id-1_3_27_7_6_2_1_1_5-bb"><span class="identifier">communicator</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">MPI_Comm</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">comm_create_kind</span><span class="special">)</span><span class="special">;</span>
  41   <a class="link" href="communicator.html#id-1_3_27_7_6_2_1_1_6-bb"><span class="identifier">communicator</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="communicator.html" title="Class communicator">communicator</a> <span class="special">&amp;</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="group.html" title="Class group">boost::mpi::group</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  42
  43   <span class="comment">// <a class="link" href="communicator.html#id-1_3_27_7_6_2_1_1_3-bb">public member functions</a></span>
  44   <span class="keyword">int</span> <a class="link" href="communicator.html#id-1_3_27_7_6_2_1_1_3_1-bb"><span class="identifier">rank</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  45   <span class="keyword">int</span> <a class="link" href="communicator.html#id-1_3_27_7_6_2_1_1_3_2-bb"><span class="identifier">size</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  46   <a class="link" href="group.html" title="Class group">boost::mpi::group</a> <a class="link" href="communicator.html#id-1_3_27_7_6_2_1_1_3_3-bb"><span class="identifier">group</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  47   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">&gt;</span> <span class="keyword">void</span> <a class="link" href="communicator.html#id-1_3_27_7_6_2_1_1_3_4-bb"><span class="identifier">send</span></a><span class="special">(</span><span class="keyword">int</span><span class="special">,</span> <span class="keyword">int</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">T</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  48   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="keyword">typename</span> A<span class="special">&gt;</span>
  49     <span class="keyword">void</span> <a class="link" href="communicator.html#id-1_3_27_7_6_2_1_1_3_5-bb"><span class="identifier">send</span></a><span class="special">(</span><span class="keyword">int</span><span class="special">,</span> <span class="keyword">int</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special">&lt;</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">A</span> <span class="special">&gt;</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  50   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">&gt;</span> <span class="keyword">void</span> <a class="link" href="communicator.html#id-1_3_27_7_6_2_1_1_3_6-bb"><span class="identifier">send</span></a><span class="special">(</span><span class="keyword">int</span><span class="special">,</span> <span class="keyword">int</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="skeleton_proxy.html" title="Struct template skeleton_proxy">skeleton_proxy</a><span class="special">&lt;</span> <span class="identifier">T</span> <span class="special">&gt;</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  51   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">&gt;</span> <span class="keyword">void</span> <a class="link" href="communicator.html#id-1_3_27_7_6_2_1_1_3_7-bb"><span class="identifier">send</span></a><span class="special">(</span><span class="keyword">int</span><span class="special">,</span> <span class="keyword">int</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">T</span> <span class="special">*</span><span class="special">,</span> <span class="keyword">int</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  52   <span class="keyword">void</span> <a class="link" href="communicator.html#id-1_3_27_7_6_2_1_1_3_8-bb"><span class="identifier">send</span></a><span class="special">(</span><span class="keyword">int</span><span class="special">,</span> <span class="keyword">int</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  53   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">&gt;</span> <a class="link" href="status.html" title="Class status">status</a> <a class="link" href="communicator.html#id-1_3_27_7_6_2_1_1_3_9-bb"><span class="identifier">recv</span></a><span class="special">(</span><span class="keyword">int</span><span class="special">,</span> <span class="keyword">int</span><span class="special">,</span> <span class="identifier">T</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  54   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="keyword">typename</span> A<span class="special">&gt;</span>
  55     <a class="link" href="status.html" title="Class status">status</a> <a class="link" href="communicator.html#id-1_3_27_7_6_2_1_1_3_10-bb"><span class="identifier">recv</span></a><span class="special">(</span><span class="keyword">int</span><span class="special">,</span> <span class="keyword">int</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special">&lt;</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">A</span> <span class="special">&gt;</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  56   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">&gt;</span>
  57     <a class="link" href="status.html" title="Class status">status</a> <a class="link" href="communicator.html#id-1_3_27_7_6_2_1_1_3_11-bb"><span class="identifier">recv</span></a><span class="special">(</span><span class="keyword">int</span><span class="special">,</span> <span class="keyword">int</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="skeleton_proxy.html" title="Struct template skeleton_proxy">skeleton_proxy</a><span class="special">&lt;</span> <span class="identifier">T</span> <span class="special">&gt;</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  58   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">&gt;</span> <a class="link" href="status.html" title="Class status">status</a> <a class="link" href="communicator.html#id-1_3_27_7_6_2_1_1_3_12-bb"><span class="identifier">recv</span></a><span class="special">(</span><span class="keyword">int</span><span class="special">,</span> <span class="keyword">int</span><span class="special">,</span> <a class="link" href="skeleton_proxy.html" title="Struct template skeleton_proxy">skeleton_proxy</a><span class="special">&lt;</span> <span class="identifier">T</span> <span class="special">&gt;</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  59   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">&gt;</span> <a class="link" href="status.html" title="Class status">status</a> <a class="link" href="communicator.html#id-1_3_27_7_6_2_1_1_3_13-bb"><span class="identifier">recv</span></a><span class="special">(</span><span class="keyword">int</span><span class="special">,</span> <span class="keyword">int</span><span class="special">,</span> <span class="identifier">T</span> <span class="special">*</span><span class="special">,</span> <span class="keyword">int</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  60   <a class="link" href="status.html" title="Class status">status</a> <a class="link" href="communicator.html#id-1_3_27_7_6_2_1_1_3_14-bb"><span class="identifier">recv</span></a><span class="special">(</span><span class="keyword">int</span><span class="special">,</span> <span class="keyword">int</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  61   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">&gt;</span>
  62     <a class="link" href="status.html" title="Class status">status</a> <a class="link" href="communicator.html#id-1_3_27_7_6_2_1_1_3_15-bb"><span class="identifier">sendrecv</span></a><span class="special">(</span><span class="keyword">int</span><span class="special">,</span> <span class="keyword">int</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">T</span> <span class="special">&amp;</span><span class="special">,</span> <span class="keyword">int</span><span class="special">,</span> <span class="keyword">int</span><span class="special">,</span> <span class="identifier">T</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  63   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">&gt;</span> <a class="link" href="request.html" title="Class request">request</a> <a class="link" href="communicator.html#id-1_3_27_7_6_2_1_1_3_16-bb"><span class="identifier">isend</span></a><span class="special">(</span><span class="keyword">int</span><span class="special">,</span> <span class="keyword">int</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">T</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  64   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">&gt;</span>
  65     <a class="link" href="request.html" title="Class request">request</a> <a class="link" href="communicator.html#id-1_3_27_7_6_2_1_1_3_17-bb"><span class="identifier">isend</span></a><span class="special">(</span><span class="keyword">int</span><span class="special">,</span> <span class="keyword">int</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="skeleton_proxy.html" title="Struct template skeleton_proxy">skeleton_proxy</a><span class="special">&lt;</span> <span class="identifier">T</span> <span class="special">&gt;</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  66   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">&gt;</span> <a class="link" href="request.html" title="Class request">request</a> <a class="link" href="communicator.html#id-1_3_27_7_6_2_1_1_3_18-bb"><span class="identifier">isend</span></a><span class="special">(</span><span class="keyword">int</span><span class="special">,</span> <span class="keyword">int</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">T</span> <span class="special">*</span><span class="special">,</span> <span class="keyword">int</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  67   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="keyword">typename</span> A<span class="special">&gt;</span>
  68     <a class="link" href="request.html" title="Class request">request</a> <a class="link" href="communicator.html#id-1_3_27_7_6_2_1_1_3_19-bb"><span class="identifier">isend</span></a><span class="special">(</span><span class="keyword">int</span><span class="special">,</span> <span class="keyword">int</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special">&lt;</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">A</span> <span class="special">&gt;</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  69   <a class="link" href="request.html" title="Class request">request</a> <a class="link" href="communicator.html#id-1_3_27_7_6_2_1_1_3_20-bb"><span class="identifier">isend</span></a><span class="special">(</span><span class="keyword">int</span><span class="special">,</span> <span class="keyword">int</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  70   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">&gt;</span> <a class="link" href="request.html" title="Class request">request</a> <a class="link" href="communicator.html#id-1_3_27_7_6_2_1_1_3_21-bb"><span class="identifier">irecv</span></a><span class="special">(</span><span class="keyword">int</span><span class="special">,</span> <span class="keyword">int</span><span class="special">,</span> <span class="identifier">T</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  71   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">&gt;</span> <a class="link" href="request.html" title="Class request">request</a> <a class="link" href="communicator.html#id-1_3_27_7_6_2_1_1_3_22-bb"><span class="identifier">irecv</span></a><span class="special">(</span><span class="keyword">int</span><span class="special">,</span> <span class="keyword">int</span><span class="special">,</span> <span class="identifier">T</span> <span class="special">*</span><span class="special">,</span> <span class="keyword">int</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  72   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="keyword">typename</span> A<span class="special">&gt;</span>
  73     <a class="link" href="request.html" title="Class request">request</a> <a class="link" href="communicator.html#id-1_3_27_7_6_2_1_1_3_23-bb"><span class="identifier">irecv</span></a><span class="special">(</span><span class="keyword">int</span><span class="special">,</span> <span class="keyword">int</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special">&lt;</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">A</span> <span class="special">&gt;</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  74   <a class="link" href="request.html" title="Class request">request</a> <a class="link" href="communicator.html#id-1_3_27_7_6_2_1_1_3_24-bb"><span class="identifier">irecv</span></a><span class="special">(</span><span class="keyword">int</span><span class="special">,</span> <span class="keyword">int</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  75   <a class="link" href="status.html" title="Class status">status</a> <a class="link" href="communicator.html#id-1_3_27_7_6_2_1_1_3_25-bb"><span class="identifier">probe</span></a><span class="special">(</span><span class="keyword">int</span> <span class="special">=</span> <span class="identifier">any_source</span><span class="special">,</span> <span class="keyword">int</span> <span class="special">=</span> <span class="identifier">any_tag</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  76   <span class="identifier">optional</span><span class="special">&lt;</span> <a class="link" href="status.html" title="Class status">status</a> <span class="special">&gt;</span> <a class="link" href="communicator.html#id-1_3_27_7_6_2_1_1_3_26-bb"><span class="identifier">iprobe</span></a><span class="special">(</span><span class="keyword">int</span> <span class="special">=</span> <span class="identifier">any_source</span><span class="special">,</span> <span class="keyword">int</span> <span class="special">=</span> <span class="identifier">any_tag</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  77   <span class="keyword">void</span> <a class="link" href="communicator.html#id-1_3_27_7_6_2_1_1_3_27-bb"><span class="identifier">barrier</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  78   <a class="link" href="communicator.html#id-1_3_27_7_6_2_1_1_3_28-bb"><span class="keyword">operator</span> <span class="keyword">bool</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  79   <a class="link" href="communicator.html#id-1_3_27_7_6_2_1_1_3_29-bb"><span class="keyword">operator</span> <span class="identifier">MPI_Comm</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  80   <a class="link" href="communicator.html" title="Class communicator">communicator</a> <a class="link" href="communicator.html#id-1_3_27_7_6_2_1_1_3_30-bb"><span class="identifier">split</span></a><span class="special">(</span><span class="keyword">int</span><span class="special">,</span> <span class="keyword">int</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  81   <a class="link" href="communicator.html" title="Class communicator">communicator</a> <a class="link" href="communicator.html#id-1_3_27_7_6_2_1_1_3_31-bb"><span class="identifier">split</span></a><span class="special">(</span><span class="keyword">int</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  82   <span class="identifier">optional</span><span class="special">&lt;</span> <a class="link" href="intercommunicator.html" title="Class intercommunicator">intercommunicator</a> <span class="special">&gt;</span> <a class="link" href="communicator.html#id-1_3_27_7_6_2_1_1_3_32-bb"><span class="identifier">as_intercommunicator</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  83   <span class="identifier">optional</span><span class="special">&lt;</span> <a class="link" href="graph_communicator.html" title="Class graph_communicator">graph_communicator</a> <span class="special">&gt;</span> <a class="link" href="communicator.html#id-1_3_27_7_6_2_1_1_3_33-bb"><span class="identifier">as_graph_communicator</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  84   <span class="keyword">bool</span> <a class="link" href="communicator.html#id-1_3_27_7_6_2_1_1_3_34-bb"><span class="identifier">has_graph_topology</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  85   <span class="identifier">optional</span><span class="special">&lt;</span> <a class="link" href="cartesian_communicator.html" title="Class cartesian_communicator">cartesian_communicator</a> <span class="special">&gt;</span> <a class="link" href="communicator.html#id-1_3_27_7_6_2_1_1_3_35-bb"><span class="identifier">as_cartesian_communicator</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  86   <span class="keyword">bool</span> <a class="link" href="communicator.html#id-1_3_27_7_6_2_1_1_3_36-bb"><span class="identifier">has_cartesian_topology</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  87   <span class="keyword">void</span> <a class="link" href="communicator.html#id-1_3_27_7_6_2_1_1_3_37-bb"><span class="identifier">abort</span></a><span class="special">(</span><span class="keyword">int</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  88
  89   <span class="comment">// <a class="link" href="communicator.html#id-1_3_27_7_6_2_1_1_7-bb">protected member functions</a></span>
  90   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="keyword">typename</span> A<span class="special">&gt;</span>
  91     <a class="link" href="request.html" title="Class request">request</a> <a class="link" href="communicator.html#id-1_3_27_7_6_2_1_1_7_1-bb"><span class="identifier">irecv_vector</span></a><span class="special">(</span><span class="keyword">int</span><span class="special">,</span> <span class="keyword">int</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special">&lt;</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">A</span> <span class="special">&gt;</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">mpl</span><span class="special">::</span><span class="identifier">true_</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  92   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="keyword">typename</span> A<span class="special">&gt;</span>
  93     <a class="link" href="request.html" title="Class request">request</a> <a class="link" href="communicator.html#id-1_3_27_7_6_2_1_1_7_2-bb"><span class="identifier">isend_vector</span></a><span class="special">(</span><span class="keyword">int</span><span class="special">,</span> <span class="keyword">int</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special">&lt;</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">A</span> <span class="special">&gt;</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">mpl</span><span class="special">::</span><span class="identifier">true_</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  94   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="keyword">typename</span> A<span class="special">&gt;</span>
  95     <span class="keyword">void</span> <a class="link" href="communicator.html#id-1_3_27_7_6_2_1_1_7_3-bb"><span class="identifier">send_vector</span></a><span class="special">(</span><span class="keyword">int</span><span class="special">,</span> <span class="keyword">int</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special">&lt;</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">A</span> <span class="special">&gt;</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">mpl</span><span class="special">::</span><span class="identifier">true_</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  96   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="keyword">typename</span> A<span class="special">&gt;</span>
  97     <a class="link" href="status.html" title="Class status">status</a> <a class="link" href="communicator.html#id-1_3_27_7_6_2_1_1_7_4-bb"><span class="identifier">recv_vector</span></a><span class="special">(</span><span class="keyword">int</span><span class="special">,</span> <span class="keyword">int</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special">&lt;</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">A</span> <span class="special">&gt;</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">mpl</span><span class="special">::</span><span class="identifier">true_</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  98   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="keyword">typename</span> A<span class="special">&gt;</span>
  99     <a class="link" href="request.html" title="Class request">request</a> <a class="link" href="communicator.html#id-1_3_27_7_6_2_1_1_7_5-bb"><span class="identifier">irecv_vector</span></a><span class="special">(</span><span class="keyword">int</span><span class="special">,</span> <span class="keyword">int</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special">&lt;</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">A</span> <span class="special">&gt;</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">mpl</span><span class="special">::</span><span class="identifier">false_</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
 100   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="keyword">typename</span> A<span class="special">&gt;</span>
 101     <a class="link" href="request.html" title="Class request">request</a> <a class="link" href="communicator.html#id-1_3_27_7_6_2_1_1_7_6-bb"><span class="identifier">isend_vector</span></a><span class="special">(</span><span class="keyword">int</span><span class="special">,</span> <span class="keyword">int</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special">&lt;</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">A</span> <span class="special">&gt;</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">mpl</span><span class="special">::</span><span class="identifier">false_</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
 102   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="keyword">typename</span> A<span class="special">&gt;</span>
 103     <span class="keyword">void</span> <a class="link" href="communicator.html#id-1_3_27_7_6_2_1_1_7_7-bb"><span class="identifier">send_vector</span></a><span class="special">(</span><span class="keyword">int</span><span class="special">,</span> <span class="keyword">int</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special">&lt;</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">A</span> <span class="special">&gt;</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">mpl</span><span class="special">::</span><span class="identifier">false_</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
 104   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="keyword">typename</span> A<span class="special">&gt;</span>
 105     <a class="link" href="status.html" title="Class status">status</a> <a class="link" href="communicator.html#id-1_3_27_7_6_2_1_1_7_8-bb"><span class="identifier">recv_vector</span></a><span class="special">(</span><span class="keyword">int</span><span class="special">,</span> <span class="keyword">int</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special">&lt;</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">A</span> <span class="special">&gt;</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">mpl</span><span class="special">::</span><span class="identifier">false_</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
 106 <span class="special">}</span><span class="special">;</span></pre></div>
 107 <div class="refsect1">
 108 <a name="id-1.3.27.7.7.4.4"></a><h2>Description</h2>
 109 <p>The <code class="computeroutput">communicator</code> class abstracts a set of communicating processes in MPI. All of the processes that belong to a certain communicator can determine the size of the communicator, their rank within the communicator, and communicate with any other processes in the communicator. </p>
 110 <div class="refsect2">
 111 <a name="id-1.3.27.7.7.4.4.3"></a><h3>
 112 <a name="boost.mpi.communicatorconstruct-copy-destruct"></a><code class="computeroutput">communicator</code>
 113         public
 114        construct/copy/destruct</h3>
 115 <div class="orderedlist"><ol class="orderedlist" type="1">
 116 <li class="listitem">
 117 <pre class="literallayout"><a name="id-1_3_27_7_6_2_1_1_4-bb"></a><span class="identifier">communicator</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
 118 <p>Build a new Boost.MPI communicator for <code class="computeroutput">MPI_COMM_WORLD</code>.</p>
 119 <p>Constructs a Boost.MPI communicator that attaches to <code class="computeroutput">MPI_COMM_WORLD</code>. This is the equivalent of constructing with <code class="computeroutput"></code>(MPI_COMM_WORLD, comm_attach). </p>
 120 </li>
 121 <li class="listitem">
 122 <pre class="literallayout"><a name="id-1_3_27_7_6_2_1_1_5-bb"></a><span class="identifier">communicator</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">MPI_Comm</span> <span class="special">&amp;</span> comm<span class="special">,</span> <span class="identifier">comm_create_kind</span> kind<span class="special">)</span><span class="special">;</span></pre>
 123 <p>Build a new Boost.MPI communicator based on the MPI communicator <code class="computeroutput">comm</code>.</p>
 124 <p><code class="computeroutput">comm</code> may be any valid MPI communicator. If <code class="computeroutput">comm</code> is MPI_COMM_NULL, an empty communicator (that cannot be used for communication) is created and the <code class="computeroutput">kind</code> parameter is ignored. Otherwise, the <code class="computeroutput">kind</code> parameters determines how the Boost.MPI communicator will be related to <code class="computeroutput">comm:</code> </p>
 125 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
 126 <li class="listitem"><p>If <code class="computeroutput">kind</code> is <code class="computeroutput">comm_duplicate</code>, duplicate <code class="computeroutput">comm</code> to create a new communicator. This new communicator will be freed when the Boost.MPI communicator (and all copies of it) is destroyed. This option is only permitted if <code class="computeroutput">comm</code> is a valid MPI intracommunicator or if the underlying MPI implementation supports MPI 2.0 (which supports duplication of intercommunicators).</p></li>
 127 <li class="listitem"><p>If <code class="computeroutput">kind</code> is <code class="computeroutput">comm_take_ownership</code>, take ownership of <code class="computeroutput">comm</code>. It will be freed automatically when all of the Boost.MPI communicators go out of scope. This option must not be used when <code class="computeroutput">comm</code> is MPI_COMM_WORLD.</p></li>
 128 <li class="listitem"><p>If <code class="computeroutput">kind</code> is <code class="computeroutput">comm_attach</code>, this Boost.MPI communicator will reference the existing MPI communicator <code class="computeroutput">comm</code> but will not free <code class="computeroutput">comm</code> when the Boost.MPI communicator goes out of scope. This option should only be used when the communicator is managed by the user or MPI library (e.g., MPI_COMM_WORLD). </p></li>
 129 </ul></div>
 130 <p>
 131 </p>
 132 </li>
 133 <li class="listitem">
 134 <pre class="literallayout"><a name="id-1_3_27_7_6_2_1_1_6-bb"></a><span class="identifier">communicator</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="communicator.html" title="Class communicator">communicator</a> <span class="special">&amp;</span> comm<span class="special">,</span> <span class="keyword">const</span> <a class="link" href="group.html" title="Class group">boost::mpi::group</a> <span class="special">&amp;</span> subgroup<span class="special">)</span><span class="special">;</span></pre>
 135 <p>Build a new Boost.MPI communicator based on a subgroup of another MPI communicator.</p>
 136 <p>This routine will construct a new communicator containing all of the processes from communicator <code class="computeroutput">comm</code> that are listed within the group <code class="computeroutput">subgroup</code>. Equivalent to <code class="computeroutput">MPI_Comm_create</code>.</p>
 137 <p>
 138 </p>
 139 <div class="variablelist"><table border="0" class="variablelist compact">
 140 <colgroup>
 141 <col align="left" valign="top">
 142 <col>
 143 </colgroup>
 144 <tbody><tr>
 145 <td><p><span class="term">Parameters:</span></p></td>
 146 <td><div class="variablelist"><table border="0" class="variablelist compact">
 147 <colgroup>
 148 <col align="left" valign="top">
 149 <col>
 150 </colgroup>
 151 <tbody>
 152 <tr>
 153 <td><p><span class="term"><code class="computeroutput">comm</code></span></p></td>
 154 <td><p>An MPI communicator.</p></td>
 155 </tr>
 156 <tr>
 157 <td><p><span class="term"><code class="computeroutput">subgroup</code></span></p></td>
 158 <td><p>A subgroup of the MPI communicator, <code class="computeroutput">comm</code>, for which we will construct a new communicator. </p></td>
 159 </tr>
 160 </tbody>
 161 </table></div></td>
 162 </tr></tbody>
 163 </table></div>
 164 </li>
 165 </ol></div>
 166 </div>
 167 <div class="refsect2">
 168 <a name="id-1.3.27.7.7.4.4.4"></a><h3>
 169 <a name="id-1_3_27_7_6_2_1_1_3-bb"></a><code class="computeroutput">communicator</code> public member functions</h3>
 170 <div class="orderedlist"><ol class="orderedlist" type="1">
 171 <li class="listitem">
 172 <pre class="literallayout"><span class="keyword">int</span> <a name="id-1_3_27_7_6_2_1_1_3_1-bb"></a><span class="identifier">rank</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Determine the rank of the executing process in a communicator. <p>This routine is equivalent to <code class="computeroutput">MPI_Comm_rank</code>.</p>
 173 <p>
 174 </p>
 175 <div class="variablelist"><table border="0" class="variablelist compact">
 176 <colgroup>
 177 <col align="left" valign="top">
 178 <col>
 179 </colgroup>
 180 <tbody><tr>
 181 <td><p><span class="term">Returns:</span></p></td>
 182 <td><p>The rank of the process in the communicator, which will be a value in [0, size()) </p></td>
 183 </tr></tbody>
 184 </table></div>
 185 </li>
 186 <li class="listitem">
 187 <pre class="literallayout"><span class="keyword">int</span> <a name="id-1_3_27_7_6_2_1_1_3_2-bb"></a><span class="identifier">size</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Determine the number of processes in a communicator. <p>This routine is equivalent to <code class="computeroutput">MPI_Comm_size</code>.</p>
 188 <p>
 189 </p>
 190 <div class="variablelist"><table border="0" class="variablelist compact">
 191 <colgroup>
 192 <col align="left" valign="top">
 193 <col>
 194 </colgroup>
 195 <tbody><tr>
 196 <td><p><span class="term">Returns:</span></p></td>
 197 <td><p>The number of processes in the communicator. </p></td>
 198 </tr></tbody>
 199 </table></div>
 200 </li>
 201 <li class="listitem">
 202 <pre class="literallayout"><a class="link" href="group.html" title="Class group">boost::mpi::group</a> <a name="id-1_3_27_7_6_2_1_1_3_3-bb"></a><span class="identifier">group</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
 203 <p>This routine constructs a new group whose members are the processes within this communicator. Equivalent to calling <code class="computeroutput">MPI_Comm_group</code>. </p>
 204 </li>
 205 <li class="listitem">
 206 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">&gt;</span> <span class="keyword">void</span> <a name="id-1_3_27_7_6_2_1_1_3_4-bb"></a><span class="identifier">send</span><span class="special">(</span><span class="keyword">int</span> dest<span class="special">,</span> <span class="keyword">int</span> tag<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">T</span> <span class="special">&amp;</span> value<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Send data to another process. <p>This routine executes a potentially blocking send with tag <code class="computeroutput">tag</code> to the process with rank <code class="computeroutput">dest</code>. It can be received by the destination process with a matching <code class="computeroutput">recv</code> call.</p>
 207 <p>The given <code class="computeroutput">value</code> must be suitable for transmission over MPI. There are several classes of types that meet these requirements:</p>
 208 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
 209 <li class="listitem"><p>Types with mappings to MPI data types: If <code class="computeroutput">is_mpi_datatype&lt;T&gt;</code> is convertible to <code class="computeroutput">mpl::true_</code>, then <code class="computeroutput">value</code> will be transmitted using the MPI data type <code class="computeroutput">get_mpi_datatype&lt;T&gt;()</code>. All primitive C++ data types that have MPI equivalents, e.g., <code class="computeroutput">int</code>, <code class="computeroutput">float</code>, <code class="computeroutput">char</code>, <code class="computeroutput">double</code>, etc., have built-in mappings to MPI data types. You may turn a Serializable type with fixed structure into an MPI data type by specializing <code class="computeroutput"><code class="computeroutput"><a class="link" href="is_mpi_datatype.html" title="Struct template is_mpi_datatype">is_mpi_datatype</a></code></code> for your type.</p></li>
 210 <li class="listitem"><p>Serializable types: Any type that provides the <code class="computeroutput">serialize()</code> functionality required by the Boost.Serialization library can be transmitted and received.</p></li>
 211 <li class="listitem"><p>Packed archives and skeletons: Data that has been packed into an <code class="computeroutput"><code class="computeroutput"><a class="link" href="packed_oarchive.html" title="Class packed_oarchive">mpi::packed_oarchive</a></code></code> or the skeletons of data that have been backed into an <code class="computeroutput">mpi::packed_skeleton_oarchive</code> can be transmitted, but will be received as <code class="computeroutput"><code class="computeroutput"><a class="link" href="packed_iarchive.html" title="Class packed_iarchive">mpi::packed_iarchive</a></code></code> and <code class="computeroutput">mpi::packed_skeleton_iarchive</code>, respectively, to allow the values (or skeletons) to be extracted by the destination process.</p></li>
 212 <li class="listitem"><p>Content: Content associated with a previously-transmitted skeleton can be transmitted by <code class="computeroutput">send</code> and received by <code class="computeroutput">recv</code>. The receiving process may only receive content into the content of a value that has been constructed with the matching skeleton.</p></li>
 213 </ul></div>
 214 <p>
 215 </p>
 216 <p>For types that have mappings to an MPI data type (including the concent of a type), an invocation of this routine will result in a single MPI_Send call. For variable-length data, e.g., serialized types and packed archives, two messages will be sent via MPI_Send: one containing the length of the data and the second containing the data itself.</p>
 217 <p>Std::vectors of MPI data type are considered variable size, e.g. their number of elements is unknown and must be transmited (although the serialization process is skipped). You can use the array specialized versions of communication methods is both sender and receiver know the vector size.</p>
 218 <p>Note that the transmission mode for variable-length data is an implementation detail that is subject to change.</p>
 219 <p>
 220 </p>
 221 <div class="variablelist"><table border="0" class="variablelist compact">
 222 <colgroup>
 223 <col align="left" valign="top">
 224 <col>
 225 </colgroup>
 226 <tbody><tr>
 227 <td><p><span class="term">Parameters:</span></p></td>
 228 <td><div class="variablelist"><table border="0" class="variablelist compact">
 229 <colgroup>
 230 <col align="left" valign="top">
 231 <col>
 232 </colgroup>
 233 <tbody>
 234 <tr>
 235 <td><p><span class="term"><code class="computeroutput">dest</code></span></p></td>
 236 <td><p>The rank of the remote process to which the data will be sent.</p></td>
 237 </tr>
 238 <tr>
 239 <td><p><span class="term"><code class="computeroutput">tag</code></span></p></td>
 240 <td><p>The tag that will be associated with this message. Tags may be any integer between zero and an implementation-defined upper limit. This limit is accessible via <code class="computeroutput">environment::max_tag()</code>.</p></td>
 241 </tr>
 242 <tr>
 243 <td><p><span class="term"><code class="computeroutput">value</code></span></p></td>
 244 <td><p>The value that will be transmitted to the receiver. The type <code class="computeroutput">T</code> of this value must meet the aforementioned criteria for transmission. </p></td>
 245 </tr>
 246 </tbody>
 247 </table></div></td>
 248 </tr></tbody>
 249 </table></div>
 250 </li>
 251 <li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="keyword">typename</span> A<span class="special">&gt;</span>
 252   <span class="keyword">void</span> <a name="id-1_3_27_7_6_2_1_1_3_5-bb"></a><span class="identifier">send</span><span class="special">(</span><span class="keyword">int</span> dest<span class="special">,</span> <span class="keyword">int</span> tag<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special">&lt;</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">A</span> <span class="special">&gt;</span> <span class="special">&amp;</span> value<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
 253 <li class="listitem">
 254 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">&gt;</span>
 255   <span class="keyword">void</span> <a name="id-1_3_27_7_6_2_1_1_3_6-bb"></a><span class="identifier">send</span><span class="special">(</span><span class="keyword">int</span> dest<span class="special">,</span> <span class="keyword">int</span> tag<span class="special">,</span> <span class="keyword">const</span> <a class="link" href="skeleton_proxy.html" title="Struct template skeleton_proxy">skeleton_proxy</a><span class="special">&lt;</span> <span class="identifier">T</span> <span class="special">&gt;</span> <span class="special">&amp;</span> proxy<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Send the skeleton of an object. <p>This routine executes a potentially blocking send with tag <code class="computeroutput">tag</code> to the process with rank <code class="computeroutput">dest</code>. It can be received by the destination process with a matching <code class="computeroutput">recv</code> call. This variation on <code class="computeroutput">send</code> will be used when a send of a skeleton is explicitly requested via code such as:</p>
 256 <pre class="programlisting"><span class="identifier">comm</span><span class="special">.</span><span class="identifier">send</span><span class="special">(</span><span class="identifier">dest</span><span class="special">,</span> <span class="identifier">tag</span><span class="special">,</span> <span class="identifier">skeleton</span><span class="special">(</span><span class="identifier">object</span><span class="special">)</span><span class="special">)</span><span class="special">;</span>
 257 </pre>
 258 <p>The semantics of this routine are equivalent to that of sending a <code class="computeroutput">packed_skeleton_oarchive</code> storing the skeleton of the <code class="computeroutput">object</code>.</p>
 259 <p>
 260 </p>
 261 <div class="variablelist"><table border="0" class="variablelist compact">
 262 <colgroup>
 263 <col align="left" valign="top">
 264 <col>
 265 </colgroup>
 266 <tbody><tr>
 267 <td><p><span class="term">Parameters:</span></p></td>
 268 <td><div class="variablelist"><table border="0" class="variablelist compact">
 269 <colgroup>
 270 <col align="left" valign="top">
 271 <col>
 272 </colgroup>
 273 <tbody>
 274 <tr>
 275 <td><p><span class="term"><code class="computeroutput">dest</code></span></p></td>
 276 <td><p>The rank of the remote process to which the skeleton will be sent.</p></td>
 277 </tr>
 278 <tr>
 279 <td><p><span class="term"><code class="computeroutput">proxy</code></span></p></td>
 280 <td><p>The <code class="computeroutput"><code class="computeroutput"><a class="link" href="skeleton_proxy.html" title="Struct template skeleton_proxy">skeleton_proxy</a></code></code> containing a reference to the object whose skeleton will be transmitted. </p></td>
 281 </tr>
 282 <tr>
 283 <td><p><span class="term"><code class="computeroutput">tag</code></span></p></td>
 284 <td><p>The tag that will be associated with this message. Tags may be any integer between zero and an implementation-defined upper limit. This limit is accessible via <code class="computeroutput">environment::max_tag()</code>.</p></td>
 285 </tr>
 286 </tbody>
 287 </table></div></td>
 288 </tr></tbody>
 289 </table></div>
 290 </li>
 291 <li class="listitem">
 292 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">&gt;</span>
 293   <span class="keyword">void</span> <a name="id-1_3_27_7_6_2_1_1_3_7-bb"></a><span class="identifier">send</span><span class="special">(</span><span class="keyword">int</span> dest<span class="special">,</span> <span class="keyword">int</span> tag<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">T</span> <span class="special">*</span> values<span class="special">,</span> <span class="keyword">int</span> n<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Send an array of values to another process. <p>This routine executes a potentially blocking send of an array of data with tag <code class="computeroutput">tag</code> to the process with rank <code class="computeroutput">dest</code>. It can be received by the destination process with a matching array <code class="computeroutput">recv</code> call.</p>
 294 <p>If <code class="computeroutput">T</code> is an MPI datatype, an invocation of this routine will be mapped to a single call to MPI_Send, using the datatype <code class="computeroutput">get_mpi_datatype&lt;T&gt;()</code>.</p>
 295 <p>
 296 </p>
 297 <div class="variablelist"><table border="0" class="variablelist compact">
 298 <colgroup>
 299 <col align="left" valign="top">
 300 <col>
 301 </colgroup>
 302 <tbody><tr>
 303 <td><p><span class="term">Parameters:</span></p></td>
 304 <td><div class="variablelist"><table border="0" class="variablelist compact">
 305 <colgroup>
 306 <col align="left" valign="top">
 307 <col>
 308 </colgroup>
 309 <tbody>
 310 <tr>
 311 <td><p><span class="term"><code class="computeroutput">dest</code></span></p></td>
 312 <td><p>The process rank of the remote process to which the data will be sent.</p></td>
 313 </tr>
 314 <tr>
 315 <td><p><span class="term"><code class="computeroutput">n</code></span></p></td>
 316 <td><p>The number of values stored in the array. The destination process must call receive with at least this many elements to correctly receive the message. </p></td>
 317 </tr>
 318 <tr>
 319 <td><p><span class="term"><code class="computeroutput">tag</code></span></p></td>
 320 <td><p>The tag that will be associated with this message. Tags may be any integer between zero and an implementation-defined upper limit. This limit is accessible via <code class="computeroutput">environment::max_tag()</code>.</p></td>
 321 </tr>
 322 <tr>
 323 <td><p><span class="term"><code class="computeroutput">values</code></span></p></td>
 324 <td><p>The array of values that will be transmitted to the receiver. The type <code class="computeroutput">T</code> of these values must be mapped to an MPI data type.</p></td>
 325 </tr>
 326 </tbody>
 327 </table></div></td>
 328 </tr></tbody>
 329 </table></div>
 330 </li>
 331 <li class="listitem">
 332 <pre class="literallayout"><span class="keyword">void</span> <a name="id-1_3_27_7_6_2_1_1_3_8-bb"></a><span class="identifier">send</span><span class="special">(</span><span class="keyword">int</span> dest<span class="special">,</span> <span class="keyword">int</span> tag<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Send a message to another process without any data. <p>This routine executes a potentially blocking send of a message to another process. The message contains no extra data, and can therefore only be received by a matching call to <code class="computeroutput">recv()</code>.</p>
 333 <p>
 334 </p>
 335 <div class="variablelist"><table border="0" class="variablelist compact">
 336 <colgroup>
 337 <col align="left" valign="top">
 338 <col>
 339 </colgroup>
 340 <tbody><tr>
 341 <td><p><span class="term">Parameters:</span></p></td>
 342 <td><div class="variablelist"><table border="0" class="variablelist compact">
 343 <colgroup>
 344 <col align="left" valign="top">
 345 <col>
 346 </colgroup>
 347 <tbody>
 348 <tr>
 349 <td><p><span class="term"><code class="computeroutput">dest</code></span></p></td>
 350 <td><p>The process rank of the remote process to which the message will be sent.</p></td>
 351 </tr>
 352 <tr>
 353 <td><p><span class="term"><code class="computeroutput">tag</code></span></p></td>
 354 <td><p>The tag that will be associated with this message. Tags may be any integer between zero and an implementation-defined upper limit. This limit is accessible via <code class="computeroutput">environment::max_tag()</code>. </p></td>
 355 </tr>
 356 </tbody>
 357 </table></div></td>
 358 </tr></tbody>
 359 </table></div>
 360 </li>
 361 <li class="listitem">
 362 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">&gt;</span> <a class="link" href="status.html" title="Class status">status</a> <a name="id-1_3_27_7_6_2_1_1_3_9-bb"></a><span class="identifier">recv</span><span class="special">(</span><span class="keyword">int</span> source<span class="special">,</span> <span class="keyword">int</span> tag<span class="special">,</span> <span class="identifier">T</span> <span class="special">&amp;</span> value<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Receive data from a remote process. <p>This routine blocks until it receives a message from the process <code class="computeroutput">source</code> with the given <code class="computeroutput">tag</code>. The type <code class="computeroutput">T</code> of the <code class="computeroutput">value</code> must be suitable for transmission over MPI, which includes serializable types, types that can be mapped to MPI data types (including most built-in C++ types), packed MPI archives, skeletons, and content associated with skeletons; see the documentation of <code class="computeroutput">send</code> for a complete description.</p>
 363 <p>
 364
 365 </p>
 366 <div class="variablelist"><table border="0" class="variablelist compact">
 367 <colgroup>
 368 <col align="left" valign="top">
 369 <col>
 370 </colgroup>
 371 <tbody>
 372 <tr>
 373 <td><p><span class="term">Parameters:</span></p></td>
 374 <td><div class="variablelist"><table border="0" class="variablelist compact">
 375 <colgroup>
 376 <col align="left" valign="top">
 377 <col>
 378 </colgroup>
 379 <tbody>
 380 <tr>
 381 <td><p><span class="term"><code class="computeroutput">source</code></span></p></td>
 382 <td><p>The process that will be sending data. This will either be a process rank within the communicator or the constant <code class="computeroutput">any_source</code>, indicating that we can receive the message from any process.</p></td>
 383 </tr>
 384 <tr>
 385 <td><p><span class="term"><code class="computeroutput">tag</code></span></p></td>
 386 <td><p>The tag that matches a particular kind of message sent by the source process. This may be any tag value permitted by <code class="computeroutput">send</code>. Alternatively, the argument may be the constant <code class="computeroutput">any_tag</code>, indicating that this receive matches a message with any tag.</p></td>
 387 </tr>
 388 <tr>
 389 <td><p><span class="term"><code class="computeroutput">value</code></span></p></td>
 390 <td><p>Will contain the value of the message after a successful receive. The type of this value must match the value transmitted by the sender, unless the sender transmitted a packed archive or skeleton: in these cases, the sender transmits a <code class="computeroutput"><code class="computeroutput"><a class="link" href="packed_oarchive.html" title="Class packed_oarchive">packed_oarchive</a></code></code> or <code class="computeroutput">packed_skeleton_oarchive</code> and the destination receives a <code class="computeroutput"><code class="computeroutput"><a class="link" href="packed_iarchive.html" title="Class packed_iarchive">packed_iarchive</a></code></code> or <code class="computeroutput">packed_skeleton_iarchive</code>, respectively.</p></td>
 391 </tr>
 392 </tbody>
 393 </table></div></td>
 394 </tr>
 395 <tr>
 396 <td><p><span class="term">Returns:</span></p></td>
 397 <td><p>Information about the received message. </p></td>
 398 </tr>
 399 </tbody>
 400 </table></div>
 401 </li>
 402 <li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="keyword">typename</span> A<span class="special">&gt;</span>
 403   <a class="link" href="status.html" title="Class status">status</a> <a name="id-1_3_27_7_6_2_1_1_3_10-bb"></a><span class="identifier">recv</span><span class="special">(</span><span class="keyword">int</span> source<span class="special">,</span> <span class="keyword">int</span> tag<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special">&lt;</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">A</span> <span class="special">&gt;</span> <span class="special">&amp;</span> value<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
 404 <li class="listitem">
 405 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">&gt;</span>
 406   <a class="link" href="status.html" title="Class status">status</a> <a name="id-1_3_27_7_6_2_1_1_3_11-bb"></a><span class="identifier">recv</span><span class="special">(</span><span class="keyword">int</span> source<span class="special">,</span> <span class="keyword">int</span> tag<span class="special">,</span> <span class="keyword">const</span> <a class="link" href="skeleton_proxy.html" title="Struct template skeleton_proxy">skeleton_proxy</a><span class="special">&lt;</span> <span class="identifier">T</span> <span class="special">&gt;</span> <span class="special">&amp;</span> proxy<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Receive a skeleton from a remote process. <p>This routine blocks until it receives a message from the process <code class="computeroutput">source</code> with the given <code class="computeroutput">tag</code> containing a skeleton.</p>
 407 <p>
 408
 409 </p>
 410 <div class="variablelist"><table border="0" class="variablelist compact">
 411 <colgroup>
 412 <col align="left" valign="top">
 413 <col>
 414 </colgroup>
 415 <tbody>
 416 <tr>
 417 <td><p><span class="term">Parameters:</span></p></td>
 418 <td><div class="variablelist"><table border="0" class="variablelist compact">
 419 <colgroup>
 420 <col align="left" valign="top">
 421 <col>
 422 </colgroup>
 423 <tbody>
 424 <tr>
 425 <td><p><span class="term"><code class="computeroutput">proxy</code></span></p></td>
 426 <td><p>The <code class="computeroutput"><code class="computeroutput"><a class="link" href="skeleton_proxy.html" title="Struct template skeleton_proxy">skeleton_proxy</a></code></code> containing a reference to the object that will be reshaped to match the received skeleton.</p></td>
 427 </tr>
 428 <tr>
 429 <td><p><span class="term"><code class="computeroutput">source</code></span></p></td>
 430 <td><p>The process that will be sending data. This will either be a process rank within the communicator or the constant <code class="computeroutput">any_source</code>, indicating that we can receive the message from any process.</p></td>
 431 </tr>
 432 <tr>
 433 <td><p><span class="term"><code class="computeroutput">tag</code></span></p></td>
 434 <td><p>The tag that matches a particular kind of message sent by the source process. This may be any tag value permitted by <code class="computeroutput">send</code>. Alternatively, the argument may be the constant <code class="computeroutput">any_tag</code>, indicating that this receive matches a message with any tag.</p></td>
 435 </tr>
 436 </tbody>
 437 </table></div></td>
 438 </tr>
 439 <tr>
 440 <td><p><span class="term">Returns:</span></p></td>
 441 <td><p>Information about the received message. </p></td>
 442 </tr>
 443 </tbody>
 444 </table></div>
 445 </li>
 446 <li class="listitem">
 447 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">&gt;</span>
 448   <a class="link" href="status.html" title="Class status">status</a> <a name="id-1_3_27_7_6_2_1_1_3_12-bb"></a><span class="identifier">recv</span><span class="special">(</span><span class="keyword">int</span> source<span class="special">,</span> <span class="keyword">int</span> tag<span class="special">,</span> <a class="link" href="skeleton_proxy.html" title="Struct template skeleton_proxy">skeleton_proxy</a><span class="special">&lt;</span> <span class="identifier">T</span> <span class="special">&gt;</span> <span class="special">&amp;</span> proxy<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Receive a skeleton from a remote process. <p>This routine blocks until it receives a message from the process <code class="computeroutput">source</code> with the given <code class="computeroutput">tag</code> containing a skeleton.</p>
 449 <p>
 450
 451 </p>
 452 <div class="variablelist"><table border="0" class="variablelist compact">
 453 <colgroup>
 454 <col align="left" valign="top">
 455 <col>
 456 </colgroup>
 457 <tbody>
 458 <tr>
 459 <td><p><span class="term">Parameters:</span></p></td>
 460 <td><div class="variablelist"><table border="0" class="variablelist compact">
 461 <colgroup>
 462 <col align="left" valign="top">
 463 <col>
 464 </colgroup>
 465 <tbody>
 466 <tr>
 467 <td><p><span class="term"><code class="computeroutput">proxy</code></span></p></td>
 468 <td><p>The <code class="computeroutput"><code class="computeroutput"><a class="link" href="skeleton_proxy.html" title="Struct template skeleton_proxy">skeleton_proxy</a></code></code> containing a reference to the object that will be reshaped to match the received skeleton.</p></td>
 469 </tr>
 470 <tr>
 471 <td><p><span class="term"><code class="computeroutput">source</code></span></p></td>
 472 <td><p>The process that will be sending data. This will either be a process rank within the communicator or the constant <code class="computeroutput">any_source</code>, indicating that we can receive the message from any process.</p></td>
 473 </tr>
 474 <tr>
 475 <td><p><span class="term"><code class="computeroutput">tag</code></span></p></td>
 476 <td><p>The tag that matches a particular kind of message sent by the source process. This may be any tag value permitted by <code class="computeroutput">send</code>. Alternatively, the argument may be the constant <code class="computeroutput">any_tag</code>, indicating that this receive matches a message with any tag.</p></td>
 477 </tr>
 478 </tbody>
 479 </table></div></td>
 480 </tr>
 481 <tr>
 482 <td><p><span class="term">Returns:</span></p></td>
 483 <td><p>Information about the received message. </p></td>
 484 </tr>
 485 </tbody>
 486 </table></div>
 487 </li>
 488 <li class="listitem">
 489 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">&gt;</span> <a class="link" href="status.html" title="Class status">status</a> <a name="id-1_3_27_7_6_2_1_1_3_13-bb"></a><span class="identifier">recv</span><span class="special">(</span><span class="keyword">int</span> source<span class="special">,</span> <span class="keyword">int</span> tag<span class="special">,</span> <span class="identifier">T</span> <span class="special">*</span> values<span class="special">,</span> <span class="keyword">int</span> n<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Receive an array of values from a remote process. <p>This routine blocks until it receives an array of values from the process <code class="computeroutput">source</code> with the given <code class="computeroutput">tag</code>. If the type <code class="computeroutput">T</code> is</p>
 490 <p>
 491
 492
 493 </p>
 494 <div class="variablelist"><table border="0" class="variablelist compact">
 495 <colgroup>
 496 <col align="left" valign="top">
 497 <col>
 498 </colgroup>
 499 <tbody>
 500 <tr>
 501 <td><p><span class="term">Parameters:</span></p></td>
 502 <td><div class="variablelist"><table border="0" class="variablelist compact">
 503 <colgroup>
 504 <col align="left" valign="top">
 505 <col>
 506 </colgroup>
 507 <tbody>
 508 <tr>
 509 <td><p><span class="term"><code class="computeroutput">n</code></span></p></td>
 510 <td><p>The number of values that can be stored into the <code class="computeroutput">values</code> array. This shall not be smaller than the number of elements transmitted by the sender.</p></td>
 511 </tr>
 512 <tr>
 513 <td><p><span class="term"><code class="computeroutput">source</code></span></p></td>
 514 <td><p>The process that will be sending data. This will either be a process rank within the communicator or the constant <code class="computeroutput">any_source</code>, indicating that we can receive the message from any process.</p></td>
 515 </tr>
 516 <tr>
 517 <td><p><span class="term"><code class="computeroutput">tag</code></span></p></td>
 518 <td><p>The tag that matches a particular kind of message sent by the source process. This may be any tag value permitted by <code class="computeroutput">send</code>. Alternatively, the argument may be the constant <code class="computeroutput">any_tag</code>, indicating that this receive matches a message with any tag.</p></td>
 519 </tr>
 520 <tr>
 521 <td><p><span class="term"><code class="computeroutput">values</code></span></p></td>
 522 <td><p>Will contain the values in the message after a successful receive. The type of these elements must match the type of the elements transmitted by the sender.</p></td>
 523 </tr>
 524 </tbody>
 525 </table></div></td>
 526 </tr>
 527 <tr>
 528 <td><p><span class="term">Returns:</span></p></td>
 529 <td><p>Information about the received message. </p></td>
 530 </tr>
 531 <tr>
 532 <td><p><span class="term">Throws:</span></p></td>
 533 <td>std::range_error if the message to be received contains more than <code class="computeroutput">n</code> values.</td>
 534 </tr>
 535 </tbody>
 536 </table></div>
 537 </li>
 538 <li class="listitem">
 539 <pre class="literallayout"><a class="link" href="status.html" title="Class status">status</a> <a name="id-1_3_27_7_6_2_1_1_3_14-bb"></a><span class="identifier">recv</span><span class="special">(</span><span class="keyword">int</span> source<span class="special">,</span> <span class="keyword">int</span> tag<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Receive a message from a remote process without any data. <p>This routine blocks until it receives a message from the process <code class="computeroutput">source</code> with the given <code class="computeroutput">tag</code>.</p>
 540 <p>
 541
 542 </p>
 543 <div class="variablelist"><table border="0" class="variablelist compact">
 544 <colgroup>
 545 <col align="left" valign="top">
 546 <col>
 547 </colgroup>
 548 <tbody>
 549 <tr>
 550 <td><p><span class="term">Parameters:</span></p></td>
 551 <td><div class="variablelist"><table border="0" class="variablelist compact">
 552 <colgroup>
 553 <col align="left" valign="top">
 554 <col>
 555 </colgroup>
 556 <tbody>
 557 <tr>
 558 <td><p><span class="term"><code class="computeroutput">source</code></span></p></td>
 559 <td><p>The process that will be sending the message. This will either be a process rank within the communicator or the constant <code class="computeroutput">any_source</code>, indicating that we can receive the message from any process.</p></td>
 560 </tr>
 561 <tr>
 562 <td><p><span class="term"><code class="computeroutput">tag</code></span></p></td>
 563 <td><p>The tag that matches a particular kind of message sent by the source process. This may be any tag value permitted by <code class="computeroutput">send</code>. Alternatively, the argument may be the constant <code class="computeroutput">any_tag</code>, indicating that this receive matches a message with any tag.</p></td>
 564 </tr>
 565 </tbody>
 566 </table></div></td>
 567 </tr>
 568 <tr>
 569 <td><p><span class="term">Returns:</span></p></td>
 570 <td><p>Information about the received message. </p></td>
 571 </tr>
 572 </tbody>
 573 </table></div>
 574 </li>
 575 <li class="listitem">
 576 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">&gt;</span>
 577   <a class="link" href="status.html" title="Class status">status</a> <a name="id-1_3_27_7_6_2_1_1_3_15-bb"></a><span class="identifier">sendrecv</span><span class="special">(</span><span class="keyword">int</span> dest<span class="special">,</span> <span class="keyword">int</span> stag<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">T</span> <span class="special">&amp;</span> sval<span class="special">,</span> <span class="keyword">int</span> src<span class="special">,</span> <span class="keyword">int</span> rtag<span class="special">,</span>
 578                   <span class="identifier">T</span> <span class="special">&amp;</span> rval<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Send a message to remote process and receive another message from another process. </li>
 579 <li class="listitem">
 580 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">&gt;</span> <a class="link" href="request.html" title="Class request">request</a> <a name="id-1_3_27_7_6_2_1_1_3_16-bb"></a><span class="identifier">isend</span><span class="special">(</span><span class="keyword">int</span> dest<span class="special">,</span> <span class="keyword">int</span> tag<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">T</span> <span class="special">&amp;</span> value<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Send a message to a remote process without blocking. <p>The <code class="computeroutput">isend</code> method is functionality identical to the <code class="computeroutput">send</code> method and transmits data in the same way, except that <code class="computeroutput">isend</code> will not block while waiting for the data to be transmitted. Instead, a request object will be immediately returned, allowing one to query the status of the communication or wait until it has completed.</p>
 581 <p>
 582
 583 </p>
 584 <div class="variablelist"><table border="0" class="variablelist compact">
 585 <colgroup>
 586 <col align="left" valign="top">
 587 <col>
 588 </colgroup>
 589 <tbody>
 590 <tr>
 591 <td><p><span class="term">Parameters:</span></p></td>
 592 <td><div class="variablelist"><table border="0" class="variablelist compact">
 593 <colgroup>
 594 <col align="left" valign="top">
 595 <col>
 596 </colgroup>
 597 <tbody>
 598 <tr>
 599 <td><p><span class="term"><code class="computeroutput">dest</code></span></p></td>
 600 <td><p>The rank of the remote process to which the data will be sent.</p></td>
 601 </tr>
 602 <tr>
 603 <td><p><span class="term"><code class="computeroutput">tag</code></span></p></td>
 604 <td><p>The tag that will be associated with this message. Tags may be any integer between zero and an implementation-defined upper limit. This limit is accessible via <code class="computeroutput">environment::max_tag()</code>.</p></td>
 605 </tr>
 606 <tr>
 607 <td><p><span class="term"><code class="computeroutput">value</code></span></p></td>
 608 <td><p>The value that will be transmitted to the receiver. The type <code class="computeroutput">T</code> of this value must meet the aforementioned criteria for transmission. If modified before transmited, the modification may or may not be transmited.</p></td>
 609 </tr>
 610 </tbody>
 611 </table></div></td>
 612 </tr>
 613 <tr>
 614 <td><p><span class="term">Returns:</span></p></td>
 615 <td><p>a <code class="computeroutput">request</code> object that describes this communication. </p></td>
 616 </tr>
 617 </tbody>
 618 </table></div>
 619 </li>
 620 <li class="listitem">
 621 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">&gt;</span>
 622   <a class="link" href="request.html" title="Class request">request</a> <a name="id-1_3_27_7_6_2_1_1_3_17-bb"></a><span class="identifier">isend</span><span class="special">(</span><span class="keyword">int</span> dest<span class="special">,</span> <span class="keyword">int</span> tag<span class="special">,</span> <span class="keyword">const</span> <a class="link" href="skeleton_proxy.html" title="Struct template skeleton_proxy">skeleton_proxy</a><span class="special">&lt;</span> <span class="identifier">T</span> <span class="special">&gt;</span> <span class="special">&amp;</span> proxy<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Send the skeleton of an object without blocking. <p>This routine is functionally identical to the <code class="computeroutput">send</code> method for <code class="computeroutput"><code class="computeroutput"><a class="link" href="skeleton_proxy.html" title="Struct template skeleton_proxy">skeleton_proxy</a></code></code> objects except that <code class="computeroutput">isend</code> will not block while waiting for the data to be transmitted. Instead, a request object will be immediately returned, allowing one to query the status of the communication or wait until it has completed.</p>
 623 <p>The semantics of this routine are equivalent to a non-blocking send of a <code class="computeroutput">packed_skeleton_oarchive</code> storing the skeleton of the <code class="computeroutput">object</code>.</p>
 624 <p>
 625
 626 </p>
 627 <div class="variablelist"><table border="0" class="variablelist compact">
 628 <colgroup>
 629 <col align="left" valign="top">
 630 <col>
 631 </colgroup>
 632 <tbody>
 633 <tr>
 634 <td><p><span class="term">Parameters:</span></p></td>
 635 <td><div class="variablelist"><table border="0" class="variablelist compact">
 636 <colgroup>
 637 <col align="left" valign="top">
 638 <col>
 639 </colgroup>
 640 <tbody>
 641 <tr>
 642 <td><p><span class="term"><code class="computeroutput">dest</code></span></p></td>
 643 <td><p>The rank of the remote process to which the skeleton will be sent.</p></td>
 644 </tr>
 645 <tr>
 646 <td><p><span class="term"><code class="computeroutput">proxy</code></span></p></td>
 647 <td><p>The <code class="computeroutput"><code class="computeroutput"><a class="link" href="skeleton_proxy.html" title="Struct template skeleton_proxy">skeleton_proxy</a></code></code> containing a reference to the object whose skeleton will be transmitted.</p></td>
 648 </tr>
 649 <tr>
 650 <td><p><span class="term"><code class="computeroutput">tag</code></span></p></td>
 651 <td><p>The tag that will be associated with this message. Tags may be any integer between zero and an implementation-defined upper limit. This limit is accessible via <code class="computeroutput">environment::max_tag()</code>.</p></td>
 652 </tr>
 653 </tbody>
 654 </table></div></td>
 655 </tr>
 656 <tr>
 657 <td><p><span class="term">Returns:</span></p></td>
 658 <td><p>a <code class="computeroutput">request</code> object that describes this communication. </p></td>
 659 </tr>
 660 </tbody>
 661 </table></div>
 662 </li>
 663 <li class="listitem">
 664 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">&gt;</span>
 665   <a class="link" href="request.html" title="Class request">request</a> <a name="id-1_3_27_7_6_2_1_1_3_18-bb"></a><span class="identifier">isend</span><span class="special">(</span><span class="keyword">int</span> dest<span class="special">,</span> <span class="keyword">int</span> tag<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">T</span> <span class="special">*</span> values<span class="special">,</span> <span class="keyword">int</span> n<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Send an array of values to another process without blocking. <p>This routine is functionally identical to the <code class="computeroutput">send</code> method for arrays except that <code class="computeroutput">isend</code> will not block while waiting for the data to be transmitted. Instead, a request object will be immediately returned, allowing one to query the status of the communication or wait until it has completed.</p>
 666 <p>
 667
 668 </p>
 669 <div class="variablelist"><table border="0" class="variablelist compact">
 670 <colgroup>
 671 <col align="left" valign="top">
 672 <col>
 673 </colgroup>
 674 <tbody>
 675 <tr>
 676 <td><p><span class="term">Parameters:</span></p></td>
 677 <td><div class="variablelist"><table border="0" class="variablelist compact">
 678 <colgroup>
 679 <col align="left" valign="top">
 680 <col>
 681 </colgroup>
 682 <tbody>
 683 <tr>
 684 <td><p><span class="term"><code class="computeroutput">dest</code></span></p></td>
 685 <td><p>The process rank of the remote process to which the data will be sent.</p></td>
 686 </tr>
 687 <tr>
 688 <td><p><span class="term"><code class="computeroutput">n</code></span></p></td>
 689 <td><p>The number of values stored in the array. The destination process must call receive with at least this many elements to correctly receive the message.</p></td>
 690 </tr>
 691 <tr>
 692 <td><p><span class="term"><code class="computeroutput">tag</code></span></p></td>
 693 <td><p>The tag that will be associated with this message. Tags may be any integer between zero and an implementation-defined upper limit. This limit is accessible via <code class="computeroutput">environment::max_tag()</code>.</p></td>
 694 </tr>
 695 <tr>
 696 <td><p><span class="term"><code class="computeroutput">values</code></span></p></td>
 697 <td><p>The array of values that will be transmitted to the receiver. The type <code class="computeroutput">T</code> of these values must be mapped to an MPI data type.</p></td>
 698 </tr>
 699 </tbody>
 700 </table></div></td>
 701 </tr>
 702 <tr>
 703 <td><p><span class="term">Returns:</span></p></td>
 704 <td><p>a <code class="computeroutput">request</code> object that describes this communication. </p></td>
 705 </tr>
 706 </tbody>
 707 </table></div>
 708 </li>
 709 <li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="keyword">typename</span> A<span class="special">&gt;</span>
 710   <a class="link" href="request.html" title="Class request">request</a> <a name="id-1_3_27_7_6_2_1_1_3_19-bb"></a><span class="identifier">isend</span><span class="special">(</span><span class="keyword">int</span> dest<span class="special">,</span> <span class="keyword">int</span> tag<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special">&lt;</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">A</span> <span class="special">&gt;</span> <span class="special">&amp;</span> values<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
 711 <li class="listitem">
 712 <pre class="literallayout"><a class="link" href="request.html" title="Class request">request</a> <a name="id-1_3_27_7_6_2_1_1_3_20-bb"></a><span class="identifier">isend</span><span class="special">(</span><span class="keyword">int</span> dest<span class="special">,</span> <span class="keyword">int</span> tag<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Send a message to another process without any data without blocking. <p>This routine is functionally identical to the <code class="computeroutput">send</code> method for sends with no data, except that <code class="computeroutput">isend</code> will not block while waiting for the message to be transmitted. Instead, a request object will be immediately returned, allowing one to query the status of the communication or wait until it has completed.</p>
 713 <p>
 714
 715 </p>
 716 <div class="variablelist"><table border="0" class="variablelist compact">
 717 <colgroup>
 718 <col align="left" valign="top">
 719 <col>
 720 </colgroup>
 721 <tbody>
 722 <tr>
 723 <td><p><span class="term">Parameters:</span></p></td>
 724 <td><div class="variablelist"><table border="0" class="variablelist compact">
 725 <colgroup>
 726 <col align="left" valign="top">
 727 <col>
 728 </colgroup>
 729 <tbody>
 730 <tr>
 731 <td><p><span class="term"><code class="computeroutput">dest</code></span></p></td>
 732 <td><p>The process rank of the remote process to which the message will be sent.</p></td>
 733 </tr>
 734 <tr>
 735 <td><p><span class="term"><code class="computeroutput">tag</code></span></p></td>
 736 <td><p>The tag that will be associated with this message. Tags may be any integer between zero and an implementation-defined upper limit. This limit is accessible via <code class="computeroutput">environment::max_tag()</code>.</p></td>
 737 </tr>
 738 </tbody>
 739 </table></div></td>
 740 </tr>
 741 <tr>
 742 <td><p><span class="term">Returns:</span></p></td>
 743 <td><p>a <code class="computeroutput">request</code> object that describes this communication. </p></td>
 744 </tr>
 745 </tbody>
 746 </table></div>
 747 </li>
 748 <li class="listitem">
 749 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">&gt;</span> <a class="link" href="request.html" title="Class request">request</a> <a name="id-1_3_27_7_6_2_1_1_3_21-bb"></a><span class="identifier">irecv</span><span class="special">(</span><span class="keyword">int</span> source<span class="special">,</span> <span class="keyword">int</span> tag<span class="special">,</span> <span class="identifier">T</span> <span class="special">&amp;</span> value<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Prepare to receive a message from a remote process. <p>The <code class="computeroutput">irecv</code> method is functionally identical to the <code class="computeroutput">recv</code> method and receive data in the same way, except that <code class="computeroutput">irecv</code> will not block while waiting for data to be transmitted. Instead, it immediately returns a request object that allows one to query the status of the receive or wait until it has completed.</p>
 750 <p>
 751
 752 </p>
 753 <div class="variablelist"><table border="0" class="variablelist compact">
 754 <colgroup>
 755 <col align="left" valign="top">
 756 <col>
 757 </colgroup>
 758 <tbody>
 759 <tr>
 760 <td><p><span class="term">Parameters:</span></p></td>
 761 <td><div class="variablelist"><table border="0" class="variablelist compact">
 762 <colgroup>
 763 <col align="left" valign="top">
 764 <col>
 765 </colgroup>
 766 <tbody>
 767 <tr>
 768 <td><p><span class="term"><code class="computeroutput">source</code></span></p></td>
 769 <td><p>The process that will be sending data. This will either be a process rank within the communicator or the constant <code class="computeroutput">any_source</code>, indicating that we can receive the message from any process.</p></td>
 770 </tr>
 771 <tr>
 772 <td><p><span class="term"><code class="computeroutput">tag</code></span></p></td>
 773 <td><p>The tag that matches a particular kind of message sent by the source process. This may be any tag value permitted by <code class="computeroutput">send</code>. Alternatively, the argument may be the constant <code class="computeroutput">any_tag</code>, indicating that this receive matches a message with any tag.</p></td>
 774 </tr>
 775 <tr>
 776 <td><p><span class="term"><code class="computeroutput">value</code></span></p></td>
 777 <td><p>Will contain the value of the message after a successful receive. The type of this value must match the value transmitted by the sender, unless the sender transmitted a packed archive or skeleton: in these cases, the sender transmits a <code class="computeroutput"><code class="computeroutput"><a class="link" href="packed_oarchive.html" title="Class packed_oarchive">packed_oarchive</a></code></code> or <code class="computeroutput">packed_skeleton_oarchive</code> and the destination receives a <code class="computeroutput"><code class="computeroutput"><a class="link" href="packed_iarchive.html" title="Class packed_iarchive">packed_iarchive</a></code></code> or <code class="computeroutput">packed_skeleton_iarchive</code>, respectively.</p></td>
 778 </tr>
 779 </tbody>
 780 </table></div></td>
 781 </tr>
 782 <tr>
 783 <td><p><span class="term">Returns:</span></p></td>
 784 <td><p>a <code class="computeroutput">request</code> object that describes this communication. </p></td>
 785 </tr>
 786 </tbody>
 787 </table></div>
 788 </li>
 789 <li class="listitem">
 790 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">&gt;</span>
 791   <a class="link" href="request.html" title="Class request">request</a> <a name="id-1_3_27_7_6_2_1_1_3_22-bb"></a><span class="identifier">irecv</span><span class="special">(</span><span class="keyword">int</span> source<span class="special">,</span> <span class="keyword">int</span> tag<span class="special">,</span> <span class="identifier">T</span> <span class="special">*</span> values<span class="special">,</span> <span class="keyword">int</span> n<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Initiate receipt of an array of values from a remote process. <p>This routine initiates a receive operation for an array of values transmitted by process <code class="computeroutput">source</code> with the given <code class="computeroutput">tag</code>.</p>
 792 <p>
 793
 794 </p>
 795 <div class="variablelist"><table border="0" class="variablelist compact">
 796 <colgroup>
 797 <col align="left" valign="top">
 798 <col>
 799 </colgroup>
 800 <tbody>
 801 <tr>
 802 <td><p><span class="term">Parameters:</span></p></td>
 803 <td><div class="variablelist"><table border="0" class="variablelist compact">
 804 <colgroup>
 805 <col align="left" valign="top">
 806 <col>
 807 </colgroup>
 808 <tbody>
 809 <tr>
 810 <td><p><span class="term"><code class="computeroutput">n</code></span></p></td>
 811 <td><p>The number of values that can be stored into the <code class="computeroutput">values</code> array. This shall not be smaller than the number of elements transmitted by the sender.</p></td>
 812 </tr>
 813 <tr>
 814 <td><p><span class="term"><code class="computeroutput">source</code></span></p></td>
 815 <td><p>The process that will be sending data. This will either be a process rank within the communicator or the constant <code class="computeroutput">any_source</code>, indicating that we can receive the message from any process.</p></td>
 816 </tr>
 817 <tr>
 818 <td><p><span class="term"><code class="computeroutput">tag</code></span></p></td>
 819 <td><p>The tag that matches a particular kind of message sent by the source process. This may be any tag value permitted by <code class="computeroutput">send</code>. Alternatively, the argument may be the constant <code class="computeroutput">any_tag</code>, indicating that this receive matches a message with any tag.</p></td>
 820 </tr>
 821 <tr>
 822 <td><p><span class="term"><code class="computeroutput">values</code></span></p></td>
 823 <td><p>Will contain the values in the message after a successful receive. The type of these elements must match the type of the elements transmitted by the sender.</p></td>
 824 </tr>
 825 </tbody>
 826 </table></div></td>
 827 </tr>
 828 <tr>
 829 <td><p><span class="term">Returns:</span></p></td>
 830 <td><p>a <code class="computeroutput">request</code> object that describes this communication. </p></td>
 831 </tr>
 832 </tbody>
 833 </table></div>
 834 </li>
 835 <li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="keyword">typename</span> A<span class="special">&gt;</span>
 836   <a class="link" href="request.html" title="Class request">request</a> <a name="id-1_3_27_7_6_2_1_1_3_23-bb"></a><span class="identifier">irecv</span><span class="special">(</span><span class="keyword">int</span> source<span class="special">,</span> <span class="keyword">int</span> tag<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special">&lt;</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">A</span> <span class="special">&gt;</span> <span class="special">&amp;</span> values<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
 837 <li class="listitem">
 838 <pre class="literallayout"><a class="link" href="request.html" title="Class request">request</a> <a name="id-1_3_27_7_6_2_1_1_3_24-bb"></a><span class="identifier">irecv</span><span class="special">(</span><span class="keyword">int</span> source<span class="special">,</span> <span class="keyword">int</span> tag<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Initiate receipt of a message from a remote process that carries no data. <p>This routine initiates a receive operation for a message from process <code class="computeroutput">source</code> with the given <code class="computeroutput">tag</code> that carries no data.</p>
 839 <p>
 840
 841 </p>
 842 <div class="variablelist"><table border="0" class="variablelist compact">
 843 <colgroup>
 844 <col align="left" valign="top">
 845 <col>
 846 </colgroup>
 847 <tbody>
 848 <tr>
 849 <td><p><span class="term">Parameters:</span></p></td>
 850 <td><div class="variablelist"><table border="0" class="variablelist compact">
 851 <colgroup>
 852 <col align="left" valign="top">
 853 <col>
 854 </colgroup>
 855 <tbody>
 856 <tr>
 857 <td><p><span class="term"><code class="computeroutput">source</code></span></p></td>
 858 <td><p>The process that will be sending the message. This will either be a process rank within the communicator or the constant <code class="computeroutput">any_source</code>, indicating that we can receive the message from any process.</p></td>
 859 </tr>
 860 <tr>
 861 <td><p><span class="term"><code class="computeroutput">tag</code></span></p></td>
 862 <td><p>The tag that matches a particular kind of message sent by the source process. This may be any tag value permitted by <code class="computeroutput">send</code>. Alternatively, the argument may be the constant <code class="computeroutput">any_tag</code>, indicating that this receive matches a message with any tag.</p></td>
 863 </tr>
 864 </tbody>
 865 </table></div></td>
 866 </tr>
 867 <tr>
 868 <td><p><span class="term">Returns:</span></p></td>
 869 <td><p>a <code class="computeroutput">request</code> object that describes this communication. </p></td>
 870 </tr>
 871 </tbody>
 872 </table></div>
 873 </li>
 874 <li class="listitem">
 875 <pre class="literallayout"><a class="link" href="status.html" title="Class status">status</a> <a name="id-1_3_27_7_6_2_1_1_3_25-bb"></a><span class="identifier">probe</span><span class="special">(</span><span class="keyword">int</span> source <span class="special">=</span> <span class="identifier">any_source</span><span class="special">,</span> <span class="keyword">int</span> tag <span class="special">=</span> <span class="identifier">any_tag</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Waits until a message is available to be received. <p>This operation waits until a message matching (<code class="computeroutput">source</code>, <code class="computeroutput">tag</code>) is available to be received. It then returns information about that message. The functionality is equivalent to <code class="computeroutput">MPI_Probe</code>. To check if a message is available without blocking, use <code class="computeroutput">iprobe</code>.</p>
 876 <p>
 877
 878 </p>
 879 <div class="variablelist"><table border="0" class="variablelist compact">
 880 <colgroup>
 881 <col align="left" valign="top">
 882 <col>
 883 </colgroup>
 884 <tbody>
 885 <tr>
 886 <td><p><span class="term">Parameters:</span></p></td>
 887 <td><div class="variablelist"><table border="0" class="variablelist compact">
 888 <colgroup>
 889 <col align="left" valign="top">
 890 <col>
 891 </colgroup>
 892 <tbody>
 893 <tr>
 894 <td><p><span class="term"><code class="computeroutput">source</code></span></p></td>
 895 <td><p>Determine if there is a message available from this rank. If <code class="computeroutput">any_source</code>, then the message returned may come from any source.</p></td>
 896 </tr>
 897 <tr>
 898 <td><p><span class="term"><code class="computeroutput">tag</code></span></p></td>
 899 <td><p>Determine if there is a message available with the given tag. If <code class="computeroutput">any_tag</code>, then the message returned may have any tag.</p></td>
 900 </tr>
 901 </tbody>
 902 </table></div></td>
 903 </tr>
 904 <tr>
 905 <td><p><span class="term">Returns:</span></p></td>
 906 <td><p>Returns information about the first message that matches the given criteria. </p></td>
 907 </tr>
 908 </tbody>
 909 </table></div>
 910 </li>
 911 <li class="listitem">
 912 <pre class="literallayout"><span class="identifier">optional</span><span class="special">&lt;</span> <a class="link" href="status.html" title="Class status">status</a> <span class="special">&gt;</span> <a name="id-1_3_27_7_6_2_1_1_3_26-bb"></a><span class="identifier">iprobe</span><span class="special">(</span><span class="keyword">int</span> source <span class="special">=</span> <span class="identifier">any_source</span><span class="special">,</span> <span class="keyword">int</span> tag <span class="special">=</span> <span class="identifier">any_tag</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Determine if a message is available to be received. <p>This operation determines if a message matching (<code class="computeroutput">source</code>, <code class="computeroutput">tag</code>) is available to be received. If so, it returns information about that message; otherwise, it returns immediately with an empty optional. The functionality is equivalent to <code class="computeroutput">MPI_Iprobe</code>. To wait until a message is available, use <code class="computeroutput">wait</code>.</p>
 913 <p>
 914
 915 </p>
 916 <div class="variablelist"><table border="0" class="variablelist compact">
 917 <colgroup>
 918 <col align="left" valign="top">
 919 <col>
 920 </colgroup>
 921 <tbody>
 922 <tr>
 923 <td><p><span class="term">Parameters:</span></p></td>
 924 <td><div class="variablelist"><table border="0" class="variablelist compact">
 925 <colgroup>
 926 <col align="left" valign="top">
 927 <col>
 928 </colgroup>
 929 <tbody>
 930 <tr>
 931 <td><p><span class="term"><code class="computeroutput">source</code></span></p></td>
 932 <td><p>Determine if there is a message available from this rank. If <code class="computeroutput">any_source</code>, then the message returned may come from any source.</p></td>
 933 </tr>
 934 <tr>
 935 <td><p><span class="term"><code class="computeroutput">tag</code></span></p></td>
 936 <td><p>Determine if there is a message available with the given tag. If <code class="computeroutput">any_tag</code>, then the message returned may have any tag.</p></td>
 937 </tr>
 938 </tbody>
 939 </table></div></td>
 940 </tr>
 941 <tr>
 942 <td><p><span class="term">Returns:</span></p></td>
 943 <td><p>If a matching message is available, returns information about that message. Otherwise, returns an empty <code class="computeroutput">boost::optional</code>. </p></td>
 944 </tr>
 945 </tbody>
 946 </table></div>
 947 </li>
 948 <li class="listitem">
 949 <pre class="literallayout"><span class="keyword">void</span> <a name="id-1_3_27_7_6_2_1_1_3_27-bb"></a><span class="identifier">barrier</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Wait for all processes within a communicator to reach the barrier. <p>This routine is a collective operation that blocks each process until all processes have entered it, then releases all of the processes "simultaneously". It is equivalent to <code class="computeroutput">MPI_Barrier</code>. </p>
 950 </li>
 951 <li class="listitem">
 952 <pre class="literallayout"><a name="id-1_3_27_7_6_2_1_1_3_28-bb"></a><span class="keyword">operator</span> <span class="keyword">bool</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Determine if this communicator is valid for communication. <p>Evaluates <code class="computeroutput">true</code> in a boolean context if this communicator is valid for communication, i.e., does not represent MPI_COMM_NULL. Otherwise, evaluates <code class="computeroutput">false</code>. </p>
 953 </li>
 954 <li class="listitem">
 955 <pre class="literallayout"><a name="id-1_3_27_7_6_2_1_1_3_29-bb"></a><span class="keyword">operator</span> <span class="identifier">MPI_Comm</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Access the MPI communicator associated with a Boost.MPI communicator. <p>This routine permits the implicit conversion from a Boost.MPI communicator to an MPI communicator.</p>
 956 <p>
 957 </p>
 958 <div class="variablelist"><table border="0" class="variablelist compact">
 959 <colgroup>
 960 <col align="left" valign="top">
 961 <col>
 962 </colgroup>
 963 <tbody><tr>
 964 <td><p><span class="term">Returns:</span></p></td>
 965 <td><p>The associated MPI communicator. </p></td>
 966 </tr></tbody>
 967 </table></div>
 968 </li>
 969 <li class="listitem">
 970 <pre class="literallayout"><a class="link" href="communicator.html" title="Class communicator">communicator</a> <a name="id-1_3_27_7_6_2_1_1_3_30-bb"></a><span class="identifier">split</span><span class="special">(</span><span class="keyword">int</span> color<span class="special">,</span> <span class="keyword">int</span> key<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
 971 <p>Split the communicator into multiple, disjoint communicators each of which is based on a particular color. This is a collective operation that returns a new communicator that is a subgroup of <code class="computeroutput">this</code>.</p>
 972 <p>
 973
 974 </p>
 975 <div class="variablelist"><table border="0" class="variablelist compact">
 976 <colgroup>
 977 <col align="left" valign="top">
 978 <col>
 979 </colgroup>
 980 <tbody>
 981 <tr>
 982 <td><p><span class="term">Parameters:</span></p></td>
 983 <td><div class="variablelist"><table border="0" class="variablelist compact">
 984 <colgroup>
 985 <col align="left" valign="top">
 986 <col>
 987 </colgroup>
 988 <tbody>
 989 <tr>
 990 <td><p><span class="term"><code class="computeroutput">color</code></span></p></td>
 991 <td><p>The color of this process. All processes with the same <code class="computeroutput">color</code> value will be placed into the same group.</p></td>
 992 </tr>
 993 <tr>
 994 <td><p><span class="term"><code class="computeroutput">key</code></span></p></td>
 995 <td><p>A key value that will be used to determine the ordering of processes with the same color in the resulting communicator. If omitted, the rank of the processes in <code class="computeroutput">this</code> will determine the ordering of processes in the resulting group.</p></td>
 996 </tr>
 997 </tbody>
 998 </table></div></td>
 999 </tr>
1000 <tr>
1001 <td><p><span class="term">Returns:</span></p></td>
1002 <td><p>A new communicator containing all of the processes in <code class="computeroutput">this</code> that have the same <code class="computeroutput">color</code>. </p></td>
1003 </tr>
1004 </tbody>
1005 </table></div>
1006 </li>
1007 <li class="listitem"><pre class="literallayout"><a class="link" href="communicator.html" title="Class communicator">communicator</a> <a name="id-1_3_27_7_6_2_1_1_3_31-bb"></a><span class="identifier">split</span><span class="special">(</span><span class="keyword">int</span> color<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
1008 <li class="listitem">
1009 <pre class="literallayout"><span class="identifier">optional</span><span class="special">&lt;</span> <a class="link" href="intercommunicator.html" title="Class intercommunicator">intercommunicator</a> <span class="special">&gt;</span> <a name="id-1_3_27_7_6_2_1_1_3_32-bb"></a><span class="identifier">as_intercommunicator</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
1010 <p>Determine if the communicator is in fact an intercommunicator and, if so, return that intercommunicator.</p>
1011 <p>
1012 </p>
1013 <div class="variablelist"><table border="0" class="variablelist compact">
1014 <colgroup>
1015 <col align="left" valign="top">
1016 <col>
1017 </colgroup>
1018 <tbody><tr>
1019 <td><p><span class="term">Returns:</span></p></td>
1020 <td><p>an <code class="computeroutput">optional</code> containing the intercommunicator, if this communicator is in fact an intercommunicator. Otherwise, returns an empty <code class="computeroutput">optional</code>. </p></td>
1021 </tr></tbody>
1022 </table></div>
1023 </li>
1024 <li class="listitem">
1025 <pre class="literallayout"><span class="identifier">optional</span><span class="special">&lt;</span> <a class="link" href="graph_communicator.html" title="Class graph_communicator">graph_communicator</a> <span class="special">&gt;</span> <a name="id-1_3_27_7_6_2_1_1_3_33-bb"></a><span class="identifier">as_graph_communicator</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
1026 <p>Determine if the communicator has a graph topology and, if so, return that <code class="computeroutput"><code class="computeroutput"><a class="link" href="graph_communicator.html" title="Class graph_communicator">graph_communicator</a></code></code>. Even though the communicators have different types, they refer to the same underlying communication space and can be used interchangeably for communication.</p>
1027 <p>
1028 </p>
1029 <div class="variablelist"><table border="0" class="variablelist compact">
1030 <colgroup>
1031 <col align="left" valign="top">
1032 <col>
1033 </colgroup>
1034 <tbody><tr>
1035 <td><p><span class="term">Returns:</span></p></td>
1036 <td><p>an <code class="computeroutput">optional</code> containing the graph communicator, if this communicator does in fact have a graph topology. Otherwise, returns an empty <code class="computeroutput">optional</code>. </p></td>
1037 </tr></tbody>
1038 </table></div>
1039 </li>
1040 <li class="listitem">
1041 <pre class="literallayout"><span class="keyword">bool</span> <a name="id-1_3_27_7_6_2_1_1_3_34-bb"></a><span class="identifier">has_graph_topology</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
1042 <p>Determines whether this communicator has a Graph topology. </p>
1043 </li>
1044 <li class="listitem">
1045 <pre class="literallayout"><span class="identifier">optional</span><span class="special">&lt;</span> <a class="link" href="cartesian_communicator.html" title="Class cartesian_communicator">cartesian_communicator</a> <span class="special">&gt;</span> <a name="id-1_3_27_7_6_2_1_1_3_35-bb"></a><span class="identifier">as_cartesian_communicator</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
1046 <p>Determine if the communicator has a cartesian topology and, if so, return that <code class="computeroutput"><code class="computeroutput"><a class="link" href="cartesian_communicator.html" title="Class cartesian_communicator">cartesian_communicator</a></code></code>. Even though the communicators have different types, they refer to the same underlying communication space and can be used interchangeably for communication.</p>
1047 <p>
1048 </p>
1049 <div class="variablelist"><table border="0" class="variablelist compact">
1050 <colgroup>
1051 <col align="left" valign="top">
1052 <col>
1053 </colgroup>
1054 <tbody><tr>
1055 <td><p><span class="term">Returns:</span></p></td>
1056 <td><p>an <code class="computeroutput">optional</code> containing the cartesian communicator, if this communicator does in fact have a cartesian topology. Otherwise, returns an empty <code class="computeroutput">optional</code>. </p></td>
1057 </tr></tbody>
1058 </table></div>
1059 </li>
1060 <li class="listitem">
1061 <pre class="literallayout"><span class="keyword">bool</span> <a name="id-1_3_27_7_6_2_1_1_3_36-bb"></a><span class="identifier">has_cartesian_topology</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
1062 <p>Determines whether this communicator has a Cartesian topology. </p>
1063 </li>
1064 <li class="listitem">
1065 <pre class="literallayout"><span class="keyword">void</span> <a name="id-1_3_27_7_6_2_1_1_3_37-bb"></a><span class="identifier">abort</span><span class="special">(</span><span class="keyword">int</span> errcode<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
1066 <p>Abort all tasks in the group of this communicator.</p>
1067 <p>Makes a "best attempt" to abort all of the tasks in the group of this communicator. Depending on the underlying MPI implementation, this may either abort the entire program (and possibly return <code class="computeroutput">errcode</code> to the environment) or only abort some processes, allowing the others to continue. Consult the documentation for your MPI implementation. This is equivalent to a call to <code class="computeroutput">MPI_Abort</code> </p>
1068 <p>
1069
1070 </p>
1071 <div class="variablelist"><table border="0" class="variablelist compact">
1072 <colgroup>
1073 <col align="left" valign="top">
1074 <col>
1075 </colgroup>
1076 <tbody>
1077 <tr>
1078 <td><p><span class="term">Parameters:</span></p></td>
1079 <td><div class="variablelist"><table border="0" class="variablelist compact">
1080 <colgroup>
1081 <col align="left" valign="top">
1082 <col>
1083 </colgroup>
1084 <tbody><tr>
1085 <td><p><span class="term"><code class="computeroutput">errcode</code></span></p></td>
1086 <td><p>The error code to return from aborted processes. </p></td>
1087 </tr></tbody>
1088 </table></div></td>
1089 </tr>
1090 <tr>
1091 <td><p><span class="term">Returns:</span></p></td>
1092 <td><p>Will not return. </p></td>
1093 </tr>
1094 </tbody>
1095 </table></div>
1096 </li>
1097 </ol></div>
1098 </div>
1099 <div class="refsect2">
1100 <a name="id-1.3.27.7.7.4.4.5"></a><h3>
1101 <a name="id-1_3_27_7_6_2_1_1_7-bb"></a><code class="computeroutput">communicator</code> protected member functions</h3>
1102 <div class="orderedlist"><ol class="orderedlist" type="1">
1103 <li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="keyword">typename</span> A<span class="special">&gt;</span>
1104   <a class="link" href="request.html" title="Class request">request</a> <a name="id-1_3_27_7_6_2_1_1_7_1-bb"></a><span class="identifier">irecv_vector</span><span class="special">(</span><span class="keyword">int</span> source<span class="special">,</span> <span class="keyword">int</span> tag<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special">&lt;</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">A</span> <span class="special">&gt;</span> <span class="special">&amp;</span> values<span class="special">,</span>
1105                        <span class="identifier">mpl</span><span class="special">::</span><span class="identifier">true_</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
1106 <li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="keyword">typename</span> A<span class="special">&gt;</span>
1107   <a class="link" href="request.html" title="Class request">request</a> <a name="id-1_3_27_7_6_2_1_1_7_2-bb"></a><span class="identifier">isend_vector</span><span class="special">(</span><span class="keyword">int</span> dest<span class="special">,</span> <span class="keyword">int</span> tag<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special">&lt;</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">A</span> <span class="special">&gt;</span> <span class="special">&amp;</span> values<span class="special">,</span>
1108                        <span class="identifier">mpl</span><span class="special">::</span><span class="identifier">true_</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
1109 <li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="keyword">typename</span> A<span class="special">&gt;</span>
1110   <span class="keyword">void</span> <a name="id-1_3_27_7_6_2_1_1_7_3-bb"></a><span class="identifier">send_vector</span><span class="special">(</span><span class="keyword">int</span> dest<span class="special">,</span> <span class="keyword">int</span> tag<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special">&lt;</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">A</span> <span class="special">&gt;</span> <span class="special">&amp;</span> value<span class="special">,</span>
1111                    <span class="identifier">mpl</span><span class="special">::</span><span class="identifier">true_</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
1112 <li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="keyword">typename</span> A<span class="special">&gt;</span>
1113   <a class="link" href="status.html" title="Class status">status</a> <a name="id-1_3_27_7_6_2_1_1_7_4-bb"></a><span class="identifier">recv_vector</span><span class="special">(</span><span class="keyword">int</span> source<span class="special">,</span> <span class="keyword">int</span> tag<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special">&lt;</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">A</span> <span class="special">&gt;</span> <span class="special">&amp;</span> value<span class="special">,</span>
1114                      <span class="identifier">mpl</span><span class="special">::</span><span class="identifier">true_</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
1115 <li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="keyword">typename</span> A<span class="special">&gt;</span>
1116   <a class="link" href="request.html" title="Class request">request</a> <a name="id-1_3_27_7_6_2_1_1_7_5-bb"></a><span class="identifier">irecv_vector</span><span class="special">(</span><span class="keyword">int</span> source<span class="special">,</span> <span class="keyword">int</span> tag<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special">&lt;</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">A</span> <span class="special">&gt;</span> <span class="special">&amp;</span> values<span class="special">,</span>
1117                        <span class="identifier">mpl</span><span class="special">::</span><span class="identifier">false_</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
1118 <li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="keyword">typename</span> A<span class="special">&gt;</span>
1119   <a class="link" href="request.html" title="Class request">request</a> <a name="id-1_3_27_7_6_2_1_1_7_6-bb"></a><span class="identifier">isend_vector</span><span class="special">(</span><span class="keyword">int</span> dest<span class="special">,</span> <span class="keyword">int</span> tag<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special">&lt;</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">A</span> <span class="special">&gt;</span> <span class="special">&amp;</span> values<span class="special">,</span>
1120                        <span class="identifier">mpl</span><span class="special">::</span><span class="identifier">false_</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
1121 <li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="keyword">typename</span> A<span class="special">&gt;</span>
1122   <span class="keyword">void</span> <a name="id-1_3_27_7_6_2_1_1_7_7-bb"></a><span class="identifier">send_vector</span><span class="special">(</span><span class="keyword">int</span> dest<span class="special">,</span> <span class="keyword">int</span> tag<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special">&lt;</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">A</span> <span class="special">&gt;</span> <span class="special">&amp;</span> value<span class="special">,</span>
1123                    <span class="identifier">mpl</span><span class="special">::</span><span class="identifier">false_</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
1124 <li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="keyword">typename</span> A<span class="special">&gt;</span>
1125   <a class="link" href="status.html" title="Class status">status</a> <a name="id-1_3_27_7_6_2_1_1_7_8-bb"></a><span class="identifier">recv_vector</span><span class="special">(</span><span class="keyword">int</span> source<span class="special">,</span> <span class="keyword">int</span> tag<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special">&lt;</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">A</span> <span class="special">&gt;</span> <span class="special">&amp;</span> value<span class="special">,</span>
1126                      <span class="identifier">mpl</span><span class="special">::</span><span class="identifier">false_</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
1127 </ol></div>
1128 </div>
1129 </div>
1130 </div>
1131 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
1132 <td align="left"></td>
1133 <td align="right"><div class="copyright-footer">Copyright &#169; 2005-2007 Douglas Gregor,
1134       Matthias Troyer, Trustees of Indiana University<p>
1135         Distributed under the Boost Software License, Version 1.0. (See accompanying
1136         file LICENSE_1_0.txt or copy at &lt;ulink url="http://www.boost.org/LICENSE_1_0.txt"&gt;
1137         http://www.boost.org/LICENSE_1_0.txt &lt;/ulink&gt;)
1138       </p>
1139 </div></td>
1140 </tr></table>
1141 <hr>
1142 <div class="spirit-nav">
1143 <a accesskey="p" href="scan.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../mpi/reference.html#header.boost.mpi.communicator_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="comm_create_kind.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
1144 </div>
1145 </body>
1146 </html>