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

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>boost::geometry::index::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__quadratic.html" title="boost::geometry::index::quadratic">
  10 <link rel="next" href="boost__geometry__index__dynamic_linear.html" title="boost::geometry::index::dynamic_linear">
  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__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="boost__geometry__index__dynamic_linear.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__rstar"></a><a name="structboost_1_1geometry_1_1index_1_1rstar"></a><a class="link" href="boost__geometry__index__rstar.html" title="boost::geometry::index::rstar">boost::geometry::index::rstar</a>
  28 </h5></div></div></div>
  29 <p>
  30             <a class="indexterm" name="idm46186977214064"></a><a class="indexterm" name="idm46186977213376"></a><a class="indexterm" name="idm46186977212688"></a><a class="indexterm" name="idm46186977212000"></a>
  31 R*-tree creation algorithm parameters.
  32           </p>
  33 <h6>
  34 <a name="geometry.reference.spatial_indexes.parameters.boost__geometry__index__rstar.h0"></a>
  35             <span class="phrase"><a name="geometry.reference.spatial_indexes.parameters.boost__geometry__index__rstar.header"></a></span><a class="link" href="boost__geometry__index__rstar.html#geometry.reference.spatial_indexes.parameters.boost__geometry__index__rstar.header">Header</a>
  36           </h6>
  37 <p>
  38             <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>
  39           </p>
  40 <h6>
  41 <a name="geometry.reference.spatial_indexes.parameters.boost__geometry__index__rstar.h1"></a>
  42             <span class="phrase"><a name="geometry.reference.spatial_indexes.parameters.boost__geometry__index__rstar.synopsis"></a></span><a class="link" href="boost__geometry__index__rstar.html#geometry.reference.spatial_indexes.parameters.boost__geometry__index__rstar.synopsis">Synopsis</a>
  43           </h6>
  44 <pre class="programlisting"><code class="computeroutput"><span class="keyword">template</span><span class="special">&lt;</span></code><code class="computeroutput"><span class="identifier">size_t</span> <span class="identifier">MaxElements</span></code><code class="computeroutput"><span class="special">,</span></code>
  45          <code class="computeroutput"><span class="identifier">size_t</span> <span class="identifier">MinElements</span></code> = <span class="emphasis"><em>default</em></span><code class="computeroutput"><span class="special">,</span></code>
  46          <code class="computeroutput"><span class="identifier">size_t</span> <span class="identifier">ReinsertedElements</span></code> = <span class="emphasis"><em>default</em></span><code class="computeroutput"><span class="special">,</span></code>
  47          <code class="computeroutput"><span class="identifier">size_t</span> <span class="identifier">OverlapCostThreshold</span></code> = <code class="computeroutput"><span class="number">32</span></code><code class="computeroutput"><span class="special">&gt;</span></code>
  48 <code class="computeroutput"><span class="keyword">struct</span> <span class="identifier">rstar</span></code>
  49 <code class="computeroutput"><span class="special">{</span></code>
  50 <code class="computeroutput">  <span class="comment">// ...</span></code>
  51 <code class="computeroutput"><span class="special">};</span></code>
  52 </pre>
  53 <h6>
  54 <a name="geometry.reference.spatial_indexes.parameters.boost__geometry__index__rstar.h2"></a>
  55             <span class="phrase"><a name="geometry.reference.spatial_indexes.parameters.boost__geometry__index__rstar.template_parameter_s_"></a></span><a class="link" href="boost__geometry__index__rstar.html#geometry.reference.spatial_indexes.parameters.boost__geometry__index__rstar.template_parameter_s_">Template
  56             parameter(s)</a>
  57           </h6>
  58 <div class="informaltable"><table class="table">
  59 <colgroup>
  60 <col>
  61 <col>
  62 </colgroup>
  63 <thead><tr>
  64 <th>
  65                     <p>
  66                       Parameter
  67                     </p>
  68                   </th>
  69 <th>
  70                     <p>
  71                       Description
  72                     </p>
  73                   </th>
  74 </tr></thead>
  75 <tbody>
  76 <tr>
  77 <td>
  78                     <p>
  79                       <code class="computeroutput"><span class="identifier">size_t</span> <span class="identifier">MaxElements</span></code>
  80                     </p>
  81                   </td>
  82 <td>
  83                     <p>
  84                       Maximum number of elements in nodes.
  85                     </p>
  86                   </td>
  87 </tr>
  88 <tr>
  89 <td>
  90                     <p>
  91                       <code class="computeroutput"><span class="identifier">size_t</span> <span class="identifier">MinElements</span></code>
  92                     </p>
  93                   </td>
  94 <td>
  95                     <p>
  96                       Minimum number of elements in nodes. Default: 0.3*Max.
  97                     </p>
  98                   </td>
  99 </tr>
 100 <tr>
 101 <td>
 102                     <p>
 103                       <code class="computeroutput"><span class="identifier">size_t</span> <span class="identifier">ReinsertedElements</span></code>
 104                     </p>
 105                   </td>
 106 <td>
 107                     <p>
 108                       The number of elements reinserted by forced reinsertions algorithm.
 109                       If 0 forced reinsertions are disabled. Maximum value is Max+1-Min.
 110                       Greater values are truncated. Default: 0.3*Max.
 111                     </p>
 112                   </td>
 113 </tr>
 114 <tr>
 115 <td>
 116                     <p>
 117                       <code class="computeroutput"><span class="identifier">size_t</span> <span class="identifier">OverlapCostThreshold</span></code>
 118                     </p>
 119                   </td>
 120 <td>
 121                     <p>
 122                       The number of most suitable leafs taken into account while
 123                       choosing the leaf node to which currently inserted value will
 124                       be added. If value is in range (0, MaxElements) - the algorithm
 125                       calculates nearly minimum overlap cost, otherwise all leafs
 126                       are analyzed and true minimum overlap cost is calculated. Default:
 127                       32.
 128                     </p>
 129                   </td>
 130 </tr>
 131 </tbody>
 132 </table></div>
 133 </div>
 134 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 135 <td align="left"></td>
 136 <td align="right"><div class="copyright-footer">Copyright &#169; 2009-2019 Barend Gehrels, Bruno Lalande, Mateusz Loskot, Adam
 137       Wulkiewicz, Oracle and/or its affiliates<p>
 138         Distributed under the Boost Software License, Version 1.0. (See accompanying
 139         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>)
 140       </p>
 141 </div></td>
 142 </tr></table>
 143 <hr>
 144 <div class="spirit-nav">
 145 <a accesskey="p" href="boost__geometry__index__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="boost__geometry__index__dynamic_linear.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
 146 </div>
 147 </body>
 148 </html>