std::ranges::shuffle() 算法

自 C++20 起

简化

// (1)
I shuffle( I first, S last, Gen&& gen );

// (2)
ranges::borrowed_iterator_t<R> shuffle( R&& r, Gen&& gen );

参数类型是泛型的，并具有以下约束

• I - std::random_access_iterator
• S - std::sentinel_for<I>
• R - std::ranges::random_access_range
• G - (无)

此外，每个重载都有以下约束

• (1) - permutable<I> && uniform_random_bit_generator<remove_reference_t<Gen>>
• (2) - permutable<ranges::iterator_t<R>> && uniform_random_bit_generator<remove_reference_t<Gen>>

（为便于阅读，省略了 std:: 命名空间）

详细

// (1)
template<
  std::random_access_iterator I,
  std::sentinel_for<I> S,
  class Gen
>
requires std::permutable<I> &&
         std::uniform_random_bit_generator<std::remove_reference_t<Gen>>
I shuffle( I first, S last, Gen&& gen );

// (2)
template<
  ranges::random_access_range R,
  class Gen
>
requires std::permutable<ranges::iterator_t<R>> &&
         std::uniform_random_bit_generator<std::remove_reference_t<Gen>>
ranges::borrowed_iterator_t<R> shuffle( R&& r, Gen&& gen );

• (1) 重新排列给定范围 [first; last) 中的元素，使得这些元素的每种可能的排列都具有相同的出现概率。

• (2) 与 (1) 相同，但使用 r 作为范围，如同使用 ranges::begin(r) 作为 first 和 ranges::end(r) 作为 last。

本页描述的函数类实体是niebloids。

参数

first last	要打乱的元素范围。
r	要打乱的元素范围。
gen	随机数生成器。

返回值

一个等于 last 的迭代器。

复杂度

恰好 (last - first) - 1 次交换。

异常

(无)

可能的实现

shuffle(1) 和 shuffle(2)

struct shuffle_fn
{
    template<std::random_access_iterator I, std::sentinel_for<I> S, class Gen>
    requires std::permutable<I> &&
             std::uniform_random_bit_generator<std::remove_reference_t<Gen>>
    I operator()(I first, S last, Gen&& gen) const
    {
        using diff_t = std::iter_difference_t<I>;
        using distr_t = std::uniform_int_distribution<diff_t>;
        using param_t = typename distr_t::param_type;
        distr_t D;
        const auto n {last - first};
        for (diff_t i {1}; i < n; ++i)
            ranges::iter_swap(first + i, first + D(gen, param_t(0, i)));
        return ranges::next(first, last);
    }

    template<ranges::random_access_range R, class Gen>
    requires std::permutable<ranges::iterator_t<R>> &&
             std::uniform_random_bit_generator<std::remove_reference_t<Gen>>
    ranges::borrowed_iterator_t<R> operator()(R&& r, Gen&& gen) const
    {
        return (*this)(ranges::begin(r), ranges::end(r), std::forward<Gen>(gen));
    }
};

inline constexpr shuffle_fn shuffle {};

示例

Main.cpp

#include <algorithm>
#include <array>
#include <iostream>
#include <random>

void print(const auto& a)
{
    for (const auto e : a)
        std::cout << e << ' ';
    std::cout << '\n';
}

int main()
{
    std::array a {'A', 'B', 'C', 'D', 'E', 'F'};
    print(a);

    std::random_device rd;
    std::mt19937 gen {rd()};

    for (int i {}; i != 3; ++i)
    {
        std::ranges::shuffle(a, gen);
        print(a);
    }
}

可能的输出

A B C D E F
F E A C D B
E C B F A D
B A E C F D