boost/circular_buffer
2
0
Fork 0
mirror of https://github.com/boostorg/circular_buffer.git synced 2026-02-18 14:02:12 +00:00
Code Issues Projects Releases Wiki Activity

Documentation update.

Browse Source 
[SVN r2915]
This commit is contained in:
Jan Gaspar
2006-04-11 22:20:17 +00:00
parent b7213842d2
commit eb77970646
3 changed files with 1268 additions and 906 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
include/boost/circular_buffer/space_optimized.hpp
View File

@@ -50,7 +50,20 @@ public:
typedef typename circular_buffer<T, Alloc>::param_value_type param_value_type;
typedef typename circular_buffer<T, Alloc>::return_value_type return_value_type;
//! Capacity type of the space optimized circular buffer.
//! Capacity controller of the space optimized circular buffer.
/*!
<code>
struct capacity_control {
capacity_control(size_type capacity, size_type min_capacity = 0);
size_type m_capacity;
size_type m_min_capacity;
};
</code>
The converting constructor of the <code>capacity_control</code>
allows implicit conversion from <code>size_type</code> like types
which ensures compatibility of creating an instance of the
<code>circular_buffer_space_optimized</code> with other STL containers.
*/
typedef cb_details::capacity_control<size_type> capacity_control;
// Inherited
@@ -90,7 +103,7 @@ public:
bool full() const { return size() == capacity(); }
//! Return the minimal guaranteed amount of allocated memory.
/*
/*!
The allocated memory will never drop under this value.
*/
size_type min_capacity() const { return m_capacity_ctrl.m_min_capacity; }