Namespaces
Variants
Views
Actions

Difference between revisions of "cpp/container/queue"

From cppreference.com
< cpp‎ | container
(+template params)
m
 
(35 intermediate revisions by 16 users not shown)
Line 1: Line 1:
 
{{cpp/title|queue}}
 
{{cpp/title|queue}}
 
{{cpp/container/queue/navbar}}
 
{{cpp/container/queue/navbar}}
{{ddcl | header=queue |
+
{{ddcl|header=queue|1=
 
template<
 
template<
 
     class T,
 
     class T,
     class Container {{=}} std::deque<T>
+
     class Container = std::deque<T>
 
> class queue;
 
> class queue;
}}  
+
}}
  
The {{tt|std::queue}} class is a container adapter that gives the programmer the functionality of a queue - specifically, a FIFO (first-in, first-out) data structure.  
+
The {{tt|std::queue}} class template is a [[cpp/container#Container adaptors|container adaptor]] that gives the functionality of a {{enwiki|Queue (abstract data type)|queue}} - specifically, a FIFO (first-in, first-out) data structure.
 +
 
 +
The class template acts as a wrapper to the underlying container - only a specific set of functions is provided. The queue pushes the elements on the back of the underlying container and pops them from the front.
  
 
===Template parameters===
 
===Template parameters===
{{param list begin}}
+
{{par begin}}
{{param list item | T | The type of the stored elements.}}
+
{{par|T|The type of the stored elements. The program is ill-formed if {{tt|T}} is not the same type as {{tt|Container::value_type}}.}}
{{param list item | Container | The type of the underlying container to use to store the elements. The container must satisfy the requirements of {{concept|SequenceContainer}}. 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}}. Additionally, it must provide the following functions with the [[cpp/named req/SequenceContainer#Optional operations|usual semantics]]:
 +
* {{tt|back()}}, e.g., {{lc|std::deque::back()}},
 +
* {{tt|front()}}, e.g. {{lc|std::list::front()}},
 +
* {{tt|push_back()}}, e.g., {{lc|std::deque::push_back()}},
 +
* {{tt|pop_front()}}, e.g., {{lc|std::list::pop_front()}}.
  
* {{tt|back()}}
+
The standard containers {{lc|std::deque}} and {{lc|std::list}} satisfy these requirements.
* {{tt|front()}}
+
}}{{par end}}
* {{tt|push_back()}}
+
* {{tt|pop_front()}}
+
 
+
The standard containers {{c|std::vector}}, {{c|std::deque}} and {{c|std::list}} satisfy these requirements.  
+
}}{{param list end}}
+
  
 
===Member types===
 
===Member types===
{{dcl list begin}}
+
{{dsc begin}}
{{dcl list hitem | Member type | Definition}}
+
{{dsc hitem|Member type|Definition}}
{{dcl list template | cpp/container/dcl list container_type | queue}}
+
{{dsc inc|cpp/container/dsc container_type|queue}}
{{dcl list template | cpp/container/dcl list value_type | queue}}
+
{{dsc inc|cpp/container/dsc value_type|queue}}
{{dcl list template | cpp/container/dcl list size_type | queue}}
+
{{dsc inc|cpp/container/dsc size_type|queue}}
{{dcl list template | cpp/container/dcl list reference | queue}}
+
{{dsc inc|cpp/container/dsc reference|queue}}
{{dcl list template | cpp/container/dcl list const_reference | queue}}
+
{{dsc inc|cpp/container/dsc const_reference|queue}}
{{dcl list end}}
+
{{dsc end}}
 +
 
 +
===Member objects===
 +
{{dsc begin}}
 +
{{dsc hitem|Member name|Definition}}
 +
{{dsc inc|cpp/container/dsc c|queue}}
 +
{{dsc end}}
  
 
===Member functions===
 
===Member functions===
{{dcl list begin}}
+
{{dsc begin}}
{{dcl list template | cpp/container/dcl list constructor | queue}}
+
{{dsc inc|cpp/container/dsc constructor|queue}}
{{dcl list template | cpp/container/dcl list destructor | queue}}
+
{{dsc inc|cpp/container/dsc destructor|queue}}
{{dcl list template | cpp/container/dcl list operator{{=}} | queue}}
+
{{dsc inc|cpp/container/dsc operator{{=}}|queue}}
  
{{dcl list h2 | Element access}}
+
{{dsc h2|Element access}}
{{dcl list template | cpp/container/dcl list front | queue}}
+
{{dsc inc|cpp/container/dsc front|queue}}
{{dcl list template | cpp/container/dcl list back | queue}}
+
{{dsc inc|cpp/container/dsc back|queue}}
  
{{dcl list h2 | Capacity}}
+
{{dsc h2|Capacity}}
{{dcl list template | cpp/container/dcl list empty | queue}}
+
{{dsc inc|cpp/container/dsc empty|queue}}
{{dcl list template | cpp/container/dcl list size | queue}}
+
{{dsc inc|cpp/container/dsc size|queue}}
  
{{dcl list h2 | Modifiers}}
+
{{dsc h2|Modifiers}}
{{dcl list template | cpp/container/dcl list push | queue}}
+
{{dsc inc|cpp/container/dsc push|queue}}
{{dcl list template | cpp/container/dcl list emplace | queue}}
+
{{dsc inc|cpp/container/dsc push_range|queue}}
{{dcl list template | cpp/container/dcl list pop | queue}}
+
{{dsc inc|cpp/container/dsc emplace|queue}}
{{dcl list template | cpp/container/dcl list swap | queue}}
+
{{dsc inc|cpp/container/dsc pop|queue}}
 
+
{{dsc inc|cpp/container/dsc swap|queue}}
{{dcl list h1 | Member objects}}
+
{{dsc end}}
{{dcl list template | cpp/container/dcl list c | queue}}
+
{{dcl list end}}
+
  
 
===Non-member functions===
 
===Non-member functions===
{{dcl list begin}}
+
{{dsc begin}}
{{dcl list template | cpp/container/dcl list operator_cmp | queue}}
+
{{dsc inc|cpp/container/dsc operator_cmp|queue}}
{{dcl list template | cpp/container/dcl list swap2 | queue}}
+
{{dsc inc|cpp/container/dsc swap2|queue}}
{{dcl list end}}
+
{{dsc end}}
  
 
===Helper classes===
 
===Helper classes===
{{dcl list begin}}
+
{{dsc begin}}
{{dcl list template | cpp/container/dcl list uses_allocator | queue}}
+
{{dsc inc|cpp/container/dsc uses_allocator|queue}}
{{dcl list end}}
+
{{dsc inc|cpp/container/dsc adaptor_formatter|queue}}
 +
{{dsc end}}
 +
 
 +
{{rrev|since=c++17|
 +
==={{rl|deduction guides|Deduction guides}}===
 +
}}
 +
 
 +
===Notes===
 +
{{ftm begin|std=1|comment=1}}
 +
{{ftm|__cpp_lib_containers_ranges|value=202202L|std=C++23|Ranges construction and insertion for containers}}
 +
{{ftm end}}
 +
 
 +
===Example===
 +
{{example
 +
|code=
 +
#include <cassert>
 +
#include <iostream>
 +
#include <queue>
 +
 
 +
int main()
 +
{
 +
    std::queue<int> q;
 +
 
 +
    q.push(0); // back pushes 0
 +
    q.push(1); // q = 0 1
 +
    q.push(2); // q = 0 1 2
 +
    q.push(3); // q = 0 1 2 3
 +
 
 +
    assert(q.front() == 0);
 +
    assert(q.back() == 3);
 +
    assert(q.size() == 4);
 +
 
 +
    q.pop(); // removes the front element, 0
 +
    assert(q.size() == 3);
 +
 
 +
    // Print and remove all elements. Note that std::queue does not
 +
    // support begin()/end(), so a range-for-loop cannot be used.
 +
    std::cout << "q: ";
 +
    for (; !q.empty(); q.pop())
 +
        std::cout << q.front() << ' ';
 +
    std::cout << '\n';
 +
    assert(q.size() == 0);
 +
}
 +
|output=
 +
q: 1 2 3
 +
}}
 +
 
 +
===Defect reports===
 +
{{dr list begin}}
 +
{{dr list item|wg=lwg|dr=307|std=C++98|before={{tt|std::queue}} did not support containers using proxy<br>reference types<ref>Such as containers similar to {{ltt|cpp/container/vector bool|std::vector<bool>}} with additional support of {{tt|pop_front()}}. The resolution of this DR<br>added support of {{ltt|cpp/container/vector bool|std::vector<bool>}} for {{lc|std::stack}} and {{lc|std::priority_queue}}. The changes involving {{tt|std::queue}}<br>are for maintaining consistency.</ref> in place of ({{tt|const}}) {{tt|value_type&}}|after=supported}}
 +
{{dr list item|wg=lwg|dr=2566|std=C++98|before=Missing the requirement for {{tt|Container::value_type}} |after=ill-formed if {{tt|T}} is not the same type as {{tt|Container::value_type}}}}
 +
{{dr list end}}
 +
<references/>
 +
 
 +
===See also===
 +
{{dsc begin}}
 +
{{dsc inc|cpp/container/dsc priority_queue}}
 +
{{dsc inc|cpp/container/dsc deque}}
 +
{{dsc inc|cpp/container/dsc list}}
 +
{{dsc end}}
  
[[de:cpp/container/queue]]
+
{{langlinks|de|es|fr|it|ja|pl|pt|ru|zh}}
[[es:cpp/container/queue]]
+
[[fr:cpp/container/queue]]
+
[[it:cpp/container/queue]]
+
[[ja:cpp/container/queue]]
+
[[pl:cpp/container/queue]]
+
[[pt:cpp/container/queue]]
+
[[ru:cpp/container/queue]]
+
[[tr:cpp/container/queue]]
+
[[zh:cpp/container/queue]]
+

Latest revision as of 23:51, 2 August 2024

 
 
 
 
Defined in header <queue>
template<

    class T,
    class Container = std::deque<T>

> class queue;

The std::queue class template is a container adaptor that gives the functionality of a queue - specifically, a FIFO (first-in, first-out) data structure.

The class template acts as a wrapper to the underlying container - only a specific set of functions is provided. The queue pushes the elements on the back of the underlying container and pops them from the front.

Contents

[edit] Template parameters

T - The type of the stored elements. The program is ill-formed if T is not the same type as Container::value_type.
Container - The type of the underlying container to use to store the elements. The container must satisfy the requirements of SequenceContainer. Additionally, it must provide the following functions with the usual semantics:

The standard containers std::deque and std::list satisfy these requirements.

[edit] Member types

Member type Definition
container_type Container[edit]
value_type Container::value_type[edit]
size_type Container::size_type[edit]
reference Container::reference[edit]
const_reference Container::const_reference[edit]

[edit] Member objects

Member name Definition
Container c
the underlying container
(protected member object) [edit]

[edit] Member functions

constructs the queue
(public member function) [edit]
destructs the queue
(public member function) [edit]
assigns values to the container adaptor
(public member function) [edit]
Element access
access the first element
(public member function) [edit]
access the last element
(public member function) [edit]
Capacity
checks whether the container adaptor is empty
(public member function) [edit]
returns the number of elements
(public member function) [edit]
Modifiers
inserts element at the end
(public member function) [edit]
inserts a range of elements at the end
(public member function) [edit]
(C++11)
constructs element in-place at the end
(public member function) [edit]
removes the first element
(public member function) [edit]
(C++11)
swaps the contents
(public member function) [edit]

[edit] Non-member functions

lexicographically compares the values of two queues
(function template) [edit]
specializes the std::swap algorithm
(function template) [edit]

[edit] Helper classes

specializes the std::uses_allocator type trait
(class template specialization) [edit]
formatting support for std::queue
(class template specialization) [edit]

Deduction guides

(since C++17)

[edit] Notes

Feature-test macro Value Std Feature
__cpp_lib_containers_ranges 202202L (C++23) Ranges construction and insertion for containers

[edit] Example

#include <cassert>
#include <iostream>
#include <queue>
 
int main()
{
    std::queue<int> q;
 
    q.push(0); // back pushes 0
    q.push(1); // q = 0 1
    q.push(2); // q = 0 1 2
    q.push(3); // q = 0 1 2 3
 
    assert(q.front() == 0);
    assert(q.back() == 3);
    assert(q.size() == 4);
 
    q.pop(); // removes the front element, 0
    assert(q.size() == 3);
 
    // Print and remove all elements. Note that std::queue does not
    // support begin()/end(), so a range-for-loop cannot be used.
    std::cout << "q: ";
    for (; !q.empty(); q.pop())
        std::cout << q.front() << ' ';
    std::cout << '\n';
    assert(q.size() == 0);
}

Output:

q: 1 2 3

[edit] 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 std::queue did not support containers using proxy
reference types[1] in place of (const) value_type&
supported
LWG 2566 C++98 Missing the requirement for Container::value_type ill-formed if T is not the same type as Container::value_type
  1. Such as containers similar to std::vector<bool> with additional support of pop_front(). The resolution of this DR
    added support of std::vector<bool> for std::stack and std::priority_queue. The changes involving std::queue
    are for maintaining consistency.

[edit] See also

adapts a container to provide priority queue
(class template) [edit]
double-ended queue
(class template) [edit]
doubly-linked list
(class template) [edit]