mtcore::FixedRingBuffer< T, Capacity > Struct Template Reference

Represents a ring buffer with static memory allocation Can be used as a FIFO or LIFO queue Allows memory reuse by wrapping pointers Cannot be dynamically resized. More...

#include <ring_buffer.hpp>

Inheritance diagram for mtcore::FixedRingBuffer< T, Capacity >:

Public Types
using	Elem = T

Public Member Functions
decltype(auto)	ptr_iter () noexcept
	Gets a pointer iterator to values.
decltype(auto)	ptr_iter () const noexcept
	Gets a constant pointer iterator to values.
decltype(auto)	iter () noexcept
	Gets an iterator that returns copies of values.
void	init ()
	Initializes a new fixed ring buffer.
void	init (std::initializer_list< T > list)
	Initializes a new fixed ring buffer with specific elements.
const T &	operator[] (size_t i) const noexcept
	Gets an element at a specific index.
T &	operator[] (size_t i) noexcept
	Gets an element at a specific index.
size_t	size () const noexcept
	Gets current size of the buffer.
const T &	at (size_t i) const noexcept
	Gets an element at a specific index.
T &	at (size_t i) noexcept
	Gets an element at a specific index.
Result< void, CollectionAddNoAllocationError >	push_back (const T &elem)
	Adds an element to the back of the buffer.
Result< void, CollectionAddNoAllocationError >	push_front (const T &elem)
	Adds an element to the front of the buffer.
Optional< T >	pop_front ()
	Removes an element from the front.
Optional< T >	pop_back ()
	Removes an element from the back.

Detailed Description

template<typename T, size_t Capacity = 10>
struct mtcore::FixedRingBuffer< T, Capacity >

Represents a ring buffer with static memory allocation Can be used as a FIFO or LIFO queue Allows memory reuse by wrapping pointers Cannot be dynamically resized.

Accessing elements is \(O(1)\) Adding elements is \(O(1)\) Removing elements is \(O(1)\)

Template Parameters

T	Type of element stored
Capacity	Max capacity

Definition at line 356 of file ring_buffer.hpp.

Member Typedef Documentation

Elem

template<typename T, size_t Capacity = 10>

using mtcore::FixedRingBuffer< T, Capacity >::Elem = T

Definition at line 364 of file ring_buffer.hpp.

Member Function Documentation

at() [1/2]

template<typename T, size_t Capacity = 10>

const T & mtcore::FixedRingBuffer< T, Capacity >::at ( size_t i ) const

inlinenodiscardnoexcept

Gets an element at a specific index.

Parameters

i

Index

Returns

Reference to element at index

Definition at line 423 of file ring_buffer.hpp.

                                                       {
      ensure(i < count, "OUT OF BOUNDS ACCESS");
      auto index = i + head;
      if (index >= elements.size()) {
        index -= elements.size();
      }
      return elements[index];
    }

Here is the caller graph for this function:

at() [2/2]

template<typename T, size_t Capacity = 10>

T & mtcore::FixedRingBuffer< T, Capacity >::at ( size_t i )

inlinenodiscardnoexcept

Gets an element at a specific index.

Parameters

i

Index

Returns

Reference to element at index

Definition at line 437 of file ring_buffer.hpp.

                                           {
      ensure(i < count, "OUT OF BOUNDS ACCESS");
      auto index = i + head;
      if (index >= elements.size()) {
        index -= elements.size();
      }
      return elements[index];
    }

init() [1/2]

template<typename T, size_t Capacity = 10>

void mtcore::FixedRingBuffer< T, Capacity >::init ( )

inline

Initializes a new fixed ring buffer.

Definition at line 387 of file ring_buffer.hpp.

{};

init() [2/2]

template<typename T, size_t Capacity = 10>

void mtcore::FixedRingBuffer< T, Capacity >::init ( std::initializer_list< T > list )

inline

Initializes a new fixed ring buffer with specific elements.

Definition at line 392 of file ring_buffer.hpp.

                                           {
      ensure(list.size() < Capacity, "TOO MANY ELEMENTS PROVIDED");
      for (const auto &e: list) {
        (void) push_back(e);
      }
    }

Here is the call graph for this function:

iter()

template<typename T, size_t Capacity = 10>

decltype(auto) mtcore::FixedRingBuffer< T, Capacity >::iter ( )

inlinenodiscardnoexcept

Gets an iterator that returns copies of values.

Returns

Value iterator

Definition at line 382 of file ring_buffer.hpp.

{ return iter::val(*this); }

Here is the call graph for this function:

operator[]() [1/2]

template<typename T, size_t Capacity = 10>

const T & mtcore::FixedRingBuffer< T, Capacity >::operator[] ( size_t i ) const

inlinenodiscardnoexcept

Gets an element at a specific index.

Parameters

i

Index

Returns

Reference to element at index

Definition at line 404 of file ring_buffer.hpp.

{ return at(i); }

Here is the call graph for this function:

operator[]() [2/2]

template<typename T, size_t Capacity = 10>

T & mtcore::FixedRingBuffer< T, Capacity >::operator[] ( size_t i )

inlinenodiscardnoexcept

Gets an element at a specific index.

Parameters

i

Index

Returns

Reference to element at index

Definition at line 411 of file ring_buffer.hpp.

{ return at(i); }

Here is the call graph for this function:

pop_back()

template<typename T, size_t Capacity = 10>

Optional< T > mtcore::FixedRingBuffer< T, Capacity >::pop_back ( )

inlinenodiscard

Removes an element from the back.

Returns

Optional with the value removed, or nullopt if no value was removed

Definition at line 509 of file ring_buffer.hpp.

                                         {
      if (count == 0) {
        return nullopt;
      }
 
      auto new_tail = tail;
      if (new_tail == 0) {
        new_tail = elements.size() - 1;
      }
      else {
        new_tail--;
      }
 
      auto res = elements[tail];
      --count;
      tail = new_tail;
      return res;
    }

pop_front()

template<typename T, size_t Capacity = 10>

Optional< T > mtcore::FixedRingBuffer< T, Capacity >::pop_front ( )

inlinenodiscard

Removes an element from the front.

Returns

Optional with the value removed, or nullopt if no value was removed

Definition at line 491 of file ring_buffer.hpp.

                                          {
      if (count == 0) {
        return nullopt;
      }
 
      auto res = std::move(elements[head++]);
 
      count--;
      if (head == elements.size()) {
        head = 0;
      }
      return res;
    }

ptr_iter() [1/2]

template<typename T, size_t Capacity = 10>

decltype(auto) mtcore::FixedRingBuffer< T, Capacity >::ptr_iter ( ) const

inlinenodiscardnoexcept

Gets a constant pointer iterator to values.

Returns

constant pointer iterator

Definition at line 376 of file ring_buffer.hpp.

{ return iter::const_ptr(*this); }

Here is the call graph for this function:

ptr_iter() [2/2]

template<typename T, size_t Capacity = 10>

decltype(auto) mtcore::FixedRingBuffer< T, Capacity >::ptr_iter ( )

inlinenodiscardnoexcept

Gets a pointer iterator to values.

Returns

Pointer iterator

Definition at line 370 of file ring_buffer.hpp.

{ return iter::ptr(*this); }

Here is the call graph for this function:

push_back()

template<typename T, size_t Capacity = 10>

Result< void, CollectionAddNoAllocationError > mtcore::FixedRingBuffer< T, Capacity >::push_back ( const T & elem )

inlinenodiscard

Adds an element to the back of the buffer.

Parameters

elem	Element to add

Returns

Result indicating success or error

Definition at line 451 of file ring_buffer.hpp.

                                                                                        {
      if (count >= elements.size()) {
        return error(CollectionAddNoAllocationError::NO_ROOM);
      }
 
      elements[tail++] = elem;
      count++;
      if (tail == elements.size()) {
        tail = 0;
      }
      return success();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

push_front()

template<typename T, size_t Capacity = 10>

Result< void, CollectionAddNoAllocationError > mtcore::FixedRingBuffer< T, Capacity >::push_front ( const T & elem )

inlinenodiscard

Adds an element to the front of the buffer.

Parameters

elem	Element to add

Returns

Result indicating success or error

Definition at line 469 of file ring_buffer.hpp.

                                                                                         {
      if (count >= elements.size()) {
        return error(CollectionAddNoAllocationError::NO_ROOM);
      }
 
      auto new_head = head;
      if (new_head == 0) {
        new_head = elements.size() - 1;
      }
      else {
        new_head--;
      }
      elements[new_head] = elem;
      count++;
      head = new_head;
      return success();
    }

Here is the call graph for this function:

size()

template<typename T, size_t Capacity = 10>

size_t mtcore::FixedRingBuffer< T, Capacity >::size ( ) const

inlinenodiscardnoexcept

Gets current size of the buffer.

Definition at line 416 of file ring_buffer.hpp.

{ return count; }

---

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

• ring_buffer.hpp