queue< ValueType > Class Template Reference

#include <queue.hpp>

Collaboration diagram for queue< ValueType >:

Public Types
using	value_type = ValueType

Public Member Functions
void	display () const
	prints the queue into the std::cout
std::vector< value_type >	toVector () const
	converts the queue into the std::vector
bool	isEmptyQueue () const
	checks if the queue has no elements
void	enQueue (const value_type &item)
	inserts a new item into the queue
value_type	front () const
void	deQueue ()
	removes the first element from the queue
void	clear ()
	removes all elements from the queue

Private Types
using	node_type = Node<ValueType>

Private Member Functions
void	ensureNotEmpty () const
	throws an exception if queue is empty

Private Attributes
std::shared_ptr< node_type >	queueFront
std::shared_ptr< node_type >	queueRear
std::size_t	size = 0

Detailed Description

template<class ValueType>
class queue< ValueType >

Definition of the queue class

Definition at line 9 of file queue.hpp.

Member Typedef Documentation

node_type

template<class ValueType >

using queue< ValueType >::node_type = Node<ValueType>

private

Definition at line 10 of file queue.hpp.

value_type

template<class ValueType >

using queue< ValueType >::value_type = ValueType

Definition at line 13 of file queue.hpp.

Member Function Documentation

clear()

template<class ValueType >

void queue< ValueType >::clear ( )

inline

removes all elements from the queue

Definition at line 90 of file queue.hpp.

                 {
        queueFront = nullptr;
        queueRear = nullptr;
        size = 0;
    }

deQueue()

template<class ValueType >

void queue< ValueType >::deQueue ( )

inline

removes the first element from the queue

Exceptions

std::invalid_argument

if queue is empty

Definition at line 81 of file queue.hpp.

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

display()

template<class ValueType >

void queue< ValueType >::display ( ) const

inline

prints the queue into the std::cout

Definition at line 17 of file queue.hpp.

                         {
        std::cout << "Front --> ";
        display_all(this->queueFront.get());
        std::cout << '\n';
        std::cout << "Size of queue: " << size << '\n';
    }

enQueue()

template<class ValueType >

void queue< ValueType >::enQueue ( const value_type & item )

inline

inserts a new item into the queue

Definition at line 54 of file queue.hpp.

                                         {
        auto newNode = std::make_shared<node_type>();
        newNode->data = item;
        newNode->next = nullptr;
        if (isEmptyQueue()) {
            queueFront = newNode;
            queueRear = newNode;
        } else {
            queueRear->next = newNode;
            queueRear = queueRear->next;
        }
        ++size;
    }

ensureNotEmpty()

template<class ValueType >

void queue< ValueType >::ensureNotEmpty ( ) const

inlineprivate

throws an exception if queue is empty

Exceptions

std::invalid_argument

if queue is empty

Definition at line 38 of file queue.hpp.

                                {
        if (isEmptyQueue()) {
            throw std::invalid_argument("Queue is empty.");
        }
    }

front()

template<class ValueType >

value_type queue< ValueType >::front ( ) const

inline

Returns

the first element of the queue

Exceptions

std::invalid_argument

if queue is empty

Definition at line 72 of file queue.hpp.

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

isEmptyQueue()

template<class ValueType >

bool queue< ValueType >::isEmptyQueue ( ) const

inline

checks if the queue has no elements

Returns

true if the queue is empty, false otherwise

Definition at line 49 of file queue.hpp.

{ return (queueFront == nullptr); }

toVector()

template<class ValueType >

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

inline

converts the queue into the std::vector

Returns

std::vector containning all of the elements of the queue in the same order

Definition at line 29 of file queue.hpp.

                                           {
        return push_all_to_vector(this->queueFront.get(), this->size);
    }

Member Data Documentation

queueFront

template<class ValueType >

std::shared_ptr<node_type> queue< ValueType >::queueFront

private

Initial value:

=
        {}

Pointer to the front of the queue

Definition at line 97 of file queue.hpp.

        {}; 

queueRear

template<class ValueType >

std::shared_ptr<node_type> queue< ValueType >::queueRear

private

Initial value:

=
        {}

Pointer to the rear of the queue

Definition at line 99 of file queue.hpp.

        {}; 

size

template<class ValueType >

std::size_t queue< ValueType >::size = 0

private

Definition at line 101 of file queue.hpp.

---

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

• data_structures/queue.hpp