Program Listing for File ArrayQueue.h

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

/*--------------------------------------------------------------------------*/
/*--------------------------- File ArrayQueue.h ----------------------------*/
/*--------------------------------------------------------------------------*/
/*--------------------------------------------------------------------------*/
/*----------------------------- DEFINITIONS --------------------------------*/
/*--------------------------------------------------------------------------*/

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

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

#include "ADS/Contract.h"
#include "ADS/Iterators.h"

#include <cstddef>
#include <memory>
#include <utility>

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

namespace ADS {

/*--------------------------------------------------------------------------*/
/*---------------------------- CLASS ArrayQueue ----------------------------*/
/*--------------------------------------------------------------------------*/

template< class T >
class ArrayQueue {

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

 using Item = T;

 explicit ArrayQueue( std::size_t dim );

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

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

 T dequeue( void );

 void enqueue( const T & v );

 [[nodiscard]] std::size_t size( void ) const;

 [[nodiscard]] std::size_t capacity( void ) const;

 [[nodiscard]] bool contains( const T & v ) const;

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

 // a constant view of the items from the front to the back, random
 // access on the circular vector

 using value_type = T;
 using size_type = std::size_t;
 using difference_type = std::ptrdiff_t;
 using reference = const T &;
 using const_reference = const T &;
 using iterator = CircularIterator< T >;
 using const_iterator = CircularIterator< T >;

 [[nodiscard]] const_iterator begin( void ) const {
  return( const_iterator( f_A.get() , f_head , f_capacity , 0 ) );
  }
 [[nodiscard]] const_iterator end( void ) const {
  return( const_iterator( f_A.get() , f_head , f_capacity ,
                          std::ptrdiff_t( f_size ) ) );
  }
 [[nodiscard]] const_iterator cbegin( void ) const { return( begin() ); }
 [[nodiscard]] const_iterator cend( void ) const { return( end() ); }

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

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

 std::unique_ptr< T[] > f_A;
 std::size_t f_size;
 std::size_t f_head;
 std::size_t f_capacity;

 };  // end( class ArrayQueue )

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

}  // end( namespace ADS )

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

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

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

#endif  /* ArrayQueue.h included */

/*--------------------------------------------------------------------------*/
/*------------------------- End File ArrayQueue.h --------------------------*/
/*--------------------------------------------------------------------------*/