doc/html/boost/container/small_vector_base.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   5 <title>Class template small_vector_base</title>
   6 <link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
   7 <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
   8 <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
   9 <link rel="up" href="../../boost_container_header_reference.html#header.boost.container.small_vector_hpp" title="Header &lt;boost/container/small_vector.hpp&gt;">
  10 <link rel="prev" href="small_vector_allocator/rebind.html" title="Struct template rebind">
  11 <link rel="next" href="pmr/small_vector_of.html" title="Struct template small_vector_of">
  12 </head>
  13 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  14 <table cellpadding="2" width="100%"><tr>
  15 <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td>
  16 <td align="center"><a href="../../../../index.html">Home</a></td>
  17 <td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
  18 <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
  19 <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
  20 <td align="center"><a href="../../../../more/index.htm">More</a></td>
  21 </tr></table>
  22 <hr>
  23 <div class="spirit-nav">
  24 <a accesskey="p" href="small_vector_allocator/rebind.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_container_header_reference.html#header.boost.container.small_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="pmr/small_vector_of.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
  25 </div>
  26 <div class="refentry">
  27 <a name="boost.container.small_vector_base"></a><div class="titlepage"></div>
  28 <div class="refnamediv">
  29 <h2><span class="refentrytitle">Class template small_vector_base</span></h2>
  30 <p>boost::container::small_vector_base</p>
  31 </div>
  32 <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
  33 <div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: &lt;<a class="link" href="../../boost_container_header_reference.html#header.boost.container.small_vector_hpp" title="Header &lt;boost/container/small_vector.hpp&gt;">boost/container/small_vector.hpp</a>&gt;
  34
  35 </span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="keyword">typename</span> SecondaryAllocator<span class="special">,</span> <span class="keyword">typename</span> Options<span class="special">&gt;</span>
  36 <span class="keyword">class</span> <a class="link" href="small_vector_base.html" title="Class template small_vector_base">small_vector_base</a> <span class="special">:</span> <span class="keyword">public</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">container</span><span class="special">::</span><span class="identifier">vector</span><span class="special">&lt;</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">A</span><span class="special">,</span> <span class="identifier">Options</span> <span class="special">&gt;</span> <span class="special">{</span>
  37 <span class="keyword">public</span><span class="special">:</span>
  38   <span class="comment">// types</span>
  39   <span class="keyword">typedef</span> <span class="identifier">real_allocator</span><span class="special">&lt;</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">SecondaryAllocator</span> <span class="special">&gt;</span><span class="special">::</span><span class="identifier">type</span>                                           <a name="boost.container.small_vector_base.secondary_allocator_t"></a><span class="identifier">secondary_allocator_t</span><span class="special">;</span>
  40   <span class="keyword">typedef</span> <a class="link" href="allocator_traits.html" title="Struct template allocator_traits">allocator_traits</a><span class="special">&lt;</span> <span class="identifier">secondary_allocator_t</span> <span class="special">&gt;</span><span class="special">::</span><span class="keyword">template</span> <span class="identifier">portable_rebind_alloc</span><span class="special">&lt;</span> <span class="keyword">void</span> <span class="special">&gt;</span><span class="special">::</span><span class="identifier">type</span> <a name="boost.container.small_vector_base.void_allocator_t"></a><span class="identifier">void_allocator_t</span><span class="special">;</span>
  41   <span class="keyword">typedef</span> <a class="link" href="dtl/get_small_vector_opt.html" title="Struct template get_small_vector_opt">dtl::get_small_vector_opt</a><span class="special">&lt;</span> <span class="identifier">Options</span> <span class="special">&gt;</span><span class="special">::</span><span class="identifier">type</span>                                              <a name="boost.container.small_vector_base.options_t"></a><span class="identifier">options_t</span><span class="special">;</span>
  42   <span class="keyword">typedef</span> <a class="link" href="dtl/vector_for_small_vector.html" title="Struct template vector_for_small_vector">dtl::vector_for_small_vector</a><span class="special">&lt;</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">SecondaryAllocator</span><span class="special">,</span> <span class="identifier">Options</span> <span class="special">&gt;</span><span class="special">::</span><span class="identifier">type</span>                    <a name="boost.container.small_vector_base.base_type"></a><span class="identifier">base_type</span><span class="special">;</span>
  43   <span class="keyword">typedef</span> <a class="link" href="allocator_traits.html" title="Struct template allocator_traits">allocator_traits</a><span class="special">&lt;</span> <span class="identifier">secondary_allocator_t</span> <span class="special">&gt;</span><span class="special">::</span><span class="identifier">pointer</span>                                      <a name="boost.container.small_vector_base.pointer"></a><span class="identifier">pointer</span><span class="special">;</span>
  44   <span class="keyword">typedef</span> <a class="link" href="allocator_traits.html" title="Struct template allocator_traits">allocator_traits</a><span class="special">&lt;</span> <span class="identifier">secondary_allocator_t</span> <span class="special">&gt;</span><span class="special">::</span><span class="identifier">const_pointer</span>                                <a name="boost.container.small_vector_base.const_pointer"></a><span class="identifier">const_pointer</span><span class="special">;</span>
  45   <span class="keyword">typedef</span> <a class="link" href="allocator_traits.html" title="Struct template allocator_traits">allocator_traits</a><span class="special">&lt;</span> <span class="identifier">secondary_allocator_t</span> <span class="special">&gt;</span><span class="special">::</span><span class="identifier">void_pointer</span>                                 <a name="boost.container.small_vector_base.void_pointer"></a><span class="identifier">void_pointer</span><span class="special">;</span>
  46   <span class="keyword">typedef</span> <a class="link" href="allocator_traits.html" title="Struct template allocator_traits">allocator_traits</a><span class="special">&lt;</span> <span class="identifier">secondary_allocator_t</span> <span class="special">&gt;</span><span class="special">::</span><span class="identifier">const_void_pointer</span>                           <a name="boost.container.small_vector_base.const_void_pointer"></a><span class="identifier">const_void_pointer</span><span class="special">;</span>
  47   <span class="keyword">typedef</span> <a class="link" href="small_vector_allocator.html" title="Class template small_vector_allocator">small_vector_allocator</a><span class="special">&lt;</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">void_allocator_t</span><span class="special">,</span> <span class="identifier">Options</span> <span class="special">&gt;</span>                                  <a name="boost.container.small_vector_base.allocator_type"></a><span class="identifier">allocator_type</span><span class="special">;</span>
  48   <span class="keyword">typedef</span> <span class="identifier">dtl</span><span class="special">::</span><span class="identifier">aligned_storage</span><span class="special">&lt;</span> <span class="keyword">sizeof</span><span class="special">(</span><span class="identifier">T</span><span class="special">)</span><span class="special">,</span> <span class="identifier">final_alignment</span> <span class="special">&gt;</span><span class="special">::</span><span class="identifier">type</span>                                <a name="boost.container.small_vector_base.storage_type"></a><span class="identifier">storage_type</span><span class="special">;</span>
  49
  50   <span class="comment">// <a class="link" href="small_vector_base.html#boost.container.small_vector_baseconstruct-copy-destruct">construct/copy/destruct</a></span>
  51   <span class="keyword">explicit</span> <a class="link" href="small_vector_base.html#idm45666067719296-bb"><span class="identifier">small_vector_base</span></a><span class="special">(</span><span class="identifier">initial_capacity_t</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span><span class="special">)</span><span class="special">;</span>
  52   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> AllocFwd<span class="special">&gt;</span>
  53     <span class="keyword">explicit</span> <a class="link" href="small_vector_base.html#idm45666067717360-bb"><span class="identifier">small_vector_base</span></a><span class="special">(</span><span class="identifier">initial_capacity_t</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span><span class="special">,</span> <span class="identifier">AllocFwd</span> <span class="special">&amp;&amp;</span><span class="special">)</span><span class="special">;</span>
  54   <a class="link" href="small_vector_base.html" title="Class template small_vector_base">small_vector_base</a> <span class="special">&amp;</span> <a class="link" href="small_vector_base.html#idm45666067711344-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="small_vector_base.html" title="Class template small_vector_base">small_vector_base</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  55   <a class="link" href="small_vector_base.html" title="Class template small_vector_base">small_vector_base</a> <span class="special">&amp;</span> <a class="link" href="small_vector_base.html#idm45666067709344-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="small_vector_base.html" title="Class template small_vector_base">small_vector_base</a> <span class="special">&amp;&amp;</span><span class="special">)</span><span class="special">;</span>
  56
  57   <span class="comment">// <a class="link" href="small_vector_base.html#idm45666067725712-bb">private member functions</a></span>
  58   <span class="identifier">const_pointer</span> <a class="link" href="small_vector_base.html#idm45666067725136-bb"><span class="identifier">internal_storage</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span>
  59   <span class="identifier">pointer</span> <a class="link" href="small_vector_base.html#idm45666067724016-bb"><span class="identifier">internal_storage</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
  60   <a class="link" href="small_vector_base.html#boost.container.small_vector_base.base_type">base_type</a> <span class="special">&amp;</span> <a class="link" href="small_vector_base.html#idm45666067722896-bb"><span class="identifier">as_base</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  61   <span class="keyword">const</span> <a class="link" href="small_vector_base.html#boost.container.small_vector_base.base_type">base_type</a> <span class="special">&amp;</span> <a class="link" href="small_vector_base.html#idm45666067721760-bb"><span class="identifier">as_base</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  62
  63   <span class="comment">// <a class="link" href="small_vector_base.html#idm45666067713888-bb">public member functions</a></span>
  64   <span class="keyword">void</span> <a class="link" href="small_vector_base.html#idm45666067713328-bb"><span class="identifier">swap</span></a><span class="special">(</span><a class="link" href="small_vector_base.html" title="Class template small_vector_base">small_vector_base</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  65 <span class="special">}</span><span class="special">;</span></pre></div>
  66 <div class="refsect1">
  67 <a name="id-1.3.10.14.34.10.4"></a><h2>Description</h2>
  68 <p>This class consists of common code from all small_vector&lt;T, N&gt; types that don't depend on the "N" template parameter. This class is non-copyable and non-destructible, so this class typically used as reference argument to functions that read or write small vectors. Since <code class="computeroutput"><a class="link" href="small_vector.html" title="Class template small_vector">small_vector</a>&lt;T, N&gt;</code> derives from <code class="computeroutput"><a class="link" href="small_vector_base.html" title="Class template small_vector_base">small_vector_base</a>&lt;T&gt;</code>, the conversion to <code class="computeroutput"><a class="link" href="small_vector_base.html" title="Class template small_vector_base">small_vector_base</a></code> is implicit </p>
  69 <pre class="programlisting"><span class="comment">//Clients can pass any small_vector&lt;Foo, N&gt;.</span>
  70 <span class="keyword">void</span> <span class="identifier">read_any_small_vector_of_foo</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">small_vector_base</span><span class="special">&lt;</span><span class="identifier">Foo</span><span class="special">&gt;</span> <span class="special">&amp;</span><span class="identifier">in_parameter</span><span class="special">)</span><span class="special">;</span>
  71
  72 <span class="keyword">void</span> <span class="identifier">modify_any_small_vector_of_foo</span><span class="special">(</span><span class="identifier">small_vector_base</span><span class="special">&lt;</span><span class="identifier">Foo</span><span class="special">&gt;</span> <span class="special">&amp;</span><span class="identifier">in_out_parameter</span><span class="special">)</span><span class="special">;</span>
  73
  74 <span class="keyword">void</span> <span class="identifier">some_function</span><span class="special">(</span><span class="special">)</span>
  75 <span class="special">{</span>
  76
  77    <span class="identifier">small_vector</span><span class="special">&lt;</span><span class="identifier">Foo</span><span class="special">,</span> <span class="number">8</span><span class="special">&gt;</span> <span class="identifier">myvector</span><span class="special">;</span>
  78
  79    <span class="identifier">read_any_small_vector_of_foo</span><span class="special">(</span><span class="identifier">myvector</span><span class="special">)</span><span class="special">;</span>   <span class="comment">// Reads myvector</span>
  80
  81    <span class="identifier">modify_any_small_vector_of_foo</span><span class="special">(</span><span class="identifier">myvector</span><span class="special">)</span><span class="special">;</span> <span class="comment">// Modifies myvector</span>
  82
  83 <span class="special">}</span>
  84 </pre>
  85 <p>All <code class="computeroutput">boost::container:vector</code> member functions are inherited. See <code class="computeroutput">vector</code> documentation for details. </p>
  86 <div class="refsect2">
  87 <a name="id-1.3.10.14.34.10.4.5"></a><h3>
  88 <a name="boost.container.small_vector_baseconstruct-copy-destruct"></a><code class="computeroutput">small_vector_base</code>
  89         public
  90        construct/copy/destruct</h3>
  91 <div class="orderedlist"><ol class="orderedlist" type="1">
  92 <li class="listitem"><pre class="literallayout"><span class="keyword">explicit</span> <a name="idm45666067719296-bb"></a><span class="identifier">small_vector_base</span><span class="special">(</span><span class="identifier">initial_capacity_t</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> initial_capacity<span class="special">)</span><span class="special">;</span></pre></li>
  93 <li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> AllocFwd<span class="special">&gt;</span>
  94   <span class="keyword">explicit</span> <a name="idm45666067717360-bb"></a><span class="identifier">small_vector_base</span><span class="special">(</span><span class="identifier">initial_capacity_t</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> capacity<span class="special">,</span>
  95                              <span class="identifier">AllocFwd</span> <span class="special">&amp;&amp;</span> a<span class="special">)</span><span class="special">;</span></pre></li>
  96 <li class="listitem"><pre class="literallayout"><a class="link" href="small_vector_base.html" title="Class template small_vector_base">small_vector_base</a> <span class="special">&amp;</span> <a name="idm45666067711344-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="small_vector_base.html" title="Class template small_vector_base">small_vector_base</a> <span class="special">&amp;</span> other<span class="special">)</span><span class="special">;</span></pre></li>
  97 <li class="listitem"><pre class="literallayout"><a class="link" href="small_vector_base.html" title="Class template small_vector_base">small_vector_base</a> <span class="special">&amp;</span> <a name="idm45666067709344-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="small_vector_base.html" title="Class template small_vector_base">small_vector_base</a> <span class="special">&amp;&amp;</span> other<span class="special">)</span><span class="special">;</span></pre></li>
  98 </ol></div>
  99 </div>
 100 <div class="refsect2">
 101 <a name="id-1.3.10.14.34.10.4.6"></a><h3>
 102 <a name="idm45666067725712-bb"></a><code class="computeroutput">small_vector_base</code> private member functions</h3>
 103 <div class="orderedlist"><ol class="orderedlist" type="1">
 104 <li class="listitem"><pre class="literallayout"><span class="identifier">const_pointer</span> <a name="idm45666067725136-bb"></a><span class="identifier">internal_storage</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre></li>
 105 <li class="listitem"><pre class="literallayout"><span class="identifier">pointer</span> <a name="idm45666067724016-bb"></a><span class="identifier">internal_storage</span><span class="special">(</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre></li>
 106 <li class="listitem"><pre class="literallayout"><a class="link" href="small_vector_base.html#boost.container.small_vector_base.base_type">base_type</a> <span class="special">&amp;</span> <a name="idm45666067722896-bb"></a><span class="identifier">as_base</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li>
 107 <li class="listitem"><pre class="literallayout"><span class="keyword">const</span> <a class="link" href="small_vector_base.html#boost.container.small_vector_base.base_type">base_type</a> <span class="special">&amp;</span> <a name="idm45666067721760-bb"></a><span class="identifier">as_base</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
 108 </ol></div>
 109 </div>
 110 <div class="refsect2">
 111 <a name="id-1.3.10.14.34.10.4.7"></a><h3>
 112 <a name="idm45666067713888-bb"></a><code class="computeroutput">small_vector_base</code> public member functions</h3>
 113 <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="idm45666067713328-bb"></a><span class="identifier">swap</span><span class="special">(</span><a class="link" href="small_vector_base.html" title="Class template small_vector_base">small_vector_base</a> <span class="special">&amp;</span> other<span class="special">)</span><span class="special">;</span></pre></li></ol></div>
 114 </div>
 115 </div>
 116 </div>
 117 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 118 <td align="left"></td>
 119 <td align="right"><div class="copyright-footer">Copyright &#169; 2009-2018 Ion Gaztanaga<p>
 120         Distributed under the Boost Software License, Version 1.0. (See accompanying
 121         file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
 122       </p>
 123 </div></td>
 124 </tr></table>
 125 <hr>
 126 <div class="spirit-nav">
 127 <a accesskey="p" href="small_vector_allocator/rebind.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_container_header_reference.html#header.boost.container.small_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="pmr/small_vector_of.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
 128 </div>
 129 </body>
 130 </html>