diff --git a/doc/circular_buffer.html b/doc/circular_buffer.html
index c96fefc..7e2fda2 100644
--- a/doc/circular_buffer.html
+++ b/doc/circular_buffer.html
@@ -47,7 +47,8 @@
Standalone Functions
Notes
See also
- Acknowledgements
+ Acknowledgements
+ Release Notes
| @@ -200,17 +201,17 @@ public: ~circular_buffer(); allocator_type get_allocator() const; +"#classboost_1_1circular__buffer_1a20b7d0e7a4da0af13286df9f53d660c">get_allocator() const; allocator_type& get_allocator(); iterator begin(); iterator end(); - const_iterator begin() const; - const_iterator end() const; + const_iterator begin() const; + const_iterator end() const; reverse_iterator rbegin(); reverse_iterator rend(); const_reverse_iterator rbegin() const; - const_reverse_iterator rend() const; +"#classboost_1_1circular__buffer_1765d91bf48341907418433a1e3aab026">rbegin() const; + const_reverse_iterator rend() const; reference operator[](size_type index); const_reference at(size_type index) const; reference front(); reference back(); - const_reference front() const; - const_reference back() const; + const_reference front() const; + const_reference back() const; array_range array_one(); array_range array_two(); - const_array_range array_one() const; - const_array_range array_two() const; + const_array_range array_one() const; + const_array_range array_two() const; pointer linearize(); - size_type size() const; - size_type max_size() const; - bool empty() const; - bool full() const; - size_type reserve() const; - capacity_type capacity() const; + size_type size() const; + size_type max_size() const; + bool empty() const; + bool full() const; + size_type reserve() const; + capacity_type capacity() const; void set_capacity(capacity_type new_capacity); void | ||
+ T
+ |
+
+ The type of the elements stored in the circular_buffer.
+
|
+
+ + |
+
+ Alloc
+ |
+
+ The allocator type used for all internal memory management.
+
|
+
+ std::allocator<T>
+ |
+
circular_buffer with a maximum capacity.
+ Create an empty circular_buffer with zero capacity.
capacity() ==
- max_size() &&
- size() == 0
+ capacity() == 0
+ && size() ==
+ 0
circular_buffer with zero capacity (e.g. by push_back(const_reference)
+ or insert(iterator,
+ value_type)) nothing will be inserted and the size (as well as capacity) remains zero.
capacity() ==
+ capacity() ==
capacity && size() == 0
+ "#classboost_1_1circular__buffer_15fa0edd153e2591dd6bf070eb663ee32">size() == 0
capacity() == n
- && full()
+ capacity() == n
+ && full()
&& (*this)[0] == item && (*this)[1] == item && ... && (*this)[n - 1] ==
item
capacity() ==
+ capacity() ==
capacity && size() == n &&
+ "#classboost_1_1circular__buffer_15fa0edd153e2591dd6bf070eb663ee32">size() == n &&
(*this)[0] == item && (*this)[1] == item && ... && (*this)[n - 1] ==
item
capacity() ==
+ capacity() ==
std::distance(first, last) && full() && (*this)[0]==
+ "#classboost_1_1circular__buffer_1fd0eef8ba91210d1575404b7e3e8207a">full() && (*this)[0]==
*first && (*this)[1] == *(first + 1) && ... && (*this)[std::distance(first,
last) - 1] == *(last - 1)
capacity() ==
+ capacity() ==
capacity && size() <=
+ "#classboost_1_1circular__buffer_15fa0edd153e2591dd6bf070eb663ee32">size() <=
std::distance(first, last) && (*this)[0]== *(last - capacity) && (*this)[1] == *(last -
capacity + 1) && ... && (*this)[capacity - 1] == *(last - 1)
@@ -1496,8 +1546,8 @@ template <class T, class Alloc>
- allocator_type get_allocator()
const;
@@ -1616,7 +1666,7 @@ template <class T, class Alloc>
See Also:
-
-
get_allocator()
+ get_allocator()
const
@@ -1747,8 +1797,8 @@ template <class T, class Alloc>
- const_iterator begin()
const;
@@ -1760,7 +1810,7 @@ template <class T, class Alloc>
-
A const random access iterator pointing to the first element of the
circular_buffer. If
the circular_buffer is empty it returns an iterator equal to the one returned by
- end()
+ end()
const.
@@ -1801,10 +1851,10 @@ template <class T, class Alloc>
See Also:
-
-
end()
+ end()
const, rbegin() const,
- rend()
+ "#classboost_1_1circular__buffer_1765d91bf48341907418433a1e3aab026">rbegin() const,
+ rend()
const
@@ -1812,8 +1862,8 @@ template <class T, class Alloc>
- const_iterator end()
const;
@@ -1826,7 +1876,7 @@ template <class T, class Alloc>
A const random access iterator pointing to the element "one behind" the last element of the
circular_buffer. If the circular_buffer is empty it returns an iterator equal
to the one returned by begin() const const.
+ "#classboost_1_1circular__buffer_10640d3d41c13b6089b6f169224cf1038">begin() const const.
@@ -2002,8 +2052,8 @@ template <class T, class Alloc>
- const_reverse_iterator rbegin()
const;
@@ -2016,7 +2066,7 @@ template <class T, class Alloc>
A const reverse random access iterator pointing to the last element of the
circular_buffer. If the circular_buffer is empty it returns an iterator equal
to the one returned by rend() const.
+ "#classboost_1_1circular__buffer_108dbf538b00a14daf5582ece80746fc3">rend() const.
@@ -2067,8 +2117,8 @@ template <class T, class Alloc>
- const_reverse_iterator rend()
const;
@@ -2081,7 +2131,7 @@ template <class T, class Alloc>
A const reverse random access iterator pointing to the element "one before" the first element of the
circular_buffer. If the circular_buffer is empty it returns an iterator equal
to the one returned by rbegin() const.
+ "#classboost_1_1circular__buffer_1765d91bf48341907418433a1e3aab026">rbegin() const.
@@ -2121,10 +2171,10 @@ template <class T, class Alloc>
See Also:
-
-
rbegin()
+ rbegin()
const, begin() const,
- end()
+ "#classboost_1_1circular__buffer_10640d3d41c13b6089b6f169224cf1038">begin() const,
+ end()
const
@@ -2144,7 +2194,7 @@ template <class T, class Alloc>
-
0 <= index && index < size()
+ "#classboost_1_1circular__buffer_15fa0edd153e2591dd6bf070eb663ee32">size()
@@ -2227,7 +2277,7 @@ template <class T, class Alloc>
-
0 <= index && index < size()
+ "#classboost_1_1circular__buffer_15fa0edd153e2591dd6bf070eb663ee32">size()
@@ -2332,7 +2382,7 @@ template <class T, class Alloc>
-
std::out_of_range when the index is invalid (when index >= size()).
+ "#classboost_1_1circular__buffer_15fa0edd153e2591dd6bf070eb663ee32">size()).
@@ -2364,7 +2414,7 @@ template <class T, class Alloc>
See Also:
-
-
operator[]
+ operator[]
@@ -2407,7 +2457,7 @@ template <class T, class Alloc>
-
std::out_of_range when the index is invalid (when index >= size()).
+ "#classboost_1_1circular__buffer_15fa0edd153e2591dd6bf070eb663ee32">size()).
@@ -2577,8 +2627,8 @@ template <class T, class Alloc>
- const_reference front()
const;
@@ -2636,7 +2686,7 @@ template <class T, class Alloc>
See Also:
-
-
back()
+ back()
const
@@ -2644,8 +2694,8 @@ template <class T, class Alloc>
- const_reference back()
const;
@@ -2703,7 +2753,7 @@ template <class T, class Alloc>
See Also:
-
-
front()
+ front()
const
@@ -2910,15 +2960,15 @@ template <class T, class Alloc>
- const_array_range array_one()
const;
Get the first continuous array of the internal buffer.
This method in combination with array_two() const can be
+ "#classboost_1_1circular__buffer_1bb8eb0f298ad2012c55c5303e1f174d5">array_two() const
can be
useful when passing the stored data into a legacy C API as an array.
- const_array_range array_two()
const;
Get the second continuous array of the internal buffer.
This method in combination with array_one() const can be
+ "#classboost_1_1circular__buffer_10f4b157e27b1170a571417986b239945">array_one() const
can be
useful when passing the stored data into a legacy C API as an array.
@@ -3035,7 +3085,7 @@ template <class T, class Alloc>
See Also:
-
-
array_one()
+ array_one()
const
@@ -3057,7 +3107,7 @@ template <class T, class Alloc>
-
&(*this)[0] < &(*this)[1] < ... < &(*this)[size() - 1]
+ "#classboost_1_1circular__buffer_15fa0edd153e2591dd6bf070eb663ee32">size() - 1]
@@ -3132,8 +3182,8 @@ template <class T, class Alloc>
- size_type size()
const;
@@ -3184,10 +3234,10 @@ template <class T, class Alloc>
-
capacity(),
+ "#classboost_1_1circular__buffer_15ebab2b2538d733790b5752582728e77">capacity() ,
max_size(),
- reserve(),
+ "#classboost_1_1circular__buffer_157e2d506bc274b2a63fbe1b8fcafebd7">max_size(),
+ reserve(),
resize(size_type,
const_reference)
@@ -3196,8 +3246,8 @@ template <class T, class Alloc>
- size_type max_size()
const;
@@ -3248,18 +3298,18 @@ template <class T, class Alloc>
See Also:
-
-
size(),
+ size(),
capacity(),
- reserve()
+ "#classboost_1_1circular__buffer_15ebab2b2538d733790b5752582728e77">capacity() ,
+ reserve()
- bool empty()
+ bool empty()
const;
Is the circular_buffer empty?
@@ -3309,15 +3359,15 @@ template <class T, class Alloc>
See Also:
-
-
full()
+ full()
- bool full()
+ bool full()
const;
Is the circular_buffer full?
@@ -3367,15 +3417,15 @@ template <class T, class Alloc>
See Also:
-
-
empty()
+ empty()
- size_type reserve()
const;
@@ -3386,8 +3436,8 @@ template <class T, class Alloc>
Returns:
-
-
capacity() -
- size()
+ capacity() -
+ size()
@@ -3428,17 +3478,17 @@ template <class T, class Alloc>
-
capacity(),
- size(),
- max_size()
+ "#classboost_1_1circular__buffer_15ebab2b2538d733790b5752582728e77">capacity()
,
+ size(),
+ max_size()
- capacity_type capacity()
const;
@@ -3488,10 +3538,10 @@ template <class T, class Alloc>
See Also:
-
-
reserve(),
- size(),
+ reserve(),
+ size(),
max_size(),
+ "#classboost_1_1circular__buffer_157e2d506bc274b2a63fbe1b8fcafebd7">max_size() ,
set_capacity(capacity_type)
@@ -3511,14 +3561,14 @@ template <class T, class Alloc>
Effect:
-
-
capacity() ==
+ capacity() ==
new_capacity && size() <=
+ "#classboost_1_1circular__buffer_15fa0edd153e2591dd6bf070eb663ee32">size() <=
new_capacity
If the current number of elements stored in the circular_buffer is greater than the
desired new capacity then number of [size() - new_capacity]
+ "#classboost_1_1circular__buffer_15fa0edd153e2591dd6bf070eb663ee32">size() - new_capacity]
last elements will be removed and the new size will be equal to new_capacity.
@@ -3573,7 +3623,7 @@ template <class T, class Alloc>
-
Linear (in
min[size(), new_capacity]).
+ "#classboost_1_1circular__buffer_15fa0edd153e2591dd6bf070eb663ee32">size(), new_capacity]).
@@ -3603,9 +3653,9 @@ template <class T, class Alloc>
Effect:
-
-
size() ==
+ size() ==
new_size && capacity() >=
+ "#classboost_1_1circular__buffer_15ebab2b2538d733790b5752582728e77">capacity() >=
new_size
If the new size is greater than the current size, copies of item will be inserted at the
@@ -3614,7 +3664,7 @@ template <class T, class Alloc>
new_size.
If the current number of elements stored in the circular_buffer is greater than the
desired new size then number of [size() - new_size]
+ "#classboost_1_1circular__buffer_15fa0edd153e2591dd6bf070eb663ee32">size() - new_size]
last elements will be removed. (The capacity will remain unchanged.)
@@ -3709,14 +3759,14 @@ template <class T, class Alloc>
Effect:
-
-
capacity() ==
+ capacity() ==
new_capacity && size() <=
+ "#classboost_1_1circular__buffer_15fa0edd153e2591dd6bf070eb663ee32">size() <=
new_capacity
If the current number of elements stored in the circular_buffer is greater than the
desired new capacity then number of [size() - new_capacity]
+ "#classboost_1_1circular__buffer_15fa0edd153e2591dd6bf070eb663ee32">size() - new_capacity]
first elements will be removed and the new size will be equal to new_capacity.
@@ -3771,7 +3821,7 @@ template <class T, class Alloc>
-
Linear (in
min[size(), new_capacity]).
+ "#classboost_1_1circular__buffer_15fa0edd153e2591dd6bf070eb663ee32">size(), new_capacity]).
@@ -3801,9 +3851,9 @@ template <class T, class Alloc>
Effect:
-
-
size() ==
+ size() ==
new_size && capacity() >=
+ "#classboost_1_1circular__buffer_15ebab2b2538d733790b5752582728e77">capacity() >=
new_size
If the new size is greater than the current size, copies of item will be inserted at the
@@ -3812,7 +3862,7 @@ template <class T, class Alloc>
new_size.
If the current number of elements stored in the circular_buffer is greater than the
desired new size then number of [size() - new_size]
+ "#classboost_1_1circular__buffer_15fa0edd153e2591dd6bf070eb663ee32">size() - new_size]
first elements will be removed. (The capacity will remain unchanged.)
@@ -3999,8 +4049,8 @@ template <class T, class Alloc>
Effect:
-
-
capacity() == n
- && size() == n
+ capacity() == n
+ && size() == n
&& (*this)[0] == item && (*this)[1] == item && ... && (*this) [n - 1]
== item
@@ -4072,9 +4122,9 @@ template <class T, class Alloc>
See Also:
-
-
operator=,
- assign(capacity_type,
- size_type, const_reference), operator=, assign(capacity_type, size_type,
+ const_reference), assign(InputIterator,
InputIterator), assign(capacity_type,
@@ -4111,9 +4161,9 @@ template <class T, class Alloc>
Effect:
-
-
capacity() ==
+ capacity() ==
capacity && size() == n &&
+ "#classboost_1_1circular__buffer_15fa0edd153e2591dd6bf070eb663ee32">size() == n &&
(*this)[0] == item && (*this)[1] == item && ... && (*this) [n - 1] ==
item
@@ -4195,8 +4245,8 @@ template <class T, class Alloc>
See Also:
-
-
operator=,
- assign(size_type,
+ operator=, assign(size_type,
const_reference), assign(InputIterator,
InputIterator), Effect:
-
-
capacity() ==
+ capacity() ==
std::distance(first, last) && size() == std::distance(first,
+ "#classboost_1_1circular__buffer_15fa0edd153e2591dd6bf070eb663ee32">size() == std::distance(first,
last) && (*this)[0]== *first && (*this)[1] == *(first + 1) && ... &&
(*this)[std::distance(first, last) - 1] == *(last - 1)
@@ -4307,8 +4357,8 @@ template <class T, class Alloc>
See Also:
-
-
operator=,
- assign(size_type,
+ operator=, assign(size_type,
const_reference), assign(capacity_type, size_type,
const_reference), Effect:
-
-
capacity() ==
+ capacity() ==
capacity && size() <=
+ "#classboost_1_1circular__buffer_15fa0edd153e2591dd6bf070eb663ee32">size() <=
std::distance(first, last) && (*this)[0]== *(last - capacity) && (*this)[1] == *(last -
capacity + 1) && ... && (*this)[capacity - 1] == *(last - 1)
@@ -4438,8 +4488,8 @@ template <class T, class Alloc>
See Also:
-
-
operator=,
- assign(size_type,
+ operator=, assign(size_type,
const_reference), assign(capacity_type, size_type,
const_reference), Effect:
-
- if
capacity()
+ if capacity()
> 0 then back() == item
If the circular_buffer is full, the first element will be removed. If the capacity is
@@ -4621,7 +4671,7 @@ template <class T, class Alloc>
Effect:
-
- if
capacity()
+ if capacity()
> 0 then front() == item
If the circular_buffer is full, the last element will be removed. If the capacity is
@@ -4978,11 +5028,11 @@ template <class T, class Alloc>
-
The number of
min[n, (pos - begin()) + reserve()] elements will
+ "#classboost_1_1circular__buffer_10a02c4fbc53385e98569e810be9843de">reserve() ] elements will
be inserted at the position pos.
The number of min[pos - begin(), max[0, n - reserve()]] elements
+ "#classboost_1_1circular__buffer_10a02c4fbc53385e98569e810be9843de">reserve()]] elements
will be overwritten at the beginning of the circular_buffer.
(See Example for the explanation.)
@@ -5058,7 +5108,7 @@ template <class T, class Alloc>
-
Linear (in
min[capacity(), std::distance(pos,
+ "#classboost_1_1circular__buffer_15ebab2b2538d733790b5752582728e77">capacity() , std::distance(pos,
end()) + n]).
@@ -5132,12 +5182,12 @@ template <class T, class Alloc>
-
Elements from the range
[first + max[0, distance(first, last) - (pos - begin()) - reserve()], last) will
+ "#classboost_1_1circular__buffer_10a02c4fbc53385e98569e810be9843de">reserve()], last) will
be inserted at the position pos.
The number of min[pos - begin(), max[0, distance(first,
last) - reserve()]] elements
+ "#classboost_1_1circular__buffer_10a02c4fbc53385e98569e810be9843de">reserve()]] elements
will be overwritten at the beginning of the circular_buffer.
(See Example for the explanation.)
@@ -5215,7 +5265,7 @@ template <class T, class Alloc>
Linear (in [std::distance(pos, end()) + std::distance(first,
last)]; in min[capacity(), std::distance(pos,
+ "#classboost_1_1circular__buffer_15ebab2b2538d733790b5752582728e77">capacity(), std::distance(pos,
end()) +
std::distance(first, last)] if the InputIterator is a RandomAccessIterator).
@@ -5413,11 +5463,11 @@ template <class T, class Alloc>
-
The number of
min[n, (end() - pos) + reserve()] elements will
+ "#classboost_1_1circular__buffer_10a02c4fbc53385e98569e810be9843de">reserve()] elements will
be inserted before the position pos.
The number of min[end() - pos, max[0, n -
- reserve()]]
+ reserve()]]
elements will be overwritten at the end of the circular_buffer.
(See Example for the explanation.)
@@ -5491,7 +5541,7 @@ template <class T, class Alloc>
-
Linear (in
min[capacity(),
+ "#classboost_1_1circular__buffer_15ebab2b2538d733790b5752582728e77">capacity(),
std::distance(begin(),
pos) + n]).
@@ -5566,12 +5616,12 @@ template <class T, class Alloc>
-
Elements from the range
[first, last - max[0, distance(first, last) - (end() - pos) - reserve()]) will be
+ "#classboost_1_1circular__buffer_10a02c4fbc53385e98569e810be9843de">reserve()]) will be
inserted before the position pos.
The number of min[end() - pos, max[0,
distance(first, last) - reserve()]] elements
+ "#classboost_1_1circular__buffer_10a02c4fbc53385e98569e810be9843de">reserve()]] elements
will be overwritten at the end of the circular_buffer.
(See Example for the explanation.)
@@ -5647,7 +5697,7 @@ template <class T, class Alloc>
Linear (in [std::distance(begin(), pos) +
std::distance(first, last)]; in min[capacity(),
+ "#classboost_1_1circular__buffer_15ebab2b2538d733790b5752582728e77">capacity(),
std::distance(begin(),
pos) + std::distance(first, last)] if the InputIterator is a RandomAccessIterator).
@@ -6161,7 +6211,7 @@ template <class T, class Alloc>
Effect:
-
-
size() ==
+ size() ==
0
@@ -6261,8 +6311,8 @@ template <class T, class Alloc>
Returns:
-
-
lhs.size() ==
- rhs.size() &&
+ lhs.size() ==
+ rhs.size() &&
std::equal(lhs.begin(), lhs.end(), rhs.
+
+ Release Notes
+
-
-
-
-
- Copyright © 2003-2007 Jan Gaspar
-
-
- Use, modification, and distribution is subject to the Boost Software License, Version 1.0.
- (See accompanying file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
-
-
-
-
-
-
-
+
+ Copyright © 2003-2007 Jan Gaspar
+
+
+ Use, modification, and distribution is subject to the Boost Software License, Version 1.0.
+ (See accompanying file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
+