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> | ||
(1) | ||
template<class ForwardIt,class Size,class T> ForwardIt search_n( ForwardIt first, ForwardIt last, | (constexpr since C++20) (until C++26) | |
template<class ForwardIt,class Size, class T=typenamestd::iterator_traits | (since C++26) | |
(2) | ||
template<class ExecutionPolicy, class ForwardIt,class Size,class T> | (since C++17) (until C++26) | |
template<class ExecutionPolicy, class ForwardIt,class Size, | (since C++26) | |
(3) | ||
template<class ForwardIt,class Size,class T,class BinaryPred> ForwardIt search_n( ForwardIt first, ForwardIt last, | (constexpr since C++20) (until C++26) | |
template<class ForwardIt,class Size, class T=typenamestd::iterator_traits | (since C++26) | |
(4) | ||
template<class ExecutionPolicy,class ForwardIt,class Size, class T,class BinaryPred> | (since C++17) (until C++26) | |
template<class ExecutionPolicy,class ForwardIt,class Size, class T=typenamestd::iterator_traits | (since C++26) | |
Searches the range[
first,
last)
for the first sequence ofcount identical elements, each equal to the givenvalue.
std::is_execution_policy_v<std::decay_t<ExecutionPolicy>> istrue. | (until C++20) |
std::is_execution_policy_v<std::remove_cvref_t<ExecutionPolicy>> istrue. | (since C++20) |
Contents |
first, last | - | the pair of iterators defining therange of elements to examine |
count | - | the length of the sequence to search for |
value | - | the value of the elements to search for |
policy | - | theexecution policy to use |
p | - | binary predicate which returns true if the elements should be treated as equal. The signature of the predicate function should be equivalent to the following: bool pred(const Type1&a,const Type2&b); While the signature does not need to haveconst&, the function must not modify the objects passed to it and must be able to accept all values of type (possibly const) |
Type requirements | ||
-ForwardIt must meet the requirements ofLegacyForwardIterator. | ||
-BinaryPred must meet the requirements ofBinaryPredicate. | ||
-Size must beconvertible to anintegral type. |
Ifcount is positive, returns an iterator to the beginning of the first sequence found in the range[
first,
last)
. Each iteratorit in the sequence should satisfy the following condition:
If no such sequence is found,last is returned.
Ifcount is zero or negative,first is returned.
Given\(\scriptsize N\)N asstd::distance(first, last):
The overloads with a template parameter namedExecutionPolicy
report errors as follows:
ExecutionPolicy
is one of thestandard policies,std::terminate is called. For any otherExecutionPolicy
, the behavior is implementation-defined.search_n (1) |
---|
template<class ForwardIt,class Size,class T=typenamestd::iterator_traits<ForwardIt>::value_type>ForwardIt search_n(ForwardIt first, ForwardIt last, Size count,const T& value){if(count<=0)return first; for(; first!= last;++first){if(!(*first== value))continue; ForwardIt candidate= first; for(Size cur_count=1;true;++cur_count){if(cur_count>= count)return candidate;// success ++first;if(first== last)return last;// exhausted the list if(!(*first== value))break;// too few in a row}}return last;} |
search_n (3) |
template<class ForwardIt,class Size,class T=typenamestd::iterator_traits<ForwardIt>::value_type,class BinaryPred>ForwardIt search_n(ForwardIt first, ForwardIt last, Size count,const T& value, BinaryPred p){if(count<=0)return first; for(; first!= last;++first){if(!p(*first, value))continue; ForwardIt candidate= first; for(Size cur_count=1;true;++cur_count){if(cur_count>= count)return candidate;// success ++first;if(first== last)return last;// exhausted the list if(!p(*first, value))break;// too few in a row}}return last;} |
Feature-test macro | Value | Std | Feature |
---|---|---|---|
__cpp_lib_algorithm_default_value_type | 202403 | (C++26) | List-initialization for algorithms(1-4) |
#include <algorithm>#include <cassert>#include <complex>#include <iostream>#include <iterator>#include <vector> template<class Container,class Size,class T>constexprbool consecutive_values(const Container& c, Size count,const T& v){return std::search_n(std::begin(c),std::end(c), count, v)!=std::end(c);} int main(){constexprchar sequence[]=".0_0.000.0_0."; static_assert(consecutive_values(sequence,3,'0')); for(int n:{4,3,2})std::cout<<std::boolalpha<<"Has "<< n<<" consecutive zeros: "<< consecutive_values(sequence, n,'0')<<'\n'; std::vector<std::complex<double>> nums{{4,2},{4,2},{1,3}};#ifdef __cpp_lib_algorithm_default_value_typeauto it= std::search_n(nums.cbegin(), nums.cend(),2,{4,2});#elseauto it= std::search_n(nums.cbegin(), nums.cend(),2,std::complex<double>{4,2});#endifassert(it== nums.begin());}
Output:
Has 4 consecutive zeros: falseHas 3 consecutive zeros: trueHas 2 consecutive zeros: true
The following behavior-changing defect reports were applied retroactively to previously published C++ standards.
DR | Applied to | Behavior as published | Correct behavior |
---|---|---|---|
LWG 283 | C++98 | T was required to beEqualityComparable, butthe value type of InputIt is not alwaysT | removed the requirement |
LWG 426 | C++98 | the complexity upper limit wasN·count ,it is negative ifcount is negative | the upper limit is0 ifcount is non-positive |
LWG 714 | C++98 | ifcount>0, the complexity upper limit wasN·count , but inthe worst case the number of comparisons/operations is always N | changed the upper limit to N in this case |
LWG 2150 | C++98 | the condition of “sequence occurence” was incorrect | corrected |
finds the last sequence of elements in a certain range (function template)[edit] | |
(C++11) | finds the first element satisfying specific criteria (function template)[edit] |
searches for the first occurrence of a range of elements (function template)[edit] | |
(C++20) | searches for the first occurrence of a number consecutive copies of an element in a range (algorithm function object)[edit] |