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