Cogs.Foundation
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Private Types | Private Member Functions | Private Attributes | List of all members
Cogs::Collections::FixedIndexQueue< Element, IndexBaseType > Class Template Reference

Indexable queue where an element index is fixed through arbitrary enqueues and dequeues. More...

#include <FixedIndexQueue.h>

Public Types

typedef std::make_unsigned< IndexBaseType >::type IndexType
 Unsigned type used for indices, typically uint32_t or uin64_t.
 

Public Member Functions

 FixedIndexQueue ()
 Constructor.
 
const IndexType capacity () const
 Returns the current capacity of the queue.
 
IndexType empty () const
 Returns true if there are currently no elements in the queue.
 
IndexType count () const
 Returns number of elements currently in the queue.
 
void clear ()
 Removes all entries from the queue, but will continue with new unused indices.
 
void reset ()
 Removes all entries from the queue, recycles indices and starts from zero.
 
void shrink ()
 Reduce capacity to the minimum needed to preserve the contents.
 
void pushBack (Element e)
 Adds a new element to the back of the queue.
 
void pushFront (Element e)
 Adds a new element to the front of the queue.
 
void popFront ()
 Removes the front from the queue.
 
Element & operator[] (IndexType fixedIndex)
 Look up an element in the queue by a fixed index.
 
const Element & operator[] (IndexType fixedIndex) const
 Look up an element in the queue by a fixed index.
 
Element & front ()
 Returns front element.
 
const Element & front () const
 Returns front element.
 
Element & back ()
 Returns back element.
 
const Element & back () const
 Returns back element.
 
IndexType frontIndex () const
 Returns fixed index of front.
 
IndexType backIndex () const
 Returns fixed index of current back element.
 
bool validIndex (uint32_t fixedIndex) const
 Check if a fixed index is valid, that is, refers to an element in the queue.
 

Private Types

typedef std::make_signed< IndexBaseType >::type SignedIndexType
 Signed helper type.
 

Private Member Functions

bool noCapacity () const
 True if there is no free capacity left.
 
void grow ()
 Double the capacity of the queue.
 
void resize (IndexType sizeL2New)
 

Private Attributes

IndexType sizeL2 = 0
 
IndexType sizeMask = 0
 
IndexType frontOffset = 0
 
IndexType backOffset = 0
 
IndexType offsetToFixedIndexShift = 0
 
Cogs::Memory::TypedBuffer< Element > storage
 

Detailed Description

template<typename Element, typename IndexBaseType>
class Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >

Indexable queue where an element index is fixed through arbitrary enqueues and dequeues.

Member Typedef Documentation

◆ IndexType

template<typename Element , typename IndexBaseType >
typedef std::make_unsigned<IndexBaseType>::type Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::IndexType

Unsigned type used for indices, typically uint32_t or uin64_t.

◆ SignedIndexType

template<typename Element , typename IndexBaseType >
typedef std::make_signed<IndexBaseType>::type Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::SignedIndexType
private

Signed helper type.

Constructor & Destructor Documentation

◆ FixedIndexQueue()

template<typename Element , typename IndexBaseType >
Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::FixedIndexQueue ( )
inline

Constructor.

References Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::capacity(), Cogs::Memory::TypedBuffer< T >::resize(), and Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::storage.

Member Function Documentation

◆ back() [1/2]

template<typename Element , typename IndexBaseType >
Element & Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::back ( )
inline

Returns back element.

References Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::backOffset, Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::empty(), Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::sizeMask, and Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::storage.

◆ back() [2/2]

template<typename Element , typename IndexBaseType >
const Element & Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::back ( ) const
inline

Returns back element.

References Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::backOffset, Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::empty(), Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::sizeMask, and Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::storage.

◆ backIndex()

template<typename Element , typename IndexBaseType >
IndexType Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::backIndex ( ) const
inline

Returns fixed index of current back element.

References Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::backOffset, Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::empty(), and Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::offsetToFixedIndexShift.

Referenced by Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::operator[](), and Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::validIndex().

◆ capacity()

template<typename Element , typename IndexBaseType >
const IndexType Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::capacity ( ) const
inline

Returns the current capacity of the queue.

References Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::sizeMask.

Referenced by Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::FixedIndexQueue(), and Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::grow().

◆ clear()

template<typename Element , typename IndexBaseType >
void Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::clear ( )
inline

Removes all entries from the queue, but will continue with new unused indices.

References Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::backOffset, Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::frontOffset, and Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::offsetToFixedIndexShift.

◆ count()

template<typename Element , typename IndexBaseType >
IndexType Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::count ( ) const
inline

Returns number of elements currently in the queue.

References Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::backOffset, Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::frontOffset, and Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::sizeMask.

Referenced by Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::resize(), and Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::shrink().

◆ empty()

template<typename Element , typename IndexBaseType >
IndexType Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::empty ( ) const
inline

Returns true if there are currently no elements in the queue.

References Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::backOffset, Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::frontOffset, and Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::sizeMask.

Referenced by Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::back(), Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::backIndex(), Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::front(), Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::frontIndex(), Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::operator[](), Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::popFront(), and Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::validIndex().

◆ front() [1/2]

template<typename Element , typename IndexBaseType >
Element & Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::front ( )
inline

Returns front element.

References Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::empty(), Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::frontOffset, Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::sizeMask, and Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::storage.

◆ front() [2/2]

template<typename Element , typename IndexBaseType >
const Element & Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::front ( ) const
inline

Returns front element.

References Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::empty(), Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::frontOffset, Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::sizeMask, and Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::storage.

◆ frontIndex()

template<typename Element , typename IndexBaseType >
IndexType Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::frontIndex ( ) const
inline

Returns fixed index of front.

References Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::empty(), Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::frontOffset, and Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::offsetToFixedIndexShift.

Referenced by Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::operator[](), and Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::validIndex().

◆ grow()

template<typename Element , typename IndexBaseType >
void Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::grow ( )
inlineprivate

Double the capacity of the queue.

References Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::capacity(), Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::resize(), and Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::sizeL2.

Referenced by Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::pushBack(), and Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::pushFront().

◆ noCapacity()

template<typename Element , typename IndexBaseType >
bool Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::noCapacity ( ) const
inlineprivate

True if there is no free capacity left.

References Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::backOffset, Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::frontOffset, and Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::sizeMask.

Referenced by Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::pushBack(), and Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::pushFront().

◆ operator[]() [1/2]

template<typename Element , typename IndexBaseType >
Element & Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::operator[] ( IndexType  fixedIndex)
inline

Look up an element in the queue by a fixed index.

References Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::backIndex(), Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::empty(), Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::frontIndex(), Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::offsetToFixedIndexShift, Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::sizeMask, and Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::storage.

◆ operator[]() [2/2]

template<typename Element , typename IndexBaseType >
const Element & Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::operator[] ( IndexType  fixedIndex) const
inline

Look up an element in the queue by a fixed index.

References Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::backIndex(), Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::empty(), Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::frontIndex(), Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::offsetToFixedIndexShift, Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::sizeMask, and Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::storage.

◆ popFront()

template<typename Element , typename IndexBaseType >
void Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::popFront ( )
inline

Removes the front from the queue.

References Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::empty(), and Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::frontOffset.

◆ pushBack()

template<typename Element , typename IndexBaseType >
void Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::pushBack ( Element  e)
inline

Adds a new element to the back of the queue.

References Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::backOffset, Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::grow(), Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::noCapacity(), Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::sizeMask, and Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::storage.

◆ pushFront()

template<typename Element , typename IndexBaseType >
void Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::pushFront ( Element  e)
inline

Adds a new element to the front of the queue.

References Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::frontOffset, Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::grow(), Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::noCapacity(), Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::sizeMask, and Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::storage.

◆ reset()

template<typename Element , typename IndexBaseType >
void Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::reset ( )
inline

Removes all entries from the queue, recycles indices and starts from zero.

References Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::backOffset, Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::frontOffset, and Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::offsetToFixedIndexShift.

◆ resize()

template<typename Element , typename IndexBaseType >
void Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::resize ( IndexType  sizeL2New)
inlineprivate

References Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::backOffset, Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::count(), Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::frontOffset, Cogs::isPowerOfTwo(), Cogs::N, Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::offsetToFixedIndexShift, Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::sizeL2, Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::sizeMask, Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::storage, and Cogs::Memory::TypedBuffer< T >::swap().

Referenced by Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::grow(), and Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::shrink().

◆ shrink()

template<typename Element , typename IndexBaseType >
void Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::shrink ( )
inline

Reduce capacity to the minimum needed to preserve the contents.

References Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::count(), Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::resize(), Cogs::roundUpToPowerOfTwoShift(), and Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::sizeL2.

◆ validIndex()

template<typename Element , typename IndexBaseType >
bool Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::validIndex ( uint32_t  fixedIndex) const
inline

Check if a fixed index is valid, that is, refers to an element in the queue.

References Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::backIndex(), Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::empty(), and Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::frontIndex().

Member Data Documentation

◆ backOffset

template<typename Element , typename IndexBaseType >
IndexType Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::backOffset = 0
private

Referenced by Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::back(), Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::backIndex(), Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::clear(), Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::count(), Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::empty(), Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::noCapacity(), Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::pushBack(), Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::reset(), and Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::resize().

◆ frontOffset

template<typename Element , typename IndexBaseType >
IndexType Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::frontOffset = 0
private

Referenced by Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::clear(), Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::count(), Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::empty(), Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::front(), Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::frontIndex(), Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::noCapacity(), Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::popFront(), Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::pushFront(), Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::reset(), and Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::resize().

◆ offsetToFixedIndexShift

template<typename Element , typename IndexBaseType >
IndexType Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::offsetToFixedIndexShift = 0
private

Referenced by Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::backIndex(), Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::clear(), Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::frontIndex(), Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::operator[](), Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::reset(), and Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::resize().

◆ sizeL2

template<typename Element , typename IndexBaseType >
IndexType Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::sizeL2 = 0
private

Referenced by Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::grow(), Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::resize(), and Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::shrink().

◆ sizeMask

template<typename Element , typename IndexBaseType >
IndexType Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::sizeMask = 0
private

Referenced by Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::back(), Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::capacity(), Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::count(), Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::empty(), Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::front(), Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::noCapacity(), Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::operator[](), Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::pushBack(), Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::pushFront(), and Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::resize().

◆ storage

template<typename Element , typename IndexBaseType >
Cogs::Memory::TypedBuffer<Element> Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::storage
private

Referenced by Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::back(), Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::FixedIndexQueue(), Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::front(), Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::operator[](), Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::pushBack(), Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::pushFront(), and Cogs::Collections::FixedIndexQueue< Element, IndexBaseType >::resize().

The documentation for this class was generated from the following file:
Generated by doxygen 1.9.6