std::ranges::shuffle

 

C++

編譯器支援

自由（freestanding）與宿主（hosted）

語言

標準庫

標準庫標頭檔案

具名要求

特性測試宏 (C++20)

語言支援庫

概念庫 (C++20)

診斷庫

記憶體管理庫

超程式設計庫 (C++11)

通用工具庫

容器庫

迭代器庫

範圍庫 (C++20)

演算法庫

字串庫

文字處理庫

數值庫

日期和時間庫

輸入/輸出庫

檔案系統庫 (C++17)

併發支援庫 (C++11)

執行控制庫 (C++26)

技術規範

符號索引

外部庫

 

演算法庫

有約束演算法與針對範圍的演算法 (C++20)
有約束的演算法，例如 ranges::copy、 ranges::sort 等……
執行策略 (C++17)
is_execution_policy (C++17)   execution::seqexecution::parexecution::par_unseqexecution::unseq (C++17)    (C++17)(C++17)(C++20)	execution::sequenced_policyexecution::parallel_policyexecution::parallel_unsequenced_policyexecution::parallel_unsequenced (C++17)(C++17)(C++17)(C++20)
非修改序列操作 批次操作 for_each for_each_n (C++17) 搜尋操作 all_ofany_ofnone_of (C++11)                (C++11)(C++11) countcount_if mismatch equal findfind_iffind_if_not (C++11) find_end find_first_of adjacent_find search search_n 修改序列操作 複製操作 copycopy_if (C++11) copy_backward copy_n (C++11) move (C++11) move_backward (C++11) 交換操作 swap iter_swap swap_ranges 變換操作 replacereplace_if transform replace_copyreplace_copy_if 生成操作 fill fill_n generate generate_n 移除操作 removeremove_if unique remove_copyremove_copy_if unique_copy 順序變換操作 reverse reverse_copy rotate rotate_copy random_shuffleshuffle (C++17 前)(C++11) shift_leftshift_right (C++20)(C++20) 取樣操作 sample (C++17)	排序及相關操作 劃分操作 partition partition_copy (C++11)   stable_partition is_partitioned (C++11) partition_point (C++11) 排序操作 sort stable_sort partial_sort partial_sort_copy is_sorted (C++11) is_sorted_until (C++11) nth_element 二分搜尋操作 （於已劃分範圍上） lower_bound upper_bound equal_range binary_search 集合操作（於已排序範圍上） includes set_union set_intersection set_difference set_symmetric_difference 歸併操作（於已排序範圍上） merge inplace_merge 堆操作 push_heap pop_heap make_heap sort_heap is_heap (C++11) is_heap_until (C++11) 最小/最大值操作 max min minmax (C++11) clamp (C++17) max_element min_element minmax_element (C++11) 字典序比較操作 lexicographical_compare lexicographical_compare_three_way (C++20) 排列操作 next_permutation prev_permutation is_permutation (C++11) C 庫 qsort bsearch
數值操作
iota (C++11) inner_product adjacent_difference    accumulate reduce (C++17) transform_reduce (C++17)	partial_sum inclusive_scan (C++17)    exclusive_scan (C++17) transform_inclusive_scan (C++17) transform_exclusive_scan (C++17)
未初始化記憶體上的操作
uninitialized_copy uninitialized_move (C++17)    uninitialized_fill uninitialized_copy_n (C++11) uninitialized_move_n (C++17) uninitialized_fill_n	destroy (C++17) destroy_n (C++17) destroy_at (C++17) construct_at (C++20)       uninitialized_default_construct (C++17) uninitialized_value_construct (C++17) uninitialized_default_construct_n (C++17) uninitialized_value_construct_n (C++17)

 

受約束演算法

此選單中的所有名稱均屬於名稱空間 std::ranges

非修改序列操作

all_ofany_ofnone_of for_each for_each_n    countcount_if adjacent_find mismatch equal lexicographical_compare    containscontains_subrange (C++23)(C++23) findfind_iffind_if_not find_lastfind_last_iffind_last_if_not (C++23)(C++23)(C++23)   find_end find_first_of search search_n starts_with (C++23) ends_with (C++23)

修改序列操作

copycopy_if copy_n copy_backward    move move_backward shift_leftshift_right (C++23)(C++23)   fill fill_n generate generate_n    transform swap_ranges    shuffle sample removeremove_if replacereplace_if reverse rotate remove_copyremove_copy_if    unique replace_copyreplace_copy_if reverse_copy rotate_copy unique_copy

劃分操作

is_partitioned    partition_point    partition    partition_copy    stable_partition

排序操作

is_sorted is_sorted_until     sort stable_sort         partial_sort       nth_element partial_sort_copy

二分查詢操作（在已排序的範圍內）

lower_bound         upper_bound         binary_search      equal_range

集合操作（於已排序範圍上）

merge inplace_merge       set_difference set_intersection    set_union          includes set_symmetric_difference

堆操作

is_heap is_heap_until       make_heap           sort_heap push_heap pop_heap

最小/最大值操作

max max_element         min min_element         minmax minmax_element     clamp

排列操作

is_permutation      next_permutation    prev_permutation

摺疊操作

fold_left (C++23) fold_left_first (C++23)   fold_right (C++23) fold_right_last (C++23)   fold_left_with_iter (C++23) fold_left_first_with_iter (C++23)

數值操作 iota (C++23)             隨機數生成 generate_random (C++26)

對未初始化儲存的操作

construct_at    destroy destroy_n destroy_at uninitialized_copy    uninitialized_move uninitialized_fill uninitialized_copy_n    uninitialized_move_n uninitialized_fill_n uninitialized_default_construct uninitialized_default_construct_n uninitialized_value_construct uninitialized_value_construct_n

返回型別

in_fun_result in_in_result in_found_result    in_out_result in_in_out_result    in_out_out_result    min_max_result out_value_result (C++23) in_value_result (C++23)

 

定義於標頭檔案 <algorithm>
呼叫簽名 (Call signature)
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 );	(1)	(C++20 起)
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 );	(2)	(C++20 起)

1) 重新排列給定範圍 [first, last) 中的元素，使這些元素的每種可能的排列都具有相同的出現機率。

2) 與 (1) 相同，但使用 r 作為範圍，如同使用 ranges::begin(r) 作為 first，使用 ranges::end(r) 作為 last。

本頁描述的類函式實體是 演算法函式物件（非正式地稱為 niebloids），即

• 呼叫它們中的任何一個時，不能指定顯式模板引數列表。
• 它們中的任何一個都對 引數依賴查詢 不可見。
• 當透過非限定查詢在函式呼叫運算子左側找到任何函式名時，將抑制實參依賴查詢。

引數

first, last	-	定義要隨機洗牌的元素範圍的迭代器-哨兵對
r	-	要隨機洗牌的元素範圍
gen	-	隨機數生成器

返回值

一個等於 last 的迭代器。

複雜度

精確地執行 (last - first) - 1 次交換。

可能的實現

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 {};

示例

執行此程式碼

#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

參閱

ranges::next_permutation (C++20)	生成元素範圍的下一個更大的字典序排列 (演算法函式物件)
ranges::prev_permutation (C++20)	生成元素範圍的下一個更小的字典序排列 (演算法函式物件)
random_shuffleshuffle (C++17 前)(C++11)	隨機地重排一個範圍中的元素 (函式模板)