summaryrefslogtreecommitdiff
path: root/libs/geometry/doc/html/geometry/reference/spatial_indexes/group__rtree__functions.html
blob: 028d291dfa7a34a252af90a70a08da3aee34ed15 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>R-tree free functions (boost::geometry::index::)</title>
<link rel="stylesheet" href="../../../../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="../../../index.html" title="Chapter&#160;1.&#160;Geometry">
<link rel="up" href="../spatial_indexes.html" title="Spatial Indexes">
<link rel="prev" href="boost__geometry__index__rtree/get_allocator__.html" title="get_allocator()">
<link rel="next" href="group__rtree__functions/insert_rtree_________value_const___.html" title="insert(rtree&lt;...&gt; &amp;, Value const &amp;)">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../boost.png"></td>
<td align="center"><a href="../../../../../../../index.html">Home</a></td>
<td align="center"><a href="../../../../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="boost__geometry__index__rtree/get_allocator__.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../spatial_indexes.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="group__rtree__functions/insert_rtree_________value_const___.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="geometry.reference.spatial_indexes.group__rtree__functions"></a><a class="link" href="group__rtree__functions.html" title="R-tree free functions (boost::geometry::index::)">R-tree
        free functions (boost::geometry::index::)</a>
</h4></div></div></div>
<div class="toc"><dl class="toc">
<dt><span class="section"><a href="group__rtree__functions/insert_rtree_________value_const___.html">insert(rtree&lt;...&gt;
          &amp;, Value const &amp;)</a></span></dt>
<dt><span class="section"><a href="group__rtree__functions/insert_rtree_________iterator__iterator_.html">insert(rtree&lt;...&gt;
          &amp;, Iterator, Iterator)</a></span></dt>
<dt><span class="section"><a href="group__rtree__functions/insert_rtree_________convertibleorrange_const___.html">insert(rtree&lt;...&gt;
          &amp;, ConvertibleOrRange const &amp;)</a></span></dt>
<dt><span class="section"><a href="group__rtree__functions/remove_rtree_________value_const___.html">remove(rtree&lt;...&gt;
          &amp;, Value const &amp;)</a></span></dt>
<dt><span class="section"><a href="group__rtree__functions/remove_rtree_________iterator__iterator_.html">remove(rtree&lt;...&gt;
          &amp;, Iterator, Iterator)</a></span></dt>
<dt><span class="section"><a href="group__rtree__functions/remove_rtree_________convertibleorrange_const___.html">remove(rtree&lt;...&gt;
          &amp;, ConvertibleOrRange const &amp;)</a></span></dt>
<dt><span class="section"><a href="group__rtree__functions/query_rtree______const____predicates_const____outiter_.html">query(rtree&lt;...&gt;
          const &amp;, Predicates const &amp;, OutIter)</a></span></dt>
<dt><span class="section"><a href="group__rtree__functions/qbegin_rtree______const____predicates_const___.html">qbegin(rtree&lt;...&gt;
          const &amp;, Predicates const &amp;)</a></span></dt>
<dt><span class="section"><a href="group__rtree__functions/qend_rtree______const___.html">qend(rtree&lt;...&gt;
          const &amp;)</a></span></dt>
<dt><span class="section"><a href="group__rtree__functions/clear_rtree________.html">clear(rtree&lt;...&gt;
          &amp;)</a></span></dt>
<dt><span class="section"><a href="group__rtree__functions/size_rtree______const___.html">size(rtree&lt;...&gt;
          const &amp;)</a></span></dt>
<dt><span class="section"><a href="group__rtree__functions/empty_rtree______const___.html">empty(rtree&lt;...&gt;
          const &amp;)</a></span></dt>
<dt><span class="section"><a href="group__rtree__functions/bounds_rtree______const___.html">bounds(rtree&lt;...&gt;
          const &amp;)</a></span></dt>
<dt><span class="section"><a href="group__rtree__functions/swap_rtree_________rtree________.html">swap(rtree&lt;...&gt;
          &amp;, rtree&lt;...&gt; &amp;)</a></span></dt>
</dl></div>
<h6>
<a name="geometry.reference.spatial_indexes.group__rtree__functions.h0"></a>
          <span class="phrase"><a name="geometry.reference.spatial_indexes.group__rtree__functions.functions"></a></span><a class="link" href="group__rtree__functions.html#geometry.reference.spatial_indexes.group__rtree__functions.functions">Functions</a>
        </h6>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
                  <p>
                    Function
                  </p>
                </th>
<th>
                  <p>
                    Description
                  </p>
                </th>
</tr></thead>
<tbody>
<tr>
<td>
                  <p>
                    <a class="link" href="group__rtree__functions/insert_rtree_________value_const___.html#group__rtree__functions_1gada4f62111ed22eb2860ea30995c1ce60"><code class="computeroutput"><span class="identifier">insert</span><span class="special">(</span><span class="identifier">rtree</span><span class="special">&lt;...&gt;</span>
                    <span class="special">&amp;,</span> <span class="identifier">Value</span>
                    <span class="keyword">const</span> <span class="special">&amp;)</span></code></a>
                  </p>
                </td>
<td>
                  <p>
                    Insert a value to the index.
                  </p>
                </td>
</tr>
<tr>
<td>
                  <p>
                    <a class="link" href="group__rtree__functions/insert_rtree_________iterator__iterator_.html#group__rtree__functions_1ga056469ea699e609e67762fe1b789997f"><code class="computeroutput"><span class="identifier">insert</span><span class="special">(</span><span class="identifier">rtree</span><span class="special">&lt;...&gt;</span>
                    <span class="special">&amp;,</span> <span class="identifier">Iterator</span><span class="special">,</span> <span class="identifier">Iterator</span><span class="special">)</span></code></a>
                  </p>
                </td>
<td>
                  <p>
                    Insert a range of values to the index.
                  </p>
                </td>
</tr>
<tr>
<td>
                  <p>
                    <a class="link" href="group__rtree__functions/insert_rtree_________convertibleorrange_const___.html#group__rtree__functions_1gab4edad000d63eb103f2dad3813ceb2b3"><code class="computeroutput"><span class="identifier">insert</span><span class="special">(</span><span class="identifier">rtree</span><span class="special">&lt;...&gt;</span>
                    <span class="special">&amp;,</span> <span class="identifier">ConvertibleOrRange</span>
                    <span class="keyword">const</span> <span class="special">&amp;)</span></code></a>
                  </p>
                </td>
<td>
                  <p>
                    Insert a value created using convertible object or a range of
                    values to the index.
                  </p>
                </td>
</tr>
<tr>
<td>
                  <p>
                    <a class="link" href="group__rtree__functions/remove_rtree_________value_const___.html#group__rtree__functions_1gaf353d90fd933e6110b031f63166fb45a"><code class="computeroutput"><span class="identifier">remove</span><span class="special">(</span><span class="identifier">rtree</span><span class="special">&lt;...&gt;</span>
                    <span class="special">&amp;,</span> <span class="identifier">Value</span>
                    <span class="keyword">const</span> <span class="special">&amp;)</span></code></a>
                  </p>
                </td>
<td>
                  <p>
                    Remove a value from the container.
                  </p>
                </td>
</tr>
<tr>
<td>
                  <p>
                    <a class="link" href="group__rtree__functions/remove_rtree_________iterator__iterator_.html#group__rtree__functions_1gaa460a8985496cf133f63f245527ac6e7"><code class="computeroutput"><span class="identifier">remove</span><span class="special">(</span><span class="identifier">rtree</span><span class="special">&lt;...&gt;</span>
                    <span class="special">&amp;,</span> <span class="identifier">Iterator</span><span class="special">,</span> <span class="identifier">Iterator</span><span class="special">)</span></code></a>
                  </p>
                </td>
<td>
                  <p>
                    Remove a range of values from the container.
                  </p>
                </td>
</tr>
<tr>
<td>
                  <p>
                    <a class="link" href="group__rtree__functions/remove_rtree_________convertibleorrange_const___.html#group__rtree__functions_1ga700c922f8b4d5ebd073e999e12b55249"><code class="computeroutput"><span class="identifier">remove</span><span class="special">(</span><span class="identifier">rtree</span><span class="special">&lt;...&gt;</span>
                    <span class="special">&amp;,</span> <span class="identifier">ConvertibleOrRange</span>
                    <span class="keyword">const</span> <span class="special">&amp;)</span></code></a>
                  </p>
                </td>
<td>
                  <p>
                    Remove a value corresponding to an object convertible to it or
                    a range of values from the container.
                  </p>
                </td>
</tr>
<tr>
<td>
                  <p>
                    <a class="link" href="group__rtree__functions/query_rtree______const____predicates_const____outiter_.html#group__rtree__functions_1gadb43b211d5d743ebe2ef256328286e95"><code class="computeroutput"><span class="identifier">query</span><span class="special">(</span><span class="identifier">rtree</span><span class="special">&lt;...&gt;</span>
                    <span class="keyword">const</span> <span class="special">&amp;,</span>
                    <span class="identifier">Predicates</span> <span class="keyword">const</span>
                    <span class="special">&amp;,</span> <span class="identifier">OutIter</span><span class="special">)</span></code></a>
                  </p>
                </td>
<td>
                  <p>
                    Finds values meeting passed predicates e.g. nearest to some Point
                    and/or intersecting some Box.
                  </p>
                </td>
</tr>
<tr>
<td>
                  <p>
                    <a class="link" href="group__rtree__functions/qbegin_rtree______const____predicates_const___.html#group__rtree__functions_1ga45c2b7b112bf730d10367e10df62aa3c"><code class="computeroutput"><span class="identifier">qbegin</span><span class="special">(</span><span class="identifier">rtree</span><span class="special">&lt;...&gt;</span>
                    <span class="keyword">const</span> <span class="special">&amp;,</span>
                    <span class="identifier">Predicates</span> <span class="keyword">const</span>
                    <span class="special">&amp;)</span></code></a>
                  </p>
                </td>
<td>
                  <p>
                    Returns the query iterator pointing at the begin of the query
                    range.
                  </p>
                </td>
</tr>
<tr>
<td>
                  <p>
                    <a class="link" href="group__rtree__functions/qend_rtree______const___.html#group__rtree__functions_1ga5c9a1eb0421bf2c702392247d48143e5"><code class="computeroutput"><span class="identifier">qend</span><span class="special">(</span><span class="identifier">rtree</span><span class="special">&lt;...&gt;</span>
                    <span class="keyword">const</span> <span class="special">&amp;)</span></code></a>
                  </p>
                </td>
<td>
                  <p>
                    Returns the query iterator pointing at the end of the query range.
                  </p>
                </td>
</tr>
<tr>
<td>
                  <p>
                    <a class="link" href="group__rtree__functions/clear_rtree________.html#group__rtree__functions_1gabaca6c24c3838a8164aa3700c459e7a4"><code class="computeroutput"><span class="identifier">clear</span><span class="special">(</span><span class="identifier">rtree</span><span class="special">&lt;...&gt;</span>
                    <span class="special">&amp;)</span></code></a>
                  </p>
                </td>
<td>
                  <p>
                    Remove all values from the index.
                  </p>
                </td>
</tr>
<tr>
<td>
                  <p>
                    <a class="link" href="group__rtree__functions/size_rtree______const___.html#group__rtree__functions_1gaa19a09e7b5f0a86a4b74ef2342de1d68"><code class="computeroutput"><span class="identifier">size</span><span class="special">(</span><span class="identifier">rtree</span><span class="special">&lt;...&gt;</span>
                    <span class="keyword">const</span> <span class="special">&amp;)</span></code></a>
                  </p>
                </td>
<td>
                  <p>
                    Get the number of values stored in the index.
                  </p>
                </td>
</tr>
<tr>
<td>
                  <p>
                    <a class="link" href="group__rtree__functions/empty_rtree______const___.html#group__rtree__functions_1gaba44e2fb12fdc7b528bfee56a88e0844"><code class="computeroutput"><span class="identifier">empty</span><span class="special">(</span><span class="identifier">rtree</span><span class="special">&lt;...&gt;</span>
                    <span class="keyword">const</span> <span class="special">&amp;)</span></code></a>
                  </p>
                </td>
<td>
                  <p>
                    Query if there are no values stored in the index.
                  </p>
                </td>
</tr>
<tr>
<td>
                  <p>
                    <a class="link" href="group__rtree__functions/bounds_rtree______const___.html#group__rtree__functions_1ga4e43e7720c66e88959ff511a7462a3ff"><code class="computeroutput"><span class="identifier">bounds</span><span class="special">(</span><span class="identifier">rtree</span><span class="special">&lt;...&gt;</span>
                    <span class="keyword">const</span> <span class="special">&amp;)</span></code></a>
                  </p>
                </td>
<td>
                  <p>
                    Get the box containing all stored values or an invalid box if
                    the index has no values.
                  </p>
                </td>
</tr>
<tr>
<td>
                  <p>
                    <a class="link" href="group__rtree__functions/swap_rtree_________rtree________.html#group__rtree__functions_1gaa1250318a78d7e27ba8f3537eb0ddb3f"><code class="computeroutput"><span class="identifier">swap</span><span class="special">(</span><span class="identifier">rtree</span><span class="special">&lt;...&gt;</span>
                    <span class="special">&amp;,</span> <span class="identifier">rtree</span><span class="special">&lt;...&gt;</span> <span class="special">&amp;)</span></code></a>
                  </p>
                </td>
<td>
                  <p>
                    Exchanges the contents of the container with those of other.
                  </p>
                </td>
</tr>
</tbody>
</table></div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright &#169; 2009-2015 Barend Gehrels, Bruno Lalande,
      Mateusz Loskot, Adam Wulkiewicz, Oracle and/or its affiliates<p>
        Distributed under the Boost Software License, Version 1.0. (See accompanying
        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>)
      </p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="boost__geometry__index__rtree/get_allocator__.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../spatial_indexes.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="group__rtree__functions/insert_rtree_________value_const___.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>