libstdc++-v3/include/experimental/algorithm

   1 // <experimental/algorithm> -*- C++ -*-
   2
   3 // Copyright (C) 2014-2025 Free Software Foundation, Inc.
   4 //
   5 // This file is part of the GNU ISO C++ Library.  This library is free
   6 // software; you can redistribute it and/or modify it under the
   7 // terms of the GNU General Public License as published by the
   8 // Free Software Foundation; either version 3, or (at your option)
   9 // any later version.
  10
  11 // This library is distributed in the hope that it will be useful,
  12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 // GNU General Public License for more details.
  15
  16 // Under Section 7 of GPL version 3, you are granted additional
  17 // permissions described in the GCC Runtime Library Exception, version
  18 // 3.1, as published by the Free Software Foundation.
  19
  20 // You should have received a copy of the GNU General Public License and
  21 // a copy of the GCC Runtime Library Exception along with this program;
  22 // see the files COPYING3 and COPYING.RUNTIME respectively.  If not, see
  23 // <http://www.gnu.org/licenses/>.
  24
  25 /** @file experimental/algorithm
  26  *  This is a TS C++ Library header.
  27  *  @ingroup libfund-ts
  28  */
  29
  30 #ifndef _GLIBCXX_EXPERIMENTAL_ALGORITHM
  31 #define _GLIBCXX_EXPERIMENTAL_ALGORITHM 1
  32
  33 #ifdef _GLIBCXX_SYSHDR
  34 #pragma GCC system_header
  35 #endif
  36
  37 #include <bits/requires_hosted.h> // experimental is currently omitted
  38
  39 #if __cplusplus >= 201402L
  40
  41 #include <algorithm>
  42 #include <experimental/bits/lfts_config.h>
  43 #include <experimental/random>
  44
  45 namespace std _GLIBCXX_VISIBILITY(default)
  46 {
  47 _GLIBCXX_BEGIN_NAMESPACE_VERSION
  48
  49 namespace experimental
  50 {
  51 inline namespace fundamentals_v2
  52 {
  53   template<typename _ForwardIterator, typename _Searcher>
  54     inline _ForwardIterator
  55     search(_ForwardIterator __first, _ForwardIterator __last,
  56            const _Searcher& __searcher)
  57     { return __searcher(__first, __last); }
  58
  59 #define __cpp_lib_experimental_sample 201402
  60
  61   /// Take a random sample from a population.
  62   template<typename _PopulationIterator, typename _SampleIterator,
  63            typename _Distance, typename _UniformRandomNumberGenerator>
  64     _SampleIterator
  65     sample(_PopulationIterator __first, _PopulationIterator __last,
  66            _SampleIterator __out, _Distance __n,
  67            _UniformRandomNumberGenerator&& __g)
  68     {
  69       using __pop_cat = typename
  70         std::iterator_traits<_PopulationIterator>::iterator_category;
  71       using __samp_cat = typename
  72         std::iterator_traits<_SampleIterator>::iterator_category;
  73
  74       static_assert(
  75           __or_<is_convertible<__pop_cat, forward_iterator_tag>,
  76                 is_convertible<__samp_cat, random_access_iterator_tag>>::value,
  77           "output range must use a RandomAccessIterator when input range"
  78           " does not meet the ForwardIterator requirements");
  79
  80       static_assert(is_integral<_Distance>::value,
  81                     "sample size must be an integer type");
  82
  83       typename iterator_traits<_PopulationIterator>::difference_type __d = __n;
  84       return _GLIBCXX_STD_A::
  85         __sample(__first, __last, __pop_cat{}, __out, __samp_cat{}, __d,
  86                  std::forward<_UniformRandomNumberGenerator>(__g));
  87     }
  88
  89   template<typename _PopulationIterator, typename _SampleIterator,
  90            typename _Distance>
  91     inline _SampleIterator
  92     sample(_PopulationIterator __first, _PopulationIterator __last,
  93            _SampleIterator __out, _Distance __n)
  94     {
  95       return experimental::sample(__first, __last, __out, __n,
  96                                   _S_randint_engine());
  97     }
  98
  99   template<typename _RandomAccessIterator>
 100     inline void
 101     shuffle(_RandomAccessIterator __first, _RandomAccessIterator __last)
 102     { return std::shuffle(__first, __last, _S_randint_engine()); }
 103
 104 } // namespace fundamentals_v2
 105 } // namespace experimental
 106
 107 _GLIBCXX_END_NAMESPACE_VERSION
 108 } // namespace std
 109
 110 #endif // C++14
 111
 112 #endif // _GLIBCXX_EXPERIMENTAL_ALGORITHM