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