shuffle.hpp 3.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990
  1. /// \file
  2. // Range v3 library
  3. //
  4. // Copyright Eric Niebler 2014-present
  5. //
  6. // Use, modification and distribution is subject to the
  7. // Boost Software License, Version 1.0. (See accompanying
  8. // file LICENSE_1_0.txt or copy at
  9. // http://www.boost.org/LICENSE_1_0.txt)
  10. //
  11. // Project home: https://github.com/ericniebler/range-v3
  12. //
  13. #ifndef RANGES_V3_ALGORITHM_SHUFFLE_HPP
  14. #define RANGES_V3_ALGORITHM_SHUFFLE_HPP
  15. #include <cstdint>
  16. #include <utility>
  17. #include <range/v3/range_fwd.hpp>
  18. #include <range/v3/functional/invoke.hpp>
  19. #include <range/v3/iterator/concepts.hpp>
  20. #include <range/v3/iterator/traits.hpp>
  21. #include <range/v3/range/access.hpp>
  22. #include <range/v3/range/concepts.hpp>
  23. #include <range/v3/range/dangling.hpp>
  24. #include <range/v3/range/traits.hpp>
  25. #include <range/v3/utility/random.hpp>
  26. #include <range/v3/utility/static_const.hpp>
  27. #include <range/v3/utility/swap.hpp>
  28. #include <range/v3/detail/prologue.hpp>
  29. namespace ranges
  30. {
  31. /// \addtogroup group-algorithms
  32. /// @{
  33. RANGES_FUNC_BEGIN(shuffle)
  34. /// \brief function template \c shuffle
  35. template(typename I, typename S, typename Gen = detail::default_random_engine &)(
  36. requires random_access_iterator<I> AND sentinel_for<S, I> AND
  37. permutable<I> AND
  38. uniform_random_bit_generator<std::remove_reference_t<Gen>> AND
  39. convertible_to<invoke_result_t<Gen &>, iter_difference_t<I>>)
  40. I RANGES_FUNC(shuffle)(I const first,
  41. S const last,
  42. Gen && gen = detail::get_random_engine()) //
  43. {
  44. auto mid = first;
  45. if(mid == last)
  46. return mid;
  47. using D1 = iter_difference_t<I>;
  48. using D2 =
  49. meta::conditional_t<std::is_integral<D1>::value, D1, std::ptrdiff_t>;
  50. std::uniform_int_distribution<D2> uid{};
  51. using param_t = typename decltype(uid)::param_type;
  52. while(++mid != last)
  53. {
  54. RANGES_ENSURE(mid - first <= PTRDIFF_MAX);
  55. if(auto const i = uid(gen, param_t{0, D2(mid - first)}))
  56. ranges::iter_swap(mid - i, mid);
  57. }
  58. return mid;
  59. }
  60. /// \overload
  61. template(typename Rng, typename Gen = detail::default_random_engine &)(
  62. requires random_access_range<Rng> AND permutable<iterator_t<Rng>> AND
  63. uniform_random_bit_generator<std::remove_reference_t<Gen>> AND
  64. convertible_to<invoke_result_t<Gen &>,
  65. iter_difference_t<iterator_t<Rng>>>)
  66. borrowed_iterator_t<Rng> //
  67. RANGES_FUNC(shuffle)(Rng && rng, Gen && rand = detail::get_random_engine()) //
  68. {
  69. return (*this)(begin(rng), end(rng), static_cast<Gen &&>(rand));
  70. }
  71. RANGES_FUNC_END(shuffle)
  72. namespace cpp20
  73. {
  74. using ranges::shuffle;
  75. }
  76. /// @}
  77. } // namespace ranges
  78. #include <range/v3/detail/epilogue.hpp>
  79. #endif