std::ranges::sample
С ru.cppreference.net
| Определено в заголовке <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) (без замены) таким образом, что каждая возможная sample имеет равную вероятность появления, и записывает эти выбранные элементы в диапазон, начинающийся с out. Алгоритм является stable (сохраняет относительный порядок выбранных элементов) только если
I моделирует std::forward_iterator. Поведение неопределено, если
out находится в [first, last).2) То же, что и (1), но использует
r в качестве исходного диапазона, как если бы использовалось ranges::begin(r) как first, и ranges::end(r) как last.Сущности, подобные функциям, описанные на этой странице, являются функциональными объектами алгоритмов (неформально известными как niebloids), то есть:
- Явные списки аргументов шаблона не могут быть указаны при вызове любого из них.
- Ни один из них не видим для поиска, зависящего от аргументов.
- Когда любой из них найден с помощью обычного неквалифицированного поиска как имя слева от оператора вызова функции, поиск, зависящий от аргументов подавляется.
Параметры
| first, last | - | пара итератор-страж, определяющая диапазон элементов, из которых производится выборка ( генеральная совокупность ) |
| r | - | диапазон, из которого производится выборка ( генеральная совокупность ) |
| out | - | выходной итератор, в который записываются выборки |
| n | - | количество извлекаемых выборок |
| gen | - | генератор случайных чисел, используемый в качестве источника случайности |
Возвращаемое значение
Итератор, равный out + M , то есть конец результирующего диапазона выборки.
Сложность
Линейная : 𝓞 ( last - first ) .
Примечания
Эта функция может реализовывать selection sampling или reservoir sampling .
Возможная реализация
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>) { // эта ветка сохраняет "стабильность" элементов выборки 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 является random_access_iterator diff_t sample_size{}; // копируем элементы [first, first + M) в "произвольный доступ" вывода for (; first != last && sample_size != n; ++first) out[sample_size++] = *first; // перезаписываем некоторые из скопированных элементов случайно выбранными 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 случайных элементов из последовательности
(шаблон функции) |