• 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(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="remove_value_type_const___.html" title="remove(value_type const &amp;)">
10<link rel="next" href="remove_convertibleorrange_const___.html" title="remove(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_value_type_const___.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="remove_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.boost__geometry__index__rtree.remove_iterator__iterator_"></a><a name="classboost_1_1geometry_1_1index_1_1rtree_1aa97084231d17564a94f0142d095cecaa"></a><a class="link" href="remove_iterator__iterator_.html" title="remove(Iterator, Iterator)">remove(Iterator,
28          Iterator)</a>
29</h5></div></div></div>
30<p>
31            <a class="indexterm" name="idm45635676067824"></a>
32Remove a range of values from the container.
33          </p>
34<h6>
35<a name="geometry.reference.spatial_indexes.boost__geometry__index__rtree.remove_iterator__iterator_.h0"></a>
36            <span class="phrase"><a name="geometry.reference.spatial_indexes.boost__geometry__index__rtree.remove_iterator__iterator_.description"></a></span><a class="link" href="remove_iterator__iterator_.html#geometry.reference.spatial_indexes.boost__geometry__index__rtree.remove_iterator__iterator_.description">Description</a>
37          </h6>
38<p>
39            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>
40            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
41            pointing to values stored in this container. It removes values equal
42            to these passed as a range. Furthermore this method removes only one
43            value for each one passed in the range, not all equal values.
44          </p>
45<h6>
46<a name="geometry.reference.spatial_indexes.boost__geometry__index__rtree.remove_iterator__iterator_.h1"></a>
47            <span class="phrase"><a name="geometry.reference.spatial_indexes.boost__geometry__index__rtree.remove_iterator__iterator_.synopsis"></a></span><a class="link" href="remove_iterator__iterator_.html#geometry.reference.spatial_indexes.boost__geometry__index__rtree.remove_iterator__iterator_.synopsis">Synopsis</a>
48          </h6>
49<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>
50<code class="literal"><a class="link" href="../boost__geometry__index__rtree.html#classboost_1_1geometry_1_1index_1_1rtree_1acc1f90d7b70afebc58107c523ece5cd5">size_type</a></code> <code class="computeroutput"><span class="identifier">remove</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>
51</pre>
52<h6>
53<a name="geometry.reference.spatial_indexes.boost__geometry__index__rtree.remove_iterator__iterator_.h2"></a>
54            <span class="phrase"><a name="geometry.reference.spatial_indexes.boost__geometry__index__rtree.remove_iterator__iterator_.parameter_s_"></a></span><a class="link" href="remove_iterator__iterator_.html#geometry.reference.spatial_indexes.boost__geometry__index__rtree.remove_iterator__iterator_.parameter_s_">Parameter(s)</a>
55          </h6>
56<div class="informaltable"><table class="table">
57<colgroup>
58<col>
59<col>
60<col>
61</colgroup>
62<thead><tr>
63<th>
64                    <p>
65                      Type
66                    </p>
67                  </th>
68<th>
69                    <p>
70                      Name
71                    </p>
72                  </th>
73<th>
74                    <p>
75                      Description
76                    </p>
77                  </th>
78</tr></thead>
79<tbody>
80<tr>
81<td>
82                    <p>
83                      <code class="computeroutput"><span class="identifier">Iterator</span></code>
84                    </p>
85                  </td>
86<td>
87                    <p>
88                      <code class="computeroutput"><span class="identifier">first</span></code>
89                    </p>
90                  </td>
91<td>
92                    <p>
93                      The beginning of the range of values.
94                    </p>
95                  </td>
96</tr>
97<tr>
98<td>
99                    <p>
100                      <code class="computeroutput"><span class="identifier">Iterator</span></code>
101                    </p>
102                  </td>
103<td>
104                    <p>
105                      <code class="computeroutput"><span class="identifier">last</span></code>
106                    </p>
107                  </td>
108<td>
109                    <p>
110                      The end of the range of values.
111                    </p>
112                  </td>
113</tr>
114</tbody>
115</table></div>
116<h6>
117<a name="geometry.reference.spatial_indexes.boost__geometry__index__rtree.remove_iterator__iterator_.h3"></a>
118            <span class="phrase"><a name="geometry.reference.spatial_indexes.boost__geometry__index__rtree.remove_iterator__iterator_.returns"></a></span><a class="link" href="remove_iterator__iterator_.html#geometry.reference.spatial_indexes.boost__geometry__index__rtree.remove_iterator__iterator_.returns">Returns</a>
119          </h6>
120<p>
121            The number of removed values.
122          </p>
123<h6>
124<a name="geometry.reference.spatial_indexes.boost__geometry__index__rtree.remove_iterator__iterator_.h4"></a>
125            <span class="phrase"><a name="geometry.reference.spatial_indexes.boost__geometry__index__rtree.remove_iterator__iterator_.throws"></a></span><a class="link" href="remove_iterator__iterator_.html#geometry.reference.spatial_indexes.boost__geometry__index__rtree.remove_iterator__iterator_.throws">Throws</a>
126          </h6>
127<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
128<li class="listitem">
129                If Value copy constructor or copy assignment throws.
130              </li>
131<li class="listitem">
132                If allocation throws or returns invalid value.
133              </li>
134</ul></div>
135<div class="warning"><table border="0" summary="Warning">
136<tr>
137<td rowspan="2" align="center" valign="top" width="25"><img alt="[Warning]" src="../../../../../../../../doc/src/images/warning.png"></td>
138<th align="left">Warning</th>
139</tr>
140<tr><td align="left" valign="top"><p>
141              This operation only guarantees that there will be no memory leaks.
142              After an exception is thrown the R-tree may be left in an inconsistent
143              state, elements must not be inserted or removed. Other operations are
144              allowed however some of them may return invalid data.
145            </p></td></tr>
146</table></div>
147</div>
148<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
149<td align="left"></td>
150<td align="right"><div class="copyright-footer">Copyright © 2009-2019 Barend Gehrels, Bruno Lalande, Mateusz Loskot, Adam
151      Wulkiewicz, Oracle and/or its affiliates<p>
152        Distributed under the Boost Software License, Version 1.0. (See accompanying
153        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>)
154      </p>
155</div></td>
156</tr></table>
157<hr>
158<div class="spirit-nav">
159<a accesskey="p" href="remove_value_type_const___.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="remove_convertibleorrange_const___.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
160</div>
161</body>
162</html>
163