Menu
▾
▴
[Boost-sandbox-cvs] boost-sandbox/libs/circular_buffer/doc circular_buffer.html, 1.60, 1.61 circular_buffer_space_optimized.html, 1.35, 1.36
|
From: Jan G. <jan...@us...> - 2007-02-18 23:03:40
|
Update of /cvsroot/boost-sandbox/boost-sandbox/libs/circular_buffer/doc In directory sc8-pr-cvs3.sourceforge.net:/tmp/cvs-serv30871/libs/circular_buffer/doc Modified Files: circular_buffer.html circular_buffer_space_optimized.html Log Message: consistent usage of capacity_type Index: circular_buffer.html =================================================================== RCS file: /cvsroot/boost-sandbox/boost-sandbox/libs/circular_buffer/doc/circular_buffer.html,v retrieving revision 1.60 retrieving revision 1.61 diff -u -d -r1.60 -r1.61 --- circular_buffer.html 23 Jan 2007 23:12:34 -0000 1.60 +++ circular_buffer.html 18 Feb 2007 23:03:26 -0000 1.61 @@ -226,13 +226,13 @@ bool <a href="#classboost_1_1circular__buffer_15be1c2a005ec9828549ef6dd7ebed583">empty</a>() const; bool <a href="#classboost_1_1circular__buffer_1fd0eef8ba91210d1575404b7e3e8207a">full</a>() const; size_type <a href="#classboost_1_1circular__buffer_10a02c4fbc53385e98569e810be9843de">reserve</a>() const; - size_type <a href="#classboost_1_1circular__buffer_1de901b1737217f2c8140fc1691bf2d98">capacity</a>() const; + capacity_type <a href="#classboost_1_1circular__buffer_15ebab2b2538d733790b5752582728e77">capacity</a>() const; void <a href= -"#classboost_1_1circular__buffer_1902a2d89e6bfab28f548cdb21cc42456">set_capacity</a>(size_type new_capacity); +"#classboost_1_1circular__buffer_161714204ef5172d156e2c7eccd04998f">set_capacity</a>(capacity_type new_capacity); void <a href= "#classboost_1_1circular__buffer_180c2e2e66a8fa9d0b7adc1b54921a8c3">resize</a>(size_type new_size, const_reference item = value_type()); void <a href= -"#classboost_1_1circular__buffer_1e5b482668b1ea6c434b7354389bcca89">rset_capacity</a>(size_type new_capacity); +"#classboost_1_1circular__buffer_1477715e9d31d2cc5b02ad8ecf3c68c46">rset_capacity</a>(capacity_type new_capacity); void <a href= "#classboost_1_1circular__buffer_144ecd9ec5f54a2d61c7d132e445d3483">rresize</a>(size_type new_size, const_reference item = value_type()); circular_buffer<T, Alloc>& <a href= @@ -940,7 +940,7 @@ <b>Effect:</b> </dt> <dd> - <code><a href="#classboost_1_1circular__buffer_1de901b1737217f2c8140fc1691bf2d98">capacity()</a> == + <code><a href="#classboost_1_1circular__buffer_15ebab2b2538d733790b5752582728e77">capacity()</a> == <a href="#classboost_1_1circular__buffer_157e2d506bc274b2a63fbe1b8fcafebd7">max_size()</a> && <a href="#classboost_1_1circular__buffer_15fa0edd153e2591dd6bf070eb663ee32">size()</a> == 0</code> </dd> @@ -1028,7 +1028,7 @@ <b>Effect:</b> </dt> <dd> - <code><a href="#classboost_1_1circular__buffer_1de901b1737217f2c8140fc1691bf2d98">capacity()</a> == + <code><a href="#classboost_1_1circular__buffer_15ebab2b2538d733790b5752582728e77">capacity()</a> == capacity && <a href= "#classboost_1_1circular__buffer_15fa0edd153e2591dd6bf070eb663ee32">size()</a> == 0</code> </dd> @@ -1068,7 +1068,7 @@ <b>Effect:</b> </dt> <dd> - <code><a href="#classboost_1_1circular__buffer_1de901b1737217f2c8140fc1691bf2d98">capacity()</a> == n + <code><a href="#classboost_1_1circular__buffer_15ebab2b2538d733790b5752582728e77">capacity()</a> == n && <a href="#classboost_1_1circular__buffer_15fa0edd153e2591dd6bf070eb663ee32">size()</a> == n && (*this)[0] == item && (*this)[1] == item && ... && (*this) [n - 1] == item</code> @@ -1156,7 +1156,7 @@ <b>Effect:</b> </dt> <dd> - <code><a href="#classboost_1_1circular__buffer_1de901b1737217f2c8140fc1691bf2d98">capacity()</a> == + <code><a href="#classboost_1_1circular__buffer_15ebab2b2538d733790b5752582728e77">capacity()</a> == capacity && <a href= "#classboost_1_1circular__buffer_15fa0edd153e2591dd6bf070eb663ee32">size()</a> == n && (*this)[0] == item && (*this)[1] == item && ... && (*this)[n - 1] == @@ -1310,7 +1310,7 @@ <b>Effect:</b> </dt> <dd> - <code><a href="#classboost_1_1circular__buffer_1de901b1737217f2c8140fc1691bf2d98">capacity()</a> == + <code><a href="#classboost_1_1circular__buffer_15ebab2b2538d733790b5752582728e77">capacity()</a> == std::distance(first, last) && <a href= "#classboost_1_1circular__buffer_15fa0edd153e2591dd6bf070eb663ee32">size()</a> == std::distance(first, last) && (*this)[0]== *first && (*this)[1] == *(first + 1) && ... && @@ -1401,7 +1401,7 @@ <b>Effect:</b> </dt> <dd> - <code><a href="#classboost_1_1circular__buffer_1de901b1737217f2c8140fc1691bf2d98">capacity()</a> == + <code><a href="#classboost_1_1circular__buffer_15ebab2b2538d733790b5752582728e77">capacity()</a> == capacity && <a href= "#classboost_1_1circular__buffer_15fa0edd153e2591dd6bf070eb663ee32">size()</a> <= std::distance(first, last) && (*this)[0]== *(last - capacity) && (*this)[1] == *(last - @@ -2375,8 +2375,8 @@ <b>Throws:</b> </dt> <dd> - std::out_of_range when the <code>index</code> is invalid (when <code>index >= <a href= - "#classboost_1_1circular__buffer_15fa0edd153e2591dd6bf070eb663ee32">size()</a></code>). + <code>std::out_of_range</code> when the <code>index</code> is invalid (when <code>index + >= <a href="#classboost_1_1circular__buffer_15fa0edd153e2591dd6bf070eb663ee32">size()</a></code>). </dd> </dl> <dl> @@ -2450,8 +2450,8 @@ <b>Throws:</b> </dt> <dd> - std::out_of_range when the <code>index</code> is invalid (when <code>index >= <a href= - "#classboost_1_1circular__buffer_15fa0edd153e2591dd6bf070eb663ee32">size()</a></code>). + <code>std::out_of_range</code> when the <code>index</code> is invalid (when <code>index + >= <a href="#classboost_1_1circular__buffer_15fa0edd153e2591dd6bf070eb663ee32">size()</a></code>). </dd> </dl> <dl> @@ -3225,7 +3225,7 @@ </dt> <dd> <code><a href= - "#classboost_1_1circular__buffer_1de901b1737217f2c8140fc1691bf2d98">capacity()</a></code>, + "#classboost_1_1circular__buffer_15ebab2b2538d733790b5752582728e77">capacity()</a></code>, <code><a href= "#classboost_1_1circular__buffer_157e2d506bc274b2a63fbe1b8fcafebd7">max_size()</a></code>, <code><a href="#classboost_1_1circular__buffer_10a02c4fbc53385e98569e810be9843de">reserve()</a></code>, @@ -3289,7 +3289,7 @@ <dd> <code><a href="#classboost_1_1circular__buffer_15fa0edd153e2591dd6bf070eb663ee32">size()</a></code>, <code><a href= - "#classboost_1_1circular__buffer_1de901b1737217f2c8140fc1691bf2d98">capacity()</a></code>, + "#classboost_1_1circular__buffer_15ebab2b2538d733790b5752582728e77">capacity()</a></code>, <code><a href="#classboost_1_1circular__buffer_10a02c4fbc53385e98569e810be9843de">reserve()</a></code> </dd> </dl> @@ -3425,7 +3425,7 @@ <b>Returns:</b> </dt> <dd> - <code><a href="#classboost_1_1circular__buffer_1de901b1737217f2c8140fc1691bf2d98">capacity()</a> - + <code><a href="#classboost_1_1circular__buffer_15ebab2b2538d733790b5752582728e77">capacity()</a> - <a href="#classboost_1_1circular__buffer_15fa0edd153e2591dd6bf070eb663ee32">size()</a></code> </dd> </dl> @@ -3467,7 +3467,7 @@ </dt> <dd> <code><a href= - "#classboost_1_1circular__buffer_1de901b1737217f2c8140fc1691bf2d98">capacity()</a></code>, + "#classboost_1_1circular__buffer_15ebab2b2538d733790b5752582728e77">capacity()</a></code>, <code><a href="#classboost_1_1circular__buffer_15fa0edd153e2591dd6bf070eb663ee32">size()</a></code>, <code><a href="#classboost_1_1circular__buffer_157e2d506bc274b2a63fbe1b8fcafebd7">max_size()</a></code> </dd> @@ -3476,9 +3476,9 @@ </tr> <tr> <td> - <a id="classboost_1_1circular__buffer_1de901b1737217f2c8140fc1691bf2d98" name= - "classboost_1_1circular__buffer_1de901b1737217f2c8140fc1691bf2d98"></a><code><b><a href= - "#classboost_1_1circular__buffer_19ba12c0142a21a7d960877c22fa3ea00">size_type</a> capacity() + <a id="classboost_1_1circular__buffer_15ebab2b2538d733790b5752582728e77" name= + "classboost_1_1circular__buffer_15ebab2b2538d733790b5752582728e77"></a><code><b><a href= + "#classboost_1_1circular__buffer_1dc642ff2be4db0be1a457810e5d09595">capacity_type</a> capacity() const;</b></code><br> <br> Get the capacity of the <code>circular_buffer</code>. @@ -3532,16 +3532,16 @@ <code><a href= "#classboost_1_1circular__buffer_157e2d506bc274b2a63fbe1b8fcafebd7">max_size()</a></code>, <code><a href= - "#classboost_1_1circular__buffer_1902a2d89e6bfab28f548cdb21cc42456">set_capacity()</a></code> + "#classboost_1_1circular__buffer_161714204ef5172d156e2c7eccd04998f">set_capacity()</a></code> </dd> </dl> </td> </tr> <tr> <td> - <a id="classboost_1_1circular__buffer_1902a2d89e6bfab28f548cdb21cc42456" name= - "classboost_1_1circular__buffer_1902a2d89e6bfab28f548cdb21cc42456"></a><code><b>void set_capacity(<a href= - "#classboost_1_1circular__buffer_19ba12c0142a21a7d960877c22fa3ea00">size_type</a> + <a id="classboost_1_1circular__buffer_161714204ef5172d156e2c7eccd04998f" name= + "classboost_1_1circular__buffer_161714204ef5172d156e2c7eccd04998f"></a><code><b>void set_capacity(<a href= + "#classboost_1_1circular__buffer_1dc642ff2be4db0be1a457810e5d09595">capacity_type</a> new_capacity);</b></code><br> <br> Change the capacity of the <code>circular_buffer</code>. @@ -3550,7 +3550,7 @@ <b>Effect:</b> </dt> <dd> - <code><a href="#classboost_1_1circular__buffer_1de901b1737217f2c8140fc1691bf2d98">capacity()</a> == + <code><a href="#classboost_1_1circular__buffer_15ebab2b2538d733790b5752582728e77">capacity()</a> == new_capacity</code><br> <br> If the current number of elements stored in the <code>circular_buffer</code> is greater than the @@ -3616,7 +3616,7 @@ </dt> <dd> <code><a href= - "#classboost_1_1circular__buffer_1e5b482668b1ea6c434b7354389bcca89">rset_capacity()</a></code>, + "#classboost_1_1circular__buffer_1477715e9d31d2cc5b02ad8ecf3c68c46">rset_capacity()</a></code>, <code><a href="#classboost_1_1circular__buffer_180c2e2e66a8fa9d0b7adc1b54921a8c3">resize()</a></code> </dd> </dl> @@ -3638,7 +3638,7 @@ <dd> <code><a href="#classboost_1_1circular__buffer_15fa0edd153e2591dd6bf070eb663ee32">size()</a> == new_size && <a href= - "#classboost_1_1circular__buffer_1de901b1737217f2c8140fc1691bf2d98">capacity()</a> >= + "#classboost_1_1circular__buffer_15ebab2b2538d733790b5752582728e77">capacity()</a> >= new_size</code><br> <br> If the new size is greater than the current size, copies of <code>item</code> will be inserted at the @@ -3720,16 +3720,16 @@ <dd> <code><a href="#classboost_1_1circular__buffer_144ecd9ec5f54a2d61c7d132e445d3483">rresize()</a></code>, <code><a href= - "#classboost_1_1circular__buffer_1902a2d89e6bfab28f548cdb21cc42456">set_capacity()</a></code> + "#classboost_1_1circular__buffer_161714204ef5172d156e2c7eccd04998f">set_capacity()</a></code> </dd> </dl> </td> </tr> <tr> <td> - <a id="classboost_1_1circular__buffer_1e5b482668b1ea6c434b7354389bcca89" name= - "classboost_1_1circular__buffer_1e5b482668b1ea6c434b7354389bcca89"></a><code><b>void rset_capacity(<a href= - "#classboost_1_1circular__buffer_19ba12c0142a21a7d960877c22fa3ea00">size_type</a> + <a id="classboost_1_1circular__buffer_1477715e9d31d2cc5b02ad8ecf3c68c46" name= + "classboost_1_1circular__buffer_1477715e9d31d2cc5b02ad8ecf3c68c46"></a><code><b>void rset_capacity(<a href= + "#classboost_1_1circular__buffer_1dc642ff2be4db0be1a457810e5d09595">capacity_type</a> new_capacity);</b></code><br> <br> Change the capacity of the <code>circular_buffer</code>. @@ -3738,7 +3738,7 @@ <b>Effect:</b> </dt> <dd> - <code><a href="#classboost_1_1circular__buffer_1de901b1737217f2c8140fc1691bf2d98">capacity()</a> == + <code><a href="#classboost_1_1circular__buffer_15ebab2b2538d733790b5752582728e77">capacity()</a> == new_capacity</code><br> <br> If the current number of elements stored in the <code>circular_buffer</code> is greater than the @@ -3804,7 +3804,7 @@ </dt> <dd> <code><a href= - "#classboost_1_1circular__buffer_1902a2d89e6bfab28f548cdb21cc42456">set_capacity()</a></code>, + "#classboost_1_1circular__buffer_161714204ef5172d156e2c7eccd04998f">set_capacity()</a></code>, <code><a href="#classboost_1_1circular__buffer_144ecd9ec5f54a2d61c7d132e445d3483">rresize()</a></code> </dd> </dl> @@ -3826,7 +3826,7 @@ <dd> <code><a href="#classboost_1_1circular__buffer_15fa0edd153e2591dd6bf070eb663ee32">size()</a> == new_size && <a href= - "#classboost_1_1circular__buffer_1de901b1737217f2c8140fc1691bf2d98">capacity()</a> >= + "#classboost_1_1circular__buffer_15ebab2b2538d733790b5752582728e77">capacity()</a> >= new_size</code><br> <br> If the new size is greater than the current size, copies of <code>item</code> will be inserted at the @@ -3908,7 +3908,7 @@ <dd> <code><a href="#classboost_1_1circular__buffer_144ecd9ec5f54a2d61c7d132e445d3483">rresize()</a></code>, <code><a href= - "#classboost_1_1circular__buffer_1902a2d89e6bfab28f548cdb21cc42456">set_capacity()</a></code> + "#classboost_1_1circular__buffer_161714204ef5172d156e2c7eccd04998f">set_capacity()</a></code> </dd> </dl> </td> @@ -4017,7 +4017,7 @@ <b>Effect:</b> </dt> <dd> - <code><a href="#classboost_1_1circular__buffer_1de901b1737217f2c8140fc1691bf2d98">capacity()</a> == n + <code><a href="#classboost_1_1circular__buffer_15ebab2b2538d733790b5752582728e77">capacity()</a> == n && <a href="#classboost_1_1circular__buffer_15fa0edd153e2591dd6bf070eb663ee32">size()</a> == n && (*this)[0] == item && (*this)[1] == item && ... && (*this) [n - 1] == item</code> @@ -4128,7 +4128,7 @@ <b>Effect:</b> </dt> <dd> - <code><a href="#classboost_1_1circular__buffer_1de901b1737217f2c8140fc1691bf2d98">capacity()</a> == + <code><a href="#classboost_1_1circular__buffer_15ebab2b2538d733790b5752582728e77">capacity()</a> == capacity && <a href= "#classboost_1_1circular__buffer_15fa0edd153e2591dd6bf070eb663ee32">size()</a> == n && (*this)[0] == item && (*this)[1] == item && ... && (*this) [n - 1] == @@ -4249,7 +4249,7 @@ <b>Effect:</b> </dt> <dd> - <code><a href="#classboost_1_1circular__buffer_1de901b1737217f2c8140fc1691bf2d98">capacity()</a> == + <code><a href="#classboost_1_1circular__buffer_15ebab2b2538d733790b5752582728e77">capacity()</a> == std::distance(first, last) && <a href= "#classboost_1_1circular__buffer_15fa0edd153e2591dd6bf070eb663ee32">size()</a> == std::distance(first, last) && (*this)[0]== *first && (*this)[1] == *(first + 1) && ... && @@ -4363,7 +4363,7 @@ <b>Effect:</b> </dt> <dd> - <code><a href="#classboost_1_1circular__buffer_1de901b1737217f2c8140fc1691bf2d98">capacity()</a> == + <code><a href="#classboost_1_1circular__buffer_15ebab2b2538d733790b5752582728e77">capacity()</a> == capacity && <a href= "#classboost_1_1circular__buffer_15fa0edd153e2591dd6bf070eb663ee32">size()</a> <= std::distance(first, last) && (*this)[0]== *(last - capacity) && (*this)[1] == *(last - @@ -4550,7 +4550,7 @@ <b>Effect:</b> </dt> <dd> - if <code><a href="#classboost_1_1circular__buffer_1de901b1737217f2c8140fc1691bf2d98">capacity()</a> + if <code><a href="#classboost_1_1circular__buffer_15ebab2b2538d733790b5752582728e77">capacity()</a> > 0</code> then <code><a href= "#classboost_1_1circular__buffer_1d985d974020f88bb4255d8edbae0a30a">back()</a> == item</code><br> If the <code>circular_buffer</code> is full, the first element will be removed. If the capacity is @@ -4632,7 +4632,7 @@ <b>Effect:</b> </dt> <dd> - if <code><a href="#classboost_1_1circular__buffer_1de901b1737217f2c8140fc1691bf2d98">capacity()</a> + if <code><a href="#classboost_1_1circular__buffer_15ebab2b2538d733790b5752582728e77">capacity()</a> > 0</code> then <code><a href= "#classboost_1_1circular__buffer_10d5fdeabeb352f47d1f7bb1ea8d9819f">front()</a> == item</code><br> If the <code>circular_buffer</code> is full, the last element will be removed. If the capacity is @@ -4969,13 +4969,13 @@ <b>Effect:</b> </dt> <dd> - The number of <code>min(n, (pos - <a href= + The number of <code>min[n, (pos - <a href= "#classboost_1_1circular__buffer_158d1ede2e85f5d46eda8db3f0c4efef0">begin()</a>) + <a href= - "#classboost_1_1circular__buffer_10a02c4fbc53385e98569e810be9843de">reserve()</a>)</code> elements will + "#classboost_1_1circular__buffer_10a02c4fbc53385e98569e810be9843de">reserve()</a>]</code> elements will be inserted at the position <code>pos</code>.<br> - The number of <code>min(pos - <a href= - "#classboost_1_1circular__buffer_158d1ede2e85f5d46eda8db3f0c4efef0">begin()</a>, max(0, n - <a href= - "#classboost_1_1circular__buffer_10a02c4fbc53385e98569e810be9843de">reserve()</a>))</code> elements + The number of <code>min[pos - <a href= + "#classboost_1_1circular__buffer_158d1ede2e85f5d46eda8db3f0c4efef0">begin()</a>, max[0, n - <a href= + "#classboost_1_1circular__buffer_10a02c4fbc53385e98569e810be9843de">reserve()</a>]]</code> elements will be overwritten at the beginning of the <code>circular_buffer</code>.<br> (See Example for the explanation.) </dd> @@ -5104,14 +5104,14 @@ <b>Effect:</b> </dt> <dd> - Elements from the range <code>[first + max(0, distance(first, last) - (pos - <a href= + Elements from the range <code>[first + max[0, distance(first, last) - (pos - <a href= "#classboost_1_1circular__buffer_158d1ede2e85f5d46eda8db3f0c4efef0">begin()</a>) - <a href= - "#classboost_1_1circular__buffer_10a02c4fbc53385e98569e810be9843de">reserve()</a>), last)</code> will + "#classboost_1_1circular__buffer_10a02c4fbc53385e98569e810be9843de">reserve()</a>], last)</code> will be inserted at the position <code>pos</code>.<br> - The number of <code>min(pos - <a href= - "#classboost_1_1circular__buffer_158d1ede2e85f5d46eda8db3f0c4efef0">begin()</a>, max(0, distance(first, + The number of <code>min[pos - <a href= + "#classboost_1_1circular__buffer_158d1ede2e85f5d46eda8db3f0c4efef0">begin()</a>, max[0, distance(first, last) - <a href= - "#classboost_1_1circular__buffer_10a02c4fbc53385e98569e810be9843de">reserve()</a>))</code> elements + "#classboost_1_1circular__buffer_10a02c4fbc53385e98569e810be9843de">reserve()</a>]]</code> elements will be overwritten at the beginning of the <code>circular_buffer</code>.<br> (See Example for the explanation.) </dd> @@ -5345,13 +5345,13 @@ <b>Effect:</b> </dt> <dd> - The number of <code>min(n, (<a href= + The number of <code>min[n, (<a href= "#classboost_1_1circular__buffer_1babfa093dad7801223b80626b598dee1">end()</a> - pos) + <a href= - "#classboost_1_1circular__buffer_10a02c4fbc53385e98569e810be9843de">reserve()</a>)</code> elements will + "#classboost_1_1circular__buffer_10a02c4fbc53385e98569e810be9843de">reserve()</a>]</code> elements will be inserted before the position <code>pos</code>.<br> - The number of <code>min(<a href= - "#classboost_1_1circular__buffer_1babfa093dad7801223b80626b598dee1">end()</a> - pos, max(0, n - - <a href="#classboost_1_1circular__buffer_10a02c4fbc53385e98569e810be9843de">reserve()</a>))</code> + The number of <code>min[<a href= + "#classboost_1_1circular__buffer_1babfa093dad7801223b80626b598dee1">end()</a> - pos, max[0, n - + <a href="#classboost_1_1circular__buffer_10a02c4fbc53385e98569e810be9843de">reserve()</a>]]</code> elements will be overwritten at the end of the <code>circular_buffer</code>.<br> (See Example for the explanation.) </dd> @@ -5479,14 +5479,14 @@ <b>Effect:</b> </dt> <dd> - Elements from the range <code>[first, last - max(0, distance(first, last) - (<a href= + Elements from the range <code>[first, last - max[0, distance(first, last) - (<a href= "#classboost_1_1circular__buffer_1babfa093dad7801223b80626b598dee1">end()</a> - pos) - <a href= - "#classboost_1_1circular__buffer_10a02c4fbc53385e98569e810be9843de">reserve()</a>))</code> will be + "#classboost_1_1circular__buffer_10a02c4fbc53385e98569e810be9843de">reserve()</a>])</code> will be inserted before the position <code>pos</code>.<br> - The number of <code>min(<a href= - "#classboost_1_1circular__buffer_1babfa093dad7801223b80626b598dee1">end()</a> - pos, max(0, + The number of <code>min[<a href= + "#classboost_1_1circular__buffer_1babfa093dad7801223b80626b598dee1">end()</a> - pos, max[0, distance(first, last) - <a href= - "#classboost_1_1circular__buffer_10a02c4fbc53385e98569e810be9843de">reserve()</a>))</code> elements + "#classboost_1_1circular__buffer_10a02c4fbc53385e98569e810be9843de">reserve()</a>]]</code> elements will be overwritten at the end of the <code>circular_buffer</code>.<br> (See Example for the explanation.) </dd> Index: circular_buffer_space_optimized.html =================================================================== RCS file: /cvsroot/boost-sandbox/boost-sandbox/libs/circular_buffer/doc/circular_buffer_space_optimized.html,v retrieving revision 1.35 retrieving revision 1.36 diff -u -d -r1.35 -r1.36 --- circular_buffer_space_optimized.html 23 Jan 2007 23:12:35 -0000 1.35 +++ circular_buffer_space_optimized.html 18 Feb 2007 23:03:27 -0000 1.36 @@ -112,7 +112,7 @@ typedef std::pair<const_pointer, size_type> <a href= "circular_buffer.html#classboost_1_1circular__buffer_11885d7f475b7e7a74c95b2448d243025">const_array_range</a>; typedef <i>implementation-defined</i> <a href= -"#classboost_1_1circular__buffer__space__optimized_1051350e031c50c8b4a7ca1e1902e92f0">capacity_type</a>; +"#classboost_1_1circular__buffer__space__optimized_1e805212e7de49dcb60f2cad1ef304bb3">capacity_type</a>; explicit <a href= "#classboost_1_1circular__buffer__space__optimized_1a05f824b31cd93d7695f4039edc7597f">circular_buffer_space_optimized</a>(const allocator_type& alloc = allocator_type()); @@ -187,14 +187,10 @@ bool <a href="#classboost_1_1circular__buffer__space__optimized_142f4a13c50904a4ac0bf746c88451954">full</a>() const; size_type <a href= "#classboost_1_1circular__buffer__space__optimized_170eec72a6e8d088b58e26ac7e2dd7c9f">reserve</a>() const; - size_type <a href= -"#classboost_1_1circular__buffer__space__optimized_1f3e4b9caed10cf7383682c6dea794917">min_capacity</a>() const; - void <a href= -"#classboost_1_1circular__buffer__space__optimized_1b3667b889d9633e88d62adb98c1b1291">set_min_capacity</a>(size_type new_min_capacity); - size_type <a href= -"#classboost_1_1circular__buffer__space__optimized_1f15db4d5579775966e300c91b3fef33a">capacity</a>() const; + const capacity_type& <a href= +"#classboost_1_1circular__buffer__space__optimized_1aa2695c84ac9fc912e28d1a5920dadfa">capacity</a>() const; void <a href= -"#classboost_1_1circular__buffer__space__optimized_1c804242b924b93eb3db7f3f4587a096c">set_capacity</a>(size_type new_capacity); +"#classboost_1_1circular__buffer__space__optimized_143fa35280fc3cad2a6510065a065d67c">set_capacity</a>(const capacity_type& new_capacity); void <a href= "#classboost_1_1circular__buffer__space__optimized_1f244ff5576b79f8d60e273c02d71c9f2">resize</a>(size_type new_size, const_reference item = value_type()); void <a href= @@ -321,8 +317,8 @@ </tr> <tr> <td> - <a id="classboost_1_1circular__buffer__space__optimized_1051350e031c50c8b4a7ca1e1902e92f0" name= - "classboost_1_1circular__buffer__space__optimized_1051350e031c50c8b4a7ca1e1902e92f0"><code>capacity_type</code></a> + <a id="classboost_1_1circular__buffer__space__optimized_1e805212e7de49dcb60f2cad1ef304bb3" name= + "classboost_1_1circular__buffer__space__optimized_1e805212e7de49dcb60f2cad1ef304bb3"><code>capacity_type</code></a> </td> <td> Capacity controller of the space optimized circular buffer. @@ -423,7 +419,7 @@ </dt> <dd> <code>(*this).<a href= - "#classboost_1_1circular__buffer__space__optimized_1f15db4d5579775966e300c91b3fef33a">capacity()</a> == + "#classboost_1_1circular__buffer__space__optimized_1aa2695c84ac9fc912e28d1a5920dadfa">capacity()</a> == capacity && (*this).size == 0</code><br> Allocates memory specified by the <code>min_capacity</code> parameter. </dd> @@ -649,7 +645,7 @@ </dt> <dd> <code>(*this).<a href= - "#classboost_1_1circular__buffer__space__optimized_1f15db4d5579775966e300c91b3fef33a">capacity()</a> == + "#classboost_1_1circular__buffer__space__optimized_1aa2695c84ac9fc912e28d1a5920dadfa">capacity()</a> == capacity</code><br> Allocates at least as much memory as specified by the - TODO change <code>min_capacity</code> parameter.<br> @@ -723,33 +719,33 @@ </tr> <tr> <td> - <a id="classboost_1_1circular__buffer__space__optimized_1f3e4b9caed10cf7383682c6dea794917" name= - "classboost_1_1circular__buffer__space__optimized_1f3e4b9caed10cf7383682c6dea794917"></a><code><b><a href= - "circular_buffer.html#classboost_1_1circular__buffer_19ba12c0142a21a7d960877c22fa3ea00">size_type</a> - min_capacity() const;</b></code><br> + <a id="classboost_1_1circular__buffer__space__optimized_1aa2695c84ac9fc912e28d1a5920dadfa" name= + "classboost_1_1circular__buffer__space__optimized_1aa2695c84ac9fc912e28d1a5920dadfa"></a><code><b>const + <a href= + "circular_buffer.html#classboost_1_1circular__buffer_1dc642ff2be4db0be1a457810e5d09595">capacity_type</a>& + capacity() const;</b></code><br> + <br> + See the <a href="circular_buffer.html#classboost_1_1circular__buffer">circular_buffer</a> source + documentation.<br> <br> - Return the minimal guaranteed amount of allocated memory. - <p> - The allocated memory will never drop under this value. - </p> </td> </tr> <tr> <td> - <a id="classboost_1_1circular__buffer__space__optimized_1b3667b889d9633e88d62adb98c1b1291" name= - "classboost_1_1circular__buffer__space__optimized_1b3667b889d9633e88d62adb98c1b1291"></a><code><b>void - set_min_capacity(<a href= - "circular_buffer.html#classboost_1_1circular__buffer_19ba12c0142a21a7d960877c22fa3ea00">size_type</a> - new_min_capacity);</b></code><br> + <a id="classboost_1_1circular__buffer__space__optimized_143fa35280fc3cad2a6510065a065d67c" name= + "classboost_1_1circular__buffer__space__optimized_143fa35280fc3cad2a6510065a065d67c"></a><code><b>void + set_capacity(const <a href= + "circular_buffer.html#classboost_1_1circular__buffer_1dc642ff2be4db0be1a457810e5d09595">capacity_type</a>& + new_capacity);</b></code><br> <br> - Change the minimal guaranteed amount of allocated memory. + TODO Change the minimal guaranteed amount of allocated memory. <dl> <dt> <b>Precondition:</b> </dt> <dd> <code>(*this).<a href= - "#classboost_1_1circular__buffer__space__optimized_1f15db4d5579775966e300c91b3fef33a">capacity()</a> + "#classboost_1_1circular__buffer__space__optimized_1aa2695c84ac9fc912e28d1a5920dadfa">capacity()</a> >= new_min_capacity</code> </dd> </dl> @@ -758,9 +754,8 @@ <b>Effect:</b> </dt> <dd> - <code>(*this).<a href= - "#classboost_1_1circular__buffer__space__optimized_1f3e4b9caed10cf7383682c6dea794917">min_capacity()</a> - == new_min_capacity</code> Allocates memory specified by the <code>new_min_capacity</code> parameter. + <code>(*this).min_capacity() == new_min_capacity</code> Allocates memory specified by the + <code>new_min_capacity</code> parameter. </dd> </dl> <dl> @@ -770,42 +765,16 @@ <dd> It is considered as a bug if the precondition is not met (i.e. if <code>new_min_capacity > (*this).<a href= - "#classboost_1_1circular__buffer__space__optimized_1f15db4d5579775966e300c91b3fef33a">capacity()</a></code>) + "#classboost_1_1circular__buffer__space__optimized_1aa2695c84ac9fc912e28d1a5920dadfa">capacity()</a></code>) and an assertion will be invoked in the debug mode. </dd> </dl> - </td> - </tr> - <tr> - <td> - <a id="classboost_1_1circular__buffer__space__optimized_1f15db4d5579775966e300c91b3fef33a" name= - "classboost_1_1circular__buffer__space__optimized_1f15db4d5579775966e300c91b3fef33a"></a><code><b><a href= - "circular_buffer.html#classboost_1_1circular__buffer_19ba12c0142a21a7d960877c22fa3ea00">size_type</a> - capacity() const;</b></code><br> - <br> - See the <a href="circular_buffer.html#classboost_1_1circular__buffer">circular_buffer</a> source - documentation.<br> - <br> - </td> - </tr> - <tr> - <td> - <a id="classboost_1_1circular__buffer__space__optimized_1c804242b924b93eb3db7f3f4587a096c" name= - "classboost_1_1circular__buffer__space__optimized_1c804242b924b93eb3db7f3f4587a096c"></a><code><b>void - set_capacity(<a href= - "circular_buffer.html#classboost_1_1circular__buffer_19ba12c0142a21a7d960877c22fa3ea00">size_type</a> - new_capacity);</b></code><br> - <br> - See the <a href="circular_buffer.html#classboost_1_1circular__buffer">circular_buffer</a> source - documentation. <dl> <dt> <b>Precondition:</b> </dt> <dd> - <code><a href= - "#classboost_1_1circular__buffer__space__optimized_1f3e4b9caed10cf7383682c6dea794917">min_capacity()</a> - <= new_capacity</code> + <code>min_capacity() <= new_capacity</code> </dd> </dl> <dl> @@ -813,9 +782,8 @@ <b>Note:</b> </dt> <dd> - It is considered as a bug if the precondition is not met (i.e. if <code>new_capacity > <a href= - "#classboost_1_1circular__buffer__space__optimized_1f3e4b9caed10cf7383682c6dea794917">min_capacity()</a></code>) - and an assertion will be invoked in the debug mode. + It is considered as a bug if the precondition is not met (i.e. if <code>new_capacity > + min_capacity()</code>) and an assertion will be invoked in the debug mode. </dd> </dl> </td> @@ -850,9 +818,7 @@ <b>Precondition:</b> </dt> <dd> - <code><a href= - "#classboost_1_1circular__buffer__space__optimized_1f3e4b9caed10cf7383682c6dea794917">min_capacity()</a> - <= new_capacity</code> + <code>min_capacity() <= new_capacity</code> </dd> </dl> <dl> @@ -860,9 +826,8 @@ <b>Note:</b> </dt> <dd> - It is considered as a bug if the precondition is not met (i.e. if <code>new_capacity > <a href= - "#classboost_1_1circular__buffer__space__optimized_1f3e4b9caed10cf7383682c6dea794917">min_capacity()</a></code>) - and an assertion will be invoked in the debug mode. + It is considered as a bug if the precondition is not met (i.e. if <code>new_capacity > + min_capacity()</code>) and an assertion will be invoked in the debug mode. </dd> </dl> </td> |
