stdincludes(3)
std::includes - std::includes
Synopsis
Defined in header <algorithm>
template< class InputIt1, class InputIt2 >
bool includes( InputIt1 first1, InputIt1 last1, (until C++20)
InputIt2 first2, InputIt2 last2 );
template< class InputIt1, class InputIt2 >
constexpr bool includes( InputIt1 first1, InputIt1 last1, (since C++20)
InputIt2 first2, InputIt2 last2 );
template< class ExecutionPolicy, class ForwardIt1, class ForwardIt2 >
bool includes( ExecutionPolicy&& policy, ForwardIt1 first1, ForwardIt1 last1, (2) (since C++17)
ForwardIt2 first2, ForwardIt2 last2 ); (1)
template< class InputIt1, class InputIt2, class Compare >
bool includes( InputIt1 first1, InputIt1 last1, (until C++20)
InputIt2 first2, InputIt2 last2, Compare comp );
template< class InputIt1, class InputIt2, class Compare >
constexpr bool includes( InputIt1 first1, InputIt1 last1, (3) (since C++20)
InputIt2 first2, InputIt2 last2, Compare comp );
template< class ExecutionPolicy, class ForwardIt1, class ForwardIt2, class Compare >
bool includes( ExecutionPolicy&& policy, ForwardIt1 first1, ForwardIt1 last1, (4) (since C++17)
ForwardIt2 first2, ForwardIt2 last2, Compare comp );Returns true if the sorted range [first2, last2) is a subsequence of the sorted range [first1, last1). (A subsequence need not be contiguous.)
- Both ranges must be sorted with operator<.
- Both ranges must be sorted with the given comparison function comp. 2,4) Same as (1,3), but executed according to policy. This overload only participates in overload resolution if std::is_execution_policy_v<std::decay_t<ExecutionPolicy>> is true
Parameters
first1, last1 - the sorted range of elements to examine
first2, last2 - the sorted range of elements to search for
policy - the execution policy to use. See execution_policy for details.
Type requirements
InputIt1, InputIt2 must meet the requirements of LegacyInputIterator.
ForwardIt1, ForwardIt2 must meet the requirements of LegacyForwardIterator.
Return value
true if [first2, last2) is a subsequence of [first1, last1); otherwise false.
Complexity
At most 2·(N1+N2-1) comparisons, where N1 = std::distance(first1, last1) and N2 = std::distance(first2, last2).
Exceptions
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 other ExecutionPolicy, the behavior is implementation-defined.
- If the algorithm fails to allocate memory, std::bad_alloc is thrown.
Possible implementation
First version
Second version
Example
// Run this code
#include <iostream>
#include <algorithm>
#include <cctype>
#include <vector>
int main()
{
std::vector<char> v1{‘a’, ‘b’, ‘c’, ‘f’, ‘h’, ‘x’};
std::vector<char> v2{‘a’, ‘b’, ‘c’};
std::vector<char> v3{‘a’, ‘c’};
std::vector<char> v4{‘g’};
std::vector<char> v5{‘a’, ‘c’, ‘g’};
for (auto i : v1)
std::cout << i << ’ ‘;
std::cout << "\nincludes:\n"
<< std::boolalpha;
for (auto i : v2)
std::cout << i << ’ ‘;
std::cout << ": " << std::includes(v1.begin(), v1.end(), v2.begin(), v2.end()) << ‘\n’;
for (auto i : v3)
std::cout << i << ’ ‘;
std::cout << ": " << std::includes(v1.begin(), v1.end(), v3.begin(), v3.end()) << ‘\n’;
for (auto i : v4)
std::cout << i << ’ ‘;
std::cout << ": " << std::includes(v1.begin(), v1.end(), v4.begin(), v4.end()) << ‘\n’;
for (auto i : v5)
std::cout << i << ’ ‘;
std::cout << ": " << std::includes(v1.begin(), v1.end(), v5.begin(), v5.end()) << ‘\n’;
auto cmp_nocase = [](char a, char b) {
return std::tolower(a) < std::tolower(b);
};
std::vector<char> v6{‘A’, ‘B’, ‘C’};
for (auto i : v6)
std::cout << i << ’ ‘;
std::cout << ": (case-insensitive) "
<< std::includes(v1.begin(), v1.end(), v6.begin(), v6.end(), cmp_nocase)
<< ‘\n’;
}
Output:
See also