summaryrefslogtreecommitdiff
path: root/doc/html/boost/container/growth_factor.html
blob: b80b884302fb214f4db27e5d6a8b8b4f8c3291c7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Struct template growth_factor</title>
<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.79.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.options_hpp" title="Header &lt;boost/container/options.hpp&gt;">
<link rel="prev" href="growth_factor_100.html" title="Struct growth_factor_100">
<link rel="next" href="stored_size.html" title="Struct template stored_size">
</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="growth_factor_100.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_container_header_reference.html#header.boost.container.options_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="stored_size.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="refentry">
<a name="boost.container.growth_factor"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Struct template growth_factor</span></h2>
<p>boost::container::growth_factor &#8212; defined(BOOST_CONTAINER_DOXYGEN_INVOKED) </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: &lt;<a class="link" href="../../boost_container_header_reference.html#header.boost.container.options_hpp" title="Header &lt;boost/container/options.hpp&gt;">boost/container/options.hpp</a>&gt;

</span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> GrowthFactor<span class="special">&gt;</span> 
<span class="keyword">struct</span> <a class="link" href="growth_factor.html" title="Struct template growth_factor">growth_factor</a> <span class="special">{</span>
<span class="special">}</span><span class="special">;</span></pre></div>
<div class="refsect1">
<a name="id-1.3.10.15.19.9.4"></a><h2>Description</h2>
<p>This option setter specifies the growth factor strategy of the underlying vector.</p>
<p>
Predefined growth factors that can be passed as arguments to this option are: <code class="computeroutput"><a class="link" href="growth_factor_50.html" title="Struct growth_factor_50">boost::container::growth_factor_50</a></code> <code class="computeroutput"><a class="link" href="growth_factor_60.html" title="Struct growth_factor_60">boost::container::growth_factor_60</a></code> <code class="computeroutput"><a class="link" href="growth_factor_100.html" title="Struct growth_factor_100">boost::container::growth_factor_100</a></code> </p>
<p>If this option is not specified, a default will be used by the container. </p>
<div class="refsect2">
<a name="id-1.3.10.15.19.9.4.5"></a><h3>Template Parameters</h3>
<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
<pre class="literallayout"><span class="keyword">typename</span> GrowthFactor</pre>
<p>A function object that has the following signature:<br>
<br>
 <code class="computeroutput">template&lt;class SizeType&gt;</code><br>
 <code class="computeroutput">SizeType operator()(SizeType cur_cap, SizeType add_min_cap, SizeType max_cap) const;</code>.<br>
<br>
 <code class="computeroutput">cur_cap</code> is the current capacity, <code class="computeroutput">add_min_cap</code> is the minimum additional capacity we want to achieve and <code class="computeroutput">max_cap</code> is the maximum capacity that the allocator or other factors allow. The implementation should return a value between <code class="computeroutput">cur_cap</code> + <code class="computeroutput">add_min_cap</code> and <code class="computeroutput">max_cap</code>. <code class="computeroutput">cur_cap</code> + <code class="computeroutput">add_min_cap</code> is guaranteed not to overflow/wraparound, but the implementation should handle wraparound produced by the growth factor.</p>
</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 &#169; 2009-2017 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="growth_factor_100.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_container_header_reference.html#header.boost.container.options_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="stored_size.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>