std::queue< _Tp, _Sequence > Class Template Reference

A standard container giving FIFO behavior. More...

#include <stl_queue.h>

List of all members.

Public Types

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

Public Member Functions

 queue (const _Sequence &__c=_Sequence())
 Default constructor creates no elements.

bool empty () const
size_type size () const
reference front ()
const_reference front () const
reference back ()
const_reference back () const
void push (const value_type &__x)
 Add data to the end of the queue.

void pop ()
 Removes first element.


Protected Attributes

_Sequence c

Private Types

typedef _Sequence::value_type _Sequence_value_type

Private Member Functions

 __glibcxx_class_requires (_Tp, _SGIAssignableConcept) __glibcxx_class_requires(_Sequence
_FrontInsertionSequenceConcept __glibcxx_class_requires (_Sequence, _BackInsertionSequenceConcept) __glibcxx_class_requires2(_Tp

Private Attributes

_FrontInsertionSequenceConcept _Sequence_value_type

Friends

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


Detailed Description

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

A standard container giving FIFO behavior.

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


Member Typedef Documentation

template<typename _Tp, typename _Sequence>
typedef _Sequence::value_type std::queue< _Tp, _Sequence >::_Sequence_value_type [private]
 

Definition at line 109 of file stl_queue.h.

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

Definition at line 126 of file stl_queue.h.

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

Definition at line 128 of file stl_queue.h.

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

Definition at line 125 of file stl_queue.h.

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

Definition at line 127 of file stl_queue.h.

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

Definition at line 124 of file stl_queue.h.


Constructor & Destructor Documentation

template<typename _Tp, typename _Sequence>
std::queue< _Tp, _Sequence >::queue const _Sequence &  __c = _Sequence()  )  [inline, explicit]
 

Default constructor creates no elements.

Definition at line 146 of file stl_queue.h.

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


Member Function Documentation

template<typename _Tp, typename _Sequence>
_FrontInsertionSequenceConcept std::queue< _Tp, _Sequence >::__glibcxx_class_requires _Sequence  ,
_BackInsertionSequenceConcept 
[private]
 

template<typename _Tp, typename _Sequence>
std::queue< _Tp, _Sequence >::__glibcxx_class_requires _Tp  ,
_SGIAssignableConcept 
[private]
 

template<typename _Tp, typename _Sequence>
const_reference std::queue< _Tp, _Sequence >::back  )  const [inline]
 

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

Definition at line 198 of file stl_queue.h.

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

template<typename _Tp, typename _Sequence>
reference std::queue< _Tp, _Sequence >::back  )  [inline]
 

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

Definition at line 187 of file stl_queue.h.

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

template<typename _Tp, typename _Sequence>
bool std::queue< _Tp, _Sequence >::empty  )  const [inline]
 

Returns true if the queue is empty.

Definition at line 152 of file stl_queue.h.

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

template<typename _Tp, typename _Sequence>
const_reference std::queue< _Tp, _Sequence >::front  )  const [inline]
 

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

Definition at line 176 of file stl_queue.h.

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

template<typename _Tp, typename _Sequence>
reference std::queue< _Tp, _Sequence >::front  )  [inline]
 

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

Definition at line 165 of file stl_queue.h.

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

template<typename _Tp, typename _Sequence>
void std::queue< _Tp, _Sequence >::pop  )  [inline]
 

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

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

template<typename _Tp, typename _Sequence>
void std::queue< _Tp, _Sequence >::push const value_type __x  )  [inline]
 

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

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

template<typename _Tp, typename _Sequence>
size_type std::queue< _Tp, _Sequence >::size  )  const [inline]
 

Returns the number of elements in the queue.

Definition at line 157 of file stl_queue.h.

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


Friends And Related Function Documentation

template<typename _Tp, typename _Sequence>
template<typename _Tp1, typename _Seq1>
bool operator< const queue< _Tp1, _Seq1 > &  ,
const queue< _Tp1, _Seq1 > & 
[friend]
 

template<typename _Tp, typename _Sequence>
template<typename _Tp1, typename _Seq1>
_FrontInsertionSequenceConcept _SameTypeConcept friend bool operator== const queue< _Tp1, _Seq1 > &  ,
const queue< _Tp1, _Seq1 > & 
[friend]
 


Member Data Documentation

template<typename _Tp, typename _Sequence>
_FrontInsertionSequenceConcept std::queue< _Tp, _Sequence >::_Sequence_value_type [private]
 

Definition at line 113 of file stl_queue.h.

template<typename _Tp, typename _Sequence>
_Sequence std::queue< _Tp, _Sequence >::c [protected]
 

'c' is the underlying container. Maintainers wondering why this isn't uglified as per style guidelines should note that this name is specified in the standard, [23.2.3.1]. (Why? Presumably for the same reason that it's protected instead of private: to allow derivation. But none of the other containers allow for derivation. Odd.)

Definition at line 139 of file stl_queue.h.

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


The documentation for this class was generated from the following file:
Generated on Tue Jan 30 17:32:15 2007 for GNU C++ STL by doxygen 1.3.6