Boost , The Boost C++ Libraries BoostBook Documentation Subset , Boost.Circular_buffer C++ Reference

Boost C++ Libraries

...one of the most highly regarded and expertly designed C++ library projects in the world. — Herb Sutter and Andrei Alexandrescu, C++ Coding Standards

Class template circular_buffer_space_optimized

boost::circular_buffer_space_optimized — Space optimized circular buffer container adaptor. T must be a copyable class or must have an noexcept move constructor and move assignment operator.

Synopsis

// In header: <boost/circular_buffer/space_optimized.hpp>
template<typename T, typename Alloc> 
class circular_buffer_space_optimized :
  private boost::circular_buffer< T, Alloc >
{
public:
  // types
  typedef circular_buffer< T, Alloc >::value_type             value_type;            
  typedef circular_buffer< T, Alloc >::pointer                pointer;               
  typedef circular_buffer< T, Alloc >::const_pointer          const_pointer;         
  typedef circular_buffer< T, Alloc >::reference              reference;             
  typedef circular_buffer< T, Alloc >::const_reference        const_reference;       
  typedef circular_buffer< T, Alloc >::size_type              size_type;             
  typedef circular_buffer< T, Alloc >::difference_type        difference_type;       
  typedef circular_buffer< T, Alloc >::allocator_type         allocator_type;        
  typedef circular_buffer< T, Alloc >::const_iterator         const_iterator;        
  typedef circular_buffer< T, Alloc >::iterator               iterator;              
  typedef circular_buffer< T, Alloc >::const_reverse_iterator const_reverse_iterator;
  typedef circular_buffer< T, Alloc >::reverse_iterator       reverse_iterator;      
  typedef circular_buffer< T, Alloc >::array_range            array_range;           
  typedef circular_buffer< T, Alloc >::const_array_range      const_array_range;     
  typedef circular_buffer< T, Alloc >::param_value_type       param_value_type;      
  typedef circular_buffer< T, Alloc >::rvalue_type            rvalue_type;           
  typedef cb_details::capacity_control< size_type >           capacity_type;         
  // construct/copy/destruct
  explicit circular_buffer_space_optimized(const allocator_type & = allocator_type()) noexcept;
  explicit circular_buffer_space_optimized(capacity_type, 
                                           const allocator_type & = allocator_type());
  circular_buffer_space_optimized(capacity_type, param_value_type, 
                                  const allocator_type & = allocator_type());
  circular_buffer_space_optimized(capacity_type, size_type, param_value_type, 
                                  const allocator_type & = allocator_type());
  circular_buffer_space_optimized(const circular_buffer_space_optimized< T, Alloc > &);
  circular_buffer_space_optimized(circular_buffer_space_optimized< T, Alloc > &&) noexcept;
  template<typename InputIterator> 
    circular_buffer_space_optimized(InputIterator, InputIterator, 
                                    const allocator_type & = allocator_type());
  template<typename InputIterator> 
    circular_buffer_space_optimized(capacity_type, InputIterator, 
                                    InputIterator, 
                                    const allocator_type & = allocator_type());
  circular_buffer_space_optimized< T, Alloc > & 
  operator=(const circular_buffer_space_optimized< T, Alloc > &);
  circular_buffer_space_optimized< T, Alloc > & 
  operator=(circular_buffer_space_optimized< T, Alloc > &&) noexcept;
  // public member functions
  bool full() const noexcept;
  size_type reserve() const noexcept;
  const capacity_type & capacity() const noexcept;
  void set_capacity(const capacity_type &);
  void resize(size_type, param_value_type = value_type());
  void rset_capacity(const capacity_type &);
  void rresize(size_type, param_value_type = value_type());
  void assign(size_type, param_value_type);
  void assign(capacity_type, size_type, param_value_type);
  template<typename InputIterator> void assign(InputIterator, InputIterator);
  template<typename InputIterator> 
    void assign(capacity_type, InputIterator, InputIterator);
  void swap(circular_buffer_space_optimized< T, Alloc > &) noexcept;
  void push_back(param_value_type);
  void push_back(rvalue_type);
  void push_back();
  void push_front(param_value_type);
  void push_front(rvalue_type);
  void push_front();
  void pop_back();
  void pop_front();
  iterator insert(iterator, param_value_type);
  iterator insert(iterator, rvalue_type);
  iterator insert(iterator);
  void insert(iterator, size_type, param_value_type);
  template<typename InputIterator> 
    void insert(iterator, InputIterator, InputIterator);
  iterator rinsert(iterator, param_value_type);
  iterator rinsert(iterator, rvalue_type);
  iterator rinsert(iterator);
  void rinsert(iterator, size_type, param_value_type);
  template<typename InputIterator> 
    void rinsert(iterator, InputIterator, InputIterator);
  iterator erase(iterator);
  iterator erase(iterator, iterator);
  iterator rerase(iterator);
  iterator rerase(iterator, iterator);
  void clear();
  // private member functions
  void adjust_min_capacity();
  size_type ensure_reserve(size_type, size_type) const;
  void check_low_capacity(size_type = 1);
  void check_high_capacity();
  void reduce_capacity(const true_type &);
  void reduce_capacity(const false_type &);
  template<typename IntegralType> 
    void insert(const iterator &, IntegralType, IntegralType, 
                const true_type &);
  template<typename Iterator> 
    void insert(const iterator &, Iterator, Iterator, const false_type &);
  template<typename IntegralType> 
    void rinsert(const iterator &, IntegralType, IntegralType, 
                 const true_type &);
  template<typename Iterator> 
    void rinsert(const iterator &, Iterator, Iterator, const false_type &);
  // private static functions
  static size_type init_capacity(const capacity_type &, size_type);
  template<typename IntegralType> 
    static size_type 
    init_capacity(const capacity_type &, IntegralType, IntegralType, 
                  const true_type &);
  template<typename Iterator> 
    static size_type 
    init_capacity(const capacity_type &, Iterator, Iterator, 
                  const false_type &);
  template<typename InputIterator> 
    static size_type 
    init_capacity(const capacity_type &, InputIterator, InputIterator, 
                  const std::input_iterator_tag &);
  template<typename ForwardIterator> 
    static size_type 
    init_capacity(const capacity_type &, ForwardIterator, ForwardIterator, 
                  const std::forward_iterator_tag &);
};

Description

`circular_buffer_space_optimized` public types

typedefcb_details:: capacity_control<size_type>capacity_type;
Контроллер емкости пространственного оптимизированного кругового буфера.
Смотрите также:
емкость_контроль в деталях.hpp.
<class capacity_control { size_type m_capacity; // Available capacity. size_type m_min_capacity; // Minimum capacity. public: capacity_control(size_type capacity, size_type min_capacity = 0) : m_capacity(capacity), m_min_capacity(min_capacity) {}; size_type capacity() const { return m_capacity; } size_type min_capacity() const { return m_min_capacity; } operator size_type() const { return m_capacity; } };>
Всегда<capacity >= min_capacity>
.
<capacity()>представляет емкость<circular_buffer_space_optimized>, а<min_capacity()>определяет минимальный выделенный размер его внутреннего буфера.
Конструктор преобразования<capacity_control>допускает неявное преобразование из<size_type>-подобных типов, что обеспечивает совместимость создания экземпляра<circular_buffer_space_optimized>с другими контейнерами STL.
С другой стороны, оператор<size_type()>обеспечивает неявное преобразование в<size_type>, что позволяет рассматривать емкость<circular_buffer_space_optimized>так же, как и в<circular_buffer>
.

`circular_buffer_space_optimized` public construct/copy/destruct

explicitcircular_buffer_space_optimized(constallocator_type&alloc=allocator_type())noexcept;

>Создать пустое пространство оптимизированного кругового буфера с нулевой емкостью.

Сложность. Постоянство.

	Предупреждение
	Со времени версии 1.36 Boost поведение этого конструктора изменилось. Теперь он создает круглый буфер с нулевой емкостью.

Параметры:

<alloc>

Бросок:

<alloc>

Распределитель.

Пост-условия:

<capacity().capacity() == 0 && capacity().min_capacity() == 0 && size() == 0>

Ничего.

explicitcircular_buffer_space_optimized(capacity_typecapacity_ctrl,
                                        constallocator_type&alloc=allocator_type());

>Создать пустое пространство оптимизированного кругового буфера с заданной емкостью.

Сложность. Константа.

Параметры:

<`alloc`>
<`capacity_ctrl`>	Контроллер емкости, представляющий максимальное количество элементов, которые могут храниться в<`circular_buffer_space_optimized>`и минимальный выделенный размер внутреннего буфера.

<capacity() == capacity_ctrl && size() == 0>

Количество выделенной памяти во внутреннем буфере составляет<capacity_ctrl.min_capacity()>.

Бросок:

Ошибка распределения, если память исчерпана (<std::bad_alloc>, если используется стандартный распределитель).

circular_buffer_space_optimized(capacity_typecapacity_ctrl,
                               param_value_typeitem,
                               constallocator_type&alloc=allocator_type());

>Создать полный пространственный оптимизированный круговой буфер с заданной емкостью, заполненный<capacity_ctrl.capacity()>копиями<item>.

Сложность. Линейный [в<capacity_ctrl.capacity()>.

Параметры:

<`alloc`>
<`capacity_ctrl`>	Контроллер емкости, представляющий максимальное количество элементов, которые могут храниться в<`circular_buffer_space_optimized>`и минимальный выделенный размер внутреннего буфера.
<`item`>	Созданный элемент<`circular_buffer_space_optimized>`будет заполнен.

Последующие условия:

<capacity() == capacity_ctrl && full() && (*this)[0] == item && (*this)[1] == item && ... && (*this) [capacity_ctrl.capacity() - 1] == item>

Количество выделенной памяти во внутреннем буфере составляет<capacity_ctrl.capacity()>.

Бросок:

Ошибка распределения, если память исчерпана (<std::bad_alloc>, если используется стандартный распределитель).<T::T(const T&)>бросков.

circular_buffer_space_optimized(capacity_typecapacity_ctrl,size_typen,
                               param_value_typeitem,
                               constallocator_type&alloc=allocator_type());

>Создать пространственный оптимизированный круговой буфер с заданной емкостью, заполненный<n>копиями<item>

Сложность. Линейный [в<n>.

Параметры:

<`alloc`>
<`capacity_ctrl`>	Контроллер емкости, представляющий максимальное количество элементов, которые могут храниться в<`circular_buffer_space_optimized>`и минимальный выделенный размер внутреннего буфера.
<`item`>	Созданный элемент<`circular_buffer_space_optimized>`будет заполнен.
<`n`>	Количество созданных элементов<`circular_buffer_space_optimized>`будет заполнен.

Требуется:

<capacity_ctrl.capacity() >= n>

Последующие условия:

<capacity() == capacity_ctrl && size() == n && (*this)[0] == item && (*this)[1] == item && ... && (*this)[n - 1] == item>

Количество выделенной памяти во внутреннем буфере составляет<max[n, capacity_ctrl.min_capacity()]>.

Броски:

Ошибка распределения, если память исчерпана (<std::bad_alloc>, если используется стандартный распределитель).<T::T(const T&)>бросок.

circular_buffer_space_optimized(constcircular_buffer_space_optimized<T,Alloc>&cb);

>Конструктор копий.

Создает копию указанного<circular_buffer_space_optimized>.

Сложность. Линейный [в размере<cb>.


<`cb`>	<`circular_buffer_space_optimized>`подлежит копированию.

template<typenameInputIterator> circular_buffer_space_optimized(capacity_typecapacity_ctrl, InputIteratorfirst,InputIteratorlast, constallocator_type&alloc=allocator_type());

	Примечание
Чтобы явно очистить дополнительно выделенную память, используйте техникутермоусадка в соответствие: <`boost::circular_buffer_space_optimized<int> cb(1000); ... boost::circular_buffer_space_optimized<int>(cb).swap(cb);`> Для получения дополнительной информации о технике термоусадки в STL см.http://www.gotw.ca/gotw/054.htm.

Примечание

Чтобы явно очистить дополнительно выделенную память, используйте техникутермоусадка в соответствие:

<boost::circular_buffer_space_optimized<int> cb(1000); ... boost::circular_buffer_space_optimized<int>(cb).swap(cb);>

Для получения дополнительной информации о технике термоусадки в STL см.http://www.gotw.ca/gotw/054.htm.

Примечание

В принципе, нет никакой разницы между<erase(iterator)>и этим методом. Он реализуется только для согласования с базой<circular_buffer>.

<pos>

Итератор, указывающий на элемент, который должен быть удален.

Примечание

В основном нет разницы между<erase(iterator, iterator)>и этим методом. Он реализуется только для согласования с базой<<circular_buffer>.

<`alloc`>
<`capacity_ctrl`>	Контроллер емкости, представляющий максимальное количество элементов, которые могут храниться в<`circular_buffer_space_optimized>`и минимальный выделенный размер внутреннего буфера.
<`first`>	Начало диапазона должно быть скопировано.
<`last`>	Конец диапазона должен быть скопирован.

Возвращает:	<`true`>, если количество элементов, хранящихся в<`circular_buffer_space_optimized`>, равно емкости<`circular_buffer_space_optimized`>;<`false`>в противном случае.
Бросает:		Ничего.

<`capacity_ctrl`>	Новый контроллер мощности.
<`first`>	Начало диапазона для копирования.
<`last`>	Конец диапазона для копирования.


[3236 Последующие условия:	если<`capacity().capacity() > 0`>то<`front() == item`> Если<`circular_buffer_space_optimized`>заполнен, последний элемент будет удален. Если вместимость<`0`>, ничего не будет вставлено. Количество выделенной памяти во внутреннем буфере может быть прогнозируемо увеличено.
Броски:	Ошибка распределения, если память исчерпана (<`std::bad_alloc`>, если используется стандартный распределитель). Что бы ни бросил<`T::T()`>. Что бы<`T::T(const T&)`>ни бросало, или ничего, если<`T::T(T&&)`>не является исключением.

<`first`>	Начало диапазона, который будет вставлен.
<`last`>	Конец диапазона должен быть вставлен.
<`pos`>	Итератор, определяющий положение, в котором будет вставлен диапазон.

Class template circular_buffer_space_optimized

Boost , The Boost C++ Libraries BoostBook Documentation Subset , Boost.Circular_buffer C++ Reference

Boost C++ Libraries

Class template circular_buffer_space_optimized

Synopsis

Description

`circular_buffer_space_optimized` public types

`circular_buffer_space_optimized` public construct/copy/destruct

`circular_buffer_space_optimized` public member functions

`circular_buffer_space_optimized` private member functions

`circular_buffer_space_optimized` private static functions

Возвращение:	<`capacity().capacity() - size()`>
Броски:	Ничего.

<`item`>	Элемент<`circular_buffer_space_optimized>`будет заполнен.
<`n`>	Количество элементов<`circular_buffer_space_optimized>`будет заполнено.

Требуется:	<`!empty()`>
Последующие условия:	Последний элемент удален из<`circular_buffer_space_optimized`> . Количество выделенной памяти во внутреннем буфере может быть предсказуемо уменьшено.
Броски:	Ошибка распределения, если память исчерпана (<`std::bad_alloc`>, если используется стандартный распределитель).

<`item`>	Элемент, копии которого будут вставлены.
<`n`>	Число<`item`>должно быть вставлено.
<`pos`>	Итератор, определяющий положение, в котором будут вставлены<`item`>с.

<`item`>	Элемент должен быть вставлен.
<`pos`>	Итератор, определяющий положение, перед которым будет вставлен<`item`>.

	<`end()`><`end()`><`end()`><`end()`><`end()`>	Начало диапазона, который будет вставлен.
<`last`>	Конец диапазона должен быть вставлен.
<`pos`>	Итератор, определяющий положение, в котором будет вставлен диапазон.

Последующие условия:	<`size() == 0`> Количество выделенной памяти во внутреннем буфере может быть предсказуемо уменьшено.
Броски:	Ошибка распределения, если память исчерпана (5843) при использовании стандартного распределителя.

Class template circular_buffer_space_optimized

Boost , The Boost C++ Libraries BoostBook Documentation Subset , Boost.Circular_buffer C++ Reference

Boost C++ Libraries

Class template circular_buffer_space_optimized

Synopsis

Description

circular_buffer_space_optimized public types

circular_buffer_space_optimized public construct/copy/destruct

circular_buffer_space_optimized public member functions

circular_buffer_space_optimized private member functions

circular_buffer_space_optimized private static functions

`circular_buffer_space_optimized` public types

`circular_buffer_space_optimized` public construct/copy/destruct

`circular_buffer_space_optimized` public member functions

`circular_buffer_space_optimized` private member functions

`circular_buffer_space_optimized` private static functions