std::sample

 

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 PopulationIt, class SampleIt, class Distance, class URBG > SampleIterator sample( PopulationIt first, PopulationIt last,                        SampleIt out, Distance n, URBG&& g );		(C++17以降)

シーケンス [first, last) から n 個の要素を（重複なしで）選択し、可能なすべてのサンプルが等しい確率で出現するようにし、選択された要素を出力イテレータ out に書き込みます。乱数は乱数ジェネレータ g を使用して生成されます。

n がシーケンス内の要素数より大きい場合、シーケンス内のすべての要素を選択します。

このアルゴリズムは、`PopulationIt` が LegacyForwardIterator の要件を満たしている場合にのみ安定です（選択された要素の相対順序を保持します）。

first の値型(C++20まで)*first(C++20以降) が out に書き込み可能でない場合、プログラムは不適格です。

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

• out は [first, last) 内にあります。
• `PopulationIt` は LegacyInputIterator の要件を満たしません。
• `SampleIt` は LegacyOutputIterator の要件を満たしません。
• 以下のすべての条件が満たされます

`PopulationIt` は LegacyForwardIterator の要件を満たしません。	(C++23まで)
`PopulationIt` は forward_iterator をモデル化しません。	(C++23から)

• `SampleIt` は LegacyRandomAccessIterator の要件を満たしません。

• 型 `T` を std::remove_reference_t<URBG> とすると、以下のいずれかの条件が満たされます。

• `T` は UniformRandomBitGenerator の要件を満たしません。

`T` の戻り値の型は `Distance` に変換できません。

(C++20まで)

パラメーター

first, last	-	サンプリング（母集団）を行う要素の範囲を定義するイテレータのペア
out	-	サンプルが書き込まれる出力イテレータ
n	-	作成するサンプルの数
g	-	ランダム性のソースとして使用される乱数ジェネレータ
型要件
- `Distance` は整数型でなければなりません。

戻り値

最後に出力されたサンプルの後、つまりサンプル範囲の終わりにある out のコピーを返します。

計算量

std::distance(first, last) に対して線形。

可能な実装

libstdc++、libc++、および MSVC STL の実装を参照してください。

備考

この関数は、選択サンプリングまたはリザーバーサンプリングを実装する場合があります。

機能テストマクロ	値	規格	機能
__cpp_lib_sample	201603L	(C++17)	std::sample

例

このコードを実行

#include <algorithm>
#include <iostream>
#include <iterator>
#include <random>
#include <string>
 
int main()
{
    std::string in {"ABCDEFGHIJK"}, out;
    std::sample(in.begin(), in.end(), std::back_inserter(out), 4,
                std::mt19937 {std::random_device{}()});
    std::cout << "Four random letters out of " << in << " : " << out << '\n';
}

実行結果の例

Four random letters out of ABCDEFGHIJK: EFGK

関連項目

random_shuffleshuffle (C++17まで)(C++11)	範囲内の要素をランダムに並べ替える (関数テンプレート)
ranges::sample (C++20)	シーケンスからN個のランダムな要素を選択する (アルゴリズム関数オブジェクト)