From 9295b204ffff24e59074fd342d97b7870fb08ef1 Mon Sep 17 00:00:00 2001 From: Jan Gaspar Date: Thu, 22 Jun 2006 22:13:38 +0000 Subject: [PATCH] capacity_control doc update [SVN r3022] --- doc/circular_buffer_space_optimized.html | 187 +++++++++--------- doc/doxygen2html.xslt | 4 + .../boost/circular_buffer/space_optimized.hpp | 14 +- 3 files changed, 106 insertions(+), 99 deletions(-) diff --git a/doc/circular_buffer_space_optimized.html b/doc/circular_buffer_space_optimized.html index 10f88fe..e09cb0f 100644 --- a/doc/circular_buffer_space_optimized.html +++ b/doc/circular_buffer_space_optimized.html @@ -89,10 +89,10 @@ public: "circular_buffer.html#classboost_1_1circular__buffer_1f38a9bc64d84757c661c2542ff9a7f65">reference; typedef typename Alloc::const_reference const_reference; - typedef typename Alloc::difference_type difference_type; typedef typename Alloc::size_type size_type; + typedef typename Alloc::difference_type difference_type; typedef Alloc allocator_type; typedef implementation-defined array_range; typedef std::pair<const_pointer, size_type> const_array_range; - typedef size_type capacity_control; + typedef implementation-defined capacity_control; explicit circular_buffer_space_optimized(const allocator_type& alloc = allocator_type()); @@ -346,12 +346,15 @@ template <class T, class Alloc> "classboost_1_1circular__buffer__space__optimized_19d8966bb6cf8253d6194be7bbf7e3c7d">capacity_control - Capacity controller of the space optimized circular buffer. struct capacity_control { - capacity_control(size_type capacity, size_type min_capacity = 0); size_type m_capacity; size_type - m_min_capacity; }; The converting constructor of the capacity_control allows implicit - conversion from size_type like types which ensures compatibility of creating an instance of - the with other STL - containers. + Capacity controller of the space optimized circular buffer.
+ struct capacity_control {
+    capacity_control(size_type capacity, size_type min_capacity = 0);
+    size_type m_capacity;
+    size_type m_min_capacity;
+ };

+ The converting constructor of the capacity_control allows implicit conversion from + size_type like types which ensures compatibility of creating an instance of the with other STL containers. @@ -371,20 +374,20 @@ template <class T, class Alloc> circular_buffer_space_optimized(const allocator_type& alloc = allocator_type());
- +
    - +
Create an empty space optimized circular buffer with a maximum capacity.
- +
TODO - doc @@ -405,20 +408,20 @@ template <class T, class Alloc> const allocator_type& alloc = allocator_type());
- +
    - +
Create an empty space optimized circular buffer with a given capacity.
- +
Precondition: @@ -428,7 +431,7 @@ template <class T, class Alloc>
- +
Postcondition: @@ -441,7 +444,7 @@ template <class T, class Alloc>
- +
Note: @@ -469,20 +472,20 @@ template <class T, class Alloc> const allocator_type& alloc = allocator_type());
- +
    - +
Create a full space optimized circular buffer filled with copies of item.
- +
Precondition: @@ -492,7 +495,7 @@ template <class T, class Alloc>
- +
Postcondition: @@ -504,7 +507,7 @@ template <class T, class Alloc>
- +
Note: @@ -535,13 +538,13 @@ template <class T, class Alloc>     const allocator_type& alloc = allocator_type());
- +
    - +
TODO doc. @@ -559,13 +562,13 @@ template <class T, class Alloc> "classboost_1_1circular__buffer__space__optimized_1296bbfa5c427d05cb02fc35249f83bb4"> template <class InputIterator>
    circular_buffer_space_optimized(InputIterator first, InputIterator last);
- +
    - +
@@ -583,13 +586,13 @@ template <class T, class Alloc>     circular_buffer_space_optimized(capacity_control capacity_ctrl, InputIterator first, InputIterator last);
-
+
    - +
@@ -608,13 +611,13 @@ template <class T, class Alloc>        InputIterator last, const allocator_type& alloc = allocator_type());
-
+
    - +
TODO doc. @@ -638,20 +641,20 @@ template <class T, class Alloc>        const allocator_type& alloc = allocator_type());
- +
    - +
Create a space optimized circular buffer with a copy of a range.
- +
Precondition: @@ -661,7 +664,7 @@ template <class T, class Alloc>
- +
Postcondition: @@ -678,7 +681,7 @@ template <class T, class Alloc>
- +
Note: @@ -707,20 +710,20 @@ template <class T, class Alloc> "classboost_1_1circular__buffer__space__optimized_1f3e4b9caed10cf7383682c6dea794917"> size_type min_capacity() const;
- +
    - +
Return the minimal guaranteed amount of allocated memory.
- +
The allocated memory will never drop under this value. @@ -739,20 +742,20 @@ template <class T, class Alloc> void set_min_capacity(size_type new_min_capacity);
- +
    - +
Change the minimal guaranteed amount of allocated memory.
- +
Precondition: @@ -764,7 +767,7 @@ template <class T, class Alloc>
- +
Postcondition: @@ -777,7 +780,7 @@ template <class T, class Alloc>
- +
Note: @@ -802,20 +805,20 @@ template <class T, class Alloc> void set_capacity(size_type new_capacity);
- +
    - +
! See the source documentation.
- +
Precondition: @@ -827,7 +830,7 @@ template <class T, class Alloc>
- +
Note: @@ -854,13 +857,13 @@ template <class T, class Alloc> value_type item = value_type());
- +
    - +
See the source documentation. @@ -879,20 +882,20 @@ template <class T, class Alloc> void rset_capacity(size_type new_capacity);
- +
    - +
! See the source documentation.
- +
Precondition: @@ -904,7 +907,7 @@ template <class T, class Alloc>
- +
Note: @@ -931,13 +934,13 @@ template <class T, class Alloc> value_type item = value_type());
- +
    - +
See the source documentation. @@ -958,13 +961,13 @@ template <class T, class Alloc> value_type item);
- +
    - +
See the source documentation. @@ -987,13 +990,13 @@ template <class T, class Alloc> value_type item);
- +
    - +
See the source documentation. @@ -1013,13 +1016,13 @@ template <class T, class Alloc>     void assign(capacity_control capacity_ctrl, InputIterator first, InputIterator last);
- +
    - +
See the source documentation. @@ -1036,13 +1039,13 @@ template <class T, class Alloc> void swap(circular_buffer_space_optimized<T,Alloc>& cb);
- +
    - +
See the source documentation. @@ -1061,13 +1064,13 @@ template <class T, class Alloc> void push_back(value_type item = value_type());
- +
    - +
! See the source documentation. @@ -1088,13 +1091,13 @@ template <class T, class Alloc> void push_front(value_type item = value_type());
- +
    - +
! See the source documentation. @@ -1113,13 +1116,13 @@ template <class T, class Alloc> void pop_back();
- +
    - +
! See the source documentation. @@ -1138,13 +1141,13 @@ template <class T, class Alloc> void pop_front();
- +
    - +
! See the source documentation. @@ -1166,13 +1169,13 @@ template <class T, class Alloc> value_type item = value_type());
- +
    - +
! See the source documentation. @@ -1197,13 +1200,13 @@ template <class T, class Alloc> value_type item);
- +
    - +
! See the source documentation. @@ -1225,13 +1228,13 @@ template <class T, class Alloc>     void insert(iterator pos, InputIterator first, InputIterator last);
- +
    - +
! See the source documentation. @@ -1253,13 +1256,13 @@ template <class T, class Alloc> value_type item = value_type());
- +
    - +
! See the source documentation. @@ -1284,13 +1287,13 @@ template <class T, class Alloc> value_type item);
- +
    - +
! See the source documentation. @@ -1312,13 +1315,13 @@ template <class T, class Alloc>     void rinsert(iterator pos, InputIterator first, InputIterator last);
- +
    - +
! See the source documentation. @@ -1338,13 +1341,13 @@ template <class T, class Alloc> "classboost_1_1circular__buffer__space__optimized_136feadef225bd8a10962a92c4ffcdfd3"> iterator erase(iterator pos);
- +
    - +
! See the source documentation. @@ -1366,13 +1369,13 @@ template <class T, class Alloc> iterator last);
- +
    - +
! See the source documentation. @@ -1392,13 +1395,13 @@ template <class T, class Alloc> "classboost_1_1circular__buffer__space__optimized_16e96800422211d02621526c894b71fa1"> iterator rerase(iterator pos);
- +
    - +
! See the source documentation. @@ -1420,13 +1423,13 @@ template <class T, class Alloc> iterator last);
- +
    - +
! See the source documentation. diff --git a/doc/doxygen2html.xslt b/doc/doxygen2html.xslt index 0b5d854..bf16fdd 100644 --- a/doc/doxygen2html.xslt +++ b/doc/doxygen2html.xslt @@ -29,6 +29,10 @@ + +    + +
diff --git a/include/boost/circular_buffer/space_optimized.hpp b/include/boost/circular_buffer/space_optimized.hpp index 3419ab5..966aef8 100644 --- a/include/boost/circular_buffer/space_optimized.hpp +++ b/include/boost/circular_buffer/space_optimized.hpp @@ -61,13 +61,13 @@ public: //! Capacity controller of the space optimized circular buffer. /*! - - struct capacity_control { - capacity_control(size_type capacity, size_type min_capacity = 0); - size_type m_capacity; - size_type m_min_capacity; - }; - +
+ struct capacity_control {
+   capacity_control(size_type capacity, size_type min_capacity = 0);
+   size_type m_capacity;
+   size_type m_min_capacity;
+ };
+
The converting constructor of the capacity_control allows implicit conversion from size_type like types which ensures compatibility of creating an instance of the