logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

std::queue< _Tp, _Sequence > - A standard container giving FIFO behavior.

Author

       Generated automatically by Doxygen for libstdc++ from the source code.

                                                    libstdc++                 std::queue<_Tp,_Sequence>(3cxx)

Constructor & Destructor Documentation

template<typename_Tp,typename_Sequence=deque<_Tp>>template<typename_Seq=_Sequence,typename_Requires=typenameenable_if<is_default_constructible<_Seq>::value>::type>std::queue<_Tp,_Sequence>::queue()[inline]
       Default constructor creates no elements.

Detailed Description

template<typename_Tp,typename_Sequence=deque<_Tp>>
       class std::queue< _Tp, _Sequence >"A standard container giving FIFO behavior.

       TemplateParameters_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.

Member Data Documentation

template<typename_Tp,typename_Sequence=deque<_Tp>>_Sequencestd::queue<_Tp,_Sequence>::c[protected]
       c is the underlying container.

       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::queue<_Tp,_Sequence>::pop(), std::queue<_Tp,_Sequence>::push(), and std::queue<_Tp,_Sequence>::size().

Member Function Documentation

template<typename_Tp,typename_Sequence=deque<_Tp>>referencestd::queue<_Tp,_Sequence>::back()[inline]
       Returns a read/write reference to the data at the last element of the queue.

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

   template<typename_Tp,typename_Sequence=deque<_Tp>>const_referencestd::queue<_Tp,_Sequence>::back()const[inline]
       Returns a read-only (constant) reference to the data at the last element of the queue.

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

   template<typename_Tp,typename_Sequence=deque<_Tp>>boolstd::queue<_Tp,_Sequence>::empty()const[inline]
       Returns true if the queue is empty.

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

   template<typename_Tp,typename_Sequence=deque<_Tp>>referencestd::queue<_Tp,_Sequence>::front()[inline]
       Returns a read/write reference to the data at the first element of the queue.

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

   template<typename_Tp,typename_Sequence=deque<_Tp>>const_referencestd::queue<_Tp,_Sequence>::front()const[inline]
       Returns a read-only (constant) reference to the data at the first element of the queue.

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

   template<typename_Tp,typename_Sequence=deque<_Tp>>voidstd::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.

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

   template<typename_Tp,typename_Sequence=deque<_Tp>>voidstd::queue<_Tp,_Sequence>::push(constvalue_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.

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

   template<typename_Tp,typename_Sequence=deque<_Tp>>size_typestd::queue<_Tp,_Sequence>::size()const[inline]
       Returns the number of elements in the queue.

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

Name

       std::queue< _Tp, _Sequence > - A standard container giving FIFO behavior.

Synopsis

       #include <queue>

   PublicTypestypedef _Sequence::const_reference const_referencetypedef _Sequence container_typetypedef _Sequence::reference referencetypedef _Sequence::size_type size_typetypedef _Sequence::value_type value_typePublicMemberFunctions
       template<typename_Seq  = _Sequence, typename _Requires  = typename
           enable_if<is_default_constructible<_Seq>::value>::type> queue ()
           Default constructor creates no elements.
       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
       voidpop ()
           Removes first element.
       voidpush (const value_type &__x)
           Add data to the end of the queue.
       voidpush (value_type &&__x)
       size_type size () const
       voidswap (queue &__q) noexcept(__is_nothrow_swappable< _Sequence >::value)

   ProtectedAttributes
       _Sequence c
           c is the underlying container.

   Friends
       template<typename_Tp1 , typename_Seq1 > 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 > &)

See Also