summaryrefslogtreecommitdiff
path: root/libs/geometry/doc/html/geometry/reference/spatial_indexes/group__rtree__functions/remove_rtree_________iterator__iterator_.html
blob: b002cacf0aa717238e6d97683fb91c90136b9ddb (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
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>remove(rtree&lt;...&gt; &amp;, Iterator, Iterator)</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="../group__rtree__functions.html" title="R-tree free functions (boost::geometry::index::)">
<link rel="prev" href="remove_rtree_________value_const___.html" title="remove(rtree&lt;...&gt; &amp;, Value const &amp;)">
<link rel="next" href="remove_rtree_________convertibleorrange_const___.html" title="remove(rtree&lt;...&gt; &amp;, ConvertibleOrRange 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="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>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<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;
          &amp;, Iterator, Iterator)</a>
</h5></div></div></div>
<p>
            <a class="indexterm" name="idp128085136"></a>
Remove a range of values from the container.
          </p>
<h6>
<a name="geometry.reference.spatial_indexes.group__rtree__functions.remove_rtree_________iterator__iterator_.h0"></a>
            <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>
          </h6>
<p>
            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
            pointing to values stored in this container. It removes values equal
            to these passed as a range. Furthermore this function removes only one
            value for each one passed in the range, not all equal values.
          </p>
<p>
            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,
            Iterator)</a></code>.
          </p>
<h6>
<a name="geometry.reference.spatial_indexes.group__rtree__functions.remove_rtree_________iterator__iterator_.h1"></a>
            <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>
          </h6>
<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>
         <code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Parameters</span></code><code class="computeroutput"><span class="special">,</span></code>
         <code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">IndexableGetter</span></code><code class="computeroutput"><span class="special">,</span></code>
         <code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">EqualTo</span></code><code class="computeroutput"><span class="special">,</span></code>
         <code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Allocator</span></code><code class="computeroutput"><span class="special">,</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>
<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>
                                                                                  <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>
                                                                                  <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>
</pre>
<h6>
<a name="geometry.reference.spatial_indexes.group__rtree__functions.remove_rtree_________iterator__iterator_.h2"></a>
            <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>
          </h6>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>
                    <p>
                      Type
                    </p>
                  </th>
<th>
                    <p>
                      Name
                    </p>
                  </th>
<th>
                    <p>
                      Description
                    </p>
                  </th>
</tr></thead>
<tbody>
<tr>
<td>
                    <p>
                      <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>
                    </p>
                  </td>
<td>
                    <p>
                      <code class="computeroutput"><span class="identifier">tree</span></code>
                    </p>
                  </td>
<td>
                    <p>
                      The spatial index.
                    </p>
                  </td>
</tr>
<tr>
<td>
                    <p>
                      <code class="computeroutput"><span class="identifier">Iterator</span></code>
                    </p>
                  </td>
<td>
                    <p>
                      <code class="computeroutput"><span class="identifier">first</span></code>
                    </p>
                  </td>
<td>
                    <p>
                      The beginning of the range of values.
                    </p>
                  </td>
</tr>
<tr>
<td>
                    <p>
                      <code class="computeroutput"><span class="identifier">Iterator</span></code>
                    </p>
                  </td>
<td>
                    <p>
                      <code class="computeroutput"><span class="identifier">last</span></code>
                    </p>
                  </td>
<td>
                    <p>
                      The end of the range of values.
                    </p>
                  </td>
</tr>
</tbody>
</table></div>
<h6>
<a name="geometry.reference.spatial_indexes.group__rtree__functions.remove_rtree_________iterator__iterator_.h3"></a>
            <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>
          </h6>
<p>
            The number of removed values.
          </p>
</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="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>
</div>
</body>
</html>