#include <stl_queue.h>

Public Types
typedef _Sequence::const_reference	const_reference
typedef _Sequence	container_type
typedef _Sequence::reference	reference
typedef _Sequence::size_type	size_type
typedef _Sequence::value_type	value_type

Public Member Functions
template<typename _Seq = _Sequence, typename _Requires = typename enable_if<is_default_constructible<_Seq>::value>::type>
constexpr	queue ()
constexpr	queue (_Sequence &&__c)
template<typename _Alloc, typename _Requires = _Uses<_Alloc>>
constexpr	queue (_Sequence &&__c, const _Alloc &__a)
template<typename _Alloc, typename _Requires = _Uses<_Alloc>>
constexpr	queue (const _Alloc &__a)
constexpr	queue (const _Sequence &__c)
template<typename _Alloc, typename _Requires = _Uses<_Alloc>>
constexpr	queue (const _Sequence &__c, const _Alloc &__a)
template<typename _Alloc, typename _Requires = _Uses<_Alloc>>
constexpr	queue (const queue &__q, const _Alloc &__a)
template<typename _Alloc, typename _Requires = _Uses<_Alloc>>
constexpr	queue (queue &&__q, const _Alloc &__a)
constexpr reference	back ()
constexpr const_reference	back () const
template<typename... _Args>
constexpr decltype(auto)	emplace (_Args &&... __args)
constexpr bool	empty () const
constexpr reference	front ()
constexpr const_reference	front () const
constexpr void	pop ()
constexpr void	push (const value_type &__x)
constexpr void	push (value_type &&__x)
constexpr size_type	size () const
constexpr void	swap (queue &__q) noexcept(__is_nothrow_swappable< _Sequence >::value)

Protected Attributes
_Sequence	c

Friends
template<typename _Tp1, typename _Seq1>
constexpr bool	operator< (const queue< _Tp1, _Seq1 > &, const queue< _Tp1, _Seq1 > &)
template<typename _Tp1, three_way_comparable _Seq1>
constexpr compare_three_way_result_t< _Seq1 >	operator<=> (const queue< _Tp1, _Seq1 > &, const queue< _Tp1, _Seq1 > &)
template<typename _Tp1, typename _Seq1>
constexpr bool	operator== (const queue< _Tp1, _Seq1 > &, const queue< _Tp1, _Seq1 > &)

Detailed Description

template<typename _Tp, typename _Sequence = deque<_Tp>>
class std::queue< _Tp, _Sequence >

A standard container giving FIFO behavior.

Template Parameters

_Tp	Type of element.
_Sequence	Type of underlying sequence, defaults to deque<_Tp>.

Meets many of the requirements of a container, but does not define anything to do with iterators. Very few of the other standard container interfaces are defined.

This is not a true container, but an adaptor. It holds another container, and provides a wrapper interface to that container. The wrapper is what enforces strict first-in-first-out queue behavior.

The second template parameter defines the type of the underlying sequence/container. It defaults to std::deque, but it can be any type that supports front, back, push_back, and pop_front, such as std::list or an appropriate user-defined type.

Members not found in normal containers are container_type, which is a typedef for the second Sequence parameter, and push and pop, which are standard queue/FIFO operations.

Definition at line 104 of file stl_queue.h.

Member Typedef Documentation

◆ const_reference

template<typename _Tp, typename _Sequence = deque<_Tp>>

typedef _Sequence::const_reference std::queue< _Tp, _Sequence >::const_reference

Definition at line 148 of file stl_queue.h.

◆ container_type

template<typename _Tp, typename _Sequence = deque<_Tp>>

typedef _Sequence std::queue< _Tp, _Sequence >::container_type

Definition at line 150 of file stl_queue.h.

◆ reference

template<typename _Tp, typename _Sequence = deque<_Tp>>

typedef _Sequence::reference std::queue< _Tp, _Sequence >::reference

Definition at line 147 of file stl_queue.h.

◆ size_type

template<typename _Tp, typename _Sequence = deque<_Tp>>

typedef _Sequence::size_type std::queue< _Tp, _Sequence >::size_type

Definition at line 149 of file stl_queue.h.

◆ value_type

template<typename _Tp, typename _Sequence = deque<_Tp>>

typedef _Sequence::value_type std::queue< _Tp, _Sequence >::value_type

Definition at line 146 of file stl_queue.h.

Constructor & Destructor Documentation

◆ queue() [1/8]

template<typename _Tp, typename _Sequence = deque<_Tp>>

template<typename _Seq = _Sequence, typename _Requires = typename enable_if<is_default_constructible<_Seq>::value>::type>

std::queue< _Tp, _Sequence >::queue ( )

inlineconstexpr

Default constructor creates no elements.

Definition at line 175 of file stl_queue.h.

References c.

◆ queue() [2/8]

template<typename _Tp, typename _Sequence = deque<_Tp>>

std::queue< _Tp, _Sequence >::queue ( const _Sequence & __c )

inlineexplicitconstexpr

Definition at line 179 of file stl_queue.h.

◆ queue() [3/8]

template<typename _Tp, typename _Sequence = deque<_Tp>>

std::queue< _Tp, _Sequence >::queue ( _Sequence && __c )

inlineexplicitconstexpr

Definition at line 183 of file stl_queue.h.

◆ queue() [4/8]

template<typename _Tp, typename _Sequence = deque<_Tp>>

template<typename _Alloc, typename _Requires = _Uses<_Alloc>>

std::queue< _Tp, _Sequence >::queue ( const _Alloc & __a )

inlineexplicitconstexpr

Definition at line 188 of file stl_queue.h.

◆ queue() [5/8]

template<typename _Tp, typename _Sequence = deque<_Tp>>

template<typename _Alloc, typename _Requires = _Uses<_Alloc>>

std::queue< _Tp, _Sequence >::queue	(	const _Sequence &	__c,
		const _Alloc &	__a )

inlineconstexpr

Definition at line 193 of file stl_queue.h.

◆ queue() [6/8]

template<typename _Tp, typename _Sequence = deque<_Tp>>

template<typename _Alloc, typename _Requires = _Uses<_Alloc>>

std::queue< _Tp, _Sequence >::queue	(	_Sequence &&	__c,
		const _Alloc &	__a )

inlineconstexpr

Definition at line 198 of file stl_queue.h.

◆ queue() [7/8]

template<typename _Tp, typename _Sequence = deque<_Tp>>

template<typename _Alloc, typename _Requires = _Uses<_Alloc>>

std::queue< _Tp, _Sequence >::queue	(	const queue< _Tp, _Sequence > &	__q,
		const _Alloc &	__a )

inlineconstexpr

Definition at line 203 of file stl_queue.h.

◆ queue() [8/8]

template<typename _Tp, typename _Sequence = deque<_Tp>>

template<typename _Alloc, typename _Requires = _Uses<_Alloc>>

std::queue< _Tp, _Sequence >::queue	(	queue< _Tp, _Sequence > &&	__q,
		const _Alloc &	__a )

inlineconstexpr

Definition at line 208 of file stl_queue.h.

Member Function Documentation

◆ back() [1/2]

template<typename _Tp, typename _Sequence = deque<_Tp>>

reference std::queue< _Tp, _Sequence >::back ( )

inlinenodiscardconstexpr

Returns a read/write reference to the data at the last element of the queue.

Definition at line 294 of file stl_queue.h.

References c.

◆ back() [2/2]

template<typename _Tp, typename _Sequence = deque<_Tp>>

const_reference std::queue< _Tp, _Sequence >::back ( ) const

inlinenodiscardconstexpr

Returns a read-only (constant) reference to the data at the last element of the queue.

Definition at line 306 of file stl_queue.h.

References c.

◆ emplace()

template<typename _Tp, typename _Sequence = deque<_Tp>>

template<typename... _Args>

decltype(auto) std::queue< _Tp, _Sequence >::emplace ( _Args &&... __args )

inlineconstexpr

Definition at line 333 of file stl_queue.h.

◆ empty()

template<typename _Tp, typename _Sequence = deque<_Tp>>

bool std::queue< _Tp, _Sequence >::empty ( ) const

inlinenodiscardconstexpr

Returns true if the queue is empty.

Definition at line 255 of file stl_queue.h.

References c.

◆ front() [1/2]

template<typename _Tp, typename _Sequence = deque<_Tp>>

reference std::queue< _Tp, _Sequence >::front ( )

inlinenodiscardconstexpr

Returns a read/write reference to the data at the first element of the queue.

Definition at line 270 of file stl_queue.h.

References c.

◆ front() [2/2]

template<typename _Tp, typename _Sequence = deque<_Tp>>

const_reference std::queue< _Tp, _Sequence >::front ( ) const

inlinenodiscardconstexpr

Returns a read-only (constant) reference to the data at the first element of the queue.

Definition at line 282 of file stl_queue.h.

References c.

◆ pop()

template<typename _Tp, typename _Sequence = deque<_Tp>>

void std::queue< _Tp, _Sequence >::pop ( )

inlineconstexpr

Removes first element.

This is a typical queue operation. It shrinks the queue by one. The time complexity of the operation depends on the underlying sequence.

Note that no data is returned, and if the first element's data is needed, it should be retrieved before pop() is called.

Definition at line 367 of file stl_queue.h.

References c.

◆ push() [1/2]

template<typename _Tp, typename _Sequence = deque<_Tp>>

void std::queue< _Tp, _Sequence >::push ( const value_type & __x )

inlineconstexpr

Add data to the end of the queue.

Parameters

__x	Data to be added.

This is a typical queue operation. The function creates an element at the end of the queue and assigns the given data to it. The time complexity of the operation depends on the underlying sequence.

Definition at line 322 of file stl_queue.h.

References c.

◆ push() [2/2]

template<typename _Tp, typename _Sequence = deque<_Tp>>

void std::queue< _Tp, _Sequence >::push ( value_type && __x )

inlineconstexpr

Definition at line 327 of file stl_queue.h.

◆ size()

template<typename _Tp, typename _Sequence = deque<_Tp>>

size_type std::queue< _Tp, _Sequence >::size ( ) const

inlinenodiscardconstexpr

Returns the number of elements in the queue.

Definition at line 261 of file stl_queue.h.

References c.

◆ swap()

template<typename _Tp, typename _Sequence = deque<_Tp>>

void std::queue< _Tp, _Sequence >::swap ( queue< _Tp, _Sequence > & __q )

inlineconstexprnoexcept

Definition at line 375 of file stl_queue.h.

Member Data Documentation

◆ c

template<typename _Tp, typename _Sequence = deque<_Tp>>

_Sequence std::queue< _Tp, _Sequence >::c

protected

c is the underlying container.

Definition at line 161 of file stl_queue.h.

Referenced by queue(), back(), back(), empty(), front(), front(), std::operator<(), std::operator==(), pop(), push(), and size().

The documentation for this class was generated from the following file:

stl_queue.h

Public Types

Public Member Functions

Protected Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ const_reference

◆ container_type

◆ reference

◆ size_type

◆ value_type

Constructor & Destructor Documentation

◆ queue() [1/8]

◆ queue() [2/8]

◆ queue() [3/8]

◆ queue() [4/8]

◆ queue() [5/8]

◆ queue() [6/8]

◆ queue() [7/8]

◆ queue() [8/8]

Member Function Documentation

◆ back() [1/2]

◆ back() [2/2]

◆ emplace()

◆ empty()

◆ front() [1/2]

◆ front() [2/2]

◆ pop()

◆ push() [1/2]

◆ push() [2/2]

◆ size()

◆ swap()

Member Data Documentation

◆ c