std::sample

 

C++

语言

标准库头文件

自立与有宿主实现

具名要求

语言支持库

概念库 (C++20)

诊断库

工具库

字符串库

容器库

迭代器库

范围库 (C++20)

算法库

数值库

本地化库

输入/输出库

文件系统库 (C++17)

正则表达式库 (C++11)

原子操作库 (C++11)

线程支持库 (C++11)

技术规范

 

算法库

受约束算法及范围上的算法 (C++20)
受约束算法： std::ranges::copy, std::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)
不修改序列的操作
all_ofany_ofnone_of (C++11)(C++11)(C++11) for_each for_each_n (C++17)	countcount_if mismatch equal adjacent_find	findfind_iffind_if_not (C++11) find_end find_first_of	adjacent_find search search_n lexicographical_compare lexicographical_compare_three_way (C++20)
修改序列的操作
copycopy_if (C++11) copy_n (C++11) copy_backward move (C++11) move_backward (C++11) shift_leftshift_right (C++20)(C++20) transform	fill fill_n generate generate_n swap iter_swap swap_ranges sample (C++17)	removeremove_if replacereplace_if reverse rotate unique random_shuffle (C++17 前)	remove_copyremove_copy_if replace_copyreplace_copy_if reverse_copy rotate_copy unique_copy shuffle (C++11)
未初始化存储上的操作
uninitialized_copy uninitialized_move (C++17) uninitialized_fill destroy (C++17)	uninitialized_copy_n (C++11) uninitialized_move_n (C++17) uninitialized_fill_n destroy_n (C++17)	uninitialized_default_construct (C++17) uninitialized_value_construct (C++17) destroy_at (C++17)	uninitialized_default_construct_n (C++17) uninitialized_value_construct_n (C++17) construct_at (C++20)
划分操作
is_partitioned (C++11) partition_point (C++11)	partition partition_copy (C++11)	stable_partition
排序操作
is_sorted (C++11) is_sorted_until (C++11)	sort stable_sort	partial_sort partial_sort_copy	nth_element
二分搜索操作
lower_bound	upper_bound	binary_search	equal_range
集合操作（在已排序范围上）
merge inplace_merge	set_difference set_intersection	set_symmetric_difference set_union	includes
堆操作
is_heap (C++11) is_heap_until (C++11)	make_heap sort_heap	push_heap pop_heap
最小/最大操作
max max_element	min min_element	minmax (C++11) minmax_element (C++11)	clamp (C++17)
排列
is_permutation (C++11)	next_permutation	prev_permutation
数值运算
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)
C 库
qsort	bsearch

 

定义于头文件 <algorithm>
template< class PopulationIterator, class SampleIterator,           class Distance, class URBG > SampleIterator sample( PopulationIterator first, PopulationIterator last,                        SampleIterator out, Distance n,                        URBG&& g);		(C++17 起)

从序列 [first; last) 选择 n 个元素（无替换），使得每个样本拥有相等的出现概率，并写入这些被选择元素到输出迭代器 out 。用随机数生成器 g 生成随机数。

若 n 大于序列中的元素数量，则选择 last-first 个元素。

算法仅若 PopulationIterator 满足老式向前迭代器 (LegacyForwardIterator) 要求才稳定（保持被选择元素 的顺序）。

若 out 在 [first; last) 中则行为未定义。

参数

first, last	-	一对组成自其采样的范围（总体）的迭代器
out	-	写入样本的输出迭代器
n	-	要抽取的样本数
g	-	用作随机源的随机数生成器
类型要求
- PopulationIterator 必须满足老式输入迭代器 (LegacyInputIterator) 的要求。
- SampleIterator 必须满足老式输出迭代器 (LegacyOutputIterator) 的要求。
- 若 PopulationIterator 不满足老式向前迭代器 (LegacyForwardIterator) ，则 SampleIterator 还必须满足老式随机访问迭代器 (LegacyRandomAccessIterator) 的要求
- PopulationIterator的 value_type 必须可写入到 out
- Distance 必须是整数类型
- std::remove_reference_t<URBG> 必须满足均匀随机位生成器 (UniformRandomBitGenerator) ，且其返回类型必须可转换为 Distance

返回值

在输出最后样本后返回 out 的副本，即采样范围的结尾。

复杂度

与 std::distance(first,last) 成线性

注解

此函数可以实现选择抽样或蓄水池抽样。

可能的实现

参阅 libstdc++、 libc++ 与 MSVC STL 中的实现。

示例

运行此代码

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

可能的输出：

five random letters out of hgfedcba: gfcba

参阅

random_shuffleshuffle (C++17 前)(C++11)

随机重排范围中的元素 (函数模板)