1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>Function inclusive_scan</title> 5<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> 6<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> 7<link rel="home" href="../../index.html" title="Chapter 1. Boost.Compute"> 8<link rel="up" href="../../boost_compute/reference.html#header.boost.compute.algorithm.inclusive_scan_hpp" title="Header <boost/compute/algorithm/inclusive_scan.hpp>"> 9<link rel="prev" href="includes.html" title="Function template includes"> 10<link rel="next" href="inner_product.html" title="Function inner_product"> 11</head> 12<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> 13<table cellpadding="2" width="100%"><tr> 14<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> 15<td align="center"><a href="../../../../../../index.html">Home</a></td> 16<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> 17<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> 18<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> 19<td align="center"><a href="../../../../../../more/index.htm">More</a></td> 20</tr></table> 21<hr> 22<div class="spirit-nav"> 23<a accesskey="p" href="includes.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_compute/reference.html#header.boost.compute.algorithm.inclusive_scan_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="inner_product.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> 24</div> 25<div class="refentry"> 26<a name="boost.compute.inclusive_scan"></a><div class="titlepage"></div> 27<div class="refnamediv"> 28<h2><span class="refentrytitle">Function inclusive_scan</span></h2> 29<p>boost::compute::inclusive_scan</p> 30</div> 31<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> 32<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="../../boost_compute/reference.html#header.boost.compute.algorithm.inclusive_scan_hpp" title="Header <boost/compute/algorithm/inclusive_scan.hpp>">boost/compute/algorithm/inclusive_scan.hpp</a>> 33 34</span> 35<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> InputIterator<span class="special">,</span> <span class="keyword">typename</span> OutputIterator<span class="special">,</span> 36 <span class="keyword">typename</span> BinaryOperator<span class="special">></span> 37 <span class="identifier">OutputIterator</span> 38 <span class="identifier">inclusive_scan</span><span class="special">(</span><span class="identifier">InputIterator</span> first<span class="special">,</span> <span class="identifier">InputIterator</span> last<span class="special">,</span> 39 <span class="identifier">OutputIterator</span> result<span class="special">,</span> <span class="identifier">BinaryOperator</span> binary_op<span class="special">,</span> 40 <span class="identifier">command_queue</span> <span class="special">&</span> queue <span class="special">=</span> <span class="identifier">system</span><span class="special">::</span><span class="identifier">default_queue</span><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span> 41<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> InputIterator<span class="special">,</span> <span class="keyword">typename</span> OutputIterator<span class="special">></span> 42 <span class="identifier">OutputIterator</span> 43 <span class="identifier">inclusive_scan</span><span class="special">(</span><span class="identifier">InputIterator</span> first<span class="special">,</span> <span class="identifier">InputIterator</span> last<span class="special">,</span> 44 <span class="identifier">OutputIterator</span> result<span class="special">,</span> 45 <span class="identifier">command_queue</span> <span class="special">&</span> queue <span class="special">=</span> <span class="identifier">system</span><span class="special">::</span><span class="identifier">default_queue</span><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span></pre></div> 46<div class="refsect1"> 47<a name="idm45849521615056"></a><h2>Description</h2> 48<p>Performs an inclusive scan of the elements in the range [<code class="computeroutput">first</code>, <code class="computeroutput">last</code>) and stores the results in the range beginning at <code class="computeroutput">result</code>.</p> 49<p>Each element in the output is assigned to the sum of the current value in the input with the sum of every previous value in the input.</p> 50<p> 51 52The default operation is to add the elements up.</p> 53<pre class="programlisting"></pre> 54<p> But different associative operation can be specified as <code class="computeroutput">binary_op</code> instead (e.g., multiplication, maximum, minimum).</p> 55<pre class="programlisting"></pre> 56<p> Space complexity on GPUs: \Omega(n)<br> 57 Space complexity on GPUs when <code class="computeroutput">first</code> == <code class="computeroutput">result:</code> \Omega(2n)<br> 58 Space complexity on CPUs: \Omega(1)</p> 59<p><span class="bold"><strong>See Also:</strong></span></p> 60<p>exclusive_scan() </p> 61<p> 62</p> 63<p> 64</p> 65<div class="variablelist"><table border="0" class="variablelist compact"> 66<colgroup> 67<col align="left" valign="top"> 68<col> 69</colgroup> 70<tbody> 71<tr> 72<td><p><span class="term">Parameters:</span></p></td> 73<td><div class="variablelist"><table border="0" class="variablelist compact"> 74<colgroup> 75<col align="left" valign="top"> 76<col> 77</colgroup> 78<tbody> 79<tr> 80<td><p><span class="term"><code class="computeroutput">binary_op</code></span></p></td> 81<td><p>associative binary operator </p></td> 82</tr> 83<tr> 84<td><p><span class="term"><code class="computeroutput">first</code></span></p></td> 85<td><p>first element in the range to scan </p></td> 86</tr> 87<tr> 88<td><p><span class="term"><code class="computeroutput">last</code></span></p></td> 89<td><p>last element in the range to scan </p></td> 90</tr> 91<tr> 92<td><p><span class="term"><code class="computeroutput">queue</code></span></p></td> 93<td><p>command queue to perform the operation</p></td> 94</tr> 95<tr> 96<td><p><span class="term"><code class="computeroutput">result</code></span></p></td> 97<td><p>first element in the result range </p></td> 98</tr> 99</tbody> 100</table></div></td> 101</tr> 102<tr> 103<td><p><span class="term">Returns:</span></p></td> 104<td><p><code class="computeroutput">OutputIterator</code> to the end of the result range</p></td> 105</tr> 106</tbody> 107</table></div> 108</div> 109</div> 110<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 111<td align="left"></td> 112<td align="right"><div class="copyright-footer">Copyright © 2013, 2014 Kyle Lutz<p> 113 Distributed under the Boost Software License, Version 1.0. (See accompanying 114 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>) 115 </p> 116</div></td> 117</tr></table> 118<hr> 119<div class="spirit-nav"> 120<a accesskey="p" href="includes.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_compute/reference.html#header.boost.compute.algorithm.inclusive_scan_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="inner_product.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> 121</div> 122</body> 123</html> 124
