FQueue< T > Class Template Reference

#include <FQueue.h>

Public Member Functions
void	clear ()
bool	empty () const
	FQueue ()
	FQueue (unsigned int initialCapacity)
T	front () const
T &	operator[] (unsigned int index)
void	pop_front ()
void	pop_front (const unsigned int numberOfElementsToPop)
void	push_back (const T &value)
void	reserve (unsigned int capacity)
unsigned int	size () const
T &	tail ()
constexpr unsigned int	wrapIndex (unsigned int i)

Private Attributes
std::vector< T >	theBuffer
unsigned int	theCapacity
unsigned int	theFront
unsigned int	theSize
unsigned int	theTail

Detailed Description

template<class T>
class FQueue< T >

Definition at line 7 of file FQueue.h.

Constructor & Destructor Documentation

template<class T>

FQueue< T >::FQueue ( )

inline

Definition at line 9 of file FQueue.h.

References FQueue< T >::theCapacity, FQueue< T >::theFront, FQueue< T >::theSize, and FQueue< T >::theTail.

           {
    theSize = 0;
    theFront = 0;
    theTail = 0;
    theCapacity = 0;
  }

template<class T>

FQueue< T >::FQueue ( unsigned int  initialCapacity )

inline

Definition at line 16 of file FQueue.h.

References FQueue< T >::theBuffer, FQueue< T >::theCapacity, FQueue< T >::theFront, FQueue< T >::theSize, and FQueue< T >::theTail.

                                       {
    theBuffer.resize(initialCapacity);
    theSize = 0;
    theFront = 0;
    theTail = 0;
    theCapacity = initialCapacity;
  }

Member Function Documentation

template<class T>

void FQueue< T >::clear ( void  )

inline

Definition at line 69 of file FQueue.h.

References FQueue< T >::theBuffer, FQueue< T >::theFront, FQueue< T >::theSize, and FQueue< T >::theTail.

Referenced by BeautifulSoup.Tag::setString().

               {
    theBuffer.clear();
    theSize = 0;
    theFront = 0;
    theTail = 0;
  }

template<class T>

bool FQueue< T >::empty ( ) const

inline

Definition at line 26 of file FQueue.h.

References FQueue< T >::theSize.

{ return theSize == 0; }

template<class T>

T FQueue< T >::front ( ) const

inline

Definition at line 28 of file FQueue.h.

References FQueue< T >::theBuffer, and FQueue< T >::theFront.

{ return theBuffer[theFront]; }

template<class T>

T& FQueue< T >::operator[] ( unsigned int  index )

inline

Definition at line 67 of file FQueue.h.

References FQueue< T >::theBuffer, FQueue< T >::theFront, and FQueue< T >::wrapIndex().

{ return theBuffer[wrapIndex(theFront + index)]; }

template<class T>

void FQueue< T >::pop_front ( )

inline

Definition at line 52 of file FQueue.h.

References FQueue< T >::theFront, FQueue< T >::theSize, and FQueue< T >::wrapIndex().

Referenced by FKDTree< TYPE, numberOfDimensions >::search().

                   {
    if (theSize > 0) {
      theFront = wrapIndex(theFront + 1);
      theSize--;
    }
  }

template<class T>

void FQueue< T >::pop_front ( const unsigned int  numberOfElementsToPop )

inline

Definition at line 59 of file FQueue.h.

References FQueue< T >::theFront, FQueue< T >::theSize, and FQueue< T >::wrapIndex().

                                                           {
    unsigned int elementsToErase = theSize > numberOfElementsToPop ? numberOfElementsToPop : theSize;
    theSize -= elementsToErase;
    theFront = wrapIndex(theFront + elementsToErase);
  }

template<class T>

void FQueue< T >::push_back ( const T &  value )

inline

Definition at line 34 of file FQueue.h.

References filterCSVwithJSON::copy, FQueue< T >::theBuffer, FQueue< T >::theCapacity, FQueue< T >::theFront, FQueue< T >::theSize, FQueue< T >::theTail, relativeConstraints::value, and FQueue< T >::wrapIndex().

Referenced by FKDTree< TYPE, numberOfDimensions >::search().

                                 {
    if (theSize >= theCapacity) {
      theBuffer.resize(theCapacity * 2);
      if (theFront != 0) {
        std::copy(theBuffer.begin(), theBuffer.begin() + theTail, theBuffer.begin() + theCapacity);

        theTail += theSize;

      } else {
        theTail += theCapacity;
      }
      theCapacity *= 2;
    }
    theBuffer[theTail] = value;
    theTail = wrapIndex(theTail + 1);
    theSize++;
  }

template<class T>

void FQueue< T >::reserve ( unsigned int  capacity )

inline

Definition at line 65 of file FQueue.h.

References FQueue< T >::theBuffer.

{ theBuffer.reserve(capacity); }

template<class T>

unsigned int FQueue< T >::size ( void  ) const

inline

Definition at line 24 of file FQueue.h.

References FQueue< T >::theSize.

Referenced by ntupleDataFormat._Collection::__iter__(), ntupleDataFormat._Collection::__len__(), and FKDTree< TYPE, numberOfDimensions >::search().

{ return theSize; }

template<class T>

T& FQueue< T >::tail ( )

inline

Definition at line 30 of file FQueue.h.

References FQueue< T >::theBuffer, and FQueue< T >::theTail.

{ return theBuffer[theTail]; }

template<class T>

constexpr unsigned int FQueue< T >::wrapIndex ( unsigned int  i )

inline

Definition at line 32 of file FQueue.h.

References FQueue< T >::theBuffer.

Referenced by FQueue< T >::operator[](), FQueue< T >::pop_front(), and FQueue< T >::push_back().

{ return i & (theBuffer.size() - 1); }

Member Data Documentation

template<class T>

std::vector<T> FQueue< T >::theBuffer

private

Definition at line 80 of file FQueue.h.

Referenced by FQueue< T >::clear(), FQueue< T >::FQueue(), FQueue< T >::front(), FQueue< T >::operator[](), FQueue< T >::push_back(), FQueue< T >::reserve(), FQueue< T >::tail(), and FQueue< T >::wrapIndex().

template<class T>

unsigned int FQueue< T >::theCapacity

private

Definition at line 81 of file FQueue.h.

Referenced by FQueue< T >::FQueue(), and FQueue< T >::push_back().

template<class T>

unsigned int FQueue< T >::theFront

private

Definition at line 78 of file FQueue.h.

Referenced by FQueue< T >::clear(), FQueue< T >::FQueue(), FQueue< T >::front(), FQueue< T >::operator[](), FQueue< T >::pop_front(), and FQueue< T >::push_back().

template<class T>

unsigned int FQueue< T >::theSize

private

Definition at line 77 of file FQueue.h.

Referenced by FQueue< T >::clear(), FQueue< T >::empty(), FQueue< T >::FQueue(), FQueue< T >::pop_front(), FQueue< T >::push_back(), and FQueue< T >::size().

template<class T>

unsigned int FQueue< T >::theTail

private

Definition at line 79 of file FQueue.h.

Referenced by FQueue< T >::clear(), FQueue< T >::FQueue(), FQueue< T >::push_back(), and FQueue< T >::tail().