diff options
Diffstat (limited to 'doc/html/boost/container/small_vector.html')
| -rw-r--r-- | doc/html/boost/container/small_vector.html | 120 |
1 files changed, 120 insertions, 0 deletions
diff --git a/doc/html/boost/container/small_vector.html b/doc/html/boost/container/small_vector.html new file mode 100644 index 0000000000..42b3fa6f4c --- /dev/null +++ b/doc/html/boost/container/small_vector.html @@ -0,0 +1,120 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Class template small_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.small_vector_hpp" title="Header <boost/container/small_vector.hpp>"> +<link rel="prev" href="slist.html" title="Class template slist"> +<link rel="next" href="small_vector_allocator.html" title="Class template small_vector_allocator"> +</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="slist.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="small_vector_allocator.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.container.small_vector"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Class template small_vector</span></h2> +<p>boost::container::small_vector</p> +</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"><span class="comment">// In header: <<a class="link" href="../../boost_container_header_reference.html#header.boost.container.small_vector_hpp" title="Header <boost/container/small_vector.hpp>">boost/container/small_vector.hpp</a>> + +</span><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> N<span class="special">,</span> <span class="keyword">typename</span> Allocator <span class="special">=</span> <a class="link" href="new_allocator.html" title="Class template new_allocator">new_allocator</a><span class="special"><</span><span class="identifier">T</span><span class="special">></span> <span class="special">></span> +<span class="keyword">class</span> <a class="link" href="small_vector.html" title="Class template small_vector">small_vector</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">small_vector_base</span><span class="special"><</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">Allocator</span> <span class="special">></span> +<span class="special">{</span> +<span class="keyword">public</span><span class="special">:</span> + <span class="comment">// <a class="link" href="small_vector.html#boost.container.small_vectorconstruct-copy-destruct">construct/copy/destruct</a></span> + <a class="link" href="small_vector.html#idp31177840-bb"><span class="identifier">small_vector</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">explicit</span> <a class="link" href="small_vector.html#idp31178128-bb"><span class="identifier">small_vector</span></a><span class="special">(</span><span class="identifier">size_type</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">explicit</span> <a class="link" href="small_vector.html#idp31179376-bb"><span class="identifier">small_vector</span></a><span class="special">(</span><span class="keyword">const</span> allocator_type <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="small_vector.html#idp31181072-bb"><span class="identifier">small_vector</span></a><span class="special">(</span><span class="identifier">size_type</span><span class="special">,</span> <span class="keyword">const</span> allocator_type <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="small_vector.html#idp31183184-bb"><span class="identifier">small_vector</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="small_vector.html" title="Class template small_vector">small_vector</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="small_vector.html#idp31184608-bb"><span class="identifier">small_vector</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="small_vector.html" title="Class template small_vector">small_vector</a> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> allocator_type <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="small_vector.html#idp31187168-bb"><span class="identifier">small_vector</span></a><span class="special">(</span><a class="link" href="small_vector.html" title="Class template small_vector">small_vector</a> <span class="special">&&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="small_vector.html#idp31188432-bb"><span class="identifier">small_vector</span></a><span class="special">(</span><a class="link" href="small_vector.html" title="Class template small_vector">small_vector</a> <span class="special">&&</span><span class="special">,</span> <span class="keyword">const</span> allocator_type <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="small_vector.html#idp31190832-bb"><span class="identifier">small_vector</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">initializer_list</span><span class="special"><</span> <span class="identifier">value_type</span> <span class="special">></span><span class="special">,</span> + <span class="keyword">const</span> allocator_type <span class="special">&</span> <span class="special">=</span> <a class="link" href="small_vector_allocator.html" title="Class template small_vector_allocator">allocator_type</a><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="small_vector.html" title="Class template small_vector">small_vector</a> <span class="special">&</span> <a class="link" href="small_vector.html#idp31193840-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.html" title="Class template small_vector">small_vector</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="small_vector.html" title="Class template small_vector">small_vector</a> <span class="special">&</span> <a class="link" href="small_vector.html#idp31195840-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="small_vector.html" title="Class template small_vector">small_vector</a> <span class="special">&&</span><span class="special">)</span><span class="special">;</span> + + <span class="comment">// <a class="link" href="small_vector.html#idp31175296-bb">public member functions</a></span> + <span class="keyword">void</span> <a class="link" href="small_vector.html#idp31175856-bb"><span class="identifier">swap</span></a><span class="special">(</span><a class="link" href="small_vector.html" title="Class template small_vector">small_vector</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> +<span class="special">}</span><span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="idp162636832"></a><h2>Description</h2> +<p><a class="link" href="small_vector.html" title="Class template small_vector">small_vector</a> a vector-like container optimized for the case when it contains few elements. It contains some preallocated elements in-place, which allows it to avoid the use of dynamic storage allocation when the actual number of elements is below that preallocated threshold.</p> +<p><code class="computeroutput"><a class="link" href="small_vector.html" title="Class template small_vector">small_vector</a><T, N, Allocator></code> is convertible to <code class="computeroutput"><a class="link" href="small_vector_base.html" title="Class template small_vector_base">small_vector_base</a><T, Allocator></code> that is independent from the preallocated element capacity, so client code does not need to be templated on that N argument.</p> +<p>All <code class="computeroutput"><a class="link" href="vector.html" title="Class template vector">boost::container::vector</a></code> member functions are inherited. See <code class="computeroutput">vector</code> documentation for details.</p> +<p> +</p> +<div class="refsect2"> +<a name="idp162644096"></a><h3>Template Parameters</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">typename</span> T</pre> +<p>The type of object that is stored in the <code class="computeroutput"><a class="link" href="small_vector.html" title="Class template small_vector">small_vector</a></code> </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> N</pre> +<p>The number of preallocated elements stored inside <code class="computeroutput"><a class="link" href="small_vector.html" title="Class template small_vector">small_vector</a></code>. It shall be less than Allocator::max_size(); </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">typename</span> Allocator <span class="special">=</span> <a class="link" href="new_allocator.html" title="Class template new_allocator">new_allocator</a><span class="special"><</span><span class="identifier">T</span><span class="special">></span></pre> +<p>The allocator used for memory management when the number of elements exceeds N. </p> +</li> +</ol></div> +</div> +<div class="refsect2"> +<a name="idp162658080"></a><h3> +<a name="boost.container.small_vectorconstruct-copy-destruct"></a><code class="computeroutput">small_vector</code> + public + construct/copy/destruct</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"> +<li class="listitem"><pre class="literallayout"><a name="idp31177840-bb"></a><span class="identifier">small_vector</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><span class="keyword">explicit</span> <a name="idp31178128-bb"></a><span class="identifier">small_vector</span><span class="special">(</span><span class="identifier">size_type</span> n<span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><span class="keyword">explicit</span> <a name="idp31179376-bb"></a><span class="identifier">small_vector</span><span class="special">(</span><span class="keyword">const</span> allocator_type <span class="special">&</span> a<span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><a name="idp31181072-bb"></a><span class="identifier">small_vector</span><span class="special">(</span><span class="identifier">size_type</span> n<span class="special">,</span> <span class="keyword">const</span> allocator_type <span class="special">&</span> a<span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><a name="idp31183184-bb"></a><span class="identifier">small_vector</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="small_vector.html" title="Class template small_vector">small_vector</a> <span class="special">&</span> other<span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><a name="idp31184608-bb"></a><span class="identifier">small_vector</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="small_vector.html" title="Class template small_vector">small_vector</a> <span class="special">&</span> other<span class="special">,</span> <span class="keyword">const</span> allocator_type <span class="special">&</span> a<span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><a name="idp31187168-bb"></a><span class="identifier">small_vector</span><span class="special">(</span><a class="link" href="small_vector.html" title="Class template small_vector">small_vector</a> <span class="special">&&</span> other<span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><a name="idp31188432-bb"></a><span class="identifier">small_vector</span><span class="special">(</span><a class="link" href="small_vector.html" title="Class template small_vector">small_vector</a> <span class="special">&&</span> other<span class="special">,</span> <span class="keyword">const</span> allocator_type <span class="special">&</span> a<span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><a name="idp31190832-bb"></a><span class="identifier">small_vector</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">initializer_list</span><span class="special"><</span> <span class="identifier">value_type</span> <span class="special">></span> il<span class="special">,</span> + <span class="keyword">const</span> allocator_type <span class="special">&</span> a <span class="special">=</span> <a class="link" href="small_vector_allocator.html" title="Class template small_vector_allocator">allocator_type</a><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><a class="link" href="small_vector.html" title="Class template small_vector">small_vector</a> <span class="special">&</span> <a name="idp31193840-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.html" title="Class template small_vector">small_vector</a> <span class="special">&</span> other<span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><a class="link" href="small_vector.html" title="Class template small_vector">small_vector</a> <span class="special">&</span> <a name="idp31195840-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="small_vector.html" title="Class template small_vector">small_vector</a> <span class="special">&&</span> other<span class="special">)</span><span class="special">;</span></pre></li> +</ol></div> +</div> +<div class="refsect2"> +<a name="idp162734272"></a><h3> +<a name="idp31175296-bb"></a><code class="computeroutput">small_vector</code> public member functions</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="idp31175856-bb"></a><span class="identifier">swap</span><span class="special">(</span><a class="link" href="small_vector.html" title="Class template small_vector">small_vector</a> <span class="special">&</span> other<span class="special">)</span><span class="special">;</span></pre></li></ol></div> +</div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2009-2013 Ion Gaztanaga<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + 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>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="slist.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="small_vector_allocator.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> |