std::ranges::sample
Определено в заголовочном файле <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) Выбирает
M = min(n, last - first) элементов из последовательности [first, last) (без возвращения) так, чтобы каждый возможный образец имел равную вероятность появления, и записывает выбранные элементы в диапазон, начинающийся с out.
Алгоритм является стабильным (сохраняет относительный порядок выбранных элементов) только если
I моделирует std::forward_iterator.
Поведение не определено, если
out находится в [first, last).
2) То же, что и (1), но в качестве исходного диапазона используется
r, как если бы в качестве first использовался ranges::begin(r), а в качестве last — ranges::end(r).Описанные на этой странице функциональные сущности являются объектами-функциями алгоритмов (неформально известными как niebloids), то есть:
- При вызове любой из них нельзя указывать явный список аргументов шаблона.
- Ни одна из них не видна при поиске, зависящем от аргументов.
- Если любая из них обнаруживается при обычном неквалифицированном поиске в качестве имени слева от оператора вызова функции, поиск, зависящий от аргументов, подавляется.
Параметры
| first, last | - | пара итератора и сентинела, определяющая диапазон элементов, из которого выполняется выборка (популяция) |
| 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 }
См. также
|
(C++20) | случайным образом переставляет элементы в диапазоне (объект-функция алгоритма) |
|
(C++17) | выбирает N случайных элементов из последовательности (шаблон функции) |
© cppreference.com
Licensed under the Creative Commons Attribution-ShareAlike Unported License v3.0.
https://en.cppreference.com/cpp/algorithm/ranges/sample
