std::ranges::sample
From cppreference.com
| ヘッダー <algorithm> で定義 |
||
| 呼び出しシグネチャ |
||
| template< std::input_iterator I, std::sentinel_for<I> S, std::weakly_incrementable O, class Gen > |
(1) | (C++20以降) |
| template< ranges::input_range R, std::weakly_incrementable O, class Gen > requires (ranges::forward_range<R> || std::random_access_iterator<O>) && |
(2) | (C++20以降) |
1) シーケンス `[first, last)` から `M = min(n, last - first)` 個の要素を（重複なしで）選択し、それらが選択される各可能な*サンプル*の確率が等しくなるようにし、選択された要素を出力範囲 `out` の先頭に書き込みます。
アルゴリズムが*安定*（選択された要素の相対順序を保持する）なのは、`I` が std::forward_iterator をモデル化する場合のみです。
`out` が `[first, last)` の範囲内にある場合、動作は未定義です。
2) (1) と同じですが、ソース範囲として `r` を使用し、`ranges::begin(r)` を `first`、`ranges::end(r)` を `last` として扱います。
このページで説明されている関数のようなエンティティは、アルゴリズム関数オブジェクト（非公式にはニーブロイドとして知られている）です。つまり、
- これらのいずれかを呼び出す際に、明示的なテンプレート引数リストを指定することはできません。
- これらのいずれも実引数依存の名前探索には見えません。
- これらのいずれかが関数呼び出し演算子の左側の名前として通常の非修飾名探索によって見つかった場合、実引数依存の名前探索は抑制されます。
目次 |
[編集] パラメータ
| first, last | - | サンプリング元の*母集団*の範囲を定義するイテレータとセンチネルのペア |
| r | - | サンプリング元の*母集団*の範囲 |
| out | - | サンプルが書き込まれる出力イテレータ |
| n | - | 取得するサンプルの数 |
| gen | - | ランダム性のソースとして使用される乱数ジェネレータ |
[編集] 戻り値
結果のサンプル範囲の末尾となる、`out + M` に等しいイテレータ。
[編集] 計算量
線形: 𝓞(last - first)。
[編集] 注意
この関数は、*選択サンプリング*またはリザーバーサンプリングを実装する場合があります。
[編集] 実装例
struct sample_fn { template<std::input_iterator I, std::sentinel_for<I> S, std::weakly_incrementable O, class Gen> requires (std::forward_iterator<I> or std::random_access_iterator<O>) && std::indirectly_copyable<I, O> && std::uniform_random_bit_generator<std::remove_reference_t<Gen>> O operator()(I first, S last, O out, std::iter_difference_t<I> n, Gen&& gen) const { using diff_t = std::iter_difference_t<I>; using distrib_t = std::uniform_int_distribution<diff_t>; using param_t = typename distrib_t::param_type; distrib_t D{}; if constexpr (std::forward_iterator<I>) { // this branch preserves "stability" of the sample elements auto rest{ranges::distance(first, last)}; for (n = ranges::min(n, rest); n != 0; ++first) if (D(gen, param_t(0, --rest)) < n) { *out++ = *first; --n; } return out; } else { // O is a random_access_iterator diff_t sample_size{}; // copy [first, first + M) elements to "random access" output for (; first != last && sample_size != n; ++first) out[sample_size++] = *first; // overwrite some of the copied elements with randomly selected ones for (auto pop_size{sample_size}; first != last; ++first, ++pop_size) { const auto i{D(gen, param_t{0, pop_size})}; if (i < n) out[i] = *first; } return out + sample_size; } } template<ranges::input_range R, std::weakly_incrementable O, class Gen> requires (ranges::forward_range<R> or std::random_access_iterator<O>) && std::indirectly_copyable<ranges::iterator_t<R>, O> && std::uniform_random_bit_generator<std::remove_reference_t<Gen>> O operator()(R&& r, O out, ranges::range_difference_t<R> n, Gen&& gen) const { return (*this)(ranges::begin(r), ranges::end(r), std::move(out), n, std::forward<Gen>(gen)); } }; inline constexpr sample_fn sample {}; |
[編集] 例
このコードを実行
#include <algorithm> #include <iomanip> #include <iostream> #include <iterator> #include <random> #include <vector> void print(auto const& rem, auto const& v) { std::cout << rem << " = [" << std::size(v) << "] { "; for (auto const& e : v) std::cout << e << ' '; std::cout << "}\n"; } int main() { const auto in = {1, 2, 3, 4, 5, 6}; print("in", in); std::vector<int> out; const int max = in.size() + 2; auto gen = std::mt19937{std::random_device{}()}; for (int n{}; n != max; ++n) { out.clear(); std::ranges::sample(in, std::back_inserter(out), n, gen); std::cout << "n = " << n; print(", out", out); } }
実行結果の例
in = [6] { 1 2 3 4 5 6 }
n = 0, out = [0] { }
n = 1, out = [1] { 5 }
n = 2, out = [2] { 4 5 }
n = 3, out = [3] { 2 3 5 }
n = 4, out = [4] { 2 4 5 6 }
n = 5, out = [5] { 1 2 3 5 6 }
n = 6, out = [6] { 1 2 3 4 5 6 }
n = 7, out = [6] { 1 2 3 4 5 6 }[編集] 関連項目
| (C++20) |
範囲内の要素をランダムに並べ替える (アルゴリズム関数オブジェクト) |
| (C++17) |
シーケンスからN個のランダムな要素を選択する (関数テンプレート) |
