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 个随机元素 (算法函数对象)