queue Class

A template container adaptor class that provides a restriction of functionality for some underlying container type, limiting access to the front and back elements. Elements can be added at the back or removed from the front, and elements can be inspected at either end of the queue.

template < 
   class Type,  
   class Container = deque<Type>  
> 
class queue

Parameters

  • Type
    The element data type to be stored in the queue

  • Container
    The type of the underlying container used to implement the queue.

Remarks

The elements of class Type stipulated in the first template parameter of a queue object are synonymous with value_type and must match the type of element in the underlying container class Container stipulated by the second template parameter. The Type must be assignable, so that it is possible to copy objects of that type and to assign values to variables of that type.

Suitable underlying container classes for queue include deque and list, or any other sequence container that supports the operations of front, back, push_back, and pop_front. The underlying container class is encapsulated within the container adaptor, which exposes only the limited set of the sequence container member functions as a public interface.

The queue objects are equality comparable if and only if the elements of class Type are equality comparable, and are less-than comparable if and only if the elements of class Type are less-than comparable.

There are three types of container adaptors defined by the STL: stack, queue, and priority_queue. Each restricts the functionality of some underlying container class to provide a precisely controlled interface to a standard data structure.

  • The stack class supports a last-in, first-out (LIFO) data structure. A good analogue to keep in mind would be a stack of plates. Elements (plates) may be inserted, inspected, or removed only from the top of the stack, which is the last element at the end of the base container. The restriction to accessing only the top element is the reason for using the stack class.

  • The queue class supports a first-in, first-out (FIFO) data structure. A good analogue to keep in mind would be people lining up for a bank teller. Elements (people) may be added to the back of the line and are removed from the front of the line. Both the front and the back of a line may be inspected. The restriction to accessing only the front and back elements in this way is the reason for using the queue class.

  • The priority_queue class orders its elements so that the largest element is always at the top position. It supports insertion of an element and the inspection and removal of the top element. A good analogue to keep in mind would be people lining up where they are arranged by age, height, or some other criterion.

Constructors

queue

Constructs a queue that is empty or that is a copy of a base container object.

Typedefs

container_type

A type that provides the base container to be adapted by the queue.

size_type

An unsigned integer type that can represent the number of elements in a queue.

value_type

A type that represents the type of object stored as an element in a queue.

Member Functions

back

Returns a reference to the last and most recently added element at the back of the queue.

empty

Tests if the queue is empty.

front

Returns a reference to the first element at the front of the queue.

pop

Removes an element from the front of the queue.

push

Adds an element to the back of the queue.

size

Returns the number of elements in the queue.

Requirements

Header: <queue>

Namespace: std

See Also

Reference

Thread Safety in the C++ Standard Library

Standard Template Library