• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html>
2<head>
3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
4<title>remove(rtree&lt;...&gt; &amp;, 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="../group__rtree__functions.html" title="R-tree free functions (boost::geometry::index::)">
9<link rel="prev" href="remove_rtree_________value_const___.html" title="remove(rtree&lt;...&gt; &amp;, Value const &amp;)">
10<link rel="next" href="remove_rtree_________convertibleorrange_const___.html" title="remove(rtree&lt;...&gt; &amp;, ConvertibleOrRange 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="remove_rtree_________value_const___.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../group__rtree__functions.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="remove_rtree_________convertibleorrange_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.group__rtree__functions.remove_rtree_________iterator__iterator_"></a><a name="group__rtree__functions_1gaa460a8985496cf133f63f245527ac6e7"></a><a class="link" href="remove_rtree_________iterator__iterator_.html" title="remove(rtree&lt;...&gt; &amp;, Iterator, Iterator)">remove(rtree&lt;...&gt;
28          &amp;, Iterator, Iterator)</a>
29</h5></div></div></div>
30<p>
31            <a class="indexterm" name="idm45635674674928"></a>
32Remove a range of values from the container.
33          </p>
34<h6>
35<a name="geometry.reference.spatial_indexes.group__rtree__functions.remove_rtree_________iterator__iterator_.h0"></a>
36            <span class="phrase"><a name="geometry.reference.spatial_indexes.group__rtree__functions.remove_rtree_________iterator__iterator_.description"></a></span><a class="link" href="remove_rtree_________iterator__iterator_.html#geometry.reference.spatial_indexes.group__rtree__functions.remove_rtree_________iterator__iterator_.description">Description</a>
37          </h6>
38<p>
39            Remove a range of values from the container. In contrast to the <code class="literal"><code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">set</span></code></code> or <code class="literal"><code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">map</span> <span class="identifier">erase</span><span class="special">()</span></code></code> method it doesn't take iterators
40            pointing to values stored in this container. It removes values equal
41            to these passed as a range. Furthermore this function removes only one
42            value for each one passed in the range, not all equal values.
43          </p>
44<p>
45            It calls <code class="literal"><a class="link" href="../boost__geometry__index__rtree/remove_iterator__iterator_.html#classboost_1_1geometry_1_1index_1_1rtree_1aa97084231d17564a94f0142d095cecaa">rtree::remove(Iterator,
46            Iterator)</a></code>.
47          </p>
48<h6>
49<a name="geometry.reference.spatial_indexes.group__rtree__functions.remove_rtree_________iterator__iterator_.h1"></a>
50            <span class="phrase"><a name="geometry.reference.spatial_indexes.group__rtree__functions.remove_rtree_________iterator__iterator_.synopsis"></a></span><a class="link" href="remove_rtree_________iterator__iterator_.html#geometry.reference.spatial_indexes.group__rtree__functions.remove_rtree_________iterator__iterator_.synopsis">Synopsis</a>
51          </h6>
52<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">Value</span></code><code class="computeroutput"><span class="special">,</span></code>
53         <code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Parameters</span></code><code class="computeroutput"><span class="special">,</span></code>
54         <code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">IndexableGetter</span></code><code class="computeroutput"><span class="special">,</span></code>
55         <code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">EqualTo</span></code><code class="computeroutput"><span class="special">,</span></code>
56         <code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Allocator</span></code><code class="computeroutput"><span class="special">,</span></code>
57         <code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Iterator</span></code><code class="computeroutput"><span class="special">&gt;</span></code>
58<code class="computeroutput"><span class="identifier">rtree</span><span class="special">&lt;</span> <span class="identifier">Value</span><span class="special">,</span> <span class="identifier">Parameters</span><span class="special">,</span> <span class="identifier">IndexableGetter</span><span class="special">,</span> <span class="identifier">EqualTo</span><span class="special">,</span> <span class="identifier">Allocator</span> <span class="special">&gt;::</span><span class="identifier">size_type</span></code> <code class="computeroutput"><span class="identifier">remove</span></code><code class="computeroutput"><span class="special">(</span></code><code class="computeroutput"><span class="identifier">rtree</span><span class="special">&lt;</span> <span class="identifier">Value</span><span class="special">,</span> <span class="identifier">Parameters</span><span class="special">,</span> <span class="identifier">IndexableGetter</span><span class="special">,</span> <span class="identifier">EqualTo</span><span class="special">,</span> <span class="identifier">Allocator</span> <span class="special">&gt;</span> <span class="special">&amp;</span></code> <code class="computeroutput"><span class="identifier">tree</span></code><code class="computeroutput"><span class="special">,</span></code>
59                                                                                  <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>
60                                                                                  <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>
61</pre>
62<h6>
63<a name="geometry.reference.spatial_indexes.group__rtree__functions.remove_rtree_________iterator__iterator_.h2"></a>
64            <span class="phrase"><a name="geometry.reference.spatial_indexes.group__rtree__functions.remove_rtree_________iterator__iterator_.parameter_s_"></a></span><a class="link" href="remove_rtree_________iterator__iterator_.html#geometry.reference.spatial_indexes.group__rtree__functions.remove_rtree_________iterator__iterator_.parameter_s_">Parameter(s)</a>
65          </h6>
66<div class="informaltable"><table class="table">
67<colgroup>
68<col>
69<col>
70<col>
71</colgroup>
72<thead><tr>
73<th>
74                    <p>
75                      Type
76                    </p>
77                  </th>
78<th>
79                    <p>
80                      Name
81                    </p>
82                  </th>
83<th>
84                    <p>
85                      Description
86                    </p>
87                  </th>
88</tr></thead>
89<tbody>
90<tr>
91<td>
92                    <p>
93                      <code class="computeroutput"><span class="identifier">rtree</span><span class="special">&lt;</span>
94                      <span class="identifier">Value</span><span class="special">,</span>
95                      <span class="identifier">Parameters</span><span class="special">,</span>
96                      <span class="identifier">IndexableGetter</span><span class="special">,</span>
97                      <span class="identifier">EqualTo</span><span class="special">,</span>
98                      <span class="identifier">Allocator</span> <span class="special">&gt;</span>
99                      <span class="special">&amp;</span></code>
100                    </p>
101                  </td>
102<td>
103                    <p>
104                      <code class="computeroutput"><span class="identifier">tree</span></code>
105                    </p>
106                  </td>
107<td>
108                    <p>
109                      The spatial index.
110                    </p>
111                  </td>
112</tr>
113<tr>
114<td>
115                    <p>
116                      <code class="computeroutput"><span class="identifier">Iterator</span></code>
117                    </p>
118                  </td>
119<td>
120                    <p>
121                      <code class="computeroutput"><span class="identifier">first</span></code>
122                    </p>
123                  </td>
124<td>
125                    <p>
126                      The beginning of the range of values.
127                    </p>
128                  </td>
129</tr>
130<tr>
131<td>
132                    <p>
133                      <code class="computeroutput"><span class="identifier">Iterator</span></code>
134                    </p>
135                  </td>
136<td>
137                    <p>
138                      <code class="computeroutput"><span class="identifier">last</span></code>
139                    </p>
140                  </td>
141<td>
142                    <p>
143                      The end of the range of values.
144                    </p>
145                  </td>
146</tr>
147</tbody>
148</table></div>
149<h6>
150<a name="geometry.reference.spatial_indexes.group__rtree__functions.remove_rtree_________iterator__iterator_.h3"></a>
151            <span class="phrase"><a name="geometry.reference.spatial_indexes.group__rtree__functions.remove_rtree_________iterator__iterator_.returns"></a></span><a class="link" href="remove_rtree_________iterator__iterator_.html#geometry.reference.spatial_indexes.group__rtree__functions.remove_rtree_________iterator__iterator_.returns">Returns</a>
152          </h6>
153<p>
154            The number of removed values.
155          </p>
156</div>
157<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
158<td align="left"></td>
159<td align="right"><div class="copyright-footer">Copyright © 2009-2019 Barend Gehrels, Bruno Lalande, Mateusz Loskot, Adam
160      Wulkiewicz, Oracle and/or its affiliates<p>
161        Distributed under the Boost Software License, Version 1.0. (See accompanying
162        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>)
163      </p>
164</div></td>
165</tr></table>
166<hr>
167<div class="spirit-nav">
168<a accesskey="p" href="remove_rtree_________value_const___.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../group__rtree__functions.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="remove_rtree_________convertibleorrange_const___.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
169</div>
170</body>
171</html>
172