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

A Queue should support Enque(), Deque() and Front() operations. More...

#include <queue.hpp>

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

Public Member Functions

virtual bool Enqueue (const Type &element)=0
 Enqueue a new element at the end of queue element element to enqueue. More...
 
virtual bool Dequeue ()=0
 Dequeue the an element from the front of queue. More...
 
virtual Type Front () const =0
 Access the front (next in line) element of queue. More...
 
virtual SzType Size () const =0
 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>
class scire::AQueue< Type, SzType >

A Queue should support Enque(), Deque() and Front() operations.

Definition at line 38 of file queue.hpp.

Member Function Documentation

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

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 ( )
inlinevirtual

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 ( )
inline

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 >
virtual bool scire::AQueue< Type, SzType >::Dequeue ( )
pure virtual

Dequeue the an element from the front of queue.

Returns
true on success

Implemented in scire::QueueCrate< Type, SzType >, and scire::Queue< Type, SzType >.

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

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 >
virtual bool scire::AQueue< Type, SzType >::Enqueue ( const Type &  element)
pure virtual

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

Returns
true on success

Implemented in scire::QueueCrate< Type, SzType >, and scire::Queue< Type, SzType >.

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

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 >
virtual Type scire::AQueue< Type, SzType >::Front ( ) const
pure virtual

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

Returns
front element of the queue

Implemented in scire::QueueCrate< Type, SzType >, and scire::Queue< Type, SzType >.

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
inlinevirtual

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 >
virtual SzType scire::AQueue< Type, SzType >::Size ( ) const
pure virtual

number of elements contained in

Returns
current size

Implements scire::AContainer< Type, SzType >.

Implemented in scire::QueueCrate< Type, SzType >, and scire::Queue< Type, SzType >.


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