17template <
class T,
size_t N>
20 static_assert(N > 0,
"Circular buffer size cannot be zero.");
31 : m_buffer{buffer}, m_index{index} {}
59 : m_buffer{buffer}, m_index{index} {}
117 size_t size()
const {
return m_length; }
127 const T&
front()
const {
return (*
this)[0]; }
135 T&
back() {
return m_data[(m_front + m_length - 1) % N]; }
143 const T&
back()
const {
return m_data[(m_front + m_length - 1) % N]; }
151 m_front = ModuloDec(m_front);
153 m_data[m_front] = value;
166 m_data[(m_front + m_length) % N] = value;
172 m_front = ModuloInc(m_front);
182 template <
class... Args>
184 m_front = ModuloDec(m_front);
186 m_data[m_front] = T{args...};
199 template <
class... Args>
201 m_data[(m_front + m_length) % N] = T{args...};
207 m_front = ModuloInc(m_front);
218 T& temp = m_data[m_front];
219 m_front = ModuloInc(m_front);
232 return m_data[(m_front + m_length) % N];
246 T&
operator[](
size_t index) {
return m_data[(m_front + index) % N]; }
252 return m_data[(m_front + index) % N];
256 std::array<T, N> m_data;
269 size_t ModuloInc(
size_t index) {
return (index + 1) % N; }
276 size_t ModuloDec(
size_t index) {
Definition: static_circular_buffer.h:50
std::forward_iterator_tag iterator_category
Definition: static_circular_buffer.h:52
const_iterator(const static_circular_buffer *buffer, size_t index)
Definition: static_circular_buffer.h:58
bool operator==(const const_iterator &) const =default
const_iterator operator++(int)
Definition: static_circular_buffer.h:65
const_iterator & operator++()
Definition: static_circular_buffer.h:61
const_reference operator*() const
Definition: static_circular_buffer.h:71
const T & const_reference
Definition: static_circular_buffer.h:56
T * pointer
Definition: static_circular_buffer.h:55
T value_type
Definition: static_circular_buffer.h:53
std::ptrdiff_t difference_type
Definition: static_circular_buffer.h:54
Definition: static_circular_buffer.h:22
iterator operator++(int)
Definition: static_circular_buffer.h:37
T value_type
Definition: static_circular_buffer.h:25
reference operator*()
Definition: static_circular_buffer.h:43
std::ptrdiff_t difference_type
Definition: static_circular_buffer.h:26
bool operator==(const iterator &) const =default
T & reference
Definition: static_circular_buffer.h:28
iterator & operator++()
Definition: static_circular_buffer.h:33
iterator(static_circular_buffer *buffer, size_t index)
Definition: static_circular_buffer.h:30
T * pointer
Definition: static_circular_buffer.h:27
std::forward_iterator_tag iterator_category
Definition: static_circular_buffer.h:24
This is a simple circular buffer so we don't need to "bucket brigade" copy old values.
Definition: static_circular_buffer.h:18
const T & back() const
Returns value at back of buffer.
Definition: static_circular_buffer.h:143
T & operator[](size_t index)
Definition: static_circular_buffer.h:246
iterator end()
Returns end iterator.
Definition: static_circular_buffer.h:86
void emplace_back(Args &&... args)
Push a new value onto the back of the buffer that is constructed with the provided constructor argume...
Definition: static_circular_buffer.h:200
void push_front(T value)
Push a new value onto the front of the buffer.
Definition: static_circular_buffer.h:150
void reset()
Empties internal buffer.
Definition: static_circular_buffer.h:238
T & back()
Returns value at back of buffer.
Definition: static_circular_buffer.h:135
T pop_back()
Pop value at back of buffer.
Definition: static_circular_buffer.h:230
T pop_front()
Pop value at front of buffer.
Definition: static_circular_buffer.h:217
void push_back(T value)
Push a new value onto the back of the buffer.
Definition: static_circular_buffer.h:165
const_iterator end() const
Returns end iterator.
Definition: static_circular_buffer.h:98
const T & operator[](size_t index) const
Definition: static_circular_buffer.h:251
const_iterator begin() const
Returns begin iterator.
Definition: static_circular_buffer.h:93
const_iterator cbegin() const
Returns begin iterator.
Definition: static_circular_buffer.h:105
const T & front() const
Returns value at front of buffer.
Definition: static_circular_buffer.h:127
void emplace_front(Args &&... args)
Push a new value onto the front of the buffer that is constructed with the provided constructor argum...
Definition: static_circular_buffer.h:183
iterator begin()
Returns begin iterator.
Definition: static_circular_buffer.h:81
const_iterator cend() const
Returns end iterator.
Definition: static_circular_buffer.h:110
size_t size() const
Returns number of elements in buffer.
Definition: static_circular_buffer.h:117
T & front()
Returns value at front of buffer.
Definition: static_circular_buffer.h:122
Definition: ntcore_cpp.h:26