compute/doc/reference/algorithm/inclusive_scan.xml

<?xml version="1.0" encoding="utf-8"?>
<header name="boost/compute/algorithm/inclusive_scan.hpp">
  <namespace name="boost">
    <namespace name="compute">

      <!-- boost::compute::inclusive_scan(first, last, result, queue) -->
      <function name="inclusive_scan">
        <template>
          <template-type-parameter name="InputIterator"/>
          <template-type-parameter name="OutputIterator"/>
        </template>

        <type>OutputIterator</type>

        <parameter name="first">
          <paramtype>InputIterator</paramtype>
        </parameter>
        <parameter name="last">
          <paramtype>InputIterator</paramtype>
        </parameter>
        <parameter name="result">
          <paramtype>OutputIterator</paramtype>
        </parameter>
        <parameter name="queue">
          <paramtype>command_queue &amp;</paramtype>
        </parameter>

        <returns>
          An iterator pointing to the end of the result range.
        </returns>

        <description>
          <para>
            Performs an inclusive scan on the elements in the range
            [<code>first</code>, <code>last</code>) and stores the results in
            the range beginning at <code>result</code>.
          </para>
          <para>
            See also: <functionname>exclusive_scan()</functionname>
          </para>
        </description>
      </function>
    </namespace>
  </namespace>
</header>