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
  39 namespace std _GLIBCXX_VISIBILITY(default)
  40 {
  41 _GLIBCXX_BEGIN_NAMESPACE_VERSION
  42
  43 namespace experimental
  44 {
  45 inline namespace fundamentals_v1
  46 {
  47   template<typename _ForwardIterator, typename _Searcher>
  48     inline _ForwardIterator
  49     search(_ForwardIterator __first, _ForwardIterator __last,
  50            const _Searcher& __searcher)
  51     { return __searcher(__first, __last); }
  52
  53 #define __cpp_lib_experimental_sample 201402
  54
  55   /// Take a random sample from a population.
  56   template<typename _PopulationIterator, typename _SampleIterator,
  57            typename _Distance, typename _UniformRandomNumberGenerator>
  58     _SampleIterator
  59     sample(_PopulationIterator __first, _PopulationIterator __last,
  60            _SampleIterator __out, _Distance __n,
  61            _UniformRandomNumberGenerator&& __g)
  62     {
  63       using __pop_cat = typename
  64         std::iterator_traits<_PopulationIterator>::iterator_category;
  65       using __samp_cat = typename
  66         std::iterator_traits<_SampleIterator>::iterator_category;
  67
  68       static_assert(
  69           __or_<is_convertible<__pop_cat, forward_iterator_tag>,
  70                 is_convertible<__samp_cat, random_access_iterator_tag>>::value,
  71           "output range must use a RandomAccessIterator when input range"
  72           " does not meet the ForwardIterator requirements");
  73
  74       static_assert(is_integral<_Distance>::value,
  75                     "sample size must be an integer type");
  76
  77       typename iterator_traits<_PopulationIterator>::difference_type __d = __n;
  78       return std::__sample(__first, __last, __pop_cat{}, __out, __samp_cat{},
  79                            __d,
  80                            std::forward<_UniformRandomNumberGenerator>(__g));
  81     }
  82 } // namespace fundamentals_v1
  83 } // namespace experimental
  84
  85 _GLIBCXX_END_NAMESPACE_VERSION
  86 } // namespace std
  87
  88 #endif // C++14
  89
  90 #endif // _GLIBCXX_EXPERIMENTAL_ALGORITHM