diff options
Diffstat (limited to 'doc/html/boost/mpi/intercommunicator.html')
-rw-r--r-- | doc/html/boost/mpi/intercommunicator.html | 42 |
1 files changed, 21 insertions, 21 deletions
diff --git a/doc/html/boost/mpi/intercommunicator.html b/doc/html/boost/mpi/intercommunicator.html index 032adb16e5..496cb6ce9a 100644 --- a/doc/html/boost/mpi/intercommunicator.html +++ b/doc/html/boost/mpi/intercommunicator.html @@ -36,29 +36,29 @@ <span class="keyword">class</span> <a class="link" href="intercommunicator.html" title="Class intercommunicator">intercommunicator</a> <span class="special">:</span> <span class="keyword">public</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">mpi</span><span class="special">::</span><span class="identifier">communicator</span> <span class="special">{</span> <span class="keyword">public</span><span class="special">:</span> <span class="comment">// <a class="link" href="intercommunicator.html#boost.mpi.intercommunicatorconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="intercommunicator.html#idp668846336-bb"><span class="identifier">intercommunicator</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">MPI_Comm</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">comm_create_kind</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="intercommunicator.html#idp668858320-bb"><span class="identifier">intercommunicator</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">&</span><span class="special">,</span> <span class="keyword">int</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="communicator.html" title="Class communicator">communicator</a> <span class="special">&</span><span class="special">,</span> <span class="keyword">int</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="intercommunicator.html#idp688134176-bb"><span class="identifier">intercommunicator</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">MPI_Comm</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">comm_create_kind</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="intercommunicator.html#idp688146160-bb"><span class="identifier">intercommunicator</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">&</span><span class="special">,</span> <span class="keyword">int</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="communicator.html" title="Class communicator">communicator</a> <span class="special">&</span><span class="special">,</span> <span class="keyword">int</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="intercommunicator.html#idp668833040-bb">public member functions</a></span> - <span class="keyword">int</span> <a class="link" href="intercommunicator.html#idp668833600-bb"><span class="identifier">local_size</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <a class="link" href="group.html" title="Class group">boost::mpi::group</a> <a class="link" href="intercommunicator.html#idp668835216-bb"><span class="identifier">local_group</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">int</span> <a class="link" href="intercommunicator.html#idp668836960-bb"><span class="identifier">local_rank</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">int</span> <a class="link" href="intercommunicator.html#idp668838544-bb"><span class="identifier">remote_size</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <a class="link" href="group.html" title="Class group">boost::mpi::group</a> <a class="link" href="intercommunicator.html#idp668840160-bb"><span class="identifier">remote_group</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <a class="link" href="communicator.html" title="Class communicator">communicator</a> <a class="link" href="intercommunicator.html#idp668841904-bb"><span class="identifier">merge</span></a><span class="special">(</span><span class="keyword">bool</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="comment">// <a class="link" href="intercommunicator.html#idp688120880-bb">public member functions</a></span> + <span class="keyword">int</span> <a class="link" href="intercommunicator.html#idp688121440-bb"><span class="identifier">local_size</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <a class="link" href="group.html" title="Class group">boost::mpi::group</a> <a class="link" href="intercommunicator.html#idp688123056-bb"><span class="identifier">local_group</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">int</span> <a class="link" href="intercommunicator.html#idp688124800-bb"><span class="identifier">local_rank</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">int</span> <a class="link" href="intercommunicator.html#idp688126384-bb"><span class="identifier">remote_size</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <a class="link" href="group.html" title="Class group">boost::mpi::group</a> <a class="link" href="intercommunicator.html#idp688128000-bb"><span class="identifier">remote_group</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <a class="link" href="communicator.html" title="Class communicator">communicator</a> <a class="link" href="intercommunicator.html#idp688129744-bb"><span class="identifier">merge</span></a><span class="special">(</span><span class="keyword">bool</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> <span class="special">}</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp421303120"></a><h2>Description</h2> +<a name="idp397557360"></a><h2>Description</h2> <p>The <code class="computeroutput">intercommunicator</code> class provides communication facilities among processes from different groups. An intercommunicator is always associated with two process groups: one "local" process group, containing the process that initiates an MPI operation (e.g., the sender in a <code class="computeroutput">send</code> operation), and one "remote" process group, containing the process that is the target of the MPI operation.</p> <p>While intercommunicators have essentially the same point-to-point operations as intracommunicators (the latter communicate only within a single process group), all communication with intercommunicators occurs between the processes in the local group and the processes in the remote group; communication within a group must use a different (intra-)communicator. </p> <div class="refsect2"> -<a name="idp421306240"></a><h3> +<a name="idp397560480"></a><h3> <a name="boost.mpi.intercommunicatorconstruct-copy-destruct"></a><code class="computeroutput">intercommunicator</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><a name="idp668846336-bb"></a><span class="identifier">intercommunicator</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">MPI_Comm</span> <span class="special">&</span> comm<span class="special">,</span> <span class="identifier">comm_create_kind</span> kind<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp688134176-bb"></a><span class="identifier">intercommunicator</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">MPI_Comm</span> <span class="special">&</span> comm<span class="special">,</span> <span class="identifier">comm_create_kind</span> kind<span class="special">)</span><span class="special">;</span></pre> <p>Build a new Boost.MPI intercommunicator based on the MPI intercommunicator <code class="computeroutput">comm</code>.</p> <p><code class="computeroutput">comm</code> may be any valid MPI intercommunicator. 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> parameter determines how the Boost.MPI communicator will be related to <code class="computeroutput">comm:</code> </p> <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> @@ -70,7 +70,7 @@ </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp668858320-bb"></a><span class="identifier">intercommunicator</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="communicator.html" title="Class communicator">communicator</a> <span class="special">&</span> local<span class="special">,</span> <span class="keyword">int</span> local_leader<span class="special">,</span> +<pre class="literallayout"><a name="idp688146160-bb"></a><span class="identifier">intercommunicator</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="communicator.html" title="Class communicator">communicator</a> <span class="special">&</span> local<span class="special">,</span> <span class="keyword">int</span> local_leader<span class="special">,</span> <span class="keyword">const</span> <a class="link" href="communicator.html" title="Class communicator">communicator</a> <span class="special">&</span> peer<span class="special">,</span> <span class="keyword">int</span> remote_leader<span class="special">)</span><span class="special">;</span></pre> <p>Constructs a new intercommunicator whose local group is <code class="computeroutput">local</code> and whose remote group is <code class="computeroutput">peer</code>. The intercommunicator can then be used to communicate between processes in the two groups. This constructor is equivalent to a call to <code class="computeroutput">MPI_Intercomm_create</code>.</p> <p> @@ -112,31 +112,31 @@ </ol></div> </div> <div class="refsect2"> -<a name="idp421352448"></a><h3> -<a name="idp668833040-bb"></a><code class="computeroutput">intercommunicator</code> public member functions</h3> +<a name="idp397606688"></a><h3> +<a name="idp688120880-bb"></a><code class="computeroutput">intercommunicator</code> public member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><span class="keyword">int</span> <a name="idp668833600-bb"></a><span class="identifier">local_size</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">int</span> <a name="idp688121440-bb"></a><span class="identifier">local_size</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Returns the size of the local group, i.e., the number of local processes that are part of the group. </p> </li> <li class="listitem"> -<pre class="literallayout"><a class="link" href="group.html" title="Class group">boost::mpi::group</a> <a name="idp668835216-bb"></a><span class="identifier">local_group</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><a class="link" href="group.html" title="Class group">boost::mpi::group</a> <a name="idp688123056-bb"></a><span class="identifier">local_group</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Returns the local group, containing all of the local processes in this intercommunicator. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">int</span> <a name="idp668836960-bb"></a><span class="identifier">local_rank</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">int</span> <a name="idp688124800-bb"></a><span class="identifier">local_rank</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Returns the rank of this process within the local group. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">int</span> <a name="idp668838544-bb"></a><span class="identifier">remote_size</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">int</span> <a name="idp688126384-bb"></a><span class="identifier">remote_size</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Returns the size of the remote group, i.e., the number of processes that are part of the remote group. </p> </li> <li class="listitem"> -<pre class="literallayout"><a class="link" href="group.html" title="Class group">boost::mpi::group</a> <a name="idp668840160-bb"></a><span class="identifier">remote_group</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><a class="link" href="group.html" title="Class group">boost::mpi::group</a> <a name="idp688128000-bb"></a><span class="identifier">remote_group</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Returns the remote group, containing all of the remote processes in this intercommunicator. </p> </li> <li class="listitem"> -<pre class="literallayout"><a class="link" href="communicator.html" title="Class communicator">communicator</a> <a name="idp668841904-bb"></a><span class="identifier">merge</span><span class="special">(</span><span class="keyword">bool</span> high<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><a class="link" href="communicator.html" title="Class communicator">communicator</a> <a name="idp688129744-bb"></a><span class="identifier">merge</span><span class="special">(</span><span class="keyword">bool</span> high<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Merge the local and remote groups in this intercommunicator into a new intracommunicator containing the union of the processes in both groups. This method is equivalent to <code class="computeroutput">MPI_Intercomm_merge</code>.</p> <p> |