命名空间
变体
操作

std::ranges::sample

来自 cppreference.com
< cpp‎ | algorithm‎ | ranges
 
 
算法库
受约束算法和范围上的算法 (C++20)
受约束算法,例如 ranges::copy, ranges::sort, ...
执行策略 (C++17)
排序和相关操作
分区操作
排序操作
二分搜索操作
(在分区范围内)
集合操作(在排序范围内)
合并操作(在排序范围内)
堆操作
最小值/最大值操作
(C++11)
(C++17)
字典序比较操作
排列操作
C 库
数值操作
未初始化内存操作
 
受约束算法
此菜单中的所有名称都属于命名空间 std::ranges
非修改序列操作
修改序列操作
分区操作
排序操作
二分搜索操作(在排序范围内)
       
       
集合操作(在排序范围内)
堆操作
最小值/最大值操作
       
       
排列操作
折叠操作
数值操作
(C++23)            
未初始化存储操作
返回值类型
 
定义在头文件 <algorithm>
调用签名
template< std::input_iterator I, std::sentinel_for<I> S,

          std::weakly_incrementable O, class Gen >
requires (std::forward_iterator<I> || std::random_access_iterator<O>) &&
          std::indirectly_copyable<I, O> &&
          std::uniform_random_bit_generator<std::remove_reference_t<Gen>>

O sample( I first, S last, O out, std::iter_difference_t<I> n, Gen&& 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>) &&
          std::indirectly_copyable<ranges::iterator_t<R>, O> &&
          std::uniform_random_bit_generator<std::remove_reference_t<Gen>>

O sample( R&& r, O out, ranges::range_difference_t<R> n, Gen&& gen );
(2) (自 C++20 起)
1) 从序列 [firstlast) 中选择 M = min(n, last - first) 个元素(不重复),使得每个可能的样本都有相同的出现概率,并将这些选定的元素写入从 out 开始的范围。
仅当 I 模型 std::forward_iterator 时,该算法才是稳定的(保留选定元素的相对顺序)。
如果 out 位于 [firstlast) 中,则行为未定义。
2)(1) 相同,但使用 r 作为源范围,就好像使用 ranges::begin(r) 作为 first,以及 ranges::end(r) 作为 last

此页面上描述的函数式实体是niebloids,即

在实践中,它们可以实现为函数对象,或者使用特殊的编译器扩展。

内容

[编辑] 参数

first1, last1 - 用于进行采样的范围(总体
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 }

[编辑] 参见

随机重新排序范围内的元素
(niebloid)[编辑]
(C++17)
从序列中选择 N 个随机元素
(函数模板) [编辑]