Difference between revisions of "cpp/algorithm/find"
m (Redirected page to enwiki:Rust (programming language)) |
|||
Line 1: | Line 1: | ||
− | + | {{cpp/title|find|find_if|find_if_not}} | |
+ | {{cpp/algorithm/navbar}} | ||
+ | {{dcl begin}} | ||
+ | {{dcl header|algorithm}} | ||
+ | {{dcl rev multi|num=1|anchor=1|dcl1= | ||
+ | template< class InputIt, class T > | ||
+ | InputIt find( InputIt first, InputIt last, const T& value ); | ||
+ | | since2=c++20|dcl2= | ||
+ | template< class InputIt, class T > | ||
+ | constexpr InputIt find( InputIt first, InputIt last, const T& value ); | ||
+ | }} | ||
+ | {{dcl|num=2|since=c++17| | ||
+ | template< class ExecutionPolicy, class ForwardIt, class T > | ||
+ | ForwardIt find( ExecutionPolicy&& policy, | ||
+ | ForwardIt first, ForwardIt last, const T& value ); | ||
+ | }} | ||
+ | {{dcl rev multi|num=3|anchor=3|dcl1= | ||
+ | template< class InputIt, class UnaryPredicate > | ||
+ | InputIt find_if( InputIt first, InputIt last, UnaryPredicate p ); | ||
+ | |since2=c++20|dcl2= | ||
+ | template< class InputIt, class UnaryPredicate > | ||
+ | constexpr InputIt find_if( InputIt first, InputIt last, UnaryPredicate p ); | ||
+ | }} | ||
+ | {{dcl|num=4|since=c++17| | ||
+ | template< class ExecutionPolicy, class ForwardIt, class UnaryPredicate > | ||
+ | ForwardIt find_if( ExecutionPolicy&& policy, | ||
+ | ForwardIt first, ForwardIt last, UnaryPredicate p ); | ||
+ | }} | ||
+ | {{dcl rev multi|num=5|anchor=5|since1=c++11|dcl1= | ||
+ | template< class InputIt, class UnaryPredicate > | ||
+ | InputIt find_if_not( InputIt first, InputIt last, UnaryPredicate q ); | ||
+ | |since2=c++20|dcl2= | ||
+ | template< class InputIt, class UnaryPredicate > | ||
+ | constexpr InputIt find_if_not( InputIt first, InputIt last, UnaryPredicate q ); | ||
+ | }} | ||
+ | {{dcl|num=6|since=c++17| | ||
+ | template< class ExecutionPolicy, class ForwardIt, class UnaryPredicate > | ||
+ | ForwardIt find_if_not( ExecutionPolicy&& policy, | ||
+ | ForwardIt first, ForwardIt last, UnaryPredicate q ); | ||
+ | }} | ||
+ | {{dcl end}} | ||
+ | |||
+ | Returns an iterator to the first element in the range {{range|first|last}} that satisfies specific criteria (or {{c|last}} if there is no such iterator): | ||
+ | @1@ {{tt|find}} searches for an element equal to {{c|value}} (using {{tt|1=operator==}}) | ||
+ | |||
+ | @3@ {{tt|find_if}} searches for an element for which predicate {{c|p}} returns {{c|true}} | ||
+ | |||
+ | @5@ {{tt|find_if_not}} searches for an element for which predicate {{c|q}} returns {{c|false}} | ||
+ | @2,4,6@ Same as {{v|1,3,5}}, but executed according to {{c|policy}}. {{cpp/algorithm/parallel overload precondition|plural=true}} | ||
+ | ===Parameters=== | ||
+ | {{par begin}} | ||
+ | {{par|first, last|the range of elements to examine}} | ||
+ | {{par|value|value to compare the elements to}} | ||
+ | {{par exec pol}} | ||
+ | {{par pred1|p|value=true|for the required element|p1=InputIt}} | ||
+ | {{par pred1|q|value=false|for the required element|p1=InputIt}} | ||
+ | {{par hreq}} | ||
+ | {{par req named|InputIt|InputIterator}} | ||
+ | {{par req named|ForwardIt|ForwardIterator}} | ||
+ | {{par req named|UnaryPredicate|Predicate}} | ||
+ | {{par end}} | ||
+ | |||
+ | ===Return value=== | ||
+ | The first iterator {{c|it}} in the [[cpp/iterator#Ranges|range]] {{range|first|last}} satisfying the following condition or {{c|last}} if there is no such iterator: | ||
+ | @1,2@ {{c|1=*it == value}} is {{c|true}} | ||
+ | @3,4@ {{c|1=p(*it)}} is {{c|true}} | ||
+ | @5,6@ {{c|1=q(*it)}} is {{c|false}} | ||
+ | |||
+ | ===Complexity=== | ||
+ | Given {{tt|N}} as {{c|std::distance(first, last)}}: | ||
+ | @1,2@ at most {{tt|N}} comparisons with {{c|value}} using {{tt|1=operator==}} | ||
+ | @3,4@ at most {{tt|N}} applications of the predicate {{c|p}} | ||
+ | @5,6@ at most {{tt|N}} applications of the predicate {{c|q}} | ||
+ | |||
+ | ===Exceptions=== | ||
+ | {{cpp/algorithm/parallel exceptions reporting behavior}} | ||
+ | |||
+ | ===Possible implementation=== | ||
+ | {{eq impl | ||
+ | |title1=find|ver1=1|1= | ||
+ | template<class InputIt, class T> | ||
+ | constexpr InputIt find(InputIt first, InputIt last, const T& value) | ||
+ | { | ||
+ | for (; first != last; ++first) | ||
+ | if (*first == value) | ||
+ | return first; | ||
+ | |||
+ | return last; | ||
+ | } | ||
+ | |title2=find_if|ver2=3|2= | ||
+ | template<class InputIt, class UnaryPredicate> | ||
+ | constexpr InputIt find_if(InputIt first, InputIt last, UnaryPredicate p) | ||
+ | { | ||
+ | for (; first != last; ++first) | ||
+ | if (p(*first)) | ||
+ | return first; | ||
+ | |||
+ | return last; | ||
+ | } | ||
+ | |title3=find_if_not|ver3=5|3= | ||
+ | template<class InputIt, class UnaryPredicate> | ||
+ | constexpr InputIt find_if_not(InputIt first, InputIt last, UnaryPredicate q) | ||
+ | { | ||
+ | for (; first != last; ++first) | ||
+ | if (!q(*first)) | ||
+ | return first; | ||
+ | |||
+ | return last; | ||
+ | } | ||
+ | }} | ||
+ | |||
+ | ===Notes=== | ||
+ | If you do not have C++11, an equivalent to {{tt|std::find_if_not}} is to use {{tt|std::find_if}} with the negated predicate. | ||
+ | {{eq fun|1= | ||
+ | template<class InputIt, class UnaryPredicate> | ||
+ | InputIt find_if_not(InputIt first, InputIt last, UnaryPredicate q) | ||
+ | { | ||
+ | return std::find_if(first, last, std::not1(q)); | ||
+ | } | ||
+ | }} | ||
+ | |||
+ | ===Example=== | ||
+ | {{example | ||
+ | |The following example finds integers in given {{lc|std::vector}}. | ||
+ | |code= | ||
+ | #include <algorithm> | ||
+ | #include <array> | ||
+ | #include <iostream> | ||
+ | |||
+ | int main() | ||
+ | { | ||
+ | const auto v = {1, 2, 3, 4}; | ||
+ | |||
+ | for (int n : {3, 5}) | ||
+ | (std::find(v.begin(), v.end(), n) == std::end(v)) | ||
+ | ? std::cout << "v does not contain " << n << '\n' | ||
+ | : std::cout << "v contains " << n << '\n'; | ||
+ | |||
+ | auto is_even = [](int i) { return i % 2 == 0; }; | ||
+ | |||
+ | for (auto const& w : {std::array{3, 1, 4}, {1, 3, 5}<!---->}) | ||
+ | if (auto it = std::find_if(begin(w), end(w), is_even); it != std::end(w)) | ||
+ | std::cout << "w contains an even number " << *it << '\n'; | ||
+ | else | ||
+ | std::cout << "w does not contain even numbers\n"; | ||
+ | } | ||
+ | |output= | ||
+ | v contains 3 | ||
+ | v does not contain 5 | ||
+ | w contains an even number 4 | ||
+ | w does not contain even numbers | ||
+ | }} | ||
+ | |||
+ | ===Defect reports=== | ||
+ | {{dr list begin}} | ||
+ | {{dr list item|wg=lwg|dr=283|std=C++98|before={{tt|T}} was required to be {{named req|EqualityComparable}}, but<br>the value type of {{tt|InputIt}} is not always {{tt|T}}|after=removed the requirement}} | ||
+ | {{dr list end}} | ||
+ | |||
+ | ===See also=== | ||
+ | {{dsc begin}} | ||
+ | {{dsc inc|cpp/algorithm/dsc adjacent_find}} | ||
+ | {{dsc inc|cpp/algorithm/dsc find_end}} | ||
+ | {{dsc inc|cpp/algorithm/dsc find_first_of}} | ||
+ | {{dsc inc|cpp/algorithm/dsc mismatch}} | ||
+ | {{dsc inc|cpp/algorithm/dsc search}} | ||
+ | {{dsc inc|cpp/algorithm/ranges/dsc find}} | ||
+ | {{dsc end}} | ||
+ | |||
+ | {{langlinks|de|es|fr|it|ja|pt|ru|zh}} |
Revision as of 09:28, 31 July 2023
Defined in header <algorithm>
|
||
(1) | ||
template< class InputIt, class T > InputIt find( InputIt first, InputIt last, const T& value ); |
(until C++20) | |
template< class InputIt, class T > constexpr InputIt find( InputIt first, InputIt last, const T& value ); |
(since C++20) | |
template< class ExecutionPolicy, class ForwardIt, class T > ForwardIt find( ExecutionPolicy&& policy, |
(2) | (since C++17) |
(3) | ||
template< class InputIt, class UnaryPredicate > InputIt find_if( InputIt first, InputIt last, UnaryPredicate p ); |
(until C++20) | |
template< class InputIt, class UnaryPredicate > constexpr InputIt find_if( InputIt first, InputIt last, UnaryPredicate p ); |
(since C++20) | |
template< class ExecutionPolicy, class ForwardIt, class UnaryPredicate > ForwardIt find_if( ExecutionPolicy&& policy, |
(4) | (since C++17) |
(5) | ||
template< class InputIt, class UnaryPredicate > InputIt find_if_not( InputIt first, InputIt last, UnaryPredicate q ); |
(since C++11) (until C++20) |
|
template< class InputIt, class UnaryPredicate > constexpr InputIt find_if_not( InputIt first, InputIt last, UnaryPredicate q ); |
(since C++20) | |
template< class ExecutionPolicy, class ForwardIt, class UnaryPredicate > ForwardIt find_if_not( ExecutionPolicy&& policy, |
(6) | (since C++17) |
Returns an iterator to the first element in the range [
first,
last)
that satisfies specific criteria (or last if there is no such iterator):
find
searches for an element equal to value (using operator==
)find_if
searches for an element for which predicate p returns truefind_if_not
searches for an element for which predicate q returns false
std::is_execution_policy_v<std::decay_t<ExecutionPolicy>> is true. |
(until C++20) |
std::is_execution_policy_v<std::remove_cvref_t<ExecutionPolicy>> is true. |
(since C++20) |
Contents |
Parameters
first, last | - | the range of elements to examine |
value | - | value to compare the elements to |
policy | - | the execution policy to use. See execution policy for details. |
p | - | unary predicate which returns true for the required element. The expression p(v) must be convertible to bool for every argument |
q | - | unary predicate which returns false for the required element. The expression q(v) must be convertible to bool for every argument |
Type requirements | ||
-InputIt must meet the requirements of LegacyInputIterator.
| ||
-ForwardIt must meet the requirements of LegacyForwardIterator.
| ||
-UnaryPredicate must meet the requirements of Predicate.
|
Return value
The first iterator it in the range [
first,
last)
satisfying the following condition or last if there is no such iterator:
Complexity
Given N
as std::distance(first, last):
N
comparisons with value using operator==
N
applications of the predicate pN
applications of the predicate qExceptions
The overloads with a template parameter named ExecutionPolicy
report errors as follows:
- If execution of a function invoked as part of the algorithm throws an exception and
ExecutionPolicy
is one of the standard policies, std::terminate is called. For any otherExecutionPolicy
, the behavior is implementation-defined. - If the algorithm fails to allocate memory, std::bad_alloc is thrown.
Possible implementation
find |
---|
template<class InputIt, class T> constexpr InputIt find(InputIt first, InputIt last, const T& value) { for (; first != last; ++first) if (*first == value) return first; return last; } |
find_if |
template<class InputIt, class UnaryPredicate> constexpr InputIt find_if(InputIt first, InputIt last, UnaryPredicate p) { for (; first != last; ++first) if (p(*first)) return first; return last; } |
find_if_not |
template<class InputIt, class UnaryPredicate> constexpr InputIt find_if_not(InputIt first, InputIt last, UnaryPredicate q) { for (; first != last; ++first) if (!q(*first)) return first; return last; } |
Notes
If you do not have C++11, an equivalent to std::find_if_not
is to use std::find_if
with the negated predicate.
template<class InputIt, class UnaryPredicate> InputIt find_if_not(InputIt first, InputIt last, UnaryPredicate q) { return std::find_if(first, last, std::not1(q)); } |
Example
The following example finds integers in given std::vector.
#include <algorithm> #include <array> #include <iostream> int main() { const auto v = {1, 2, 3, 4}; for (int n : {3, 5}) (std::find(v.begin(), v.end(), n) == std::end(v)) ? std::cout << "v does not contain " << n << '\n' : std::cout << "v contains " << n << '\n'; auto is_even = [](int i) { return i % 2 == 0; }; for (auto const& w : {std::array{3, 1, 4}, {1, 3, 5}}) if (auto it = std::find_if(begin(w), end(w), is_even); it != std::end(w)) std::cout << "w contains an even number " << *it << '\n'; else std::cout << "w does not contain even numbers\n"; }
Output:
v contains 3 v does not contain 5 w contains an even number 4 w does not contain even numbers
Defect reports
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 be EqualityComparable, butthe value type of InputIt is not always T
|
removed the requirement |
See also
finds the first two adjacent items that are equal (or satisfy a given predicate) (function template) | |
finds the last sequence of elements in a certain range (function template) | |
searches for any one of a set of elements (function template) | |
finds the first position where two ranges differ (function template) | |
searches for the first occurrence of a range of elements (function template) | |
(C++20)(C++20)(C++20) |
finds the first element satisfying specific criteria (niebloid) |