diff options
Diffstat (limited to 'doc/html/boost/mpi/scan.html')
| -rw-r--r-- | doc/html/boost/mpi/scan.html | 14 |
1 files changed, 4 insertions, 10 deletions
diff --git a/doc/html/boost/mpi/scan.html b/doc/html/boost/mpi/scan.html index f1daf88e08..eefe71e04b 100644 --- a/doc/html/boost/mpi/scan.html +++ b/doc/html/boost/mpi/scan.html @@ -4,7 +4,7 @@ <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> <title>Function scan</title> <link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> -<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.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 <boost/mpi/collectives.hpp>"> <link rel="prev" href="reduce.html" title="Function reduce"> @@ -42,25 +42,19 @@ <span class="keyword">void</span> <span class="identifier">scan</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> <span class="keyword">const</span> <span class="identifier">T</span> <span class="special">*</span> in_values<span class="special">,</span> <span class="keyword">int</span> n<span class="special">,</span> <span class="identifier">T</span> <span class="special">*</span> out_values<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="idm45555223575024"></a><h2>Description</h2> +<a name="idp303695648"></a><h2>Description</h2> <p><code class="computeroutput">scan</code> is a collective algorithm that combines the values stored by each process with the values of all processes with a smaller rank. The values can be arbitrarily combined, specified via a function object <code class="computeroutput">op</code>. 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">gather</code> to some process, followed by an <code class="computeroutput">std::prefix_sum()</code> over the gathered values using the operation <code class="computeroutput">op</code>. The ith process returns the ith value emitted by <code class="computeroutput">std::prefix_sum()</code>.</p> <p>When the type <code class="computeroutput">T</code> has an associated MPI data type, this routine invokes <code class="computeroutput">MPI_Scan</code> to perform the reduction. If possible, built-in MPI operations will be used; otherwise, <code class="computeroutput">scan()</code> will create a custom <code class="computeroutput">MPI_Op</code> for the call to MPI_Scan.</p> <p> </p> -<div class="variablelist"><table border="0" class="variablelist compact"> -<colgroup> +<div class="variablelist"><table border="0"> <col align="left" valign="top"> -<col> -</colgroup> <tbody> <tr> <td><p><span class="term">Parameters:</span></p></td> -<td><div class="variablelist"><table border="0" class="variablelist compact"> -<colgroup> +<td><div class="variablelist"><table border="0"> <col align="left" valign="top"> -<col> -</colgroup> <tbody> <tr> <td><p><span class="term"><code class="computeroutput">comm</code></span></p></td> |