blob: cd4bf46e9797ccce3d171a001c14b90098fee96e (
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
|
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>remove(value_type const &)</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 1. Geometry">
<link rel="up" href="../boost__geometry__index__rtree.html" title="boost::geometry::index::rtree">
<link rel="prev" href="insert_convertibleorrange_const___.html" title="insert(ConvertibleOrRange const &)">
<link rel="next" href="remove_iterator__iterator_.html" title="remove(Iterator, Iterator)">
</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="insert_convertibleorrange_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_iterator__iterator_.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.boost__geometry__index__rtree.remove_value_type_const___"></a><a name="classboost_1_1geometry_1_1index_1_1rtree_1a1ce933b0b833faec5349bfc27bde15d4"></a><a class="link" href="remove_value_type_const___.html" title="remove(value_type const &)">remove(value_type
const &)</a>
</h5></div></div></div>
<p>
<a class="indexterm" name="idp129156512"></a>
Remove a value from the container.
</p>
<h6>
<a name="geometry.reference.spatial_indexes.boost__geometry__index__rtree.remove_value_type_const___.h0"></a>
<span class="phrase"><a name="geometry.reference.spatial_indexes.boost__geometry__index__rtree.remove_value_type_const___.description"></a></span><a class="link" href="remove_value_type_const___.html#geometry.reference.spatial_indexes.boost__geometry__index__rtree.remove_value_type_const___.description">Description</a>
</h6>
<p>
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 this method removes
only one value from the container.
</p>
<h6>
<a name="geometry.reference.spatial_indexes.boost__geometry__index__rtree.remove_value_type_const___.h1"></a>
<span class="phrase"><a name="geometry.reference.spatial_indexes.boost__geometry__index__rtree.remove_value_type_const___.synopsis"></a></span><a class="link" href="remove_value_type_const___.html#geometry.reference.spatial_indexes.boost__geometry__index__rtree.remove_value_type_const___.synopsis">Synopsis</a>
</h6>
<pre class="programlisting"><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="literal"><a class="link" href="../boost__geometry__index__rtree.html#classboost_1_1geometry_1_1index_1_1rtree_1a5761a41d87b93d4fd548ecb6600ae757">value_type</a></code><code class="computeroutput"> <span class="keyword">const</span> <span class="special">&</span></code> <code class="computeroutput"><span class="identifier">value</span></code><code class="computeroutput"><span class="special">)</span></code>
</pre>
<h6>
<a name="geometry.reference.spatial_indexes.boost__geometry__index__rtree.remove_value_type_const___.h2"></a>
<span class="phrase"><a name="geometry.reference.spatial_indexes.boost__geometry__index__rtree.remove_value_type_const___.parameter_s_"></a></span><a class="link" href="remove_value_type_const___.html#geometry.reference.spatial_indexes.boost__geometry__index__rtree.remove_value_type_const___.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="literal"><a class="link" href="../boost__geometry__index__rtree.html#classboost_1_1geometry_1_1index_1_1rtree_1a5761a41d87b93d4fd548ecb6600ae757">value_type</a></code><code class="computeroutput">
<span class="keyword">const</span> <span class="special">&</span></code>
</p>
</td>
<td>
<p>
<code class="computeroutput"><span class="identifier">value</span></code>
</p>
</td>
<td>
<p>
The value which will be removed from the container.
</p>
</td>
</tr></tbody>
</table></div>
<h6>
<a name="geometry.reference.spatial_indexes.boost__geometry__index__rtree.remove_value_type_const___.h3"></a>
<span class="phrase"><a name="geometry.reference.spatial_indexes.boost__geometry__index__rtree.remove_value_type_const___.returns"></a></span><a class="link" href="remove_value_type_const___.html#geometry.reference.spatial_indexes.boost__geometry__index__rtree.remove_value_type_const___.returns">Returns</a>
</h6>
<p>
1 if the value was removed, 0 otherwise.
</p>
<h6>
<a name="geometry.reference.spatial_indexes.boost__geometry__index__rtree.remove_value_type_const___.h4"></a>
<span class="phrase"><a name="geometry.reference.spatial_indexes.boost__geometry__index__rtree.remove_value_type_const___.throws"></a></span><a class="link" href="remove_value_type_const___.html#geometry.reference.spatial_indexes.boost__geometry__index__rtree.remove_value_type_const___.throws">Throws</a>
</h6>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem">
If Value copy constructor or copy assignment throws.
</li>
<li class="listitem">
If allocation throws or returns invalid value.
</li>
</ul></div>
<div class="warning"><table border="0" summary="Warning">
<tr>
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Warning]" src="../../../../../../../../doc/src/images/warning.png"></td>
<th align="left">Warning</th>
</tr>
<tr><td align="left" valign="top"><p>
This operation only guarantees that there will be no memory leaks.
After an exception is thrown the R-tree may be left in an inconsistent
state, elements must not be inserted or removed. Other operations are
allowed however some of them may return invalid data.
</p></td></tr>
</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 © 2009-2014 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="insert_convertibleorrange_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_iterator__iterator_.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>
|
