std::ranges::shuffle

Defined in header `<algorithm>`
呼び出しシグネチャ
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) であり、つまり次のようになります:

これらのいずれかを呼び出すときに、明示的なテンプレート引数リストを指定することはできません。
それらのいずれも argument-dependent lookup には見えません。
これらのいずれかが通常の非修飾名前検索によって関数呼び出し演算子の左側の名前として見つかった場合、argument-dependent lookup は抑制されます。

パラメータ

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

コンパイラサポート
フリースタンディングとホスト環境
言語
標準ライブラリ
標準ライブラリヘッダ
名前付き要件
機能テストマクロ (C++20)
言語サポートライブラリ
コンセプトライブラリ (C++20)
診断ライブラリ
メモリ管理ライブラリ
メタプログラミングライブラリ (C++11)
汎用ユーティリティライブラリ
コンテナライブラリ
イテレータライブラリ
レンジライブラリ (C++20)
アルゴリズムライブラリ
文字列ライブラリ
テキスト処理ライブラリ
数値ライブラリ
日時ライブラリ
入出力ライブラリ
ファイルシステムライブラリ (C++17)
並行処理サポートライブラリ (C++11)
実行制御ライブラリ (C++26)
技術仕様書
シンボル索引
外部ライブラリ

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

ja.cppreference.net

Namespaces

Variants

std::ranges::shuffle

目次

パラメータ

戻り値

計算量

実装例

例

関連項目