diff options
Diffstat (limited to 'doc/html/boost/mpi/status.html')
| -rw-r--r-- | doc/html/boost/mpi/status.html | 46 |
1 files changed, 23 insertions, 23 deletions
diff --git a/doc/html/boost/mpi/status.html b/doc/html/boost/mpi/status.html index 36d09ceefd..e5a425c6f8 100644 --- a/doc/html/boost/mpi/status.html +++ b/doc/html/boost/mpi/status.html @@ -36,56 +36,56 @@ <span class="keyword">class</span> <a class="link" href="status.html" title="Class status">status</a> <span class="special">{</span> <span class="keyword">public</span><span class="special">:</span> <span class="comment">// <a class="link" href="status.html#boost.mpi.statusconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="status.html#idp688523072-bb"><span class="identifier">status</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="status.html#idp688523360-bb"><span class="identifier">status</span></a><span class="special">(</span><span class="identifier">MPI_Status</span> <span class="keyword">const</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="status.html#idp670265632-bb"><span class="identifier">status</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="status.html#idp670265920-bb"><span class="identifier">status</span></a><span class="special">(</span><span class="identifier">MPI_Status</span> <span class="keyword">const</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="status.html#idp688505936-bb">public member functions</a></span> - <span class="keyword">int</span> <a class="link" href="status.html#idp688506496-bb"><span class="identifier">source</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="status.html#idp688508048-bb"><span class="identifier">tag</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="status.html#idp688509600-bb"><span class="identifier">error</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">bool</span> <a class="link" href="status.html#idp688511152-bb"><span class="identifier">cancelled</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <span class="identifier">optional</span><span class="special"><</span> <span class="keyword">int</span> <span class="special">></span> <a class="link" href="status.html#idp688512768-bb"><span class="identifier">count</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <a class="link" href="status.html#idp688519184-bb"><span class="keyword">operator</span> <span class="identifier">MPI_Status</span> <span class="special">&</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="status.html#idp688520912-bb"><span class="keyword">operator</span> <span class="keyword">const</span> <span class="identifier">MPI_Status</span> <span class="special">&</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="comment">// <a class="link" href="status.html#idp670248496-bb">public member functions</a></span> + <span class="keyword">int</span> <a class="link" href="status.html#idp670249056-bb"><span class="identifier">source</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="status.html#idp670250608-bb"><span class="identifier">tag</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="status.html#idp670252160-bb"><span class="identifier">error</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="status.html#idp670253712-bb"><span class="identifier">cancelled</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <span class="identifier">optional</span><span class="special"><</span> <span class="keyword">int</span> <span class="special">></span> <a class="link" href="status.html#idp670255328-bb"><span class="identifier">count</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <a class="link" href="status.html#idp670261744-bb"><span class="keyword">operator</span> <span class="identifier">MPI_Status</span> <span class="special">&</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="status.html#idp670263472-bb"><span class="keyword">operator</span> <span class="keyword">const</span> <span class="identifier">MPI_Status</span> <span class="special">&</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> <span class="comment">// public data members</span> <span class="keyword">mutable</span> <span class="keyword">int</span> <span class="identifier">m_count</span><span class="special">;</span> <span class="special">}</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp399424560"></a><h2>Description</h2> +<a name="idp418278480"></a><h2>Description</h2> <p>This structure contains status information about messages that have been received (with <code class="computeroutput">communicator::recv</code>) or can be received (returned from <code class="computeroutput">communicator::probe</code> or <code class="computeroutput">communicator::iprobe</code>). It permits access to the source of the message, message tag, error code (rarely used), or the number of elements that have been transmitted. </p> <div class="refsect2"> -<a name="idp399427648"></a><h3> +<a name="idp418281568"></a><h3> <a name="boost.mpi.statusconstruct-copy-destruct"></a><code class="computeroutput">status</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> -<li class="listitem"><pre class="literallayout"><a name="idp688523072-bb"></a><span class="identifier">status</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> -<li class="listitem"><pre class="literallayout"><a name="idp688523360-bb"></a><span class="identifier">status</span><span class="special">(</span><span class="identifier">MPI_Status</span> <span class="keyword">const</span> <span class="special">&</span> s<span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><a name="idp670265632-bb"></a><span class="identifier">status</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><a name="idp670265920-bb"></a><span class="identifier">status</span><span class="special">(</span><span class="identifier">MPI_Status</span> <span class="keyword">const</span> <span class="special">&</span> s<span class="special">)</span><span class="special">;</span></pre></li> </ol></div> </div> <div class="refsect2"> -<a name="idp399439296"></a><h3> -<a name="idp688505936-bb"></a><code class="computeroutput">status</code> public member functions</h3> +<a name="idp418293024"></a><h3> +<a name="idp670248496-bb"></a><code class="computeroutput">status</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="idp688506496-bb"></a><span class="identifier">source</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="idp670249056-bb"></a><span class="identifier">source</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Retrieve the source of the message. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">int</span> <a name="idp688508048-bb"></a><span class="identifier">tag</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="idp670250608-bb"></a><span class="identifier">tag</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Retrieve the message tag. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">int</span> <a name="idp688509600-bb"></a><span class="identifier">error</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="idp670252160-bb"></a><span class="identifier">error</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Retrieve the error code. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">bool</span> <a name="idp688511152-bb"></a><span class="identifier">cancelled</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">bool</span> <a name="idp670253712-bb"></a><span class="identifier">cancelled</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Determine whether the communication associated with this object has been successfully cancelled. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <span class="identifier">optional</span><span class="special"><</span> <span class="keyword">int</span> <span class="special">></span> <a name="idp688512768-bb"></a><span class="identifier">count</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">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <span class="identifier">optional</span><span class="special"><</span> <span class="keyword">int</span> <span class="special">></span> <a name="idp670255328-bb"></a><span class="identifier">count</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Determines the number of elements of type <code class="computeroutput">T</code> contained in the message. The type <code class="computeroutput">T</code> must have an associated data type, i.e., <code class="computeroutput">is_mpi_datatype<T></code> must derive <code class="computeroutput">mpl::true_</code>. In cases where the type <code class="computeroutput">T</code> does not match the transmitted type, this routine will return an empty <code class="computeroutput">optional<int></code>.</p> <p> </p> @@ -101,11 +101,11 @@ </table></div> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp688519184-bb"></a><span class="keyword">operator</span> <span class="identifier">MPI_Status</span> <span class="special">&</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp670261744-bb"></a><span class="keyword">operator</span> <span class="identifier">MPI_Status</span> <span class="special">&</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>References the underlying <code class="computeroutput">MPI_Status</code> </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp688520912-bb"></a><span class="keyword">operator</span> <span class="keyword">const</span> <span class="identifier">MPI_Status</span> <span class="special">&</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp670263472-bb"></a><span class="keyword">operator</span> <span class="keyword">const</span> <span class="identifier">MPI_Status</span> <span class="special">&</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>References the underlying <code class="computeroutput">MPI_Status</code> </p> </li> </ol></div> |