scire
Sadh's C++ Impromptu Routines Ensemble
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
scire::Queue< Type, SzType > Class Template Reference

Linked List implementation of Queue. More...

#include <queue.hpp>

Inheritance diagram for scire::Queue< Type, SzType >:
scire::AQueue< Type, SzType > scire::AContainer< Type, SzType >

Public Member Functions

 Queue ()
 initialize a Queue object, with head and tail pointing to nullptr More...
 
 ~Queue ()
 finalize a Queue object by deleting all items from it More...
 
bool Enqueue (const Type &element)
 Enqueue a new element at the end of queue element element to enqueue. More...
 
bool Dequeue ()
 Dequeue the an element from the front of queue. More...
 
Type Front () const
 Access the front (next in line) element of queue. More...
 
SzType Size () const
 number of elements contained in More...
 
bool Enque (const Type &element)
 Enqueue a new element at the end of queue element element to enqueue. More...
 
bool Deque ()
 Enqueue a new element at the end of queue element element to enqueue. More...
 
Type Fore () const
 Enqueue a new element at the end of queue element element to enqueue. More...
 
bool Add (const Type &element)
 add an element More...
 
bool Deduce ()
 deduce one element More...
 
Type Peek () const
 peek into next element contained in More...
 
virtual bool IsEmpty () const
 check if empty More...
 

Detailed Description

template<typename Type, typename SzType = int>
class scire::Queue< Type, SzType >

Linked List implementation of Queue.

Queue implemented as linked items. A pointer points to head and another to tail of the queue. A new element is always added to the tail of the queue and removed from the head. This is a FIFO structure.

Definition at line 116 of file queue.hpp.

Constructor & Destructor Documentation

template<typename Type , typename SzType >
scire::Queue< Type, SzType >::Queue ( )

initialize a Queue object, with head and tail pointing to nullptr

Definition at line 162 of file queue.hpp.

template<typename Type , typename SzType >
scire::Queue< Type, SzType >::~Queue ( )

finalize a Queue object by deleting all items from it

Definition at line 169 of file queue.hpp.

Member Function Documentation

template<typename Type , typename SzType >
bool scire::AQueue< Type, SzType >::Add ( const Type &  element)
inlinevirtualinherited

add an element

Parameters
elementelement to be added as new element
Returns
true on success

Implements scire::AContainer< Type, SzType >.

Definition at line 85 of file queue.hpp.

template<typename Type , typename SzType >
bool scire::AQueue< Type, SzType >::Deduce ( )
inlinevirtualinherited

deduce one element

Returns
true on success

Implements scire::AContainer< Type, SzType >.

Definition at line 91 of file queue.hpp.

template<typename Type , typename SzType >
bool scire::AQueue< Type, SzType >::Deque ( )
inlineinherited

Enqueue a new element at the end of queue element element to enqueue.

Returns
true on success

Definition at line 72 of file queue.hpp.

template<typename Type , typename SzType >
bool scire::Queue< Type, SzType >::Dequeue ( )
virtual

Dequeue the an element from the front of queue.

Returns
true on success

Implements scire::AQueue< Type, SzType >.

Definition at line 200 of file queue.hpp.

template<typename Type , typename SzType >
bool scire::AQueue< Type, SzType >::Enque ( const Type &  element)
inlineinherited

Enqueue a new element at the end of queue element element to enqueue.

Returns
true on success

Definition at line 66 of file queue.hpp.

template<typename Type , typename SzType >
bool scire::Queue< Type, SzType >::Enqueue ( const Type &  element)
virtual

Enqueue a new element at the end of queue element element to enqueue.

Returns
true on success

Implements scire::AQueue< Type, SzType >.

Definition at line 182 of file queue.hpp.

template<typename Type , typename SzType >
Type scire::AQueue< Type, SzType >::Fore ( ) const
inlineinherited

Enqueue a new element at the end of queue element element to enqueue.

Returns
true on success

Definition at line 78 of file queue.hpp.

template<typename Type , typename SzType >
Type scire::Queue< Type, SzType >::Front ( ) const
virtual

Access the front (next in line) element of queue.

Returns
front element of the queue

Implements scire::AQueue< Type, SzType >.

Definition at line 217 of file queue.hpp.

template<typename Type , typename SzType = int>
virtual bool scire::AContainer< Type, SzType >::IsEmpty ( ) const
inlinevirtualinherited

check if empty

Returns
true when empty

Definition at line 75 of file container.hpp.

template<typename Type , typename SzType >
Type scire::AQueue< Type, SzType >::Peek ( ) const
inlinevirtualinherited

peek into next element contained in

Returns
element

Implements scire::AContainer< Type, SzType >.

Definition at line 97 of file queue.hpp.

template<typename Type , typename SzType >
SzType scire::Queue< Type, SzType >::Size ( ) const
virtual

number of elements contained in

Returns
current size

Implements scire::AQueue< Type, SzType >.

Definition at line 223 of file queue.hpp.


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