std::includes

From Cppreference

Jump to: navigation, search
Defined in header <algorithm>

template< class InputIterator1, class InputIterator2 >

bool includes( InputIterator1 first1, InputIterator1 last1,

               InputIterator2 first2, InputIterator2 last2 );
(1)
template< class InputIterator1, class InputIterator2 >

bool includes( InputIterator1 first1, InputIterator1 last1,

               InputIterator2 first2, InputIterator2 last2, Compare comp );
(2)

Returns true if every element from the sorted range [first2, last2) is found within the sorted range [first, last). Also returns true if [first2, last2) is empty. The first version expects both ranges to be sorted with operator<, the second version expects them to be sorted with the given comparison function comp.

Contents

[edit] Parameters

first1, last1 - the range of elements to examine
first2, last2 - the range of elements to search for
comp - comparison function which returns ​true if the first argument is less than the second.

The signature of the comparison function should be equivalent to the following:

bool cmp(const Type1 &a, const Type2 &b);

The signature does not need to have const &, but the function must not modify the objects passed to it.
The types Type1 and Type2 must be such that an object of type InputIterator can be dereferenced and then implicitly converted to both of them. ​

[edit] Return value

true if every element from [first2, last2) is a member of [first, last).

[edit] Complexity

At most 2·(N1+N2-1) comparisons, where N1 = std::distance(first1, last1) and N2 = std::distance(first2, last2).

[edit] Equivalent function

[edit] Example

[edit] See also

set_difference
computes the difference between two sets
(function template)