1<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> 2<html> 3<head> 4<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 5<title>Function scatterv</title> 6<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> 7<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> 8<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> 9<link rel="up" href="../../mpi/reference.html#header.boost.mpi.collectives_hpp" title="Header <boost/mpi/collectives.hpp>"> 10<link rel="prev" href="scatter.html" title="Function scatter"> 11<link rel="next" href="reduce.html" title="Function reduce"> 12</head> 13<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> 14<table cellpadding="2" width="100%"><tr> 15<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> 16<td align="center"><a href="../../../../index.html">Home</a></td> 17<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> 18<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> 19<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> 20<td align="center"><a href="../../../../more/index.htm">More</a></td> 21</tr></table> 22<hr> 23<div class="spirit-nav"> 24<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> 25</div> 26<div class="refentry"> 27<a name="boost.mpi.scatterv"></a><div class="titlepage"></div> 28<div class="refnamediv"> 29<h2><span class="refentrytitle">Function scatterv</span></h2> 30<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> 31</div> 32<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> 33<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>> 34 35</span> 36<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> 37 <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> 38 <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> 39 <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> 40 <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> 41<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> 42 <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> 43 <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> 44 <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> 45 <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> 46<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> 47 <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> 48 <span class="keyword">int</span> root<span class="special">)</span><span class="special">;</span> 49<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> 50 <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> 51 <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> 52<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> 53 <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> 54 <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> 55<div class="refsect1"> 56<a name="id-1.3.27.7.5.11.4"></a><h2>Description</h2> 57<p> 58</p> 59<div class="variablelist"><table border="0" class="variablelist compact"> 60<colgroup> 61<col align="left" valign="top"> 62<col> 63</colgroup> 64<tbody><tr> 65<td><p><span class="term">Parameters:</span></p></td> 66<td><div class="variablelist"><table border="0" class="variablelist compact"> 67<colgroup> 68<col align="left" valign="top"> 69<col> 70</colgroup> 71<tbody> 72<tr> 73<td><p><span class="term"><code class="computeroutput">comm</code></span></p></td> 74<td><p>The communicator over which the scatter will occur.</p></td> 75</tr> 76<tr> 77<td><p><span class="term"><code class="computeroutput">displs</code></span></p></td> 78<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> 79</tr> 80<tr> 81<td><p><span class="term"><code class="computeroutput">in_values</code></span></p></td> 82<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> 83</tr> 84<tr> 85<td><p><span class="term"><code class="computeroutput">out_size</code></span></p></td> 86<td><p>For each non-root process this will contain the size of <code class="computeroutput">out_values</code>.</p></td> 87</tr> 88<tr> 89<td><p><span class="term"><code class="computeroutput">out_values</code></span></p></td> 90<td><p>The array of values received by each process.</p></td> 91</tr> 92<tr> 93<td><p><span class="term"><code class="computeroutput">root</code></span></p></td> 94<td><p>The process ID number that will scatter the values. This value must be the same on all processes. </p></td> 95</tr> 96<tr> 97<td><p><span class="term"><code class="computeroutput">sizes</code></span></p></td> 98<td><p>A vector containing the number of elements each non-root process will receive.</p></td> 99</tr> 100</tbody> 101</table></div></td> 102</tr></tbody> 103</table></div> 104</div> 105</div> 106<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 107<td align="left"></td> 108<td align="right"><div class="copyright-footer">Copyright © 2005-2007 Douglas Gregor, 109 Matthias Troyer, Trustees of Indiana University<p> 110 Distributed under the Boost Software License, Version 1.0. (See accompanying 111 file LICENSE_1_0.txt or copy at <ulink url="http://www.boost.org/LICENSE_1_0.txt"> 112 http://www.boost.org/LICENSE_1_0.txt </ulink>) 113 </p> 114</div></td> 115</tr></table> 116<hr> 117<div class="spirit-nav"> 118<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> 119</div> 120</body> 121</html> 122
