diff --git a/doc/HOWTO-srcdoc b/doc/HOWTO-srcdoc index eac259e..d5abd2f 100644 --- a/doc/HOWTO-srcdoc +++ b/doc/HOWTO-srcdoc @@ -2,7 +2,7 @@ # HOW-TO documentation about generating/updating source code documentation for # # the Circular Buffer library. # # # -# Copyright (c) 2006 Jan Gaspar # +# Copyright (c) 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 # diff --git a/doc/circular_buffer.html b/doc/circular_buffer.html index fe8415f..4c5c660 100644 --- a/doc/circular_buffer.html +++ b/doc/circular_buffer.html @@ -983,7 +983,7 @@ template <class T, class Alloc>
This constructor has been defined only due to compatibility with the STL container definition. Avoid - using it because it allocates very large amount of memory. + using it because it may allocate very large amount of memory.
@@ -1497,6 +1497,15 @@ template <class T, class Alloc> Nothing. +
+
+ Iterator Invalidation: +
+
+ Invalidates all iterators pointing to the circular_buffer (including iterators equal to + end()). +
+
Complexity: @@ -1505,22 +1514,6 @@ template <class T, class Alloc> Linear (in the size of the circular_buffer).
-
-
- Exception Safety: -
-
- No-throw. -
-
-
-
- Iterator Invalidation: -
-
- Invalidates all iterators pointing to the circular_buffer. -
-
See Also: @@ -1562,14 +1555,6 @@ template <class T, class Alloc> Nothing.
-
-
- Complexity: -
-
- Constant (in the size of the circular_buffer). -
-
Exception Safety: @@ -1586,6 +1571,14 @@ template <class T, class Alloc> Does not invalidate any iterators.
+
+
+ Complexity: +
+
+ Constant (in the size of the circular_buffer). +
+
See Also: @@ -1622,14 +1615,6 @@ template <class T, class Alloc> Nothing.
-
-
- Complexity: -
-
- Constant (in the size of the circular_buffer). -
-
Exception Safety: @@ -1646,6 +1631,14 @@ template <class T, class Alloc> Does not invalidate any iterators.
+
+
+ Complexity: +
+
+ Constant (in the size of the circular_buffer). +
+
Note: @@ -1691,14 +1684,6 @@ template <class T, class Alloc> Nothing.
-
-
- Complexity: -
-
- Constant (in the size of the circular_buffer). -
-
Exception Safety: @@ -1715,6 +1700,14 @@ template <class T, class Alloc> Does not invalidate any iterators.
+
+
+ Complexity: +
+
+ Constant (in the size of the circular_buffer). +
+
See Also: @@ -1753,14 +1746,6 @@ template <class T, class Alloc> Nothing.
-
-
- Complexity: -
-
- Constant (in the size of the circular_buffer). -
-
Exception Safety: @@ -1777,6 +1762,14 @@ template <class T, class Alloc> Does not invalidate any iterators.
+
+
+ Complexity: +
+
+ Constant (in the size of the circular_buffer). +
+
See Also: @@ -1816,14 +1809,6 @@ template <class T, class Alloc> Nothing.
-
-
- Complexity: -
-
- Constant (in the size of the circular_buffer). -
-
Exception Safety: @@ -1840,6 +1825,14 @@ template <class T, class Alloc> Does not invalidate any iterators.
+
+
+ Complexity: +
+
+ Constant (in the size of the circular_buffer). +
+
See Also: @@ -1881,14 +1874,6 @@ template <class T, class Alloc> Nothing.
-
-
- Complexity: -
-
- Constant (in the size of the circular_buffer). -
-
Exception Safety: @@ -1905,6 +1890,14 @@ template <class T, class Alloc> Does not invalidate any iterators.
+
+
+ Complexity: +
+
+ Constant (in the size of the circular_buffer). +
+
See Also: @@ -1945,14 +1938,6 @@ template <class T, class Alloc> Nothing.
-
-
- Complexity: -
-
- Constant (in the size of the circular_buffer). -
-
Exception Safety: @@ -1969,6 +1954,14 @@ template <class T, class Alloc> Does not invalidate any iterators.
+
+
+ Complexity: +
+
+ Constant (in the size of the circular_buffer). +
+
See Also: @@ -2008,14 +2001,6 @@ template <class T, class Alloc> Nothing.
-
-
- Complexity: -
-
- Constant (in the size of the circular_buffer). -
-
Exception Safety: @@ -2032,6 +2017,14 @@ template <class T, class Alloc> Does not invalidate any iterators.
+
+
+ Complexity: +
+
+ Constant (in the size of the circular_buffer). +
+
See Also: @@ -2071,14 +2064,6 @@ template <class T, class Alloc> Nothing.
-
-
- Complexity: -
-
- Constant (in the size of the circular_buffer). -
-
Exception Safety: @@ -2095,6 +2080,14 @@ template <class T, class Alloc> Does not invalidate any iterators.
+
+
+ Complexity: +
+
+ Constant (in the size of the circular_buffer). +
+
See Also: @@ -2136,14 +2129,6 @@ template <class T, class Alloc> Nothing.
-
-
- Complexity: -
-
- Constant (in the size of the circular_buffer). -
-
Exception Safety: @@ -2160,6 +2145,14 @@ template <class T, class Alloc> Does not invalidate any iterators.
+
+
+ Complexity: +
+
+ Constant (in the size of the circular_buffer). +
+
See Also: @@ -2222,14 +2215,6 @@ template <class T, class Alloc> Nothing.
-
-
- Complexity: -
-
- Constant (in the size of the circular_buffer). -
-
Exception Safety: @@ -2246,6 +2231,14 @@ template <class T, class Alloc> Does not invalidate any iterators.
+
+
+ Complexity: +
+
+ Constant (in the size of the circular_buffer). +
+
See Also: @@ -2305,14 +2298,6 @@ template <class T, class Alloc> Nothing.
-
-
- Complexity: -
-
- Constant (in the size of the circular_buffer). -
-
Exception Safety: @@ -2329,6 +2314,14 @@ template <class T, class Alloc> Does not invalidate any iterators.
+
+
+ Complexity: +
+
+ Constant (in the size of the circular_buffer). +
+
See Also: @@ -2375,16 +2368,8 @@ template <class T, class Alloc> Throws:
- <code>std::out_of_range</code> when the index is invalid (when index - >= size()). -
-
-
-
- Complexity: -
-
- Constant (in the size of the circular_buffer). + std::out_of_range when the index is invalid (when index >= size()).
@@ -2403,6 +2388,14 @@ template <class T, class Alloc> Does not invalidate any iterators.
+
+
+ Complexity: +
+
+ Constant (in the size of the circular_buffer). +
+
See Also: @@ -2450,16 +2443,8 @@ template <class T, class Alloc> Throws:
- <code>std::out_of_range</code> when the index is invalid (when index - >= size()). -
-
-
-
- Complexity: -
-
- Constant (in the size of the circular_buffer). + std::out_of_range when the index is invalid (when index >= size()).
@@ -2478,6 +2463,14 @@ template <class T, class Alloc> Does not invalidate any iterators.
+
+
+ Complexity: +
+
+ Constant (in the size of the circular_buffer). +
+
See Also: @@ -2520,14 +2513,6 @@ template <class T, class Alloc> Nothing.
-
-
- Complexity: -
-
- Constant (in the size of the circular_buffer). -
-
Exception Safety: @@ -2544,6 +2529,14 @@ template <class T, class Alloc> Does not invalidate any iterators.
+
+
+ Complexity: +
+
+ Constant (in the size of the circular_buffer). +
+
See Also: @@ -2585,14 +2578,6 @@ template <class T, class Alloc> Nothing.
-
-
- Complexity: -
-
- Constant (in the size of the circular_buffer). -
-
Exception Safety: @@ -2609,6 +2594,14 @@ template <class T, class Alloc> Does not invalidate any iterators.
+
+
+ Complexity: +
+
+ Constant (in the size of the circular_buffer). +
+
See Also: @@ -2651,14 +2644,6 @@ template <class T, class Alloc> Nothing.
-
-
- Complexity: -
-
- Constant (in the size of the circular_buffer). -
-
Exception Safety: @@ -2675,6 +2660,14 @@ template <class T, class Alloc> Does not invalidate any iterators.
+
+
+ Complexity: +
+
+ Constant (in the size of the circular_buffer). +
+
See Also: @@ -2718,14 +2711,6 @@ template <class T, class Alloc> Nothing.
-
-
- Complexity: -
-
- Constant (in the size of the circular_buffer). -
-
Exception Safety: @@ -2742,6 +2727,14 @@ template <class T, class Alloc> Does not invalidate any iterators.
+
+
+ Complexity: +
+
+ Constant (in the size of the circular_buffer). +
+
See Also: @@ -2825,14 +2818,6 @@ template <class T, class Alloc> Nothing.
-
-
- Complexity: -
-
- Constant (in the size of the circular_buffer). -
-
Exception Safety: @@ -2849,6 +2834,14 @@ template <class T, class Alloc> Does not invalidate any iterators.
+
+
+ Complexity: +
+
+ Constant (in the size of the circular_buffer). +
+
Warning: @@ -2917,14 +2910,6 @@ template <class T, class Alloc> Nothing.
-
-
- Complexity: -
-
- Constant (in the size of the circular_buffer). -
-
Exception Safety: @@ -2941,6 +2926,14 @@ template <class T, class Alloc> Does not invalidate any iterators.
+
+
+ Complexity: +
+
+ Constant (in the size of the circular_buffer). +
+
See Also: @@ -2982,14 +2975,6 @@ template <class T, class Alloc> Nothing.
-
-
- Complexity: -
-
- Constant (in the size of the circular_buffer). -
-
Exception Safety: @@ -3006,6 +2991,14 @@ template <class T, class Alloc> Does not invalidate any iterators.
+
+
+ Complexity: +
+
+ Constant (in the size of the circular_buffer). +
+
See Also: @@ -3050,14 +3043,6 @@ template <class T, class Alloc> Nothing.
-
-
- Complexity: -
-
- Constant (in the size of the circular_buffer). -
-
Exception Safety: @@ -3074,6 +3059,14 @@ template <class T, class Alloc> Does not invalidate any iterators.
+
+
+ Complexity: +
+
+ Constant (in the size of the circular_buffer). +
+
See Also: @@ -3123,20 +3116,12 @@ template <class T, class Alloc> Whatever T::operator = (const T&) throws.
-
-
- Complexity: -
-
- Linear (in the size of the circular_buffer); constant if the postcondition is already met. -
-
Exception Safety:
- Basic; no-throw if the operations in the Throws section do not throw anything. + Basic; no-throw if the operations in the Throws section do not throw anything.
@@ -3144,8 +3129,17 @@ template <class T, class Alloc> Iterator Invalidation:
- Invalidates all iterators pointing to the circular_buffer; does not invalidate any - iterators if the postcondition is already met prior calling this method. + Invalidates all iterators pointing to the circular_buffer (except iterators equal to + end()); does not + invalidate any iterators if the postcondition is already met prior calling this method. +
+
+
+
+ Complexity: +
+
+ Linear (in the size of the circular_buffer); constant if the postcondition is already met.
@@ -3195,14 +3189,6 @@ template <class T, class Alloc> Nothing.
-
-
- Complexity: -
-
- Constant (in the size of the circular_buffer). -
-
Exception Safety: @@ -3219,6 +3205,14 @@ template <class T, class Alloc> Does not invalidate any iterators.
+
+
+ Complexity: +
+
+ Constant (in the size of the circular_buffer). +
+
See Also: @@ -3258,14 +3252,6 @@ template <class T, class Alloc> Nothing.
-
-
- Complexity: -
-
- Constant (in the size of the circular_buffer). -
-
Exception Safety: @@ -3282,6 +3268,14 @@ template <class T, class Alloc> Does not invalidate any iterators.
+
+
+ Complexity: +
+
+ Constant (in the size of the circular_buffer). +
+
See Also: @@ -3319,14 +3313,6 @@ template <class T, class Alloc> Nothing.
-
-
- Complexity: -
-
- Constant (in the size of the circular_buffer). -
-
Exception Safety: @@ -3343,6 +3329,14 @@ template <class T, class Alloc> Does not invalidate any iterators.
+
+
+ Complexity: +
+
+ Constant (in the size of the circular_buffer). +
+
See Also: @@ -3377,14 +3371,6 @@ template <class T, class Alloc> Nothing.
-
-
- Complexity: -
-
- Constant (in the size of the circular_buffer). -
-
Exception Safety: @@ -3401,6 +3387,14 @@ template <class T, class Alloc> Does not invalidate any iterators.
+
+
+ Complexity: +
+
+ Constant (in the size of the circular_buffer). +
+
See Also: @@ -3437,14 +3431,6 @@ template <class T, class Alloc> Nothing.
-
-
- Complexity: -
-
- Constant (in the size of the circular_buffer). -
-
Exception Safety: @@ -3461,6 +3447,14 @@ template <class T, class Alloc> Does not invalidate any iterators.
+
+
+ Complexity: +
+
+ Constant (in the size of the circular_buffer). +
+
See Also: @@ -3498,14 +3492,6 @@ template <class T, class Alloc> Nothing.
-
-
- Complexity: -
-
- Constant (in the size of the circular_buffer). -
-
Exception Safety: @@ -3522,6 +3508,14 @@ template <class T, class Alloc> Does not invalidate any iterators.
+
+
+ Complexity: +
+
+ Constant (in the size of the circular_buffer). +
+
See Also: @@ -3551,12 +3545,14 @@ template <class T, class Alloc>
capacity() == + new_capacity && 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] - last elements will be removed. + last elements will be removed and the new size will be equal to new_capacity.
@@ -3586,14 +3582,6 @@ template <class T, class Alloc> Whatever T::T(const T&) throws.
-
-
- Complexity: -
-
- Linear (in the size/new capacity of the circular_buffer). -
-
Exception Safety: @@ -3607,8 +3595,17 @@ template <class T, class Alloc> Iterator Invalidation:
- Invalidates all iterators pointing to the circular_buffer if the new capacity is different - from the original. + Invalidates all iterators pointing to the circular_buffer (except iterators equal to + end()) if the new + capacity is different from the original. +
+
+
+
+ Complexity: +
+
+ Linear (in the size/new capacity of the circular_buffer).
@@ -3690,14 +3687,6 @@ template <class T, class Alloc> Whatever T::T(const T&) throws.
-
-
- Complexity: -
-
- Linear (in the new size of the circular_buffer). -
-
Exception Safety: @@ -3711,8 +3700,18 @@ template <class T, class Alloc> Iterator Invalidation:
- Invalidates all iterators pointing to the circular_buffer if the new size is different - from the original. + Invalidates all iterators pointing to the circular_buffer (except iterators equal to + end()) if the new size + is greater than the current capacity. Invalidates iterators pointing to the removed elements if the new + size is lower that the original size. Otherwise it does not invalidate any iterator. +
+
+
+
+ Complexity: +
+
+ Linear (in the new size of the circular_buffer).
@@ -3741,12 +3740,14 @@ template <class T, class Alloc>
capacity() == + new_capacity && 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] - first elements will be removed. + first elements will be removed and the new size will be equal to new_capacity.
@@ -3776,14 +3777,6 @@ template <class T, class Alloc> Whatever T::T(const T&) throws.
-
-
- Complexity: -
-
- Linear (in the size/new capacity of the circular_buffer). -
-
Exception Safety: @@ -3797,8 +3790,17 @@ template <class T, class Alloc> Iterator Invalidation:
- Invalidates all iterators pointing to the circular_buffer if the new capacity is different - from the original. + Invalidates all iterators pointing to the circular_buffer (except iterators equal to + end()) if the new + capacity is different from the original. +
+
+
+
+ Complexity: +
+
+ Linear (in the size/new capacity of the circular_buffer).
@@ -3863,7 +3865,7 @@ template <class T, class Alloc>
The element the circular_buffer will be filled with in order to gain the requested - size. (See the postcondition.) + size. (See the Effect.)
@@ -3880,14 +3882,6 @@ template <class T, class Alloc> Whatever T::T(const T&) throws. -
-
- Complexity: -
-
- Linear (in the new size of the circular_buffer). -
-
Exception Safety: @@ -3901,8 +3895,18 @@ template <class T, class Alloc> Iterator Invalidation:
- Invalidates all iterators pointing to the circular_buffer if the new size is different - from the original. + Invalidates all iterators pointing to the circular_buffer (except iterators equal to + end()) if the new size + is greater than the current capacity. Invalidates iterators pointing to the removed elements if the new + size is lower that the original size. Otherwise it does not invalidate any iterator. +
+
+
+
+ Complexity: +
+
+ Linear (in the new size of the circular_buffer).
@@ -3962,14 +3966,6 @@ template <class T, class Alloc> Whatever T::T(const T&) throws.
-
-
- Complexity: -
-
- Linear (in the size of cb). -
-
Exception Safety: @@ -3986,6 +3982,14 @@ template <class T, class Alloc> Invalidates all iterators pointing to this circular_buffer.
+
+
+ Complexity: +
+
+ Linear (in the size of cb). +
+
See Also: @@ -4064,14 +4068,6 @@ template <class T, class Alloc> Whatever T::T(const T&) throws.
-
-
- Complexity: -
-
- Linear (in the n). -
-
Exception Safety: @@ -4088,6 +4084,14 @@ template <class T, class Alloc> Invalidates all iterators pointing to the circular_buffer.
+
+
+ Complexity: +
+
+ Linear (in the n). +
+
See Also: @@ -4186,14 +4190,6 @@ template <class T, class Alloc> Whatever T::T(const T&) throws.
-
-
- Complexity: -
-
- Linear (in the n). -
-
Exception Safety: @@ -4210,6 +4206,14 @@ template <class T, class Alloc> Invalidates all iterators pointing to the circular_buffer.
+
+
+ Complexity: +
+
+ Linear (in the n). +
+
See Also: @@ -4297,14 +4301,6 @@ template <class T, class Alloc> Whatever T::T(const T&) throws.
-
-
- Complexity: -
-
- Linear (in the std::distance(first, last)). -
-
Exception Safety: @@ -4321,6 +4317,14 @@ template <class T, class Alloc> Invalidates all iterators pointing to the circular_buffer.
+
+
+ Complexity: +
+
+ Linear (in the std::distance(first, last)). +
+
See Also: @@ -4350,7 +4354,7 @@ template <class T, class Alloc>

The capacity of the circular_buffer will be set to the specified value and the content of the circular_buffer will be removed and replaced with copies of elements from the specified - range. (See the postcondition.) + range. (See the Effect.)

@@ -4425,14 +4429,6 @@ template <class T, class Alloc> Whatever T::T(const T&) throws.
-
-
- Complexity: -
-
- Linear (in the std::distance(first, last)). -
-
Exception Safety: @@ -4449,6 +4445,14 @@ template <class T, class Alloc> Invalidates all iterators pointing to the circular_buffer.
+
+
+ Complexity: +
+
+ Linear (in the std::distance(first, last)). +
+
See Also: @@ -4503,14 +4507,6 @@ template <class T, class Alloc> Nothing.
-
-
- Complexity: -
-
- Constant (in the size of the circular_buffer). -
-
Exception Safety: @@ -4530,6 +4526,14 @@ template <class T, class Alloc> invalidated iterator is used.)
+
+
+ Complexity: +
+
+ Constant (in the size of the circular_buffer). +
+
See Also: @@ -4584,20 +4588,12 @@ template <class T, class Alloc> Whatever T::T(const T&) throws.
-
-
- Complexity: -
-
- Constant (in the size of the circular_buffer). -
-
Exception Safety:
- Basic; no-throw if the operation in the Throws section do not throw anything. + Basic; no-throw if the operation in the Throws section does not throw anything.
@@ -4608,6 +4604,14 @@ template <class T, class Alloc> Does not invalidate any iterators with the exception of iterators pointing to the overwritten element.
+
+
+ Complexity: +
+
+ Constant (in the size of the circular_buffer). +
+
See Also: @@ -4666,20 +4670,12 @@ template <class T, class Alloc> Whatever T::T(const T&) throws.
-
-
- Complexity: -
-
- Constant (in the size of the circular_buffer). -
-
Exception Safety:
- Basic; no-throw if the operation in the Throws section do not throw anything. + Basic; no-throw if the operation in the Throws section does not throw anything.
@@ -4690,6 +4686,14 @@ template <class T, class Alloc> Does not invalidate any iterators with the exception of iterators pointing to the overwritten element.
+
+
+ Complexity: +
+
+ Constant (in the size of the circular_buffer). +
+
See Also: @@ -4736,14 +4740,6 @@ template <class T, class Alloc> Nothing.
-
-
- Complexity: -
-
- Constant (in the size of the circular_buffer). -
-
Exception Safety: @@ -4760,6 +4756,14 @@ template <class T, class Alloc> Invalidates only iterators pointing to the removed element.
+
+
+ Complexity: +
+
+ Constant (in the size of the circular_buffer). +
+
See Also: @@ -4806,14 +4810,6 @@ template <class T, class Alloc> Nothing.
-
-
- Complexity: -
-
- Constant (in the size of the circular_buffer). -
-
Exception Safety: @@ -4830,6 +4826,14 @@ template <class T, class Alloc> Invalidates only iterators pointing to the removed element.
+
+
+ Complexity: +
+
+ Constant (in the size of the circular_buffer). +
+
See Also: @@ -4907,7 +4911,7 @@ template <class T, class Alloc>
Iterator to the inserted element or begin() if the - item is not inserted. (See the postcondition.) + item is not inserted. (See the Effect.)
@@ -4921,6 +4925,14 @@ template <class T, class Alloc> Whatever T::operator = (const T&) throws.
+
+
+ Exception Safety: +
+
+ Basic; no-throw if the operation in the Throws section does not throw anything. +
+
Iterator Invalidation: @@ -4931,6 +4943,14 @@ template <class T, class Alloc> overwritten element.
+
+
+ Complexity: +
+
+ Linear (in the size of the circular_buffer). +
+
See Also: @@ -4981,7 +5001,7 @@ template <class T, class Alloc> "#classboost_1_1circular__buffer_158d1ede2e85f5d46eda8db3f0c4efef0">begin(), max[0, n - reserve()]] elements will be overwritten at the beginning of the circular_buffer.
- (See Example for the explanation.) + (See Example for the explanation.)
@@ -5030,6 +5050,32 @@ template <class T, class Alloc> Whatever T::operator = (const T&) throws.
+
+
+ Exception Safety: +
+
+ Basic; no-throw if the operations in the Throws section do not throw anything. +
+
+
+
+ Iterator Invalidation: +
+
+ Invalidates iterators pointing to the elements at the insertion point (including pos) and + iterators behind the insertion point (towards the end). It also invalidates iterators pointing to the + overwritten elements. +
+
+
+
+ Complexity: +
+
+ Linear (in the size of the circular_buffer). +
+
Example: @@ -5055,16 +5101,6 @@ template <class T, class Alloc> |1|2|0|0|0|0|0|3|4|.
-
-
- Iterator Invalidation: -
-
- Invalidates iterators pointing to the elements at the insertion point (including pos) and - iterators behind the insertion point (towards the end). It also invalidates iterators pointing to the - overwritten elements. -
-
See Also: @@ -5117,7 +5153,7 @@ template <class T, class Alloc> last) - reserve()]] elements will be overwritten at the beginning of the circular_buffer.
- (See Example for the explanation.) + (See Example for the explanation.)
@@ -5155,6 +5191,43 @@ template <class T, class Alloc>
+
+
+ Throws: +
+
+ Whatever T::T(const T&) throws. +
+
+ Whatever T::operator = (const T&) throws. +
+
+
+
+ Exception Safety: +
+
+ Basic; no-throw if the operations in the Throws section do not throw anything. +
+
+
+
+ Iterator Invalidation: +
+
+ Invalidates iterators pointing to the elements at the insertion point (including pos) and + iterators behind the insertion point (towards the end). It also invalidates iterators pointing to the + overwritten elements. +
+
+
+
+ Complexity: +
+
+ Linear (in the size of the circular_buffer). +
+
Example: @@ -5182,27 +5255,6 @@ template <class T, class Alloc> |1|2|5|6|7|8|9|3|4|.
-
-
- Throws: -
-
- Whatever T::T(const T&) throws. -
-
- Whatever T::operator = (const T&) throws. -
-
-
-
- Iterator Invalidation: -
-
- Invalidates iterators pointing to the elements at the insertion point (including pos) and - iterators behind the insertion point (towards the end). It also invalidates iterators pointing to the - overwritten elements. -
-
See Also: @@ -5284,7 +5336,7 @@ template <class T, class Alloc>
Iterator to the inserted element or end() if the - item is not inserted. (See the postcondition.) + item is not inserted. (See the Effect.)
@@ -5298,6 +5350,14 @@ template <class T, class Alloc> Whatever T::operator = (const T&) throws.
+
+
+ Exception Safety: +
+
+ Basic; no-throw if the operations in the Throws section do not throw anything. +
+
Iterator Invalidation: @@ -5307,6 +5367,14 @@ template <class T, class Alloc> excluding pos). It also invalidates iterators pointing to the overwritten element.
+
+
+ Complexity: +
+
+ Linear (in the size of the circular_buffer). +
+
See Also: @@ -5357,7 +5425,7 @@ template <class T, class Alloc> "#classboost_1_1circular__buffer_1babfa093dad7801223b80626b598dee1">end() - pos, max[0, n - reserve()]] elements will be overwritten at the end of the circular_buffer.
- (See Example for the explanation.) + (See Example for the explanation.)
@@ -5406,6 +5474,31 @@ template <class T, class Alloc> Whatever T::operator = (const T&) throws.
+
+
+ Exception Safety: +
+
+ Basic; no-throw if the operations in the Throws section do not throw anything. +
+
+
+
+ Iterator Invalidation: +
+
+ Invalidates iterators pointing to the elements before the insertion point (towards the beginning and + excluding pos). It also invalidates iterators pointing to the overwritten elements. +
+
+
+
+ Complexity: +
+
+ Linear (in the size of the circular_buffer). +
+
Example: @@ -5431,15 +5524,6 @@ template <class T, class Alloc> |1|2|0|0|0|0|0|3|4|.
-
-
- Iterator Invalidation: -
-
- Invalidates iterators pointing to the elements before the insertion point (towards the beginning and - excluding pos). It also invalidates iterators pointing to the overwritten elements. -
-
See Also: @@ -5492,7 +5576,7 @@ template <class T, class Alloc> distance(first, last) - reserve()]] elements will be overwritten at the end of the circular_buffer.
- (See Example for the explanation.) + (See Example for the explanation.)
@@ -5530,6 +5614,42 @@ template <class T, class Alloc>
+
+
+ Throws: +
+
+ Whatever T::T(const T&) throws. +
+
+ Whatever T::operator = (const T&) throws. +
+
+
+
+ Exception Safety: +
+
+ Basic; no-throw if the operations in the Throws section do not throw anything. +
+
+
+
+ Iterator Invalidation: +
+
+ Invalidates iterators pointing to the elements before the insertion point (towards the beginning and + excluding pos). It also invalidates iterators pointing to the overwritten elements. +
+
+
+
+ Complexity: +
+
+ Linear (in the size of the circular_buffer). +
+
Example: @@ -5557,26 +5677,6 @@ template <class T, class Alloc> |1|2|5|6|7|8|9|3|4|.
-
-
- Throws: -
-
- Whatever T::T(const T&) throws. -
-
- Whatever T::operator = (const T&) throws. -
-
-
-
- Iterator Invalidation: -
-
- Invalidates iterators pointing to the elements before the insertion point (towards the beginning and - excluding pos). It also invalidates iterators pointing to the overwritten elements. -
-
See Also: @@ -5621,6 +5721,21 @@ template <class T, class Alloc> The element at the position pos is removed.
+
+
+ Parameter(s): +
+
+
+
+ pos +
+
+ An iterator pointing at the element to be removed. +
+
+
+
Returns: @@ -5639,20 +5754,12 @@ template <class T, class Alloc> Whatever T::operator = (const T&) throws.
-
-
- Complexity: -
-
- Linear (in the size of the circular_buffer). -
-
Exception Safety:
- Basic; no-throw if the operation in the Throws section does not throw anything. + Basic; no-throw if the operation in the Throws section does not throw anything.
@@ -5664,6 +5771,14 @@ template <class T, class Alloc> erased element (towards the end).
+
+
+ Complexity: +
+
+ Linear (in the size of the circular_buffer). +
+
See Also: @@ -5705,6 +5820,31 @@ template <class T, class Alloc> nothing is removed.)
+
+
+ Parameter(s): +
+
+
+
+ first +
+
+ The beginning of the range to be removed. +
+
+
+
+
+
+ last +
+
+ The end of the range to be removed. +
+
+
+
Returns: @@ -5723,20 +5863,12 @@ template <class T, class Alloc> Whatever T::operator = (const T&) throws.
-
-
- Complexity: -
-
- Linear (in the size of the circular_buffer). -
-
Exception Safety:
- Basic; no-throw if the operation in the Throws section does not throw anything. + Basic; no-throw if the operation in the Throws section does not throw anything.
@@ -5748,6 +5880,14 @@ template <class T, class Alloc> erased range (towards the end).
+
+
+ Complexity: +
+
+ Linear (in the size of the circular_buffer). +
+
See Also: @@ -5777,7 +5917,8 @@ template <class T, class Alloc> Precondition:
- pos is a valid iterator pointing to the circular_buffer or its end. + pos is a valid iterator pointing to the circular_buffer (but not an + end()).
@@ -5788,6 +5929,21 @@ template <class T, class Alloc> The element at the position pos is removed.
+
+
+ Parameter(s): +
+
+
+
+ pos +
+
+ An iterator pointing at the element to be removed. +
+
+
+
Returns: @@ -5806,20 +5962,12 @@ template <class T, class Alloc> Whatever T::operator = (const T&) throws.
-
-
- Complexity: -
-
- Linear (in the size of the circular_buffer). -
-
Exception Safety:
- Basic; no-throw if the operation in the Throws section does not throw anything. + Basic; no-throw if the operation in the Throws section does not throw anything.
@@ -5831,6 +5979,14 @@ template <class T, class Alloc> the erased element (towards the beginning).
+
+
+ Complexity: +
+
+ Linear (in the size of the circular_buffer). +
+
See Also: @@ -5872,6 +6028,31 @@ template <class T, class Alloc> The elements from the range [first, last) are removed.
+
+
+ Parameter(s): +
+
+
+
+ first +
+
+ The beginning of the range to be removed. +
+
+
+
+
+
+ last +
+
+ The end of the range to be removed. +
+
+
+
Returns: @@ -5890,20 +6071,12 @@ template <class T, class Alloc> Whatever T::operator = (const T&) throws.
-
-
- Complexity: -
-
- Linear (in the size of the circular_buffer). -
-
Exception Safety:
- Basic; no-throw if the operation in the Throws section does not throw anything. + Basic; no-throw if the operation in the Throws section does not throw anything.
@@ -5915,6 +6088,14 @@ template <class T, class Alloc> of the erased range (towards the beginning).
+
+
+ Complexity: +
+
+ Linear (in the size of the circular_buffer). +
+
See Also: @@ -5954,14 +6135,6 @@ template <class T, class Alloc> Nothing.
-
-
- Complexity: -
-
- Linear (in the size of the circular_buffer). -
-
Exception Safety: @@ -5978,6 +6151,14 @@ template <class T, class Alloc> Invalidates all iterators pointing to the circular_buffer.
+
+
+ Complexity: +
+
+ Linear (in the size of the circular_buffer). +
+
See Also: @@ -6595,7 +6776,7 @@ template <class T, class Alloc>

- Copyright © 2003-2006 Jan Gaspar + Copyright © 2003-2007 Jan Gaspar

Use, modification, and distribution is subject to the Boost Software License, Version 1.0.
diff --git a/doc/circular_buffer.xslt b/doc/circular_buffer.xslt index a87d3a6..4117111 100644 --- a/doc/circular_buffer.xslt +++ b/doc/circular_buffer.xslt @@ -3,7 +3,7 @@ XSL transformation from the XML files generated by Doxygen into XHTML source code documentation of the circular_buffer. -Copyright (c) 2006 Jan Gaspar +Copyright (c) 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 diff --git a/doc/circular_buffer_space_optimized.html b/doc/circular_buffer_space_optimized.html index c3bf0d5..12c9a70 100644 --- a/doc/circular_buffer_space_optimized.html +++ b/doc/circular_buffer_space_optimized.html @@ -1333,7 +1333,7 @@ template <class T, class Alloc>

- Copyright © 2003-2006 Jan Gaspar + Copyright © 2003-2007 Jan Gaspar

Use, modification, and distribution is subject to the Boost Software License, Version 1.0.
diff --git a/doc/circular_buffer_space_optimized.xslt b/doc/circular_buffer_space_optimized.xslt index 3293c11..1de5db4 100644 --- a/doc/circular_buffer_space_optimized.xslt +++ b/doc/circular_buffer_space_optimized.xslt @@ -3,7 +3,7 @@ XSL transformation from the XML files generated by Doxygen into XHTML source code documentation of the circular_buffer_space_optimized. -Copyright (c) 2006 Jan Gaspar +Copyright (c) 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 diff --git a/doc/copy.xslt b/doc/copy.xslt index 499fb86..95f5f10 100644 --- a/doc/copy.xslt +++ b/doc/copy.xslt @@ -2,7 +2,7 @@