Difference between revisions of "cpp/container/priority queue"
(Added see-also links.) |
m (fmt, links) |
||
Line 7: | Line 7: | ||
class Compare = std::less<typename Container::value_type> | class Compare = std::less<typename Container::value_type> | ||
> class priority_queue; | > class priority_queue; | ||
− | }} | + | }} |
A priority queue is a container adaptor that provides constant time lookup of the largest (by default) element, at the expense of logarithmic insertion and extraction. | A priority queue is a container adaptor that provides constant time lookup of the largest (by default) element, at the expense of logarithmic insertion and extraction. | ||
Line 19: | Line 19: | ||
{{par|T|The type of the stored elements. {{rev inl|since=c++17|The behavior is undefined if {{tt|T}} is not the same type as {{tt|Container::value_type}}.}}}} | {{par|T|The type of the stored elements. {{rev inl|since=c++17|The behavior is undefined if {{tt|T}} is not the same type as {{tt|Container::value_type}}.}}}} | ||
{{par|Container|The type of the underlying container to use to store the elements. The container must satisfy the requirements of {{named req|SequenceContainer}}, and its iterators must satisfy the requirements of {{named req|RandomAccessIterator}}. Additionally, it must provide the following functions with the usual semantics: | {{par|Container|The type of the underlying container to use to store the elements. The container must satisfy the requirements of {{named req|SequenceContainer}}, and its iterators must satisfy the requirements of {{named req|RandomAccessIterator}}. Additionally, it must provide the following functions with the usual semantics: | ||
− | * {{ | + | * {{lc|front()}} |
− | * {{ | + | * {{lc|push_back()}} |
− | * {{ | + | * {{lc|pop_back()}}. |
− | The standard containers {{lc|std::vector}} (including {{ | + | The standard containers {{lc|std::vector}} (including {{rlpt|vector bool|std::vector<bool>}}) and {{lc|std::deque}} satisfy these requirements.}} |
{{par|Compare|A {{named req|Compare}} type providing a strict weak ordering. | {{par|Compare|A {{named req|Compare}} type providing a strict weak ordering. | ||
Line 31: | Line 31: | ||
===Member types=== | ===Member types=== | ||
{{dsc begin}} | {{dsc begin}} | ||
− | {{dsc hitem | Member type | Definition}} | + | {{dsc hitem|Member type|Definition}} |
− | {{dsc inc | cpp/container/dsc container_type | priority_queue}} | + | {{dsc inc|cpp/container/dsc container_type|priority_queue}} |
− | {{dsc | {{tt|value_compare}} | {{tt|Compare}} }} | + | {{dsc|{{tt|value_compare}}|{{tt|Compare}}}} |
− | {{dsc inc | cpp/container/dsc value_type | priority_queue}} | + | {{dsc inc|cpp/container/dsc value_type|priority_queue}} |
− | {{dsc inc | cpp/container/dsc size_type | priority_queue}} | + | {{dsc inc|cpp/container/dsc size_type|priority_queue}} |
− | {{dsc inc | cpp/container/dsc reference | priority_queue}} | + | {{dsc inc|cpp/container/dsc reference|priority_queue}} |
− | {{dsc inc | cpp/container/dsc const_reference | priority_queue}} | + | {{dsc inc|cpp/container/dsc const_reference|priority_queue}} |
{{dsc end}} | {{dsc end}} | ||
===Member functions=== | ===Member functions=== | ||
{{dsc begin}} | {{dsc begin}} | ||
− | {{dsc inc | cpp/container/dsc constructor | priority_queue}} | + | {{dsc inc|cpp/container/dsc constructor|priority_queue}} |
− | {{dsc inc | cpp/container/dsc destructor | priority_queue}} | + | {{dsc inc|cpp/container/dsc destructor|priority_queue}} |
− | {{dsc inc | cpp/container/dsc operator{{=}} | priority_queue}} | + | {{dsc inc|cpp/container/dsc operator{{=}}|priority_queue}} |
− | {{dsc h2 | Element access}} | + | {{dsc h2|Element access}} |
− | {{dsc inc | cpp/container/dsc top | priority_queue}} | + | {{dsc inc|cpp/container/dsc top|priority_queue}} |
− | {{dsc h2 | Capacity}} | + | {{dsc h2|Capacity}} |
− | {{dsc inc | cpp/container/dsc empty | priority_queue}} | + | {{dsc inc|cpp/container/dsc empty|priority_queue}} |
− | {{dsc inc | cpp/container/dsc size | priority_queue}} | + | {{dsc inc|cpp/container/dsc size|priority_queue}} |
− | {{dsc h2 | Modifiers}} | + | {{dsc h2|Modifiers}} |
− | {{dsc inc | cpp/container/dsc push | priority_queue}} | + | {{dsc inc|cpp/container/dsc push|priority_queue}} |
− | {{dsc inc | cpp/container/dsc emplace | priority_queue}} | + | {{dsc inc|cpp/container/dsc emplace|priority_queue}} |
− | {{dsc inc | cpp/container/dsc pop | priority_queue}} | + | {{dsc inc|cpp/container/dsc pop|priority_queue}} |
− | {{dsc inc | cpp/container/dsc swap | priority_queue}} | + | {{dsc inc|cpp/container/dsc swap|priority_queue}} |
− | {{dsc h1 | Member objects}} | + | {{dsc h1|Member objects}} |
− | {{dsc inc | cpp/container/dsc c | priority_queue}} | + | {{dsc inc|cpp/container/dsc c|priority_queue}} |
− | {{dsc prot mem obj | nolink=true | {{dsc small|Compare}} comp | the comparison function object}} | + | {{dsc prot mem obj|nolink=true|{{dsc small|Compare}} comp|the comparison function object}} |
{{dsc end}} | {{dsc end}} | ||
===Non-member functions=== | ===Non-member functions=== | ||
{{dsc begin}} | {{dsc begin}} | ||
− | {{dsc inc | cpp/container/dsc swap2 | priority_queue}} | + | {{dsc inc|cpp/container/dsc swap2|priority_queue}} |
{{dsc end}} | {{dsc end}} | ||
===Helper classes=== | ===Helper classes=== | ||
{{dsc begin}} | {{dsc begin}} | ||
− | {{dsc inc | cpp/container/dsc uses_allocator | priority_queue}} | + | {{dsc inc|cpp/container/dsc uses_allocator|priority_queue}} |
{{dsc end}} | {{dsc end}} | ||
Line 81: | Line 81: | ||
|code= | |code= | ||
#include <functional> | #include <functional> | ||
− | |||
− | |||
#include <iostream> | #include <iostream> | ||
+ | #include <queue> | ||
#include <string_view> | #include <string_view> | ||
+ | #include <vector> | ||
template<typename T> | template<typename T> | ||
Line 146: | Line 146: | ||
print_queue("q5", q5); | print_queue("q5", q5); | ||
} | } | ||
− | |||
|output= | |output= | ||
− | data: | + | data: 1 8 5 6 3 4 0 9 7 2 |
− | q1: | + | q1: 9 8 7 6 5 4 3 2 1 0 |
− | minq1: | + | minq1: 0 1 2 3 4 5 6 7 8 9 |
− | minq2: | + | minq2: 0 1 2 3 4 5 6 7 8 9 |
− | minq3: | + | minq3: 0 1 2 3 4 5 6 7 8 9 |
− | q5: | + | q5: 8 9 6 7 4 5 2 3 0 1 |
}} | }} | ||
Revision as of 08:05, 10 January 2023
Defined in header <queue>
|
||
template< class T, |
||
A priority queue is a container adaptor that provides constant time lookup of the largest (by default) element, at the expense of logarithmic insertion and extraction.
A user-provided Compare
can be supplied to change the ordering, e.g. using std::greater<T> would cause the smallest element to appear as the top().
Working with a priority_queue
is similar to managing a heap in some random access container, with the benefit of not being able to accidentally invalidate the heap.
Contents |
Template parameters
T | - | The type of the stored elements. The behavior is undefined if T is not the same type as Container::value_type .(since C++17)
|
Container | - | The type of the underlying container to use to store the elements. The container must satisfy the requirements of SequenceContainer, and its iterators must satisfy the requirements of LegacyRandomAccessIterator. Additionally, it must provide the following functions with the usual semantics:
The standard containers std::vector (including |
Compare | - | A Compare type providing a strict weak ordering.
Note that the Compare parameter is defined such that it returns true if its first argument comes before its second argument in a weak ordering. But because the priority queue outputs largest elements first, the elements that "come before" are actually output last. That is, the front of the queue contains the "last" element according to the weak ordering imposed by Compare. |
Member types
Member type | Definition |
container_type
|
Container
|
value_compare
|
Compare
|
value_type
|
Container::value_type
|
size_type
|
Container::size_type |
reference
|
Container::reference
|
const_reference
|
Container::const_reference
|
Member functions
constructs the priority_queue (public member function) | |
destructs the priority_queue (public member function) | |
assigns values to the container adaptor (public member function) | |
Element access | |
accesses the top element (public member function) | |
Capacity | |
checks whether the container adaptor is empty (public member function) | |
returns the number of elements (public member function) | |
Modifiers | |
inserts element and sorts the underlying container (public member function) | |
(C++11) |
constructs element in-place and sorts the underlying container (public member function) |
removes the top element (public member function) | |
(C++11) |
swaps the contents (public member function) |
Member objects | |
Container c |
the underlying container (protected member object) |
Compare comp |
the comparison function object (protected member object) |
Non-member functions
specializes the std::swap algorithm (function template) |
Helper classes
specializes the std::uses_allocator type trait (class template specialization) |
Deduction guides (since C++17)
Example
#include <functional> #include <iostream> #include <queue> #include <string_view> #include <vector> template<typename T> void print(std::string_view name, T const& q) { std::cout << name << ": \t"; for (auto const& n : q) std::cout << n << ' '; std::cout << '\n'; } template<typename Q> void print_queue(std::string_view name, Q q) { // NB: q is passed by value because there is no way to traverse // priority_queue's content without erasing the queue. for (std::cout << name << ": \t"; !q.empty(); q.pop()) std::cout << q.top() << ' '; std::cout << '\n'; } int main() { const auto data = {1, 8, 5, 6, 3, 4, 0, 9, 7, 2}; print("data", data); std::priority_queue<int> q1; // Max priority queue for (int n : data) q1.push(n); print_queue("q1", q1); // Min priority queue // std::greater<int> makes the max priority queue act as a min priority queue std::priority_queue<int, std::vector<int>, std::greater<int>> minq1(data.begin(), data.end()); print_queue("minq1", minq1); // Second way to define a min priority queue std::priority_queue minq2(data.begin(), data.end(), std::greater<int>()); print_queue("minq2", minq2); // Using a custom function object to compare elements. struct { bool operator() (const int l, const int r) const { return l > r; } } customLess; std::priority_queue minq3(data.begin(), data.end(), customLess); print_queue("minq3", minq3); // Using lambda to compare elements. auto cmp = [](int left, int right) { return (left ^ 1) < (right ^ 1); }; std::priority_queue<int, std::vector<int>, decltype(cmp)> q5(cmp); for (int n : data) q5.push(n); print_queue("q5", q5); }
Output:
data: 1 8 5 6 3 4 0 9 7 2 q1: 9 8 7 6 5 4 3 2 1 0 minq1: 0 1 2 3 4 5 6 7 8 9 minq2: 0 1 2 3 4 5 6 7 8 9 minq3: 0 1 2 3 4 5 6 7 8 9 q5: 8 9 6 7 4 5 2 3 0 1
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 307 | C++98 | Container could not be std::vector<bool>
|
allowed |
LWG 2684 | C++98 | priority_queue takes a comparator but lacked member typedef for it
|
added |
See also
dynamic contiguous array (class template) | |
space-efficient dynamic bitset (class template specialization) | |
double-ended queue (class template) |