mtcore::Queue< T > Struct Template Reference

FIFO Queue (First In, First Out) Dynamically allocated, can be resized. More...

#include <queue.hpp>

Public Member Functions
Result< void, AllocationError >	init (Allocator &alloc, size_t capacity=10)
	Initializes Queue with capacity.
Result< void, AllocationError >	init (Allocator &alloc, std::initializer_list< T > init, size_t capacity=10)
	Initializes Queue with initial items.
void	deinit (Allocator &alloc)
	Cleans up allocated memory.
bool	is_full () const noexcept
	Checks if ring buffer is full.
bool	is_empty () const noexcept
	Checks if ring buffer is empty.
size_t	size () const noexcept
size_t	capacity () const noexcept
Result< void, AllocationError >	shrink_to_fit (Allocator &alloc)
Optional< T >	peek () const noexcept
	Peeks at first element of Queue.
Optional< T >	pop () noexcept
	Removes and returns the next element in the Queue.
Result< void, CollectionAddNoAllocationError >	push (const T &elem) noexcept
	Tries to add an element to the Queue Fails if Queue is empty.
Result< void, AllocationError >	push (Allocator &alloc, const T &elem) noexcept
	Tries to add an element to the Queue Will allocate more space if needed Fails if it cannot allocate larger Queue.
bool	is_initialized () const noexcept
	Checks if an Queue is initialized.

Detailed Description

template<typename T>
struct mtcore::Queue< T >

FIFO Queue (First In, First Out) Dynamically allocated, can be resized.

Adding elements is worst case \(O(N)\), but generally \(O(1)\) Removing elements is \(O(1)\)

Template Parameters

T	Element to store

Definition at line 37 of file queue.hpp.

Member Function Documentation

capacity()

template<typename T>

size_t mtcore::Queue< T >::capacity ( ) const

inlinenodiscardnoexcept

Returns

Capacity of Queue

Definition at line 87 of file queue.hpp.

{ return buffer.capacity(); }

Here is the caller graph for this function:

deinit()

template<typename T>

void mtcore::Queue< T >::deinit ( Allocator & alloc )

inline

Cleans up allocated memory.

Parameters

alloc

Allocator to clean up memory with

Definition at line 65 of file queue.hpp.

{ buffer.deinit(alloc); }

Here is the caller graph for this function:

init() [1/2]

template<typename T>

Result< void, AllocationError > mtcore::Queue< T >::init ( Allocator & alloc, size_t capacity = 10 )

inline

Initializes Queue with capacity.

Parameters

alloc	Allocator for initial allocation
capacity	Initial capacity

Returns

success or failure

Definition at line 48 of file queue.hpp.

{ return buffer.init(alloc, capacity); }

Here is the call graph for this function:

Here is the caller graph for this function:

init() [2/2]

template<typename T>

Result< void, AllocationError > mtcore::Queue< T >::init ( Allocator & alloc, std::initializer_list< T > init, size_t capacity = 10 )

inline

Initializes Queue with initial items.

Parameters

alloc	Allocator for initial allocation
init	Initial elements
capacity	Initial capacity

Returns

success or failure

Definition at line 57 of file queue.hpp.

                                                                                                            {
      return buffer.init(alloc, init, capacity);
    }

Here is the call graph for this function:

is_empty()

template<typename T>

bool mtcore::Queue< T >::is_empty ( ) const

inlinenodiscardnoexcept

Checks if ring buffer is empty.

Returns

true if ring buffer is empty

Definition at line 77 of file queue.hpp.

{ return size() == 0; }

Here is the call graph for this function:

is_full()

template<typename T>

bool mtcore::Queue< T >::is_full ( ) const

inlinenodiscardnoexcept

Checks if ring buffer is full.

Returns

true if ring buffer is full

Definition at line 71 of file queue.hpp.

{ return buffer.size() >= buffer.capacity(); }

Here is the caller graph for this function:

is_initialized()

template<typename T>

bool mtcore::Queue< T >::is_initialized ( ) const

inlinenodiscardnoexcept

Checks if an Queue is initialized.

Returns

true if initialized, false otherwise

Definition at line 142 of file queue.hpp.

{ return buffer.capacity() > 0; }

Here is the caller graph for this function:

peek()

template<typename T>

Optional< T > mtcore::Queue< T >::peek ( ) const

inlinenoexcept

Peeks at first element of Queue.

Returns

First elem or nullopt

Definition at line 95 of file queue.hpp.

                                      {
      ensure(is_initialized(), "Not initialized");
      if (buffer.size() > 0) {
        return buffer.at(0);
      }
      return nullopt;
    }

Here is the call graph for this function:

pop()

template<typename T>

Optional< T > mtcore::Queue< T >::pop ( )

inlinenoexcept

Removes and returns the next element in the Queue.

Returns

Next elem in Queue or nullopt

Definition at line 107 of file queue.hpp.

                               {
      ensure(is_initialized(), "Not initialized");
      mtdefer { ensure(size() <= capacity(), "SIZE MISMATCH"); };
      return buffer.pop_front();
    }

Here is the call graph for this function:

push() [1/2]

template<typename T>

Result< void, AllocationError > mtcore::Queue< T >::push ( Allocator & alloc, const T & elem )

inlinenoexcept

Tries to add an element to the Queue Will allocate more space if needed Fails if it cannot allocate larger Queue.

Parameters

alloc	Allocator to use for new allocation
elem	Element to add

Returns

Success or failure

Definition at line 133 of file queue.hpp.

                                                                                 {
      ensure(is_initialized(), "Not initialized");
      return buffer.push_back(alloc, elem);
    }

Here is the call graph for this function:

push() [2/2]

template<typename T>

Result< void, CollectionAddNoAllocationError > mtcore::Queue< T >::push ( const T & elem )

inlinenoexcept

Tries to add an element to the Queue Fails if Queue is empty.

Parameters

elem	Element to add

Returns

Success or failure

Definition at line 119 of file queue.hpp.

                                                                              {
      ensure(is_initialized(), "Not initialized");
      mtdefer { ensure(size() <= capacity(), "SIZE MISMATCH"); };
      return buffer.push_back(elem);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

shrink_to_fit()

template<typename T>

Result< void, AllocationError > mtcore::Queue< T >::shrink_to_fit ( Allocator & alloc )

inline

Definition at line 89 of file queue.hpp.

{ return buffer.shrink_to_fit(alloc); }

size()

template<typename T>

size_t mtcore::Queue< T >::size ( ) const

inlinenodiscardnoexcept

Returns

Size of Queue

Definition at line 82 of file queue.hpp.

{ return buffer.size(); }

Here is the caller graph for this function:

---

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

• queue.hpp