compute/doc/reference/algorithm/partition.xml

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

      <!-- boost::compute::partition(first, last, predicate, queue) -->
      <function name="partition">
        <template>
          <template-type-parameter name="Iterator"/>
          <template-type-parameter name="UnaryPredicate"/>
        </template>

        <type>Iterator</type>

        <parameter name="first">
          <paramtype>Iterator</paramtype>
        </parameter>
        <parameter name="last">
          <paramtype>Iterator</paramtype>
        </parameter>
        <parameter name="predicate">
          <paramtype>UnaryPredicate</paramtype>
        </parameter>
        <parameter name="queue">
          <paramtype>command_queue &amp;</paramtype>
        </parameter>

        <returns>
          An iterator pointing to the end of the <code>true</code> values.
        </returns>

        <description>
          <para>
            Partitions the values in the range [<code>first</code>,
            <code>last</code>) according to <code>predicate</code>.
          </para>
          <para>
            See also: <functionname>is_partitioned()</functionname>
          </para>
        </description>
      </function>
    </namespace>
  </namespace>
</header>