diff options
Diffstat (limited to 'doc/html/boost/mpi/gather_idp667893312.html')
| -rw-r--r-- | doc/html/boost/mpi/gather_idp667893312.html | 108 |
1 files changed, 0 insertions, 108 deletions
diff --git a/doc/html/boost/mpi/gather_idp667893312.html b/doc/html/boost/mpi/gather_idp667893312.html deleted file mode 100644 index c6ff956185..0000000000 --- a/doc/html/boost/mpi/gather_idp667893312.html +++ /dev/null @@ -1,108 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<title>Function gather</title> -<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 <boost/mpi/collectives.hpp>"> -<link rel="prev" href="broadcast.html" title="Function broadcast"> -<link rel="next" href="gatherv.html" title="Function gatherv"> -</head> -<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> -<table cellpadding="2" width="100%"><tr> -<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> -<td align="center"><a href="../../../../index.html">Home</a></td> -<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> -<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> -<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> -<td align="center"><a href="../../../../more/index.htm">More</a></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="broadcast.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="gatherv.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> -</div> -<div class="refentry"> -<a name="boost.mpi.gather_idp667893312"></a><div class="titlepage"></div> -<div class="refnamediv"> -<h2><span class="refentrytitle">Function gather</span></h2> -<p>boost::mpi::gather — Gather the values stored at every process into a vector at the root process. </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: <<a class="link" href="../../mpi/reference.html#header.boost.mpi.collectives_hpp" title="Header <boost/mpi/collectives.hpp>">boost/mpi/collectives.hpp</a>> - -</span> -<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> - <span class="keyword">void</span> <span class="identifier">gather</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_value<span class="special">,</span> - <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span> <span class="identifier">T</span> <span class="special">></span> <span class="special">&</span> out_values<span class="special">,</span> <span class="keyword">int</span> root<span class="special">)</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="keyword">void</span> <span class="identifier">gather</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_value<span class="special">,</span> <span class="identifier">T</span> <span class="special">*</span> out_values<span class="special">,</span> - <span class="keyword">int</span> root<span class="special">)</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="keyword">void</span> <span class="identifier">gather</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_value<span class="special">,</span> <span class="keyword">int</span> root<span class="special">)</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="keyword">void</span> <span class="identifier">gather</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">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span> <span class="identifier">T</span> <span class="special">></span> <span class="special">&</span> out_values<span class="special">,</span> <span class="keyword">int</span> root<span class="special">)</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="keyword">void</span> <span class="identifier">gather</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="keyword">int</span> root<span class="special">)</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="keyword">void</span> <span class="identifier">gather</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="keyword">int</span> root<span class="special">)</span><span class="special">;</span></pre></div> -<div class="refsect1"> -<a name="idp417809360"></a><h2>Description</h2> -<p><code class="computeroutput">gather</code> is a collective algorithm that collects the values stored at each process into a vector of values at the <code class="computeroutput">root</code> process. This vector is indexed by the process number that the value came from. The type <code class="computeroutput">T</code> of the values may be any type that is serializable or has an associated MPI data type.</p> -<p>When the type <code class="computeroutput">T</code> has an associated MPI data type, this routine invokes <code class="computeroutput">MPI_Gather</code> to gather the values.</p> -<p> -</p> -<div class="variablelist"><table border="0" class="variablelist compact"> -<colgroup> -<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> -<col align="left" valign="top"> -<col> -</colgroup> -<tbody> -<tr> -<td><p><span class="term"><code class="computeroutput">comm</code></span></p></td> -<td><p>The communicator over which the gather will occur.</p></td> -</tr> -<tr> -<td><p><span class="term"><code class="computeroutput">in_value</code></span></p></td> -<td><p>The value to be transmitted by each process. For gathering arrays of values, <code class="computeroutput">in_values</code> points to storage for <code class="computeroutput">n*comm</code>.size() values.</p></td> -</tr> -<tr> -<td><p><span class="term"><code class="computeroutput">out_values</code></span></p></td> -<td><p>A vector or pointer to storage that will be populated with the values from each process, indexed by the process ID number. If it is a vector, it will be resized accordingly. For non-root processes, this parameter may be omitted. If it is still provided, however, it will be unchanged.</p></td> -</tr> -<tr> -<td><p><span class="term"><code class="computeroutput">root</code></span></p></td> -<td><p>The process ID number that will collect the values. This value must be the same on all processes. </p></td> -</tr> -</tbody> -</table></div></td> -</tr></tbody> -</table></div> -</div> -</div> -<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> -<td align="left"></td> -<td align="right"><div class="copyright-footer">Copyright © 2005-2007 Douglas Gregor, - Matthias Troyer, Trustees of Indiana University<p> - Distributed under the Boost Software License, Version 1.0. (See accompanying - file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top"> - http://www.boost.org/LICENSE_1_0.txt </a>) - </p> -</div></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="broadcast.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="gatherv.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> -</div> -</body> -</html> |