| Constrained algorithms and algorithms on ranges(C++20) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Constrained algorithms, e.g.ranges::copy,ranges::sort, ... | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Execution policies(C++17) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Numeric operations | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Operations on uninitialized memory | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Defined in header <algorithm> | ||
template<class PopulationIt,class SampleIt,class Distance,class URBG> SampleIterator sample( PopulationIt first, PopulationIt last, | (since C++17) | |
Selectsn elements from the sequence[first, last) (without replacement) such that each possible sample has equal probability of appearance, and writes those selected elements into the output iteratorout. Random numbers are generated using the random number generatorg.
Ifn is greater than the number of elements in the sequence, selects all elements in the sequence.
The algorithm is stable (preserves the relative order of the selected elements) only ifPopulationIt meets the requirements ofLegacyForwardIterator.
Ifthe value type offirst(until C++20)*first(since C++20) is notwritable toout, the program is ill-formed.
If any of the following conditions is satisfied, the behavior is undefined:
[first, last).PopulationIt does not meet the requirements ofLegacyInputIterator.SampleIt does not meet the requirements ofLegacyOutputIterator.
| (until C++23) |
| (since C++23) |
SampleIt does not meet the requirements ofLegacyRandomAccessIterator.T asstd::remove_reference_t<URBG>, any of the following conditions is satisfied:T does not meet the requirements ofUniformRandomBitGenerator.
| (until C++20) |
Contents |
| first, last | - | the pair of iterators defining therange of elements from which to make the sampling (the population) |
| out | - | the output iterator where the samples are written |
| n | - | number of samples to make |
| g | - | the random number generator used as the source of randomness |
| Type requirements | ||
-Distance must be an integer type. | ||
Returns a copy ofout after the last sample that was output, that is, end of the sample range.
Linear instd::distance(first, last).
See the implementations inlibstdc++,libc++ andMSVC STL.
This function may implement selection sampling orreservoir sampling.
| Feature-test macro | Value | Std | Feature |
|---|---|---|---|
__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';}
Possible output:
Four random letters out of ABCDEFGHIJK: EFGK
(until C++17)(C++11) | randomly re-orders elements in a range (function template)[edit] |
(C++20) | selects N random elements from a sequence (algorithm function object)[edit] |
