libs/geometry/doc/html/geometry/reference/spatial_indexes/parameters/boost__geometry__index__dynamic_rstar.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>boost::geometry::index::dynamic_rstar</title>
   5 <link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
   7 <link rel="home" href="../../../../index.html" title="Chapter&#160;1.&#160;Geometry">
   8 <link rel="up" href="../parameters.html" title="R-tree parameters (boost::geometry::index::)">
   9 <link rel="prev" href="boost__geometry__index__dynamic_quadratic.html" title="boost::geometry::index::dynamic_quadratic">
  10 <link rel="next" href="../observers.html" title="Observers (boost::geometry::index::)">
  11 </head>
  12 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  13 <table cellpadding="2" width="100%"><tr>
  14 <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td>
  15 <td align="center"><a href="../../../../../../../../index.html">Home</a></td>
  16 <td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td>
  17 <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
  18 <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
  19 <td align="center"><a href="../../../../../../../../more/index.htm">More</a></td>
  20 </tr></table>
  21 <hr>
  22 <div class="spirit-nav">
  23 <a accesskey="p" href="boost__geometry__index__dynamic_quadratic.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../parameters.html"><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="../observers.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="section">
  26 <div class="titlepage"><div><div><h5 class="title">
  27 <a name="geometry.reference.spatial_indexes.parameters.boost__geometry__index__dynamic_rstar"></a><a name="classboost_1_1geometry_1_1index_1_1dynamic__rstar"></a><a class="link" href="boost__geometry__index__dynamic_rstar.html" title="boost::geometry::index::dynamic_rstar">boost::geometry::index::dynamic_rstar</a>
  28 </h5></div></div></div>
  29 <div class="toc"><dl class="toc"><dt><span class="section"><a href="boost__geometry__index__dynamic_rstar.html#geometry.reference.spatial_indexes.parameters.boost__geometry__index__dynamic_rstar.dynamic_rstar_size_t_">dynamic_rstar(size_t)</a></span></dt></dl></div>
  30 <p>
  31             <a class="indexterm" name="idm46186976992992"></a><a class="indexterm" name="idm46186976992304"></a><a class="indexterm" name="idm46186976991616"></a><a class="indexterm" name="idm46186976990928"></a>
  32 R*-tree creation algorithm parameters - run-time version.
  33           </p>
  34 <h6>
  35 <a name="geometry.reference.spatial_indexes.parameters.boost__geometry__index__dynamic_rstar.h0"></a>
  36             <span class="phrase"><a name="geometry.reference.spatial_indexes.parameters.boost__geometry__index__dynamic_rstar.header"></a></span><a class="link" href="boost__geometry__index__dynamic_rstar.html#geometry.reference.spatial_indexes.parameters.boost__geometry__index__dynamic_rstar.header">Header</a>
  37           </h6>
  38 <p>
  39             <code class="computeroutput"><span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">geometry</span><span class="special">/</span><span class="identifier">index</span><span class="special">/</span><span class="identifier">parameters</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span></code>
  40           </p>
  41 <h6>
  42 <a name="geometry.reference.spatial_indexes.parameters.boost__geometry__index__dynamic_rstar.h1"></a>
  43             <span class="phrase"><a name="geometry.reference.spatial_indexes.parameters.boost__geometry__index__dynamic_rstar.synopsis"></a></span><a class="link" href="boost__geometry__index__dynamic_rstar.html#geometry.reference.spatial_indexes.parameters.boost__geometry__index__dynamic_rstar.synopsis">Synopsis</a>
  44           </h6>
  45 <pre class="programlisting"><code class="computeroutput"><span class="keyword">class</span> <span class="identifier">dynamic_rstar</span></code>
  46 <code class="computeroutput"><span class="special">{</span></code>
  47 <code class="computeroutput">  <span class="comment">// ...</span></code>
  48 <code class="computeroutput"><span class="special">};</span></code>
  49 </pre>
  50 <h6>
  51 <a name="geometry.reference.spatial_indexes.parameters.boost__geometry__index__dynamic_rstar.h2"></a>
  52             <span class="phrase"><a name="geometry.reference.spatial_indexes.parameters.boost__geometry__index__dynamic_rstar.constructor_s__and_destructor"></a></span><a class="link" href="boost__geometry__index__dynamic_rstar.html#geometry.reference.spatial_indexes.parameters.boost__geometry__index__dynamic_rstar.constructor_s__and_destructor">Constructor(s)
  53             and destructor</a>
  54           </h6>
  55 <div class="informaltable"><table class="table">
  56 <colgroup>
  57 <col>
  58 <col>
  59 </colgroup>
  60 <thead><tr>
  61 <th>
  62                     <p>
  63                       Function
  64                     </p>
  65                   </th>
  66 <th>
  67                     <p>
  68                       Description
  69                     </p>
  70                   </th>
  71 </tr></thead>
  72 <tbody><tr>
  73 <td>
  74                     <p>
  75                       <a class="link" href="boost__geometry__index__dynamic_rstar.html#classboost_1_1geometry_1_1index_1_1dynamic__rstar_1ad5115c769752603a179bf158f02fdb1c"><code class="computeroutput"><span class="identifier">dynamic_rstar</span><span class="special">(</span><span class="identifier">size_t</span><span class="special">)</span></code></a>
  76                     </p>
  77                   </td>
  78 <td>
  79                     <p>
  80                       The constructor.
  81                     </p>
  82                   </td>
  83 </tr></tbody>
  84 </table></div>
  85 <div class="section">
  86 <div class="titlepage"><div><div><h6 class="title">
  87 <a name="geometry.reference.spatial_indexes.parameters.boost__geometry__index__dynamic_rstar.dynamic_rstar_size_t_"></a><a name="classboost_1_1geometry_1_1index_1_1dynamic__rstar_1ad5115c769752603a179bf158f02fdb1c"></a><a class="link" href="boost__geometry__index__dynamic_rstar.html#geometry.reference.spatial_indexes.parameters.boost__geometry__index__dynamic_rstar.dynamic_rstar_size_t_" title="dynamic_rstar(size_t)">dynamic_rstar(size_t)</a>
  88 </h6></div></div></div>
  89 <p>
  90               <a class="indexterm" name="idm46186976954400"></a>
  91 The constructor.
  92             </p>
  93 <h7><a name="geometry.reference.spatial_indexes.parameters.boost__geometry__index__dynamic_rstar.dynamic_rstar_size_t_.h0"></a>
  94               <span class="phrase"><a name="geometry.reference.spatial_indexes.parameters.boost__geometry__index__dynamic_rstar.dynamic_rstar_size_t_.synopsis"></a></span><a class="link" href="boost__geometry__index__dynamic_rstar.html#geometry.reference.spatial_indexes.parameters.boost__geometry__index__dynamic_rstar.dynamic_rstar_size_t_.synopsis">Synopsis</a>
  95             </h7><pre class="programlisting"><code class="computeroutput"><span class="identifier">dynamic_rstar</span></code><code class="computeroutput"><span class="special">(</span></code><code class="computeroutput"><span class="identifier">size_t</span></code> <code class="computeroutput"><span class="identifier">max_elements</span></code><code class="computeroutput"><span class="special">,</span></code>
  96               <code class="computeroutput"><span class="identifier">size_t</span></code> <code class="computeroutput"><span class="identifier">min_elements</span></code> = <span class="emphasis"><em>default</em></span><code class="computeroutput"><span class="special">,</span></code>
  97               <code class="computeroutput"><span class="identifier">size_t</span></code> <code class="computeroutput"><span class="identifier">reinserted_elements</span></code> = <span class="emphasis"><em>default</em></span><code class="computeroutput"><span class="special">,</span></code>
  98               <code class="computeroutput"><span class="identifier">size_t</span></code> <code class="computeroutput"><span class="identifier">overlap_cost_threshold</span></code> = <code class="computeroutput"><span class="number">32</span></code><code class="computeroutput"><span class="special">)</span></code>
  99 </pre>
 100 <h7><a name="geometry.reference.spatial_indexes.parameters.boost__geometry__index__dynamic_rstar.dynamic_rstar_size_t_.h1"></a>
 101               <span class="phrase"><a name="geometry.reference.spatial_indexes.parameters.boost__geometry__index__dynamic_rstar.dynamic_rstar_size_t_.modifier_s_"></a></span><a class="link" href="boost__geometry__index__dynamic_rstar.html#geometry.reference.spatial_indexes.parameters.boost__geometry__index__dynamic_rstar.dynamic_rstar_size_t_.modifier_s_">Modifier(s)</a>
 102             </h7><p>
 103 </p>
 104 <pre class="programlisting"><span class="keyword">explicit</span></pre>
 105 <p>
 106             </p>
 107 <h7><a name="geometry.reference.spatial_indexes.parameters.boost__geometry__index__dynamic_rstar.dynamic_rstar_size_t_.h2"></a>
 108               <span class="phrase"><a name="geometry.reference.spatial_indexes.parameters.boost__geometry__index__dynamic_rstar.dynamic_rstar_size_t_.parameter_s_"></a></span><a class="link" href="boost__geometry__index__dynamic_rstar.html#geometry.reference.spatial_indexes.parameters.boost__geometry__index__dynamic_rstar.dynamic_rstar_size_t_.parameter_s_">Parameter(s)</a>
 109             </h7><div class="informaltable"><table class="table">
 110 <colgroup>
 111 <col>
 112 <col>
 113 <col>
 114 </colgroup>
 115 <thead><tr>
 116 <th>
 117                       <p>
 118                         Type
 119                       </p>
 120                     </th>
 121 <th>
 122                       <p>
 123                         Name
 124                       </p>
 125                     </th>
 126 <th>
 127                       <p>
 128                         Description
 129                       </p>
 130                     </th>
 131 </tr></thead>
 132 <tbody>
 133 <tr>
 134 <td>
 135                       <p>
 136                         <code class="computeroutput"><span class="identifier">size_t</span></code>
 137                       </p>
 138                     </td>
 139 <td>
 140                       <p>
 141                         <code class="computeroutput"><span class="identifier">max_elements</span></code>
 142                       </p>
 143                     </td>
 144 <td>
 145                       <p>
 146                         Maximum number of elements in nodes.
 147                       </p>
 148                     </td>
 149 </tr>
 150 <tr>
 151 <td>
 152                       <p>
 153                         <code class="computeroutput"><span class="identifier">size_t</span></code>
 154                       </p>
 155                     </td>
 156 <td>
 157                       <p>
 158                         <code class="computeroutput"><span class="identifier">min_elements</span></code>
 159                       </p>
 160                     </td>
 161 <td>
 162                       <p>
 163                         Minimum number of elements in nodes. Default: 0.3*Max.
 164                       </p>
 165                     </td>
 166 </tr>
 167 <tr>
 168 <td>
 169                       <p>
 170                         <code class="computeroutput"><span class="identifier">size_t</span></code>
 171                       </p>
 172                     </td>
 173 <td>
 174                       <p>
 175                         <code class="computeroutput"><span class="identifier">reinserted_elements</span></code>
 176                       </p>
 177                     </td>
 178 <td>
 179                       <p>
 180                         The number of elements reinserted by forced reinsertions
 181                         algorithm. If 0 forced reinsertions are disabled. Maximum
 182                         value is Max-Min+1. Greater values are truncated. Default:
 183                         0.3*Max.
 184                       </p>
 185                     </td>
 186 </tr>
 187 <tr>
 188 <td>
 189                       <p>
 190                         <code class="computeroutput"><span class="identifier">size_t</span></code>
 191                       </p>
 192                     </td>
 193 <td>
 194                       <p>
 195                         <code class="computeroutput"><span class="identifier">overlap_cost_threshold</span></code>
 196                       </p>
 197                     </td>
 198 <td>
 199                       <p>
 200                         The number of most suitable leafs taken into account while
 201                         choosing the leaf node to which currently inserted value
 202                         will be added. If value is in range (0, MaxElements) - the
 203                         algorithm calculates nearly minimum overlap cost, otherwise
 204                         all leafs are analyzed and true minimum overlap cost is calculated.
 205                         Default: 32.
 206                       </p>
 207                     </td>
 208 </tr>
 209 </tbody>
 210 </table></div>
 211 </div>
 212 </div>
 213 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 214 <td align="left"></td>
 215 <td align="right"><div class="copyright-footer">Copyright &#169; 2009-2019 Barend Gehrels, Bruno Lalande, Mateusz Loskot, Adam
 216       Wulkiewicz, Oracle and/or its affiliates<p>
 217         Distributed under the Boost Software License, Version 1.0. (See accompanying
 218         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>)
 219       </p>
 220 </div></td>
 221 </tr></table>
 222 <hr>
 223 <div class="spirit-nav">
 224 <a accesskey="p" href="boost__geometry__index__dynamic_quadratic.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../parameters.html"><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="../observers.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
 225 </div>
 226 </body>
 227 </html>