std::sample

 

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)

 

定義於標頭檔案 <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 個隨機元素 (演算法函式物件)