libstdc++-v3/include/experimental/algorithm

   1 // <experimental/algorithm> -*- C++ -*-
   2
   3 // Copyright (C) 2014-2018 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  */
  28
  29 #ifndef _GLIBCXX_EXPERIMENTAL_ALGORITHM
  30 #define _GLIBCXX_EXPERIMENTAL_ALGORITHM 1
  31
  32 #pragma GCC system_header
  33
  34 #if __cplusplus >= 201402L
  35
  36 #include <algorithm>
  37 #include <experimental/bits/lfts_config.h>
  38 #include <experimental/random>
  39
  40 namespace std _GLIBCXX_VISIBILITY(default)
  41 {
  42 _GLIBCXX_BEGIN_NAMESPACE_VERSION
  43
  44 namespace experimental
  45 {
  46 inline namespace fundamentals_v2
  47 {
  48   template<typename _ForwardIterator, typename _Searcher>
  49     inline _ForwardIterator
  50     search(_ForwardIterator __first, _ForwardIterator __last,
  51            const _Searcher& __searcher)
  52     { return __searcher(__first, __last); }
  53
  54 #define __cpp_lib_experimental_sample 201402
  55
  56   /// Take a random sample from a population.
  57   template<typename _PopulationIterator, typename _SampleIterator,
  58            typename _Distance, typename _UniformRandomNumberGenerator>
  59     _SampleIterator
  60     sample(_PopulationIterator __first, _PopulationIterator __last,
  61            _SampleIterator __out, _Distance __n,
  62            _UniformRandomNumberGenerator&& __g)
  63     {
  64       using __pop_cat = typename
  65         std::iterator_traits<_PopulationIterator>::iterator_category;
  66       using __samp_cat = typename
  67         std::iterator_traits<_SampleIterator>::iterator_category;
  68
  69       static_assert(
  70           __or_<is_convertible<__pop_cat, forward_iterator_tag>,
  71                 is_convertible<__samp_cat, random_access_iterator_tag>>::value,
  72           "output range must use a RandomAccessIterator when input range"
  73           " does not meet the ForwardIterator requirements");
  74
  75       static_assert(is_integral<_Distance>::value,
  76                     "sample size must be an integer type");
  77
  78       typename iterator_traits<_PopulationIterator>::difference_type __d = __n;
  79       return std::__sample(__first, __last, __pop_cat{}, __out, __samp_cat{},
  80                            __d,
  81                            std::forward<_UniformRandomNumberGenerator>(__g));
  82     }
  83
  84   template<typename _PopulationIterator, typename _SampleIterator,
  85            typename _Distance>
  86     inline _SampleIterator
  87     sample(_PopulationIterator __first, _PopulationIterator __last,
  88            _SampleIterator __out, _Distance __n)
  89     {
  90       return experimental::sample(__first, __last, __out, __n,
  91                                   _S_randint_engine());
  92     }
  93
  94   template<typename _RandomAccessIterator>
  95     inline void
  96     shuffle(_RandomAccessIterator __first, _RandomAccessIterator __last)
  97     { return std::shuffle(__first, __last, _S_randint_engine()); }
  98
  99 } // namespace fundamentals_v2
 100 } // namespace experimental
 101
 102 _GLIBCXX_END_NAMESPACE_VERSION
 103 } // namespace std
 104
 105 #endif // C++14
 106
 107 #endif // _GLIBCXX_EXPERIMENTAL_ALGORITHM