diff options
| author | DongHun Kwak <dh0128.kwak@samsung.com> | 2016-10-06 10:30:07 +0900 |
|---|---|---|
| committer | DongHun Kwak <dh0128.kwak@samsung.com> | 2016-10-06 10:32:57 +0900 |
| commit | 71d216b90256936a9638f325af9bc69d720e75de (patch) | |
| tree | 9c5f682d341c7c88ad0c8e3d4b262e00b6fb691a /doc/html/boost/mpi/scatterv.html | |
| parent | 733b5d5ae2c5d625211e2985ac25728ac3f54883 (diff) | |
| download | boost-71d216b90256936a9638f325af9bc69d720e75de.tar.gz boost-71d216b90256936a9638f325af9bc69d720e75de.tar.bz2 boost-71d216b90256936a9638f325af9bc69d720e75de.zip | |
Imported Upstream version 1.59.0
Change-Id: I2dde00f4eca71df3eea9d251dcaecde18a6c90a5
Signed-off-by: DongHun Kwak <dh0128.kwak@samsung.com>
Diffstat (limited to 'doc/html/boost/mpi/scatterv.html')
| -rw-r--r-- | doc/html/boost/mpi/scatterv.html | 121 |
1 files changed, 121 insertions, 0 deletions
diff --git a/doc/html/boost/mpi/scatterv.html b/doc/html/boost/mpi/scatterv.html new file mode 100644 index 0000000000..60eb4475f0 --- /dev/null +++ b/doc/html/boost/mpi/scatterv.html @@ -0,0 +1,121 @@ +<!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 scatterv</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.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="scatter.html" title="Function scatter"> +<link rel="next" href="reduce.html" title="Function reduce"> +</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="scatter.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="reduce.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.mpi.scatterv"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Function scatterv</span></h2> +<p>boost::mpi::scatterv — Similar to boost::mpi::scatter with the difference that the number of values stored at the root process does not need to be a multiple of the communicator's size. </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">scatterv</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">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> in_values<span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span> <span class="keyword">int</span> <span class="special">></span> <span class="special">&</span> sizes<span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span> <span class="keyword">int</span> <span class="special">></span> <span class="special">&</span> displs<span class="special">,</span> <span class="identifier">T</span> <span class="special">*</span> out_values<span class="special">,</span> + <span class="keyword">int</span> out_size<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">scatterv</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">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span> <span class="keyword">int</span> <span class="special">></span> <span class="special">&</span> sizes<span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span> <span class="keyword">int</span> <span class="special">></span> <span class="special">&</span> displs<span class="special">,</span> <span class="identifier">T</span> <span class="special">*</span> out_values<span class="special">,</span> + <span class="keyword">int</span> out_size<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">scatterv</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="identifier">T</span> <span class="special">*</span> out_values<span class="special">,</span> <span class="keyword">int</span> out_size<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">scatterv</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">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span> <span class="keyword">int</span> <span class="special">></span> <span class="special">&</span> sizes<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">scatterv</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">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> in_values<span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span> <span class="keyword">int</span> <span class="special">></span> <span class="special">&</span> sizes<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></pre></div> +<div class="refsect1"> +<a name="idp337818736"></a><h2>Description</h2> +<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 scatter will occur.</p></td> +</tr> +<tr> +<td><p><span class="term"><code class="computeroutput">displs</code></span></p></td> +<td><p>A vector such that the i-th entry specifies the displacement (relative to <code class="computeroutput">in_values</code>) from which to take the outgoing data to process i. Overloaded versions for which <code class="computeroutput">displs</code> is omitted assume that the data is contiguous at the <code class="computeroutput">root</code> process.</p></td> +</tr> +<tr> +<td><p><span class="term"><code class="computeroutput">in_values</code></span></p></td> +<td><p>A vector or pointer to storage that will contain the values to send to each process, indexed by the process rank. 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">out_size</code></span></p></td> +<td><p>For each non-root process this will contain the size of <code class="computeroutput">out_values</code>.</p></td> +</tr> +<tr> +<td><p><span class="term"><code class="computeroutput">out_values</code></span></p></td> +<td><p>The array of values received by each process.</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 scatter the values. This value must be the same on all processes. </p></td> +</tr> +<tr> +<td><p><span class="term"><code class="computeroutput">sizes</code></span></p></td> +<td><p>A vector containing the number of elements each non-root process will receive.</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="scatter.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="reduce.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> |