9#ifndef circular_buffer_H
10#define circular_buffer_H
38 if (
m_size<=2)
throw std::invalid_argument(
"size must be >2");
50 throw std::out_of_range(
"push: circular_buffer is full");
61 throw std::out_of_range(
"push: circular_buffer is full");
69 push(*array_elements++);
77 throw std::out_of_range(
"pop: circular_buffer is empty");
87 void pop(T &out_val) {
89 throw std::out_of_range(
"pop: circular_buffer is empty");
111 if (index>=this->
size())
throw std::out_of_range(
"peek: seek out of range");
121 if (peek_read==
m_next_write)
throw std::out_of_range(
"peek: circular_buffer is empty");
122 T val =
m_data[peek_read++];
123 if (peek_read==
m_size) peek_read=0;
A circular buffer of fixed size (defined at construction-time), implemented with a std::vector as the...
size_t size() const
Return the number of elements available for read ("pop") in the buffer (this is NOT the maximum size ...
void pop(T &out_val)
Retrieve an element from the buffer.
void peek_many(T *out_array, size_t count) const
Like peek(), for multiple elements, storing a number of elements into a user-provided array.
size_t available() const
The maximum number of elements that can be written ("push") without rising an overflow error.
circular_buffer(const size_t size)
T peek() const
Peek (see without modifying) what is to be read from the buffer if pop() was to be called.
T pop()
Retrieve an element from the buffer.
void push_many(T *array_elements, size_t count)
Insert an array of elements in the buffer.
void push_ref(const T &d)
Insert a reference of the given element in the buffer.
void pop_many(T *out_array, size_t count)
Pop a number of elements into a user-provided array.
void clear()
Delete all the stored data, if any.
size_t capacity() const
Return the maximum capacity of the buffer.
void push(T d)
Insert a copy of the given element in the buffer.
T peek(size_t index) const
Like peek(), but seeking ahead in the buffer (index=0 means the immediate next element,...
This is the global namespace for all Mobile Robot Programming Toolkit (MRPT) libraries.