std::random_shuffle, std::shuffle

 

C++

コンパイラサポート

フリースタンディングとホスト

言語

標準ライブラリ

標準ライブラリヘッダー

名前付き要件

機能テストマクロ (C++20)

言語サポートライブラリ

コンセプトライブラリ (C++20)

診断ライブラリ

メモリ管理ライブラリ

メタプログラミングライブラリ (C++11)

汎用ユーティリティライブラリ

コンテナライブラリ

イテレータライブラリ

Rangesライブラリ (C++20)

アルゴリズムライブラリ

文字列ライブラリ

テキスト処理ライブラリ

数値ライブラリ

日付と時刻ライブラリ

入出力ライブラリ

ファイルシステムライブラリ (C++17)

並行サポートライブラリ (C++11)

実行制御ライブラリ (C++26)

Technical specifications (技術仕様)

シンボルインデックス

外部ライブラリ

 

アルゴリズムライブラリ

制約付きアルゴリズムとRangeアルゴリズム (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)

 

ヘッダー <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以降)

指定された範囲 [first, last) の要素を並べ替えて、それらの要素の可能なすべての順列が等しい確率で出現するようにします。

1) ランダム性のソースは実装依存ですが、関数 std::rand がしばしば使用されます。

2) ランダム性のソースは関数オブジェクト r です。

以下のいずれかの条件が満たされている場合、動作は未定義です。

• r の戻り値の型が std::iterator_traits<RandomIt>::difference_type に変換可能でない。
• 型 std::iterator_traits<RandomIt>::difference_type の正の値 n が与えられた場合、r(n) の結果が区間 [​0​, n) のランダムに選ばれた値でない。

3) ランダム性のソースはオブジェクト g です。

型 T を std::remove_reference_t<URBG> とすると、以下のいずれかの条件が満たされている場合、動作は未定義です。

• T が UniformRandomBitGenerator でない。

T::result_type が std::iterator_traits<RandomIt>::difference_type に変換可能でない。

(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))]); } }

注意

実装は標準によって規定されていないため、まったく同じ RandomFunc または URBG (Uniform Random Number Generator) を使用しても、標準ライブラリの実装が異なれば異なる結果が得られる可能性があることに注意してください。

C++17 で std::random_shuffle が削除された理由は、イテレータのみのバージョンが通常 std::rand に依存しているためです。std::rand は、非推奨の議論にも上がっています。(std::rand は、std::rand は有害と見なされるため、<random> ヘッダーのクラスに置き換えるべきです。) さらに、イテレータのみの std::random_shuffle バージョンは通常、グローバル状態に依存します。std::shuffle のシャッフルアルゴリズムは、3 番目のパラメータとして URBG を使用するため、推奨される代替手段です。

例

整数 [1, 10] のシーケンスをランダムにシャッフルします。

このコードを実行

#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++標準に遡って適用されました。

DR	適用対象	公開された動作	正しい動作
LWG 395	C++98	(1) のオーバーロードのランダム性のソースが指定されておらず、 std::rand は C ライブラリの要件によりソースになれなかった。	実装依存である。 std::rand の使用が許可されている。
LWG 552 (N2423)	C++98	r はランダム性のソースである必要がなかった。 （2）のオーバーロード	必要

関連項目

next_permutation	要素の範囲の次に大きい辞書順の順列を生成する (関数テンプレート)
prev_permutation	要素の範囲の次に小さい辞書順の順列を生成する (関数テンプレート)
ranges::shuffle (C++20)	範囲内の要素をランダムに並べ替える (アルゴリズム関数オブジェクト)