boost-react-native-bundle

<html> <head> <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> <title>Class template circular_buffer_space_optimized</title> <link rel="stylesheet" href="../../../doc/src/boostbook.css" type="text/css"> <meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> <link rel="home" href="../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <link rel="up" href="../boost_circular_buffer_c___reference.html#header.boost.circular_buffer.space_optimized_hpp" title="Header <boost/circular_buffer/space_optimized.hpp>"> <link rel="prev" href="swap_idp31458912.html" title="Function template swap"> <link rel="next" href="../circular_buffer/s14.html" title="Index"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> <table cellpadding="2" width="100%"><tr> <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../boost.png"></td> <td align="center"><a href="../../../index.html">Home</a></td> <td align="center"><a href="../../../libs/libraries.htm">Libraries</a></td> <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> <td align="center"><a href="../../../more/index.htm">More</a></td> </tr></table> <hr> <div class="spirit-nav"> <a accesskey="p" href="swap_idp31458912.html"><img src="../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../boost_circular_buffer_c___reference.html#header.boost.circular_buffer.space_optimized_hpp"><img src="../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../circular_buffer/s14.html"><img src="../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> <a name="boost.circular_buffe_idp31480224"></a><div class="titlepage"></div> <div class="refnamediv"> <h2>Class template circular_buffer_space_optimized</h2> boost::circular_buffer_space_optimized — Space optimized circular buffer container adaptor. <code class="computeroutput">T</code> must be a copyable class or must have an noexcept move constructor and move assignment operator. </div> <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> <div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis">// In header: <<a class="link" href="../boost_circular_buffer_c___reference.html#header.boost.circular_buffer.space_optimized_hpp" title="Header <boost/circular_buffer/space_optimized.hpp>">boost/circular_buffer/space_optimized.hpp</a>> template<typename T, typename Alloc> class <a class="link" href="circular_buffe_idp31480224.html" title="Class template circular_buffer_space_optimized">circular_buffer_space_optimized</a> : private boost::circular_buffer< T, Alloc > { public: // <a class="link" href="circular_buffe_idp31480224.html#boost.circular_buffe_idp31480224types">types</a> typedef <a class="link" href="circular_buffer.html" title="Class template circular_buffer">circular_buffer</a>< T, Alloc >::value_type <a name="boost.circular_buffe_idp31480224.value_type"></a>value_type; typedef <a class="link" href="circular_buffer.html" title="Class template circular_buffer">circular_buffer</a>< T, Alloc >::pointer <a name="boost.circular_buffe_idp31480224.pointer"></a>pointer; typedef <a class="link" href="circular_buffer.html" title="Class template circular_buffer">circular_buffer</a>< T, Alloc >::const_pointer <a name="boost.circular_buffe_idp31480224.const_pointer"></a>const_pointer; typedef <a class="link" href="circular_buffer.html" title="Class template circular_buffer">circular_buffer</a>< T, Alloc >::reference <a name="boost.circular_buffe_idp31480224.reference"></a>reference; typedef <a class="link" href="circular_buffer.html" title="Class template circular_buffer">circular_buffer</a>< T, Alloc >::const_reference <a name="boost.circular_buffe_idp31480224.const_reference"></a>const_reference; typedef <a class="link" href="circular_buffer.html" title="Class template circular_buffer">circular_buffer</a>< T, Alloc >::size_type <a name="boost.circular_buffe_idp31480224.size_type"></a>size_type; typedef <a class="link" href="circular_buffer.html" title="Class template circular_buffer">circular_buffer</a>< T, Alloc >::difference_type <a name="boost.circular_buffe_idp31480224.difference_type"></a>difference_type; typedef <a class="link" href="circular_buffer.html" title="Class template circular_buffer">circular_buffer</a>< T, Alloc >::allocator_type <a name="boost.circular_buffe_idp31480224.allocator_type"></a>allocator_type; typedef <a class="link" href="circular_buffer.html" title="Class template circular_buffer">circular_buffer</a>< T, Alloc >::const_iterator <a name="boost.circular_buffe_idp31480224.const_iterator"></a>const_iterator; typedef <a class="link" href="circular_buffer.html" title="Class template circular_buffer">circular_buffer</a>< T, Alloc >::iterator <a name="boost.circular_buffe_idp31480224.iterator"></a>iterator; typedef <a class="link" href="circular_buffer.html" title="Class template circular_buffer">circular_buffer</a>< T, Alloc >::const_reverse_iterator <a name="boost.circular_buffe_idp31480224.const_reverse_iterator"></a>const_reverse_iterator; typedef <a class="link" href="circular_buffer.html" title="Class template circular_buffer">circular_buffer</a>< T, Alloc >::reverse_iterator <a name="boost.circular_buffe_idp31480224.reverse_iterator"></a>reverse_iterator; typedef <a class="link" href="circular_buffer.html" title="Class template circular_buffer">circular_buffer</a>< T, Alloc >::array_range <a name="boost.circular_buffe_idp31480224.array_range"></a>array_range; typedef <a class="link" href="circular_buffer.html" title="Class template circular_buffer">circular_buffer</a>< T, Alloc >::const_array_range <a name="boost.circular_buffe_idp31480224.const_array_range"></a>const_array_range; typedef <a class="link" href="circular_buffer.html" title="Class template circular_buffer">circular_buffer</a>< T, Alloc >::param_value_type <a name="boost.circular_buffe_idp31480224.param_value_type"></a>param_value_type; typedef <a class="link" href="circular_buffer.html" title="Class template circular_buffer">circular_buffer</a>< T, Alloc >::rvalue_type <a name="boost.circular_buffe_idp31480224.rvalue_type"></a>rvalue_type; typedef cb_details::capacity_control< size_type > <a class="link" href="circular_buffe_idp31480224.html#boost.circular_buffe_idp31480224.capacity_type">capacity_type</a>; // <a class="link" href="circular_buffe_idp31480224.html#boost.circular_buffe_idp31480224construct-copy-destruct">construct/copy/destruct</a> explicit <a class="link" href="circular_buffe_idp31480224.html#idp32214432-bb">circular_buffer_space_optimized</a>(const allocator_type & = allocator_type()) noexcept; explicit <a class="link" href="circular_buffe_idp31480224.html#idp32220448-bb">circular_buffer_space_optimized</a>(capacity_type, const allocator_type & = allocator_type()); <a class="link" href="circular_buffe_idp31480224.html#idp32228992-bb">circular_buffer_space_optimized</a>(capacity_type, param_value_type, const allocator_type & = allocator_type()); <a class="link" href="circular_buffe_idp31480224.html#idp32241184-bb">circular_buffer_space_optimized</a>(capacity_type, size_type, param_value_type, const allocator_type & = allocator_type()); <a class="link" href="circular_buffe_idp31480224.html#idp32256048-bb">circular_buffer_space_optimized</a>(const <a class="link" href="circular_buffe_idp31480224.html" title="Class template circular_buffer_space_optimized">circular_buffer_space_optimized</a>< T, Alloc > &); <a class="link" href="circular_buffe_idp31480224.html#idp32264960-bb">circular_buffer_space_optimized</a>(<a class="link" href="circular_buffe_idp31480224.html" title="Class template circular_buffer_space_optimized">circular_buffer_space_optimized</a>< T, Alloc > &&) noexcept; template<typename InputIterator> <a class="link" href="circular_buffe_idp31480224.html#idp32272672-bb">circular_buffer_space_optimized</a>(InputIterator, InputIterator, const allocator_type & = allocator_type()); template<typename InputIterator> <a class="link" href="circular_buffe_idp31480224.html#idp32286736-bb">circular_buffer_space_optimized</a>(capacity_type, InputIterator, InputIterator, const allocator_type & = allocator_type()); <a class="link" href="circular_buffe_idp31480224.html" title="Class template circular_buffer_space_optimized">circular_buffer_space_optimized</a>< T, Alloc > & <a class="link" href="circular_buffe_idp31480224.html#idp32305904-bb">operator=</a>(const <a class="link" href="circular_buffe_idp31480224.html" title="Class template circular_buffer_space_optimized">circular_buffer_space_optimized</a>< T, Alloc > &); <a class="link" href="circular_buffe_idp31480224.html" title="Class template circular_buffer_space_optimized">circular_buffer_space_optimized</a>< T, Alloc > & <a class="link" href="circular_buffe_idp31480224.html#idp32322240-bb">operator=</a>(<a class="link" href="circular_buffe_idp31480224.html" title="Class template circular_buffer_space_optimized">circular_buffer_space_optimized</a>< T, Alloc > &&) noexcept; // <a class="link" href="circular_buffe_idp31480224.html#idp31516928-bb">public member functions</a> bool <a class="link" href="circular_buffe_idp31480224.html#idp31517488-bb">full</a>() const noexcept; size_type <a class="link" href="circular_buffe_idp31480224.html#idp31528784-bb">reserve</a>() const noexcept; const capacity_type & <a class="link" href="circular_buffe_idp31480224.html#idp31538816-bb">capacity</a>() const noexcept; void <a class="link" href="circular_buffe_idp31480224.html#idp31549952-bb">set_capacity</a>(const capacity_type &); void <a class="link" href="circular_buffe_idp31480224.html#idp31572144-bb">resize</a>(size_type, param_value_type = value_type()); void <a class="link" href="circular_buffe_idp31480224.html#idp31594080-bb">rset_capacity</a>(const capacity_type &); void <a class="link" href="circular_buffe_idp31480224.html#idp31612032-bb">rresize</a>(size_type, param_value_type = value_type()); void <a class="link" href="circular_buffe_idp31480224.html#idp31633968-bb">assign</a>(size_type, param_value_type); void <a class="link" href="circular_buffe_idp31480224.html#idp31652448-bb">assign</a>(capacity_type, size_type, param_value_type); template<typename InputIterator> void <a class="link" href="circular_buffe_idp31480224.html#idp31673680-bb">assign</a>(InputIterator, InputIterator); template<typename InputIterator> void <a class="link" href="circular_buffe_idp31480224.html#idp31693824-bb">assign</a>(capacity_type, InputIterator, InputIterator); void <a class="link" href="circular_buffe_idp31480224.html#idp31719696-bb">swap</a>(<a class="link" href="circular_buffe_idp31480224.html" title="Class template circular_buffer_space_optimized">circular_buffer_space_optimized</a>< T, Alloc > &) noexcept; void <a class="link" href="circular_buffe_idp31480224.html#idp31733424-bb">push_back</a>(param_value_type); void <a class="link" href="circular_buffe_idp31480224.html#idp31748496-bb">push_back</a>(rvalue_type); void <a class="link" href="circular_buffe_idp31480224.html#idp31763104-bb">push_back</a>(); void <a class="link" href="circular_buffe_idp31480224.html#idp31777952-bb">push_front</a>(param_value_type); void <a class="link" href="circular_buffe_idp31480224.html#idp31793024-bb">push_front</a>(rvalue_type); void <a class="link" href="circular_buffe_idp31480224.html#idp31808544-bb">push_front</a>(); void <a class="link" href="circular_buffe_idp31480224.html#idp31823392-bb">pop_back</a>(); void <a class="link" href="circular_buffe_idp31480224.html#idp31836048-bb">pop_front</a>(); iterator <a class="link" href="circular_buffe_idp31480224.html#idp31848704-bb">insert</a>(iterator, param_value_type); iterator <a class="link" href="circular_buffe_idp31480224.html#idp31872608-bb">insert</a>(iterator, rvalue_type); iterator <a class="link" href="circular_buffe_idp31480224.html#idp31896496-bb">insert</a>(iterator); void <a class="link" href="circular_buffe_idp31480224.html#idp31919712-bb">insert</a>(iterator, size_type, param_value_type); template<typename InputIterator> void <a class="link" href="circular_buffe_idp31480224.html#idp31951152-bb">insert</a>(iterator, InputIterator, InputIterator); iterator <a class="link" href="circular_buffe_idp31480224.html#idp31988656-bb">rinsert</a>(iterator, param_value_type); iterator <a class="link" href="circular_buffe_idp31480224.html#idp32012544-bb">rinsert</a>(iterator, rvalue_type); iterator <a class="link" href="circular_buffe_idp31480224.html#idp32036416-bb">rinsert</a>(iterator); void <a class="link" href="circular_buffe_idp31480224.html#idp32059616-bb">rinsert</a>(iterator, size_type, param_value_type); template<typename InputIterator> void <a class="link" href="circular_buffe_idp31480224.html#idp32091024-bb">rinsert</a>(iterator, InputIterator, InputIterator); iterator <a class="link" href="circular_buffe_idp31480224.html#idp32128528-bb">erase</a>(iterator); iterator <a class="link" href="circular_buffe_idp31480224.html#idp32145520-bb">erase</a>(iterator, iterator); iterator <a class="link" href="circular_buffe_idp31480224.html#idp32163296-bb">rerase</a>(iterator); iterator <a class="link" href="circular_buffe_idp31480224.html#idp32182256-bb">rerase</a>(iterator, iterator); void <a class="link" href="circular_buffe_idp31480224.html#idp32202176-bb">clear</a>(); // <a class="link" href="circular_buffe_idp31480224.html#idp32330288-bb">private member functions</a> void <a class="link" href="circular_buffe_idp31480224.html#idp32330864-bb">adjust_min_capacity</a>(); size_type <a class="link" href="circular_buffe_idp31480224.html#idp32332016-bb">ensure_reserve</a>(size_type, size_type) const; void <a class="link" href="circular_buffe_idp31480224.html#idp32334832-bb">check_low_capacity</a>(size_type = 1); void <a class="link" href="circular_buffe_idp31480224.html#idp32336960-bb">check_high_capacity</a>(); void <a class="link" href="circular_buffe_idp31480224.html#idp32338112-bb">reduce_capacity</a>(const true_type &); void <a class="link" href="circular_buffe_idp31480224.html#idp32339968-bb">reduce_capacity</a>(const false_type &); template<typename IntegralType> void <a class="link" href="circular_buffe_idp31480224.html#idp32341824-bb">insert</a>(const iterator &, IntegralType, IntegralType, const true_type &); template<typename Iterator> void <a class="link" href="circular_buffe_idp31480224.html#idp32346576-bb">insert</a>(const iterator &, Iterator, Iterator, const false_type &); template<typename IntegralType> void <a class="link" href="circular_buffe_idp31480224.html#idp32351328-bb">rinsert</a>(const iterator &, IntegralType, IntegralType, const true_type &); template<typename Iterator> void <a class="link" href="circular_buffe_idp31480224.html#idp32356080-bb">rinsert</a>(const iterator &, Iterator, Iterator, const false_type &); // <a class="link" href="circular_buffe_idp31480224.html#idp32360992-bb">private static functions</a> static size_type <a class="link" href="circular_buffe_idp31480224.html#idp32361568-bb">init_capacity</a>(const capacity_type &, size_type); template<typename IntegralType> static size_type <a class="link" href="circular_buffe_idp31480224.html#idp32364368-bb">init_capacity</a>(const capacity_type &, IntegralType, IntegralType, const true_type &); template<typename Iterator> static size_type <a class="link" href="circular_buffe_idp31480224.html#idp32369424-bb">init_capacity</a>(const capacity_type &, Iterator, Iterator, const false_type &); template<typename InputIterator> static size_type <a class="link" href="circular_buffe_idp31480224.html#idp32374480-bb">init_capacity</a>(const capacity_type &, InputIterator, InputIterator, const std::input_iterator_tag &); template<typename ForwardIterator> static size_type <a class="link" href="circular_buffe_idp31480224.html#idp32379552-bb">init_capacity</a>(const capacity_type &, ForwardIterator, ForwardIterator, const std::forward_iterator_tag &); };</pre></div> <div class="refsect1"> <a name="idp146544208"></a><h2>Description</h2> <div class="refsect2"> <a name="idp146544624"></a><h3> <a name="boost.circular_buffe_idp31480224types"></a><code class="computeroutput">circular_buffer_space_optimized</code> public types</h3> <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> typedef cb_details::capacity_control< size_type > <a name="boost.circular_buffe_idp31480224.capacity_type"></a>capacity_type; Capacity controller of the space optimized circular buffer. See Also: capacity_control in details.hpp. <code class="computeroutput"> 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; } }; </code> Always <code class="computeroutput">capacity >= min_capacity</code>. The <code class="computeroutput">capacity()</code> represents the capacity of the <code class="computeroutput"><a class="link" href="circular_buffe_idp31480224.html" title="Class template circular_buffer_space_optimized">circular_buffer_space_optimized</a></code> and the <code class="computeroutput">min_capacity()</code> determines the minimal allocated size of its internal buffer. The converting constructor of the <code class="computeroutput">capacity_control</code> allows implicit conversion from <code class="computeroutput">size_type</code>-like types which ensures compatibility of creating an instance of the <code class="computeroutput"><a class="link" href="circular_buffe_idp31480224.html" title="Class template circular_buffer_space_optimized">circular_buffer_space_optimized</a></code> with other STL containers. On the other hand the operator <code class="computeroutput">size_type()</code> provides implicit conversion to the <code class="computeroutput">size_type</code> which allows to treat the capacity of the <code class="computeroutput"><a class="link" href="circular_buffe_idp31480224.html" title="Class template circular_buffer_space_optimized">circular_buffer_space_optimized</a></code> the same way as in the <code class="computeroutput"><a class="link" href="circular_buffer.html" title="Class template circular_buffer">circular_buffer</a></code>. </li></ol></div> </div> <div class="refsect2"> <a name="idp146569248"></a><h3> <a name="boost.circular_buffe_idp31480224construct-copy-destruct"></a><code class="computeroutput">circular_buffer_space_optimized</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> <pre class="literallayout">explicit <a name="idp32214432-bb"></a>circular_buffer_space_optimized(const allocator_type & alloc = allocator_type()) noexcept;</pre>Create an empty space optimized circular buffer with zero capacity. Complexity. Constant. <div class="warning"><table border="0" summary="Warning"> <tr> <td rowspan="2" align="center" valign="top" width="25"><img alt="[Warning]" src="../../../doc/src/images/warning.png"></td> <th align="left">Warning</th> </tr> <tr><td align="left" valign="top">Since Boost version 1.36 the behaviour of this constructor has changed. Now it creates a space optimized circular buffer with zero capacity. </td></tr> </table></div> <div class="variablelist"><table border="0" class="variablelist compact"> <colgroup> <col align="left" valign="top"> <col> </colgroup> <tbody> <tr> <td>Parameters:</td> <td><div class="variablelist"><table border="0" class="variablelist compact"> <colgroup> <col align="left" valign="top"> <col> </colgroup> <tbody><tr> <td><code class="computeroutput">alloc</code></td> <td>The allocator. </td> </tr></tbody> </table></div></td> </tr> <tr> <td>Postconditions:</td> <td><code class="computeroutput">capacity().capacity() == 0 && capacity().min_capacity() == 0 && size() == 0</code> </td> </tr> <tr> <td>Throws:</td> <td>Nothing. </td> </tr> </tbody> </table></div> </li> <li class="listitem"> <pre class="literallayout">explicit <a name="idp32220448-bb"></a>circular_buffer_space_optimized(capacity_type capacity_ctrl, const allocator_type & alloc = allocator_type());</pre>Create an empty space optimized circular buffer with the specified capacity. Complexity. Constant. <div class="variablelist"><table border="0" class="variablelist compact"> <colgroup> <col align="left" valign="top"> <col> </colgroup> <tbody> <tr> <td>Parameters:</td> <td><div class="variablelist"><table border="0" class="variablelist compact"> <colgroup> <col align="left" valign="top"> <col> </colgroup> <tbody> <tr> <td><code class="computeroutput">alloc</code></td> <td>The allocator. </td> </tr> <tr> <td><code class="computeroutput">capacity_ctrl</code></td> <td>The capacity controller representing the ma