stack< ValueType > Class Template Reference

#include <stack.hpp>

Collaboration diagram for stack< ValueType >:

Public Types
using	value_type = ValueType

Public Member Functions
void	display () const
std::vector< value_type >	toVector () const
bool	isEmptyStack () const
void	push (const value_type &item)
value_type	top () const
void	pop ()
void	clear ()

Private Member Functions
void	ensureNotEmpty () const

Private Attributes
std::shared_ptr< node< value_type > >	stackTop
std::size_t	size = 0
	size of stack

Detailed Description

template<class ValueType>
class stack< ValueType >

Definition of the stack class

Template Parameters

value_type

type of data nodes of the linked list in the stack should contain

Member Function Documentation

clear()

template<class ValueType >

void stack< ValueType >::clear ( )

inline

Clear stack

                 {
        stackTop = nullptr;
        size = 0;
    }

display()

template<class ValueType >

void stack< ValueType >::display ( ) const

inline

Show stack

                         {
        std::cout << "Top --> ";
        traverse(stackTop.get(), [](const node<value_type>& inNode) {
            std::cout << inNode.data << "  ";
        });
        std::cout << std::endl;
        std::cout << "Size of stack: " << size << std::endl;
    }

Here is the call graph for this function:

ensureNotEmpty()

template<class ValueType >

void stack< ValueType >::ensureNotEmpty ( ) const

inlineprivate

                                {
        if (isEmptyStack()) {
            throw std::invalid_argument("Stack is empty.");
        }
    }

isEmptyStack()

template<class ValueType >

bool stack< ValueType >::isEmptyStack ( ) const

inline

Determine whether the stack is empty

{ return (stackTop == nullptr); }

pop()

template<class ValueType >

void stack< ValueType >::pop ( )

inline

Remove the top element of the stack

               {
        ensureNotEmpty();
        stackTop = stackTop->next;
        size--;
    }

push()

template<class ValueType >

void stack< ValueType >::push ( const value_type &  item )

inline

Add new item to the stack

                                      {
        auto newNode = std::make_shared<node<value_type>>();
        newNode->data = item;
        newNode->next = stackTop;
        stackTop = newNode;
        size++;
    }

top()

template<class ValueType >

value_type stack< ValueType >::top ( ) const

inline

Return the top element of the stack

                           {
        ensureNotEmpty();
        return stackTop->data;
    }

toVector()

template<class ValueType >

std::vector< value_type > stack< ValueType >::toVector ( ) const

inline

                                           {
        std::vector<value_type> res;
        res.reserve(this->size);
        traverse(stackTop.get(), [&res](const node<value_type>& inNode) {
            res.push_back(inNode.data);
        });
        return res;
    }

Member Data Documentation

stackTop

template<class ValueType >

std::shared_ptr<node<value_type> > stack< ValueType >::stackTop

private

Initial value:

=
        {}

Pointer to the stack

---

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

• data_structures/stack.hpp