libs/geometry/doc/html/geometry/reference/spatial_indexes/boost__geometry__index__rtree/rtree_range_const___.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>rtree(Range const &amp;)</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="../boost__geometry__index__rtree.html" title="boost::geometry::index::rtree">
   9 <link rel="prev" href="rtree_iterator__iterator_.html" title="rtree(Iterator, Iterator)">
  10 <link rel="next" href="_rtree__.html" title="~rtree()">
  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="rtree_iterator__iterator_.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../boost__geometry__index__rtree.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="_rtree__.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.boost__geometry__index__rtree.rtree_range_const___"></a><a name="classboost_1_1geometry_1_1index_1_1rtree_1a7b96b715c52ddc13d7a81db344825848"></a><a class="link" href="rtree_range_const___.html" title="rtree(Range const &amp;)">rtree(Range
  28           const &amp;)</a>
  29 </h5></div></div></div>
  30 <p>
  31             <a class="indexterm" name="idm46186980444912"></a>
  32 The constructor.
  33           </p>
  34 <h6>
  35 <a name="geometry.reference.spatial_indexes.boost__geometry__index__rtree.rtree_range_const___.h0"></a>
  36             <span class="phrase"><a name="geometry.reference.spatial_indexes.boost__geometry__index__rtree.rtree_range_const___.description"></a></span><a class="link" href="rtree_range_const___.html#geometry.reference.spatial_indexes.boost__geometry__index__rtree.rtree_range_const___.description">Description</a>
  37           </h6>
  38 <p>
  39             The tree is created using packing algorithm.
  40           </p>
  41 <h6>
  42 <a name="geometry.reference.spatial_indexes.boost__geometry__index__rtree.rtree_range_const___.h1"></a>
  43             <span class="phrase"><a name="geometry.reference.spatial_indexes.boost__geometry__index__rtree.rtree_range_const___.synopsis"></a></span><a class="link" href="rtree_range_const___.html#geometry.reference.spatial_indexes.boost__geometry__index__rtree.rtree_range_const___.synopsis">Synopsis</a>
  44           </h6>
  45 <pre class="programlisting"><code class="computeroutput"><span class="keyword">template</span><span class="special">&lt;</span></code><code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Range</span></code><code class="computeroutput"><span class="special">&gt;</span></code>
  46 <code class="computeroutput"><span class="identifier">rtree</span></code><code class="computeroutput"><span class="special">(</span></code><code class="computeroutput"><span class="identifier">Range</span> <span class="keyword">const</span> <span class="special">&amp;</span></code> <code class="computeroutput"><span class="identifier">rng</span></code><code class="computeroutput"><span class="special">,</span></code>
  47       <code class="literal"><a class="link" href="../boost__geometry__index__rtree.html#classboost_1_1geometry_1_1index_1_1rtree_1a80db5532eb59f7a809bd44ded265eb17">parameters_type</a></code><code class="computeroutput"> <span class="keyword">const</span> <span class="special">&amp;</span></code> <code class="computeroutput"><span class="identifier">parameters</span></code> = <code class="literal"><a class="link" href="../boost__geometry__index__rtree.html#classboost_1_1geometry_1_1index_1_1rtree_1a80db5532eb59f7a809bd44ded265eb17">parameters_type</a></code><code class="computeroutput"><span class="special">()</span></code><code class="computeroutput"><span class="special">,</span></code>
  48       <code class="literal"><a class="link" href="../boost__geometry__index__rtree.html#classboost_1_1geometry_1_1index_1_1rtree_1a43a7adb311cafc08e23010ccb4e97fb5">indexable_getter</a></code><code class="computeroutput"> <span class="keyword">const</span> <span class="special">&amp;</span></code> <code class="computeroutput"><span class="identifier">getter</span></code> = <code class="literal"><a class="link" href="../boost__geometry__index__rtree.html#classboost_1_1geometry_1_1index_1_1rtree_1a43a7adb311cafc08e23010ccb4e97fb5">indexable_getter</a></code><code class="computeroutput"><span class="special">()</span></code><code class="computeroutput"><span class="special">,</span></code>
  49       <code class="literal"><a class="link" href="../boost__geometry__index__rtree.html#classboost_1_1geometry_1_1index_1_1rtree_1ad8fe544de514014a1bd87ea1b881ff9b">value_equal</a></code><code class="computeroutput"> <span class="keyword">const</span> <span class="special">&amp;</span></code> <code class="computeroutput"><span class="identifier">equal</span></code> = <code class="literal"><a class="link" href="../boost__geometry__index__rtree.html#classboost_1_1geometry_1_1index_1_1rtree_1ad8fe544de514014a1bd87ea1b881ff9b">value_equal</a></code><code class="computeroutput"><span class="special">()</span></code><code class="computeroutput"><span class="special">,</span></code>
  50       <code class="literal"><a class="link" href="../boost__geometry__index__rtree.html#classboost_1_1geometry_1_1index_1_1rtree_1ab6618b5c7e88ed70533233fbac0f5b2e">allocator_type</a></code><code class="computeroutput"> <span class="keyword">const</span> <span class="special">&amp;</span></code> <code class="computeroutput"><span class="identifier">allocator</span></code> = <code class="literal"><a class="link" href="../boost__geometry__index__rtree.html#classboost_1_1geometry_1_1index_1_1rtree_1ab6618b5c7e88ed70533233fbac0f5b2e">allocator_type</a></code><code class="computeroutput"><span class="special">()</span></code><code class="computeroutput"><span class="special">)</span></code>
  51 </pre>
  52 <h6>
  53 <a name="geometry.reference.spatial_indexes.boost__geometry__index__rtree.rtree_range_const___.h2"></a>
  54             <span class="phrase"><a name="geometry.reference.spatial_indexes.boost__geometry__index__rtree.rtree_range_const___.modifier_s_"></a></span><a class="link" href="rtree_range_const___.html#geometry.reference.spatial_indexes.boost__geometry__index__rtree.rtree_range_const___.modifier_s_">Modifier(s)</a>
  55           </h6>
  56 <p>
  57 </p>
  58 <pre class="programlisting"><span class="keyword">explicit</span></pre>
  59 <p>
  60           </p>
  61 <h6>
  62 <a name="geometry.reference.spatial_indexes.boost__geometry__index__rtree.rtree_range_const___.h3"></a>
  63             <span class="phrase"><a name="geometry.reference.spatial_indexes.boost__geometry__index__rtree.rtree_range_const___.parameter_s_"></a></span><a class="link" href="rtree_range_const___.html#geometry.reference.spatial_indexes.boost__geometry__index__rtree.rtree_range_const___.parameter_s_">Parameter(s)</a>
  64           </h6>
  65 <div class="informaltable"><table class="table">
  66 <colgroup>
  67 <col>
  68 <col>
  69 <col>
  70 </colgroup>
  71 <thead><tr>
  72 <th>
  73                     <p>
  74                       Type
  75                     </p>
  76                   </th>
  77 <th>
  78                     <p>
  79                       Name
  80                     </p>
  81                   </th>
  82 <th>
  83                     <p>
  84                       Description
  85                     </p>
  86                   </th>
  87 </tr></thead>
  88 <tbody>
  89 <tr>
  90 <td>
  91                     <p>
  92                       <code class="computeroutput"><span class="identifier">Range</span> <span class="keyword">const</span>
  93                       <span class="special">&amp;</span></code>
  94                     </p>
  95                   </td>
  96 <td>
  97                     <p>
  98                       <code class="computeroutput"><span class="identifier">rng</span></code>
  99                     </p>
 100                   </td>
 101 <td>
 102                     <p>
 103                       The range of Values.
 104                     </p>
 105                   </td>
 106 </tr>
 107 <tr>
 108 <td>
 109                     <p>
 110                       <code class="literal"><a class="link" href="../boost__geometry__index__rtree.html#classboost_1_1geometry_1_1index_1_1rtree_1a80db5532eb59f7a809bd44ded265eb17">parameters_type</a></code><code class="computeroutput">
 111                       <span class="keyword">const</span> <span class="special">&amp;</span></code>
 112                     </p>
 113                   </td>
 114 <td>
 115                     <p>
 116                       <code class="computeroutput"><span class="identifier">parameters</span></code>
 117                     </p>
 118                   </td>
 119 <td>
 120                     <p>
 121                       The parameters object.
 122                     </p>
 123                   </td>
 124 </tr>
 125 <tr>
 126 <td>
 127                     <p>
 128                       <code class="literal"><a class="link" href="../boost__geometry__index__rtree.html#classboost_1_1geometry_1_1index_1_1rtree_1a43a7adb311cafc08e23010ccb4e97fb5">indexable_getter</a></code><code class="computeroutput">
 129                       <span class="keyword">const</span> <span class="special">&amp;</span></code>
 130                     </p>
 131                   </td>
 132 <td>
 133                     <p>
 134                       <code class="computeroutput"><span class="identifier">getter</span></code>
 135                     </p>
 136                   </td>
 137 <td>
 138                     <p>
 139                       The function object extracting Indexable from Value.
 140                     </p>
 141                   </td>
 142 </tr>
 143 <tr>
 144 <td>
 145                     <p>
 146                       <code class="literal"><a class="link" href="../boost__geometry__index__rtree.html#classboost_1_1geometry_1_1index_1_1rtree_1ad8fe544de514014a1bd87ea1b881ff9b">value_equal</a></code><code class="computeroutput">
 147                       <span class="keyword">const</span> <span class="special">&amp;</span></code>
 148                     </p>
 149                   </td>
 150 <td>
 151                     <p>
 152                       <code class="computeroutput"><span class="identifier">equal</span></code>
 153                     </p>
 154                   </td>
 155 <td>
 156                     <p>
 157                       The function object comparing Values.
 158                     </p>
 159                   </td>
 160 </tr>
 161 <tr>
 162 <td>
 163                     <p>
 164                       <code class="literal"><a class="link" href="../boost__geometry__index__rtree.html#classboost_1_1geometry_1_1index_1_1rtree_1ab6618b5c7e88ed70533233fbac0f5b2e">allocator_type</a></code><code class="computeroutput">
 165                       <span class="keyword">const</span> <span class="special">&amp;</span></code>
 166                     </p>
 167                   </td>
 168 <td>
 169                     <p>
 170                       <code class="computeroutput"><span class="identifier">allocator</span></code>
 171                     </p>
 172                   </td>
 173 <td>
 174                     <p>
 175                       The allocator object.
 176                     </p>
 177                   </td>
 178 </tr>
 179 </tbody>
 180 </table></div>
 181 <h6>
 182 <a name="geometry.reference.spatial_indexes.boost__geometry__index__rtree.rtree_range_const___.h4"></a>
 183             <span class="phrase"><a name="geometry.reference.spatial_indexes.boost__geometry__index__rtree.rtree_range_const___.throws"></a></span><a class="link" href="rtree_range_const___.html#geometry.reference.spatial_indexes.boost__geometry__index__rtree.rtree_range_const___.throws">Throws</a>
 184           </h6>
 185 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
 186 <li class="listitem">
 187                 If allocator copy constructor throws.
 188               </li>
 189 <li class="listitem">
 190                 If Value copy constructor or copy assignment throws.
 191               </li>
 192 <li class="listitem">
 193                 If allocation throws or returns invalid value.
 194               </li>
 195 </ul></div>
 196 </div>
 197 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 198 <td align="left"></td>
 199 <td align="right"><div class="copyright-footer">Copyright &#169; 2009-2019 Barend Gehrels, Bruno Lalande, Mateusz Loskot, Adam
 200       Wulkiewicz, Oracle and/or its affiliates<p>
 201         Distributed under the Boost Software License, Version 1.0. (See accompanying
 202         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>)
 203       </p>
 204 </div></td>
 205 </tr></table>
 206 <hr>
 207 <div class="spirit-nav">
 208 <a accesskey="p" href="rtree_iterator__iterator_.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../boost__geometry__index__rtree.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="_rtree__.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
 209 </div>
 210 </body>
 211 </html>