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

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>rtree()</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="../boost__geometry__index__rtree.html" title="boost::geometry::index::rtree">
  10 <link rel="next" href="rtree_parameters_type_const____indexable_getter_const____value_equal_const____allocator_type_const___.html" title="rtree(parameters_type const &amp;, indexable_getter const &amp;, value_equal const &amp;, allocator_type const &amp;)">
  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__rtree.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_parameters_type_const____indexable_getter_const____value_equal_const____allocator_type_const___.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__"></a><a name="classboost_1_1geometry_1_1index_1_1rtree_1a55d5fd5d205df08db5267253689ccf0c"></a><a class="link" href="rtree__.html" title="rtree()">rtree()</a>
  28 </h5></div></div></div>
  29 <p>
  30             <a class="indexterm" name="idm46186980694480"></a>
  31 The constructor.
  32           </p>
  33 <h6>
  34 <a name="geometry.reference.spatial_indexes.boost__geometry__index__rtree.rtree__.h0"></a>
  35             <span class="phrase"><a name="geometry.reference.spatial_indexes.boost__geometry__index__rtree.rtree__.synopsis"></a></span><a class="link" href="rtree__.html#geometry.reference.spatial_indexes.boost__geometry__index__rtree.rtree__.synopsis">Synopsis</a>
  36           </h6>
  37 <pre class="programlisting"><code class="computeroutput"><span class="identifier">rtree</span></code><code class="computeroutput"><span class="special">(</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="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>
  38       <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>
  39       <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>
  40 </pre>
  41 <h6>
  42 <a name="geometry.reference.spatial_indexes.boost__geometry__index__rtree.rtree__.h1"></a>
  43             <span class="phrase"><a name="geometry.reference.spatial_indexes.boost__geometry__index__rtree.rtree__.modifier_s_"></a></span><a class="link" href="rtree__.html#geometry.reference.spatial_indexes.boost__geometry__index__rtree.rtree__.modifier_s_">Modifier(s)</a>
  44           </h6>
  45 <p>
  46 </p>
  47 <pre class="programlisting"><span class="keyword">explicit</span></pre>
  48 <p>
  49           </p>
  50 <h6>
  51 <a name="geometry.reference.spatial_indexes.boost__geometry__index__rtree.rtree__.h2"></a>
  52             <span class="phrase"><a name="geometry.reference.spatial_indexes.boost__geometry__index__rtree.rtree__.parameter_s_"></a></span><a class="link" href="rtree__.html#geometry.reference.spatial_indexes.boost__geometry__index__rtree.rtree__.parameter_s_">Parameter(s)</a>
  53           </h6>
  54 <div class="informaltable"><table class="table">
  55 <colgroup>
  56 <col>
  57 <col>
  58 <col>
  59 </colgroup>
  60 <thead><tr>
  61 <th>
  62                     <p>
  63                       Type
  64                     </p>
  65                   </th>
  66 <th>
  67                     <p>
  68                       Name
  69                     </p>
  70                   </th>
  71 <th>
  72                     <p>
  73                       Description
  74                     </p>
  75                   </th>
  76 </tr></thead>
  77 <tbody>
  78 <tr>
  79 <td>
  80                     <p>
  81                       <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">
  82                       <span class="keyword">const</span> <span class="special">&amp;</span></code>
  83                     </p>
  84                   </td>
  85 <td>
  86                     <p>
  87                       <code class="computeroutput"><span class="identifier">parameters</span></code>
  88                     </p>
  89                   </td>
  90 <td>
  91                     <p>
  92                       The parameters object.
  93                     </p>
  94                   </td>
  95 </tr>
  96 <tr>
  97 <td>
  98                     <p>
  99                       <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">
 100                       <span class="keyword">const</span> <span class="special">&amp;</span></code>
 101                     </p>
 102                   </td>
 103 <td>
 104                     <p>
 105                       <code class="computeroutput"><span class="identifier">getter</span></code>
 106                     </p>
 107                   </td>
 108 <td>
 109                     <p>
 110                       The function object extracting Indexable from Value.
 111                     </p>
 112                   </td>
 113 </tr>
 114 <tr>
 115 <td>
 116                     <p>
 117                       <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">
 118                       <span class="keyword">const</span> <span class="special">&amp;</span></code>
 119                     </p>
 120                   </td>
 121 <td>
 122                     <p>
 123                       <code class="computeroutput"><span class="identifier">equal</span></code>
 124                     </p>
 125                   </td>
 126 <td>
 127                     <p>
 128                       The function object comparing Values.
 129                     </p>
 130                   </td>
 131 </tr>
 132 </tbody>
 133 </table></div>
 134 <h6>
 135 <a name="geometry.reference.spatial_indexes.boost__geometry__index__rtree.rtree__.h3"></a>
 136             <span class="phrase"><a name="geometry.reference.spatial_indexes.boost__geometry__index__rtree.rtree__.throws"></a></span><a class="link" href="rtree__.html#geometry.reference.spatial_indexes.boost__geometry__index__rtree.rtree__.throws">Throws</a>
 137           </h6>
 138 <p>
 139             If allocator default constructor throws.
 140           </p>
 141 </div>
 142 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 143 <td align="left"></td>
 144 <td align="right"><div class="copyright-footer">Copyright &#169; 2009-2019 Barend Gehrels, Bruno Lalande, Mateusz Loskot, Adam
 145       Wulkiewicz, Oracle and/or its affiliates<p>
 146         Distributed under the Boost Software License, Version 1.0. (See accompanying
 147         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>)
 148       </p>
 149 </div></td>
 150 </tr></table>
 151 <hr>
 152 <div class="spirit-nav">
 153 <a accesskey="p" href="../boost__geometry__index__rtree.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_parameters_type_const____indexable_getter_const____value_equal_const____allocator_type_const___.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
 154 </div>
 155 </body>
 156 </html>