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

make basic_ring_buffer fulfull its own template parameter requirements

Browse Source
This commit is contained in:
Ferdinand Bachmann
2020-04-22 15:52:07 +02:00
parent fd04982754
commit f1562b7960
2 changed files with 15 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
README.md
View File

@@ -70,12 +70,15 @@ The iterators returned by `begin()`, `end()`, `begin() const`, `end() const`,
after the logical last element. (i.e., they wrap around if they reach the end of
the underlying container)
`basic_ring_buffer` fulfills its own template parameter requirements.
#### Template parameter requirements
The parameter `Container` needs to have member types `value_type` and
`size_type`, and methods `size_type size() const`, `iterator begin()`,
`iterator end()`, `const_iterator cbegin() const`, and `const_iterator cend()
const`, as well as an overloaded `value_type& operator[](size_type)`.
const`, as well as an overloaded `value_type& operator[](size_type)` and `const
value_type& operator[](size_type) const)`.
The iterators returned by the container need to be random access iterators.