summaryrefslogtreecommitdiff
path: root/doc/html/boost/mpi/all_reduce.html
diff options
context:
space:
mode:
Diffstat (limited to 'doc/html/boost/mpi/all_reduce.html')
-rw-r--r--doc/html/boost/mpi/all_reduce.html10
1 files changed, 5 insertions, 5 deletions
diff --git a/doc/html/boost/mpi/all_reduce.html b/doc/html/boost/mpi/all_reduce.html
index 982800a10e..e81a16d35c 100644
--- a/doc/html/boost/mpi/all_reduce.html
+++ b/doc/html/boost/mpi/all_reduce.html
@@ -6,7 +6,7 @@
<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
-<link rel="up" href="../../mpi/reference.html#header.boost.mpi.collectives_hpp" title="Header &lt;boost/mpi/collectives.hpp&gt;">
+<link rel="up" href="../../mpi/tutorial.html#header.boost.mpi.collectives_hpp" title="Header &lt;boost/mpi/collectives.hpp&gt;">
<link rel="prev" href="all_gather.html" title="Function all_gather">
<link rel="next" href="all_to_all.html" title="Function all_to_all">
</head>
@@ -21,7 +21,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="all_gather.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../mpi/reference.html#header.boost.mpi.collectives_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="all_to_all.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
+<a accesskey="p" href="all_gather.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../mpi/tutorial.html#header.boost.mpi.collectives_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="all_to_all.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="refentry">
<a name="boost.mpi.all_reduce"></a><div class="titlepage"></div>
@@ -30,7 +30,7 @@
<p>boost::mpi::all_reduce &#8212; Combine the values stored by each process into a single value available to all processes. </p>
</div>
<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
-<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.collectives_hpp" title="Header &lt;boost/mpi/collectives.hpp&gt;">boost/mpi/collectives.hpp</a>&gt;
+<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/tutorial.html#header.boost.mpi.collectives_hpp" title="Header &lt;boost/mpi/collectives.hpp&gt;">boost/mpi/collectives.hpp</a>&gt;
</span>
<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> Op<span class="special">&gt;</span>
@@ -47,7 +47,7 @@
<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> Op<span class="special">&gt;</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">&amp;</span> comm<span class="special">,</span> <a class="link" href="inplace_t.html" title="Struct template inplace_t">inplace_t</a><span class="special">&lt;</span> <span class="identifier">T</span> <span class="special">&gt;</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="id-1.3.26.6.4.5.4"></a><h2>Description</h2>
+<a name="id-1.3.26.5.14.5.5.4"></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>
@@ -112,7 +112,7 @@ If wrapped in a <code class="computeroutput"><code class="computeroutput"><a cla
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="all_gather.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../mpi/reference.html#header.boost.mpi.collectives_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="all_to_all.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
+<a accesskey="p" href="all_gather.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../mpi/tutorial.html#header.boost.mpi.collectives_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="all_to_all.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>