StaticQueue< T > Class Template Reference

Queue implementation using a native C++ array as data storage. More...

#include <StaticQueue.hpp>

Inheritance diagram for StaticQueue< T >:

Collaboration diagram for StaticQueue< T >:

Public Member Functions
std::string	getName ()
	Provides the name of the data structure as a string representation. More...
	StaticQueue (int size)
	Create a fixed-size queue. More...
	StaticQueue (T data[])
	create the structure and populate it with the data from the array More...
	~StaticQueue ()
void	enqueue (T val)
	Add an element to the end of the queue. More...
T	dequeue ()
	Remove an element from the queue. More...
T	peek ()
	See the first value from the queue, without removing it. More...
int	getSize ()
	Outputs the number of elements stored in the structure. More...
bool	isEmpty ()
	Check whether the structure is empty. More...
bool	isFull ()
	Check whether the structure is full. More...
Public Member Functions inherited from Queue< T >
std::string	getName ()
	Provides the name of the data structure as a string representation. More...

Private Attributes
int	size
int	head
int	tail
int	count
T *	data

Detailed Description

template<class T>
class StaticQueue< T >

Queue implementation using a native C++ array as data storage.

Author

Douglas De Rizzo Meneghetti (dougl.nosp@m.asri.nosp@m.zzom@.nosp@m.gmai.nosp@m.l.com)

Date

2017-6-14Queue implementation using a native C++ array as data storage.

Template Parameters

T	The type of object the data structure will contain

Definition at line 17 of file StaticQueue.hpp.

Constructor & Destructor Documentation

StaticQueue() [1/2]

template<class T>

StaticQueue< T >::StaticQueue ( int  size )

inlineexplicit

Create a fixed-size queue.

Parameters

size	the size of the queue

Definition at line 27 of file StaticQueue.hpp.

                                 {
    head = tail = count = 0;
    this->size = size;
    data = new T[size];
  }

StaticQueue() [2/2]

template<class T>

StaticQueue< T >::StaticQueue ( T  data[] )

inlineexplicit

create the structure and populate it with the data from the array

Parameters

data	an array with data with which the structure will be initialized

Definition at line 35 of file StaticQueue.hpp.

                                 {
    this->data = data;

    size = count = (sizeof(data) / sizeof(data[0])) + 1;
    head = 0;
    tail = (sizeof(data) / sizeof(data[0]));
  }

~StaticQueue()

template<class T>

StaticQueue< T >::~StaticQueue ( )

inline

Definition at line 43 of file StaticQueue.hpp.

{ delete[] data; }

Member Function Documentation

dequeue()

template<class T>

T StaticQueue< T >::dequeue ( )

inlinevirtual

Remove an element from the queue.

Returns

the value that is being removed

Implements Queue< T >.

Definition at line 55 of file StaticQueue.hpp.

              {
    if (isEmpty())
      throw std::out_of_range("The queue is empty.");

    T tmp = data[head];
    count --;
    head = (head + 1) % size;

    return tmp;
  }

enqueue()

template<class T>

void StaticQueue< T >::enqueue ( T  val )

inlinevirtual

Add an element to the end of the queue.

Parameters

val	the value to be added to the queue

Implements Queue< T >.

Definition at line 45 of file StaticQueue.hpp.

                      {
    if (isFull()) {
      throw std::out_of_range("The queue is full.");
    }

    data[tail] = val;
    count ++;
    tail = (tail + 1) % size;
  }

Here is the call graph for this function:

getName()

template<class T>

std::string StaticQueue< T >::getName ( )

inlinevirtual

Provides the name of the data structure as a string representation.

Returns

name of the data structure

Implements DataStructure.

Definition at line 23 of file StaticQueue.hpp.

{ return "Static Queue"; }

getSize()

template<class T>

int StaticQueue< T >::getSize ( )

inlinevirtual

Outputs the number of elements stored in the structure.

Returns

number of elements stored in the structure

Implements DataStructure.

Definition at line 72 of file StaticQueue.hpp.

{ return count; }

isEmpty()

template<class T>

bool StaticQueue< T >::isEmpty ( )

inlinevirtual

Check whether the structure is empty.

Returns

True if empty, otherwise false

Implements DataStructure.

Definition at line 74 of file StaticQueue.hpp.

{ return count == 0; }

isFull()

template<class T>

bool StaticQueue< T >::isFull ( )

inlinevirtual

Check whether the structure is full.

Returns

True if full, otherwise false

Implements DataStructure.

Definition at line 76 of file StaticQueue.hpp.

{ return count == size; }

Here is the caller graph for this function:

peek()

template<class T>

T StaticQueue< T >::peek ( )

inlinevirtual

See the first value from the queue, without removing it.

Returns

The first value on the queue

Implements Queue< T >.

Definition at line 66 of file StaticQueue.hpp.

           {
    if (isEmpty())
      throw std::out_of_range("The queue is empty.");
    return data[head];
  }

Field Documentation

count

template<class T>

int StaticQueue< T >::count

private

Definition at line 19 of file StaticQueue.hpp.

data

template<class T>

T* StaticQueue< T >::data

private

Definition at line 20 of file StaticQueue.hpp.

head

template<class T>

int StaticQueue< T >::head

private

Definition at line 19 of file StaticQueue.hpp.

size

template<class T>

int StaticQueue< T >::size

private

Definition at line 19 of file StaticQueue.hpp.

tail

template<class T>

int StaticQueue< T >::tail

private

Definition at line 19 of file StaticQueue.hpp.

---

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

• include/StaticQueue.hpp