diff options
Diffstat (limited to 'doc/html/boost/mpi/all_reduce.html')
| -rw-r--r-- | doc/html/boost/mpi/all_reduce.html | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/doc/html/boost/mpi/all_reduce.html b/doc/html/boost/mpi/all_reduce.html index 702415607b..b27862fae5 100644 --- a/doc/html/boost/mpi/all_reduce.html +++ b/doc/html/boost/mpi/all_reduce.html @@ -47,7 +47,7 @@ <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="keyword">typename</span> Op<span class="special">></span> <span class="keyword">void</span> <span class="identifier">all_reduce</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> comm<span class="special">,</span> <a class="link" href="inplace_t.html" title="Struct template inplace_t">inplace_t</a><span class="special"><</span> <span class="identifier">T</span> <span class="special">></span> value<span class="special">,</span> <span class="identifier">Op</span> op<span class="special">)</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp337158400"></a><h2>Description</h2> +<a name="idm45555224399312"></a><h2>Description</h2> <p><code class="computeroutput">all_reduce</code> is a collective algorithm that combines the values stored by each process into a single value available to all processes. The values are combined in a user-defined way, specified via a function object. The type <code class="computeroutput">T</code> of the values may be any type that is serializable or has an associated MPI data type. One can think of this operation as a <code class="computeroutput">all_gather</code>, followed by an <code class="computeroutput">std::accumulate()</code> over the gather values and using the operation <code class="computeroutput">op</code>.</p> <p>When the type <code class="computeroutput">T</code> has an associated MPI data type, this routine invokes <code class="computeroutput">MPI_Allreduce</code> to perform the reduction. If possible, built-in MPI operations will be used; otherwise, <code class="computeroutput">all_reduce()</code> will create a custom MPI_Op for the call to MPI_Allreduce.</p> <p> |