data_structures::Stack< T > Class Template Reference

Class representation of a stack. More...

Collaboration diagram for data_structures::Stack< T >:

Public Member Functions
	Stack (int size)
	Constructs a new Stack object.
bool	full () const
	Checks if the stack is full.
bool	empty () const
	Checks if the stack is empty.
void	push (T element)
	Pushes an element onto the stack.
T	pop ()
	Pops an element from the stack.
void	show () const
	Displays all elements in the stack.
T	topmost () const
	Displays the topmost element of the stack.
T	bottom () const
	Displays the bottom element of the stack.

Private Attributes
std::unique_ptr< T[]>	stack
	Smart pointer to the stack array.
int	stackSize
	Maximum size of the stack.
int	stackIndex
	Index pointing to the top element of the stack.

Detailed Description

template<typename T>
class data_structures::Stack< T >

Class representation of a stack.

Template Parameters

T	The type of the elements in the stack

Constructor & Destructor Documentation

Stack()

template<typename T >

data_structures::Stack< T >::Stack ( int size )

inline

Constructs a new Stack object.

Parameters

size	Maximum size of the stack

: stackSize(size), stackIndex(-1), stack(new T[size]) {}

Member Function Documentation

bottom()

template<typename T >

T data_structures::Stack< T >::bottom ( ) const

inline

Displays the bottom element of the stack.

Returns

The bottom element of the stack

Exceptions

std::out_of_range

if the stack is empty

                     {
        if (empty()) {
            throw std::out_of_range("Stack underflow");
        }
        return stack[0];
    }

Here is the call graph for this function:

empty()

template<typename T >

bool data_structures::Stack< T >::empty ( ) const

inline

Checks if the stack is empty.

Returns

true if the stack is empty, false otherwise

{ return stackIndex == -1; }

full()

template<typename T >

bool data_structures::Stack< T >::full ( ) const

inline

Checks if the stack is full.

Returns

true if the stack is full, false otherwise

{ return stackIndex == stackSize - 1; }

pop()

template<typename T >

T data_structures::Stack< T >::pop ( )

inline

Pops an element from the stack.

Returns

The popped element

Exceptions

std::out_of_range

if the stack is empty

            {
        if (empty()) {
            throw std::out_of_range("Stack underflow");
        }
        return stack[stackIndex--];
    }

Here is the call graph for this function:

push()

template<typename T >

void data_structures::Stack< T >::push ( T element )

inline

Pushes an element onto the stack.

Parameters

element

Element to push onto the stack

                         {
        if (full()) {
            throw std::out_of_range("Stack overflow");
        } else {
            stack[++stackIndex] = element;
        }
    }

Here is the call graph for this function:

show()

template<typename T >

void data_structures::Stack< T >::show ( ) const

inline

Displays all elements in the stack.

                      {
        for (int i = 0; i <= stackIndex; i++) {
            std::cout << stack[i] << "\n";
        }
    }

topmost()

template<typename T >

T data_structures::Stack< T >::topmost ( ) const

inline

Displays the topmost element of the stack.

Returns

The topmost element of the stack

Exceptions

std::out_of_range

if the stack is empty

                      {
        if (empty()) {
            throw std::out_of_range("Stack underflow");
        }
        return stack[stackIndex];
    }

Here is the call graph for this function:

---

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

• data_structures/stack_using_array.cpp