命名空间
变体
操作

std::random_shuffle, std::shuffle

来自 cppreference.cn
< cpp‎ | 算法
 
 
算法库
有约束算法与针对范围的算法 (C++20)
有约束的算法,例如 ranges::copyranges::sort 等……
执行策略 (C++17)
排序及相关操作
划分操作
排序操作
二分搜索操作
(于已划分范围上)
集合操作(于已排序范围上)
归并操作(于已排序范围上)
堆操作
最小/最大值操作
(C++11)
(C++17)
字典序比较操作
排列操作
C 库
数值操作
未初始化内存上的操作
 
定义于头文件 <algorithm>
template< class RandomIt >
void random_shuffle( RandomIt first, RandomIt last );
(1) (C++14 中已弃用)
(在 C++17 中已移除)
(2)
template< class RandomIt, class RandomFunc >
void random_shuffle( RandomIt first, RandomIt last, RandomFunc& r );
(C++11 前)
template< class RandomIt, class RandomFunc >
void random_shuffle( RandomIt first, RandomIt last, RandomFunc&& r );
(C++11 起)
(C++14 中已弃用)
(在 C++17 中已移除)
template< class RandomIt, class URBG >
void shuffle( RandomIt first, RandomIt last, URBG&& g );
(3) (C++11 起)

重新排列给定范围 [firstlast) 中的元素,使得这些元素所有可能的排列都具有相同的出现概率。

1) 随机源是实现定义的,但通常使用函数 std::rand
2) 随机源是函数对象 r
如果满足以下任何条件,则行为未定义:
  • r 的返回类型不可转换为 std::iterator_traits<RandomIt>::difference_type
  • 给定类型为 std::iterator_traits<RandomIt>::difference_type 的正值 nr(n) 的结果不是区间 [0n) 中随机选择的值。
3) 随机源是对象 g
假定类型 Tstd::remove_reference_t<URBG>,如果满足以下任何条件,则行为未定义:
(C++20 前)

如果*first 的类型不是 Swappable(C++11 前)RandomIt 不是 ValueSwappable(C++11 起),则行为未定义。

目录

[编辑] 参数

first, last - 定义要随机洗牌的元素范围的迭代器对
r - 返回随机选择值的函数对象
g - 返回随机选择值的生成器对象
类型要求
-
RandomIt 必须满足 LegacyRandomAccessIterator 的要求。

[编辑] 复杂度

恰好 std::distance(first, last) - 1 次交换。

[编辑] 可能实现

另请参阅 libstdc++libc++ 中的实现。

random_shuffle (1)
template<class RandomIt>
void random_shuffle(RandomIt first, RandomIt last)
{
    typedef typename std::iterator_traits<RandomIt>::difference_type diff_t;
 
    for (diff_t i = last - first - 1; i > 0; --i)
    {
        using std::swap;
        swap(first[i], first[std::rand() % (i + 1)]);
        // rand() % (i + 1) is not actually correct, because the generated number is
        // not uniformly distributed for most values of i. The correct code would be
        // a variation of the C++11 std::uniform_int_distribution implementation.
    }
}
random_shuffle (2)
template<class RandomIt, class RandomFunc>
void random_shuffle(RandomIt first, RandomIt last, RandomFunc&& r)
{
    typedef typename std::iterator_traits<RandomIt>::difference_type diff_t;
 
    for (diff_t i = last - first - 1; i > 0; --i)
    {
        using std::swap;
        swap(first[i], first[r(i + 1)]);
    }
}
shuffle (3)
template<class RandomIt, class URBG>
void shuffle(RandomIt first, RandomIt last, URBG&& g)
{
    typedef typename std::iterator_traits<RandomIt>::difference_type diff_t;
    typedef std::uniform_int_distribution<diff_t> distr_t;
    typedef typename distr_t::param_type param_t;
 
    distr_t D;
    for (diff_t i = last - first - 1; i > 0; --i)
    {
        using std::swap;
        swap(first[i], first[D(g, param_t(0, i))]);
    }
}

[编辑] 注意

请注意,该实现并非由标准规定,因此即使您使用完全相同的 RandomFuncURBG (统一随机数生成器),您也可能在不同的标准库实现中获得不同的结果。

C++17 中删除 std::random_shuffle 的原因是,仅迭代器版本通常依赖于 std::rand,而该函数目前也正在讨论弃用。(std::rand 应该替换为 <random> 头文件中的类,因为 std::rand 被认为是“有害的”。)此外,仅迭代器版本的 std::random_shuffle 通常依赖于全局状态。std::shuffle 的洗牌算法是首选替代方案,因为它使用 URBG 作为其第三个参数。

[编辑] 示例

随机洗牌整数序列 [110]

#include <algorithm>
#include <iostream>
#include <iterator>
#include <random>
#include <vector>
 
int main()
{
    std::vector<int> v{1, 2, 3, 4, 5, 6, 7, 8, 9, 10};
 
    std::random_device rd;
    std::mt19937 g(rd());
 
    std::shuffle(v.begin(), v.end(), g);
 
    std::copy(v.begin(), v.end(), std::ostream_iterator<int>(std::cout, " "));
    std::cout << '\n';
}

可能的输出

8 6 10 4 2 3 7 1 9 5

[编辑] 缺陷报告

下列更改行为的缺陷报告追溯地应用于以前出版的 C++ 标准。

缺陷报告 应用于 发布时的行为 正确的行为
LWG 395 C++98 重载 (1) 的随机源未指定,且
由于 C 库要求,std::rand 不能作为源
它是实现定义的,
并且允许使用 std::rand
LWG 552
(N2423)
C++98 未要求 r 作为
重载 (2) 的随机源[1]
需要
  1. 重载 (3) 存在相同的缺陷,但该部分的解决方案不适用于 C++98。

[编辑] 另请参阅

生成元素范围的下一个更大的字典序排列
(函数模板) [编辑]
生成元素范围的下一个更小的字典序排列
(函数模板) [编辑]
随机地重排一个范围中的元素
(算法函数对象)[编辑]