boost-react-native-bundle

<html> <head> <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> <title>Class template static_vector</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_container_header_reference.html#header.boost.container.static_vector_hpp" title="Header <boost/container/static_vector.hpp>"> <link rel="prev" href="stable_vector.html" title="Class template stable_vector"> <link rel="next" href="operator___idp41222992.html" title="Function template operator=="> </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="stable_vector.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_container_header_reference.html#header.boost.container.static_vector_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="operator___idp41222992.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> <a name="boost.container.static_vector"></a><div class="titlepage"></div> <div class="refnamediv"> <h2>Class template static_vector</h2> boost::container::static_vector — A variable-size array container with fixed capacity. </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_container_header_reference.html#header.boost.container.static_vector_hpp" title="Header <boost/container/static_vector.hpp>">boost/container/static_vector.hpp</a>> template<typename Value, std::size_t Capacity> class <a class="link" href="static_vector.html" title="Class template static_vector">static_vector</a> { public: // types typedef base_t::value_type <a name="boost.container.static_vector.value_type"></a>value_type; // The type of elements stored in the container. typedef base_t::size_type <a name="boost.container.static_vector.size_type"></a>size_type; // The unsigned integral type used by the container. typedef base_t::difference_type <a name="boost.container.static_vector.difference_type"></a>difference_type; // The pointers difference type. typedef base_t::pointer <a name="boost.container.static_vector.pointer"></a>pointer; // The pointer type. typedef base_t::const_pointer <a name="boost.container.static_vector.const_pointer"></a>const_pointer; // The const pointer type. typedef base_t::reference <a name="boost.container.static_vector.reference"></a>reference; // The value reference type. typedef base_t::const_reference <a name="boost.container.static_vector.const_reference"></a>const_reference; // The value const reference type. typedef base_t::iterator <a name="boost.container.static_vector.iterator"></a>iterator; // The iterator type. typedef base_t::const_iterator <a name="boost.container.static_vector.const_iterator"></a>const_iterator; // The const iterator type. typedef base_t::reverse_iterator <a name="boost.container.static_vector.reverse_iterator"></a>reverse_iterator; // The reverse iterator type. typedef base_t::const_reverse_iterator <a name="boost.container.static_vector.const_reverse_iterator"></a>const_reverse_iterator; // The const reverse iterator. // <a class="link" href="static_vector.html#boost.container.static_vectorconstruct-copy-destruct">construct/copy/destruct</a> <a class="link" href="static_vector.html#idp41099872-bb">static_vector</a>() noexcept; explicit <a class="link" href="static_vector.html#idp41103440-bb">static_vector</a>(size_type); <a class="link" href="static_vector.html#idp41108912-bb">static_vector</a>(size_type, <a class="link" href="default_init_t.html" title="Struct default_init_t">default_init_t</a>); <a class="link" href="static_vector.html#idp41115808-bb">static_vector</a>(size_type, value_type const &); template<typename Iterator> <a class="link" href="static_vector.html#idp41122144-bb">static_vector</a>(Iterator, Iterator); <a class="link" href="static_vector.html#idp41131872-bb">static_vector</a>(std::initializer_list< value_type >); <a class="link" href="static_vector.html#idp41138448-bb">static_vector</a>(<a class="link" href="static_vector.html" title="Class template static_vector">static_vector</a> const &); template<std::size_t C> <a class="link" href="static_vector.html#idp41144096-bb">static_vector</a>(<a class="link" href="static_vector.html" title="Class template static_vector">static_vector</a>< value_type, C > const &); <a class="link" href="static_vector.html#idp41151616-bb">static_vector</a>(<a class="link" href="static_vector.html" title="Class template static_vector">static_vector</a> &&); template<std::size_t C> <a class="link" href="static_vector.html#idp41160560-bb">static_vector</a>(<a class="link" href="static_vector.html" title="Class template static_vector">static_vector</a>< value_type, C > &&); <a class="link" href="static_vector.html" title="Class template static_vector">static_vector</a> & <a class="link" href="static_vector.html#idp41171200-bb">operator=</a>(const <a class="link" href="static_vector.html" title="Class template static_vector">static_vector</a> &); <a class="link" href="static_vector.html" title="Class template static_vector">static_vector</a> & <a class="link" href="static_vector.html#idp41177616-bb">operator=</a>(std::initializer_list< value_type >); template<std::size_t C> <a class="link" href="static_vector.html" title="Class template static_vector">static_vector</a> & <a class="link" href="static_vector.html#idp41182160-bb">operator=</a>(<a class="link" href="static_vector.html" title="Class template static_vector">static_vector</a>< value_type, C > const &); <a class="link" href="static_vector.html" title="Class template static_vector">static_vector</a> & <a class="link" href="static_vector.html#idp41190128-bb">operator=</a>(<a class="link" href="static_vector.html" title="Class template static_vector">static_vector</a> &&); template<std::size_t C> <a class="link" href="static_vector.html" title="Class template static_vector">static_vector</a> & <a class="link" href="static_vector.html#idp41199712-bb">operator=</a>(<a class="link" href="static_vector.html" title="Class template static_vector">static_vector</a>< value_type, C > &&); <a class="link" href="static_vector.html#idp41210992-bb">~static_vector</a>(); // <a class="link" href="static_vector.html#idp40819984-bb">public member functions</a> void <a class="link" href="static_vector.html#idp40820544-bb">swap</a>(<a class="link" href="static_vector.html" title="Class template static_vector">static_vector</a> &); template<std::size_t C> void <a class="link" href="static_vector.html#idp40830096-bb">swap</a>(<a class="link" href="static_vector.html" title="Class template static_vector">static_vector</a>< value_type, C > &); void <a class="link" href="static_vector.html#idp40841376-bb">resize</a>(size_type); void <a class="link" href="static_vector.html#idp40846464-bb">resize</a>(size_type, <a class="link" href="default_init_t.html" title="Struct default_init_t">default_init_t</a>); void <a class="link" href="static_vector.html#idp40853248-bb">resize</a>(size_type, value_type const &); void <a class="link" href="static_vector.html#idp40859472-bb">reserve</a>(size_type) noexcept; void <a class="link" href="static_vector.html#idp40864784-bb">push_back</a>(value_type const &); void <a class="link" href="static_vector.html#idp40869776-bb">push_back</a>(value_type &&); void <a class="link" href="static_vector.html#idp40874768-bb">pop_back</a>(); iterator <a class="link" href="static_vector.html#idp40878624-bb">insert</a>(const_iterator, value_type const &); iterator <a class="link" href="static_vector.html#idp40888880-bb">insert</a>(const_iterator, value_type &&); iterator <a class="link" href="static_vector.html#idp40897680-bb">insert</a>(const_iterator, size_type, value_type const &); template<typename Iterator> iterator <a class="link" href="static_vector.html#idp40909088-bb">insert</a>(const_iterator, Iterator, Iterator); iterator <a class="link" href="static_vector.html#idp40923824-bb">insert</a>(const_iterator, std::initializer_list< value_type >); iterator <a class="link" href="static_vector.html#idp40934048-bb">erase</a>(const_iterator); iterator <a class="link" href="static_vector.html#idp40939952-bb">erase</a>(const_iterator, const_iterator); template<typename Iterator> void <a class="link" href="static_vector.html#idp40948976-bb">assign</a>(Iterator, Iterator); void <a class="link" href="static_vector.html#idp40956544-bb">assign</a>(std::initializer_list< value_type >); void <a class="link" href="static_vector.html#idp40961600-bb">assign</a>(size_type, value_type const &); template<class... Args> void <a class="link" href="static_vector.html#idp40967792-bb">emplace_back</a>(Args &&...); template<class... Args> iterator <a class="link" href="static_vector.html#idp40974480-bb">emplace</a>(const_iterator, Args &&...); void <a class="link" href="static_vector.html#idp40984912-bb">clear</a>() noexcept; reference <a class="link" href="static_vector.html#idp40988336-bb">at</a>(size_type); const_reference <a class="link" href="static_vector.html#idp40994032-bb">at</a>(size_type) const; reference <a class="link" href="static_vector.html#idp41000032-bb">operator[]</a>(size_type); const_reference <a class="link" href="static_vector.html#idp41005440-bb">operator[]</a>(size_type) const; reference <a class="link" href="static_vector.html#idp41011152-bb">front</a>(); const_reference <a class="link" href="static_vector.html#idp41015632-bb">front</a>() const; reference <a class="link" href="static_vector.html#idp41020400-bb">back</a>(); const_reference <a class="link" href="static_vector.html#idp41024864-bb">back</a>() const; Value * <a class="link" href="static_vector.html#idp41029632-bb">data</a>() noexcept; const Value * <a class="link" href="static_vector.html#idp41033968-bb">data</a>() const noexcept; iterator <a class="link" href="static_vector.html#idp41038320-bb">begin</a>() noexcept; const_iterator <a class="link" href="static_vector.html#idp41042336-bb">begin</a>() const noexcept; const_iterator <a class="link" href="static_vector.html#idp41046384-bb">cbegin</a>() const noexcept; iterator <a class="link" href="static_vector.html#idp41050432-bb">end</a>() noexcept; const_iterator <a class="link" href="static_vector.html#idp41054496-bb">end</a>() const noexcept; const_iterator <a class="link" href="static_vector.html#idp41058576-bb">cend</a>() const noexcept; reverse_iterator <a class="link" href="static_vector.html#idp41062656-bb">rbegin</a>() noexcept; const_reverse_iterator <a class="link" href="static_vector.html#idp41067472-bb">rbegin</a>() const noexcept; const_reverse_iterator <a class="link" href="static_vector.html#idp41072288-bb">crbegin</a>() const noexcept; reverse_iterator <a class="link" href="static_vector.html#idp41077104-bb">rend</a>() noexcept; const_reverse_iterator <a class="link" href="static_vector.html#idp41081936-bb">rend</a>() const noexcept; const_reverse_iterator <a class="link" href="static_vector.html#idp41086784-bb">crend</a>() const noexcept; size_type <a class="link" href="static_vector.html#idp41091632-bb">size</a>() const noexcept; bool <a class="link" href="static_vector.html#idp41095648-bb">empty</a>() const noexcept; // <a class="link" href="static_vector.html#idp41213584-bb">public static functions</a> static size_type <a class="link" href="static_vector.html#idp41214144-bb">capacity</a>() noexcept; static size_type <a class="link" href="static_vector.html#idp41218400-bb">max_size</a>() noexcept; };</pre></div> <div class="refsect1"> <a name="idp171999168"></a><h2>Description</h2> <a class="link" href="static_vector.html" title="Class template static_vector">static_vector</a> is a sequence container like <a class="link" href="vector.html" title="Class template vector">boost::container::vector</a> with contiguous storage that can change in size, along with the static allocation, low overhead, and fixed capacity of boost::array. A <a class="link" href="static_vector.html" title="Class template static_vector">static_vector</a> is a sequence that supports random access to elements, constant time insertion and removal of elements at the end, and linear time insertion and removal of elements at the beginning or in the middle. The number of elements in a <a class="link" href="static_vector.html" title="Class template static_vector">static_vector</a> may vary dynamically up to a fixed capacity because elements are stored within the object itself similarly to an array. However, objects are initialized as they are inserted into <a class="link" href="static_vector.html" title="Class template static_vector">static_vector</a> unlike C arrays or std::array which must construct all elements on instantiation. The behavior of <a class="link" href="static_vector.html" title="Class template static_vector">static_vector</a> enables the use of statically allocated elements in cases with complex object lifetime requirements that would otherwise not be trivially possible. Error Handling. Insertion beyond the capacity result in throwing std::bad_alloc() if exceptions are enabled or calling throw_bad_alloc() if not enabled. std::out_of_range is thrown if out of bound access is performed in <code class="computeroutput">at()</code> if exceptions are enabled, throw_out_of_range() if not enabled. <div class="refsect2"> <a name="idp172008080"></a><h3>Template Parameters</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> <pre class="literallayout">typename Value</pre> The type of element that will be stored. </li> <li class="listitem"> <pre class="literallayout">std::size_t Capacity</pre> The maximum number of elements <code class="computeroutput"><a class="link" href="static_vector.html" title="Class template static_vector">static_vector</a></code> can store, fixed at compile time. </li> </ol></div> </div> <div class="refsect2"> <a name="idp172015632"></a><h3> <a name="boost.container.static_vectorconstruct-copy-destruct"></a><code class="computeroutput">static_vector</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> <pre class="literallayout"><a name="idp41099872-bb"></a>static_vector() noexcept;</pre>Constructs an empty <code class="computeroutput"><a class="link" href="static_vector.html" title="Class template static_vector">static_vector</a></code>. Throws. Nothing. Complexity. Constant O(1). </li> <li class="listitem"> <pre class="literallayout">explicit <a name="idp41103440-bb"></a>static_vector(size_type count);</pre>Constructs a <code class="computeroutput"><a class="link" href="static_vector.html" title="Class template static_vector">static_vector</a></code> containing count value initialized values. Throws. If Value's value initialization throws. Complexity. Linear O(N). <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">count</code></td> <td>The number of values which will be contained in the container.</td> </tr></tbody> </table></div></td> </tr> <tr> <td>Requires:</td> <td><code class="computeroutput">count <= capacity()</code></td> </tr> </tbody> </table></div> </li> <li class="listitem"> <pre class="literallayout"><a name="idp41108912-bb"></a>static_vector(size_type count, <a class="link" href="default_init_t.html" title="Struct default_init_t">default_init_t</a>);</pre>Constructs a <code class="computeroutput"><a class="link" href="static_vector.html" title="Class template static_vector">static_vector</a></code> containing count default initialized values. Throws. If Value's default initialization throws. Complexity. Linear O(N). Note. Non-standard extension <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">count</code></td> <td>The number of values which will be contained in the container.</td> </tr></tbody> </table></div></td> </tr> <tr> <td>Requires:</td> <td><code class="computeroutput">count <= capacity()</code></td> </tr> </tbody> </table></div> </li> <li class="listitem"> <pre class="literallayout"><a name="idp41115808-bb"></a>static_vector(size_type count, value_type const & value);</pre>Constructs a <code class="computeroutput"><a class="link" href="static_vector.html" title="Class template static_vector">static_vector</a></code> containing count copies of value. Throws. If Value's copy constructor throws. Complexity. Linear O(N). <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">count</code></td> <td>The number of copies of a values that will be contained in the container. </td> </tr> <tr> <td><code class="computeroutput">value</code></td> <td>The value which will be used to copy construct values.</td> </tr> </tbody> </table></div></td> </tr> <tr> <td>Requires:</td> <td><code class="computeroutput">count <= capacity()</code></td> </tr> </tbody> </table></div> </li> <li class="listitem"> <pre class="literallayout">template<typename Iterator> <a name="idp41122144-bb"></a>static_vector(Iterator first, Iterator last);</pre>Constructs a <code class="computeroutput"><a class="link" href="static_vector.html" title="Class template static_vector">static_vector</a></code> containing copy of a range <code class="computeroutput">[first, last)</code>. Throws. If Value's constructor taking a dereferenced Iterator throws. Complexity. Linear O(N). <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">first</code></td> <td>The iterator to the first element in range. </td> </tr> <tr> <td><code class="computeroutput">last</code></td> <td>The iterator to the one after the last element in range.</td> </tr> </tbody> </table></div></td> </tr> <tr> <td>Requires:</td> <td> <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> <li class="listitem"><code class="computeroutput">distance(first, last) <= capacity()</code> </li> <li class="listitem">Iterator must meet the <code class="computeroutput">ForwardTraversalIterator</code> concept.</li> </ul></div> </td> </tr> </tbody> </table></div> </li> <li class="listitem"> <pre class="literallayout"><a name="idp41131872-bb"></a>static_vector(std::initializer_list< value_type > il);</pre>Constructs a <code class="computeroutput"><a class="link" href="static_vector.html" title="Class template static_vector">static_vector</a></code> containing copy of a range <code class="computeroutput">[il.begin(), il.end())</code>. Throws. If Value's constructor taking a dereferenced std::initializer_list throws. Complexity. Linear O(N). <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">il</code></td> <td>std::initializer_list with values to initialize vector.</td> </tr></tbody> </table></div></td> </tr> <tr> <td>Requires:</td> <td> <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><code class="computeroutput">distance(il.begin(), il.end()) <= capacity()</code></li></ul></div> </td> </tr> </tbody> </table></div> </li> <li class="listitem"> <pre class="literallayout"><a name="idp41138448-bb"></a>static_vector(<a class="link" href="static_vector.html" title="Class template static_vector">static_vector</a> const & other);</pre>Constructs a copy of other <code class="computeroutput"><a class="link" href="static_vector.html" title="Class template static_vector">static_vector</a></code>. Throws. If Value's copy constructor throws. Complexity. Linear O(N). <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">other</code></td> <td>The <code class="computeroutput"><a class="link" href="static_vector.html" title="Class template static_vector">static_vector</a></code> which content will be copied to this one.</td> </tr></tbody> </table></div></td> </tr></tbody> </table></div> </li> <li class="listitem"> <pre class="literallayout">template<std::size_t C> <a name="idp41144096-bb"></a>static_vector(<a class="link" href="static_vector.html" title="Class template static_vector">static_vector</a>< value_type, C > const & other);</pre>Constructs a copy of other <code class="computeroutput"><a class="link" href="static_vector.html" title="Class template static_vector">static_vector</a></code>. Throws. If Value's copy constructor throws. Complexity. Linear O(N). <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">other</code></td> <td>The <code class="computeroutput"><a class="link" href="static_vector.html" title="Class template static_vector">static_vector</a></code> which content will be copied to this one.</td> </tr></tbody> </table></div></td> </tr> <tr> <td>Requires:</td> <td><code class="computeroutput">other.size() <= capacity()</code>.</td> </tr> </tbody> </table></div> </li> <li class="listitem"> <pre class="literallayout"><a name="idp41151616-bb"></a>static_vector(<a class="link" href="static_vector.html" title="Class template static_vector">static_vector</a> && other);</pre>Move constructor. Moves Values stored in the other <code class="computeroutput"><a class="link" href="static_vector.html" title="Class template static_vector">static_vector</a></code> to this one. Throws.  <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> <li class="listitem">If <code class="computeroutput">boost::has_nothrow_move<Value>::value</code> is <code class="computeroutput">true</code> and Value's move constructor throws. </li> <li class="listitem">If <code class="computeroutput">boost::has_nothrow_move<Value>::value</code> is <code class="computeroutput">false</code> and Value's copy constructor throws.</li> </ul></div> Complexity. Linear O(N). <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">other</code></td> <td>The <code class="computeroutput"><a class="link" href="static_vector.html" title="Class template static_vector">static_vector</a></code> which content will be moved to this one.</td> </tr></tbody> </table></div></td> </tr></tbody> </table></div> </li> <li class="listitem"> <pre class="literallayout">template<std::size_t C> <a name="idp41160560-bb"></a>static_vector(<a class="link" href="static_vector.html" title="Class template static_vector">static_vector</a>< value_type, C > &amp