std::set<Key,Compare,Allocator>::equal_range
From cppreference.com
C++
Feature test macros (C++20)
Concepts library (C++20)
Metaprogramming library (C++11)
Ranges library (C++20)
Filesystem library (C++17)
Concurrency support library (C++11)
Execution control library (C++26)
Containers library
(C++17)
(C++11)
(C++26)
(C++26)
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
(C++23)
(C++23)
(C++23)
(C++23)
(C++20)
(C++23)
Tables
std::set
Non-member functions
Deduction guides (C++17)
(C++11)
(C++11)
(C++11)
(C++11)
(C++17)
(C++17)
(C++23)
(C++11)
(C++11)
(C++20)
set::equal_range
(until C++20)(until C++20)(until C++20)(until C++20)(until C++20)
std::pair <iterator, iterator> equal_range( const Key& key );
(1)
(constexpr since C++26)
std::pair <const_iterator, const_iterator>
equal_range( const Key& key ) const;
(2)
(constexpr since C++26)
equal_range( const Key& key ) const;
template< class K >
std::pair <iterator, iterator> equal_range( const K& x );
(3)
(since C++14) std::pair <iterator, iterator> equal_range( const K& x );
(constexpr since C++26)
template< class K >
(4)
(since C++14) std::pair <const_iterator, const_iterator>
(constexpr since C++26)
Returns a range containing all elements with the given key in the container. The range is defined by two iterators, one pointing to the first element that is not less than the given key and another pointing to the first element greater than the given key.
Alternatively, the first iterator may be obtained with lower_bound() , and the second with upper_bound() .
1,2) Compares the keys to key.
3,4) Compares the keys to the value x.
This overload participates in overload resolution only if
Compare
is transparent. It allows calling this function without constructing an instance of Key
.[edit] Parameters
key
-
key value to compare the elements to
x
-
alternative value that can be compared to
Key
[edit] Return value
std::pair containing a pair of iterators defining the wanted range:
- The first iterator points to the first element not less than the given key, or end() if no such element exists.
- The second iterator points to the first element greater than the given key, or end() if no such element exists.
[edit] Complexity
Logarithmic in the size of the container.
Notes
Feature-test macro | Value | Std | Feature |
---|---|---|---|
__cpp_lib_generic_associative_lookup |
201304L |
(C++14) | Heterogeneous comparison lookup in associative containers, for overloads (3,4) |
[edit] Example
Run this code
#include <set> #include <functional> #include <print> #include <ranges> #include <string> #include <string_view> #include <tuple> struct Names { std::string forename, surname; friend auto operator<(const Names& lhs, const Names& rhs) { return std::tie (lhs.surname, lhs.forename) < std::tie (rhs.surname, rhs.forename); } }; struct SurnameCompare { std::string_view surname; friend bool operator<(const Names& lhs, const SurnameCompare& rhs) { return lhs.surname < rhs.surname; } friend bool operator<(const SurnameCompare& lhs, const Names& rhs) { return lhs.surname < rhs.surname; } }; std::set <Names, std::less <>> characters { {"Homer", "Simpson"}, {"Marge", "Simpson"}, {"Lisa", "Simpson"}, {"Ned", "Flanders"}, {"Joe", "Quimby"} }; void print_unique(const Names& names) { auto [begin, end] = characters.equal_range(names); std::print ( "Found {} characters with name \"{} {}\"\n", std::distance (begin, end), names.forename, names.surname ); } void print_by_surname(std::string_view surname) { auto [begin, end] = characters.equal_range(SurnameCompare{surname}); std::print ("Found {} characters with surname \"{}\":\n", std::distance (begin, end), surname); for (const Names& names : std::ranges::subrange (begin, end)) std::print (" {} {}\n", names.forename, names.surname); } int main() { print_unique({"Maude", "Flanders"}); print_unique({"Lisa", "Simpson"}); print_by_surname("Simpson"); }
Output:
Found 0 characters with name "Maude Flanders" Found 1 characters with name "Lisa Simpson" Found 3 characters with surname "Simpson": Homer Simpson Lisa Simpson Marge Simpson
[edit] See also
returns an iterator to the first element not less than the given key
(public member function) [edit]
(public member function) [edit]