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::stack< _Tp, _Sequence > - A standard container giving FILO behavior.

Author

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

                                                    libstdc++                 std::stack<_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::stack<_Tp,_Sequence>::stack()[inline]
       Default constructor creates no elements.

Detailed Description

template<typename_Tp,typename_Sequence=deque<_Tp>>
       class std::stack< _Tp, _Sequence >"A standard container giving FILO 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-last-out stack 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 back, push_back, and pop_back, such as std::list,
       std::vector, 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, pop, and top, which are standard stack/FILO operations.

Member Function Documentation

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

   template<typename_Tp,typename_Sequence=deque<_Tp>>voidstd::stack<_Tp,_Sequence>::pop()[inline]
       Removes first element. This is a typical stack operation. It shrinks the stack 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.

   template<typename_Tp,typename_Sequence=deque<_Tp>>voidstd::stack<_Tp,_Sequence>::push(constvalue_type&__x)[inline]
       Add data to the top of the stack.

       Parameters__x Data to be added.

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

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

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

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

Name

       std::stack< _Tp, _Sequence > - A standard container giving FILO behavior.

Synopsis

       #include <stack>

   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> stack ()
           Default constructor creates no elements.
       stack (_Sequence &&__c)
       template<typename _Alloc , typename _Requires  = _Uses<_Alloc>> stack (_Sequence &&__c, const _Alloc
           &__a)
       template<typename _Alloc , typename _Requires  = _Uses<_Alloc>> stack (const _Alloc &__a)
       stack (const _Sequence &__c)
       template<typename _Alloc , typename _Requires  = _Uses<_Alloc>> stack (const _Sequence &__c, const _Alloc
           &__a)
       template<typename _Alloc , typename _Requires  = _Uses<_Alloc>> stack (const stack &__q, const _Alloc
           &__a)
       template<typename _Alloc , typename _Requires  = _Uses<_Alloc>> stack (stack &&__q, const _Alloc &__a)
       template<typename... _Args> decltype(auto) emplace (_Args &&... __args)
       bool empty () const
       voidpop ()
           Removes first element.
       voidpush (const value_type &__x)
           Add data to the top of the stack.
       voidpush (value_type &&__x)
       size_type size () const
       voidswap (stack &__s) noexcept(__is_nothrow_swappable< _Sequence >::value)
       reference top ()
       const_reference top () const

   ProtectedAttributes
       _Sequence cFriends
       template<typename_Tp1 , typename_Seq1 > bool operator< (const stack< _Tp1, _Seq1 > &, const stack<
           _Tp1, _Seq1 > &)
       template<typename_Tp1 , typename_Seq1 > bool operator== (const stack< _Tp1, _Seq1 > &, const stack<
           _Tp1, _Seq1 > &)

See Also