algorithms.html

<cxx-clause id="algorithms">
  <h1>Algorithms library</h1>

  <cxx-section id="algorithm.syn">
    <h1>Header <code>&lt;experimental/algorithm></code> synopsis</h1>

<pre><code>#include &lt;algorithm>

namespace std::experimental::inline fundamentals_v3 {

  <cxx-ref insynopsis="" to="alg.random.sample"></cxx-ref>
  template&lt;class PopulationIterator, class SampleIterator, class Distance>
  SampleIterator sample(PopulationIterator first, PopulationIterator last,
                        SampleIterator out, Distance n);

  <cxx-ref insynopsis="" to="alg.random.shuffle"></cxx-ref>
  template&lt;class RandomAccessIterator>
  void shuffle(RandomAccessIterator first, RandomAccessIterator last);

} // namespace std::experimental::inline fundamentals_v3</code></pre>

  </cxx-section>

  <cxx-section id="alg.random.sample">
    <h1>Sampling</h1>

    <cxx-function>
      <cxx-signature class="formatted">template&lt;class PopulationIterator, class SampleIterator, class Distance>
SampleIterator sample(PopulationIterator first, PopulationIterator last,
                      SampleIterator out, Distance n);</cxx-signature>
      <cxx-effects>
        Equivalent to:
        <pre><code>return ::std::sample(first, last, out, n, g);</code></pre>
        where <code>g</code> denotes
        the per-thread engine (<cxx-ref to="rand.randint"></cxx-ref>).
        To the extent that the implementation of this function makes use of
        random numbers, the object <code>g</code> serves as the
        implementation’s source of randomness.
      </cxx-effects>
    </cxx-function>
  </cxx-section>

  <cxx-section id="alg.random.shuffle">
    <h1>Shuffle</h1>
    <cxx-function>
      <cxx-signature>template&lt;class RandomAccessIterator>
  void shuffle(RandomAccessIterator first, RandomAccessIterator last);</cxx-signature>
      <cxx-preconditions><code>RandomAccessIterator</code> meets the
        <cxx-17concept>Cpp17ValueSwappable</cxx-17concept> requirements (<cxx-ref in="cxx" to="swappable.requirements"></cxx-ref>).
      </cxx-preconditions>
      <cxx-effects>Permutes the elements in the range <code>[first,last)</code>
        such that each possible permutation of those elements has equal
        probability of appearance.</cxx-effects>
      <cxx-complexity>Exactly <code>(last - first) - 1</code> swaps.</cxx-complexity>
      <cxx-remarks>To the extent that the implementation of this function
        makes use of random numbers, the per-thread engine (<cxx-ref to="rand.randint"></cxx-ref>)
        serves as the implementation's source of randomness.
      </cxx-remarks>
    </cxx-function>
  </cxx-section>
</cxx-clause>