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=UTF-8"> 5<title>Struct template growth_factor</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.options_hpp" title="Header <boost/container/options.hpp>"> 10<link rel="prev" href="deque_options.html" title="Struct template deque_options"> 11<link rel="next" href="growth_factor_100.html" title="Struct growth_factor_100"> 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="deque_options.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="growth_factor_100.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> 25</div> 26<div class="refentry"> 27<a name="boost.container.growth_factor"></a><div class="titlepage"></div> 28<div class="refnamediv"> 29<h2><span class="refentrytitle">Struct template growth_factor</span></h2> 30<p>boost::container::growth_factor — defined(BOOST_CONTAINER_DOXYGEN_INVOKED) </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: <<a class="link" href="../../boost_container_header_reference.html#header.boost.container.options_hpp" title="Header <boost/container/options.hpp>">boost/container/options.hpp</a>> 34 35</span><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> GrowthFactor<span class="special">></span> 36<span class="keyword">struct</span> <a class="link" href="growth_factor.html" title="Struct template growth_factor">growth_factor</a> <span class="special">{</span> 37<span class="special">}</span><span class="special">;</span></pre></div> 38<div class="refsect1"> 39<a name="id-1.3.10.14.19.6.4"></a><h2>Description</h2> 40<p>This option setter specifies the growth factor strategy of the underlying vector.</p> 41<p> 42Predefined 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> 43<p>If this option is not specified, a default will be used by the container. </p> 44<div class="refsect2"> 45<a name="id-1.3.10.14.19.6.4.5"></a><h3>Template Parameters</h3> 46<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> 47<pre class="literallayout"><span class="keyword">typename</span> GrowthFactor</pre> 48<p>A function object that has the following signature:<br> 49<br> 50 <code class="computeroutput">template<class SizeType></code><br> 51 <code class="computeroutput">SizeType operator()(SizeType cur_cap, SizeType add_min_cap, SizeType max_cap) const;</code>.<br> 52<br> 53 <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> 54</li></ol></div> 55</div> 56</div> 57</div> 58<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 59<td align="left"></td> 60<td align="right"><div class="copyright-footer">Copyright © 2009-2018 Ion Gaztanaga<p> 61 Distributed under the Boost Software License, Version 1.0. (See accompanying 62 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>) 63 </p> 64</div></td> 65</tr></table> 66<hr> 67<div class="spirit-nav"> 68<a accesskey="p" href="deque_options.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="growth_factor_100.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> 69</div> 70</body> 71</html> 72
