compute/doc/reference/algorithm/copy_if.xml

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

      <!-- boost::compute::copy_if(first, last, predicate, queue) -->
      <function name="copy_if">
        <template>
          <template-type-parameter name="InputIterator"/>
          <template-type-parameter name="OutputIterator"/>
          <template-type-parameter name="Predicate"/>
        </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="predicate">
          <paramtype>Predicate</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>
            Copies each element in the range [<code>first</code>,
            <code>last</code>) for which <code>predicate</code> returns
            <code>true</code> to the range beginning at <code>result</code>.
          </para>
        </description>
      </function>
    </namespace>
  </namespace>
</header>