feedc0de/cxx-ring-buffer
1
0
Fork 0
forked from Ferdi265/cxx-ring-buffer
Code Pull Requests Activity

initial documentation for iterators and ring_buffer

Browse Source
This commit is contained in:
Ferdinand Bachmann
2020-04-22 15:44:37 +02:00
parent b564c50730
commit 352069a7f0
1 changed files with 41 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

41
README.md
View File

@ -47,7 +47,14 @@ The last 3 options set preprocessor defines with the same name when enabled.
## Documentation ## Documentation
### `class ring_buffer<T, N>`
(defined in `<ring-buffer.h>`)
`ring_buffer` is an alias template resolving to
`basic_ring_buffer<std::array<T, N>>`.
### `class basic_ring_buffer<Container>` ### `class basic_ring_buffer<Container>`
(defined in `<ring-buffer.h>`)
`basic_ring_buffer` is a template class wrapping a container, providing a `basic_ring_buffer` is a template class wrapping a container, providing a
`push_back(value)` method that treats the container as a ring buffer, and an `push_back(value)` method that treats the container as a ring buffer, and an
@ -145,3 +152,37 @@ The iterators returned by the container need to be random access iterators.
- `const_iterator cend() const`: - `const_iterator cend() const`:
returns a `ring_buffer_const_iterator` to the logical one-after-last element returns a `ring_buffer_const_iterator` to the logical one-after-last element
of the container. of the container.
### `class ring_buffer_iterator<Container>`
(defined in `<ring-buffer-iterator.h>`)
`ring_buffer_iterator` is a template class providing an iterator usable for
iterating over a container in a ring-buffer-like fashion, i.e., start at an
index other than 0, and wrap around when the end of the container is reached.
`ring_buffer_iterator` is a random access iterator and fulfills the
requirements of the C++ named requirement
[LegacyRandomAccessIterator][lra-iter].
#### Template parameter requirements
The parameter `Container` needs to fulfill the same requirements as for
`basic_ring_buffer`.
### `class ring_buffer_const_iterator<Container>`
(defined in `<ring-buffer-iterator.h>`)
`ring_buffer_const_iterator` is a template class providing an iterator usable
for iterating over a container in a ring-buffer-like fashion, i.e., start at an
index other than 0, and wrap around when the end of the container is reached.
`ring_buffer_const_iterator` is a random access iterator and fulfills the
requirements of the C++ named requirement
[LegacyRandomAccessIterator][lra-iter].
#### Template parameter requirements
The parameter `Container` needs to fulfill the same requirements as for
`basic_ring_buffer`.
[lra-iter]: (https://en.cppreference.com/w/cpp/named_req/RandomAccessIterator)