Program Listing for File Dequeue.h

↰ Return to documentation for file (ADS/queue/Dequeue.h)

/*--------------------------------------------------------------------------*/
/*----------------------------- File Dequeue.h -----------------------------*/
/*--------------------------------------------------------------------------*/
/*--------------------------------------------------------------------------*/
/*----------------------------- DEFINITIONS --------------------------------*/
/*--------------------------------------------------------------------------*/

#ifndef __ADS_Dequeue
 #define __ADS_Dequeue
                      /* self-identification: #endif constant */

/*--------------------------------------------------------------------------*/
/*------------------------------ INCLUDES ----------------------------------*/
/*--------------------------------------------------------------------------*/

#include "ADS/Contract.h"
#include "ADS/sequence/List.h"

#include <cstddef>

/*--------------------------------------------------------------------------*/
/*--------------------------- NAMESPACE ------------------------------------*/
/*--------------------------------------------------------------------------*/

namespace ADS {

/*--------------------------------------------------------------------------*/
/*----------------------------- CLASS Dequeue ------------------------------*/
/*--------------------------------------------------------------------------*/

template< class T >
class Dequeue {

/*--------------------------------------------------------------------------*/
 public:

 using Item = T;

 [[nodiscard]] bool empty( void ) const;

 void insertHead( const T & v );

 void insertTail( const T & v );

 T removeHead( void );

 T removeTail( void );

 [[nodiscard]] const T & head( void ) const;

 [[nodiscard]] const T & tail( void ) const;

/*------------------------- THE STANDARD INTERFACE -------------------------*/

 // the bidirectional iterators of the list, from the head to the tail

 using value_type = T;
 using size_type = std::size_t;
 using difference_type = std::ptrdiff_t;
 using reference = T &;
 using const_reference = const T &;
 using iterator = typename List< T >::iterator;
 using const_iterator = typename List< T >::const_iterator;
 using reverse_iterator = typename List< T >::reverse_iterator;
 using const_reverse_iterator = typename List< T >::const_reverse_iterator;

 [[nodiscard]] iterator begin( void ) { return( f_L.begin() ); }
 [[nodiscard]] iterator end( void ) { return( f_L.end() ); }
 [[nodiscard]] const_iterator begin( void ) const { return( f_L.begin() ); }
 [[nodiscard]] const_iterator end( void ) const { return( f_L.end() ); }
 [[nodiscard]] const_iterator cbegin( void ) const { return( begin() ); }
 [[nodiscard]] const_iterator cend( void ) const { return( end() ); }
 [[nodiscard]] reverse_iterator rbegin( void ) { return( f_L.rbegin() ); }
 [[nodiscard]] reverse_iterator rend( void ) { return( f_L.rend() ); }
 [[nodiscard]] const_reverse_iterator rbegin( void ) const {
  return( f_L.rbegin() );
  }
 [[nodiscard]] const_reverse_iterator rend( void ) const {
  return( f_L.rend() );
  }

 void push_back( const T & v ) { insertTail( v ); }
 void push_front( const T & v ) { insertHead( v ); }

/*--------------------------------------------------------------------------*/
 private:

 List< T > f_L;

 };  // end( class Dequeue )

/*--------------------------------------------------------------------------*/

}  // end( namespace ADS )

/*--------------------------------------------------------------------------*/
/*-------------------------- IMPLEMENTATION --------------------------------*/
/*--------------------------------------------------------------------------*/

#include "ADS/queue/impl/Dequeue.tpp"

/*--------------------------------------------------------------------------*/

#endif  /* Dequeue.h included */

/*--------------------------------------------------------------------------*/
/*--------------------------- End File Dequeue.h ---------------------------*/
/*--------------------------------------------------------------------------*/