1// <experimental/algorithm> -*- C++ -*-
3// Copyright (C) 2014-2021 Free Software Foundation, Inc.
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)
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.
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.
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/>.
25/** @file experimental/algorithm
26 * This is a TS C++ Library header.
30#ifndef _GLIBCXX_EXPERIMENTAL_ALGORITHM
31#define _GLIBCXX_EXPERIMENTAL_ALGORITHM 1
33#pragma GCC system_header
35#if __cplusplus >= 201402L
38#include <experimental/bits/lfts_config.h>
39#include <experimental/random>
41namespace std _GLIBCXX_VISIBILITY(default)
43_GLIBCXX_BEGIN_NAMESPACE_VERSION
47inline namespace fundamentals_v2
49 template<typename _ForwardIterator, typename _Searcher>
50 inline _ForwardIterator
51 search(_ForwardIterator __first, _ForwardIterator __last,
52 const _Searcher& __searcher)
53 { return __searcher(__first, __last); }
55#define __cpp_lib_experimental_sample 201402
57 /// Take a random sample from a population.
58 template<typename _PopulationIterator, typename _SampleIterator,
59 typename _Distance, typename _UniformRandomNumberGenerator>
61 sample(_PopulationIterator __first, _PopulationIterator __last,
62 _SampleIterator __out, _Distance __n,
63 _UniformRandomNumberGenerator&& __g)
65 using __pop_cat = typename
66 std::iterator_traits<_PopulationIterator>::iterator_category;
67 using __samp_cat = typename
68 std::iterator_traits<_SampleIterator>::iterator_category;
71 __or_<is_convertible<__pop_cat, forward_iterator_tag>,
72 is_convertible<__samp_cat, random_access_iterator_tag>>::value,
73 "output range must use a RandomAccessIterator when input range"
74 " does not meet the ForwardIterator requirements");
76 static_assert(is_integral<_Distance>::value,
77 "sample size must be an integer type");
79 typename iterator_traits<_PopulationIterator>::difference_type __d = __n;
80 return _GLIBCXX_STD_A::
81 __sample(__first, __last, __pop_cat{}, __out, __samp_cat{}, __d,
82 std::forward<_UniformRandomNumberGenerator>(__g));
85 template<typename _PopulationIterator, typename _SampleIterator,
87 inline _SampleIterator
88 sample(_PopulationIterator __first, _PopulationIterator __last,
89 _SampleIterator __out, _Distance __n)
91 return experimental::sample(__first, __last, __out, __n,
95 template<typename _RandomAccessIterator>
97 shuffle(_RandomAccessIterator __first, _RandomAccessIterator __last)
98 { return std::shuffle(__first, __last, _S_randint_engine()); }
100} // namespace fundamentals_v2
101} // namespace experimental
103_GLIBCXX_END_NAMESPACE_VERSION
108#endif // _GLIBCXX_EXPERIMENTAL_ALGORITHM