compute/doc/reference/algorithm/fill.xml

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

      <!-- boost::compute::fill(first, last, value, queue) -->
      <function name="fill">
        <template>
          <template-type-parameter name="Iterator"/>
          <template-type-parameter name="T"/>
        </template>

        <type>Iterator</type>

        <parameter name="first">
          <paramtype>Iterator</paramtype>
        </parameter>
        <parameter name="last">
          <paramtype>Iterator</paramtype>
        </parameter>
        <parameter name="value">
          <paramtype>const T&amp;</paramtype>
        </parameter>
        <parameter name="queue">
          <paramtype>command_queue &amp;</paramtype>
        </parameter>

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

        <description>
          <para>
            Fills the range [<code>first</code>, <code>last</code>) with
            <code>value</code>.
          </para>
          <para>
            If available, the <functionname>fill()</functionname> function
            will make use of the <code>clEnqueueFillBuffer()</code> function.
          </para>
        </description>
      </function>
    </namespace>
  </namespace>
</header>