libstdc++: std::queue< _Tp, _Sequence > Class Template Reference (original) (raw)

#include <[stl_queue.h](a00737%5Fsource.html)>

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>
	queue ()

	queue (_Sequence &&__c)

template<typename _Alloc , typename _Requires = _Uses<_Alloc>>
	queue (_Sequence &&__c, const _Alloc &__a)

template<typename _Alloc , typename _Requires = _Uses<_Alloc>>
	queue (const _Alloc &__a)

	queue (const _Sequence &__c)

template<typename _Alloc , typename _Requires = _Uses<_Alloc>>
	queue (const _Sequence &__c, const _Alloc &__a)

template<typename _Alloc , typename _Requires = _Uses<_Alloc>>
	queue (const queue &__q, const _Alloc &__a)

template<typename _Alloc , typename _Requires = _Uses<_Alloc>>
	queue (queue &&__q, const _Alloc &__a)

reference	back ()

const_reference	back () const

template<typename... _Args>
decltype(auto)	emplace (_Args &&... __args)

bool	empty () const

reference	front ()

const_reference	front () const

void	pop ()

void	push (const value_type &__x)

void	push (value_type &&__x)

size_type	size () const

void	swap (queue &__q) noexcept(__is_nothrow_swappable< _Sequence >::value)

Protected Attributes
_Sequence	c

Friends
template<typename _Tp1 , typename _Seq1 >
bool	operator< (const queue< _Tp1, _Seq1 > &, const queue< _Tp1, _Seq1 > &)

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

template<typename _Tp1 , typename _Seq1 >
bool	operator== (const queue< _Tp1, _Seq1 > &, const queue< _Tp1, _Seq1 > &)

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 96 of file stl_queue.h.

◆ const_reference

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

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

◆ container_type

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

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

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

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

◆ size_type

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

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

◆ value_type

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

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

◆ 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>

Default constructor creates no elements.

Definition at line 166 of file stl_queue.h.

◆ queue() [2/8]

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

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

◆ queue() [3/8]

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

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

◆ 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)	inlineexplicit

◆ 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 )	inline

◆ 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 )	inline

◆ 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 )	inline

◆ 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 )	inline

◆ back() [1/2]

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

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

◆ back() [2/2]

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

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

◆ emplace()

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

template<typename... _Args>

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

◆ empty()

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

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

◆ front() [1/2]

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

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

◆ front() [2/2]

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

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

◆ pop()

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

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 316 of file stl_queue.h.

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

◆ push() [1/2]

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

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

Add data to the end of the queue.

Parameters

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 283 of file stl_queue.h.

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

◆ push() [2/2]

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

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

◆ size()

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

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

◆ swap()

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

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

◆ c

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

c is the underlying container.

Definition at line 153 of file stl_queue.h.

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

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

stl_queue.h