1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>remove(rtree<...> &, Value const &)</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="insert_rtree_________convertibleorrange_const___.html" title="insert(rtree<...> &, ConvertibleOrRange const &)"> 10<link rel="next" href="remove_rtree_________iterator__iterator_.html" title="remove(rtree<...> &, Iterator, Iterator)"> 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="insert_rtree_________convertibleorrange_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_________iterator__iterator_.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_________value_const___"></a><a name="group__rtree__functions_1gaf353d90fd933e6110b031f63166fb45a"></a><a class="link" href="remove_rtree_________value_const___.html" title="remove(rtree<...> &, Value const &)">remove(rtree<...> 28 &, Value const &)</a> 29</h5></div></div></div> 30<p> 31 <a class="indexterm" name="idm45635674766432"></a> 32Remove a value from the container. 33 </p> 34<h6> 35<a name="geometry.reference.spatial_indexes.group__rtree__functions.remove_rtree_________value_const___.h0"></a> 36 <span class="phrase"><a name="geometry.reference.spatial_indexes.group__rtree__functions.remove_rtree_________value_const___.description"></a></span><a class="link" href="remove_rtree_________value_const___.html#geometry.reference.spatial_indexes.group__rtree__functions.remove_rtree_________value_const___.description">Description</a> 37 </h6> 38<p> 39 Remove a value 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 this function removes 40 only one value from the container. 41 </p> 42<p> 43 It calls <code class="literal"><a class="link" href="../boost__geometry__index__rtree/remove_value_type_const___.html#classboost_1_1geometry_1_1index_1_1rtree_1a1ce933b0b833faec5349bfc27bde15d4">rtree::remove(value_type 44 const&)</a></code>. 45 </p> 46<h6> 47<a name="geometry.reference.spatial_indexes.group__rtree__functions.remove_rtree_________value_const___.h1"></a> 48 <span class="phrase"><a name="geometry.reference.spatial_indexes.group__rtree__functions.remove_rtree_________value_const___.synopsis"></a></span><a class="link" href="remove_rtree_________value_const___.html#geometry.reference.spatial_indexes.group__rtree__functions.remove_rtree_________value_const___.synopsis">Synopsis</a> 49 </h6> 50<pre class="programlisting"><code class="computeroutput"><span class="keyword">template</span><span class="special"><</span></code><code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Value</span></code><code class="computeroutput"><span class="special">,</span></code> 51 <code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Parameters</span></code><code class="computeroutput"><span class="special">,</span></code> 52 <code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">IndexableGetter</span></code><code class="computeroutput"><span class="special">,</span></code> 53 <code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">EqualTo</span></code><code class="computeroutput"><span class="special">,</span></code> 54 <code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Allocator</span></code><code class="computeroutput"><span class="special">></span></code> 55<code class="computeroutput"><span class="identifier">rtree</span><span class="special"><</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">>::</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"><</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">></span> <span class="special">&</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">Value</span> <span class="keyword">const</span> <span class="special">&</span></code> <code class="computeroutput"><span class="identifier">v</span></code><code class="computeroutput"><span class="special">)</span></code> 56</pre> 57<h6> 58<a name="geometry.reference.spatial_indexes.group__rtree__functions.remove_rtree_________value_const___.h2"></a> 59 <span class="phrase"><a name="geometry.reference.spatial_indexes.group__rtree__functions.remove_rtree_________value_const___.parameter_s_"></a></span><a class="link" href="remove_rtree_________value_const___.html#geometry.reference.spatial_indexes.group__rtree__functions.remove_rtree_________value_const___.parameter_s_">Parameter(s)</a> 60 </h6> 61<div class="informaltable"><table class="table"> 62<colgroup> 63<col> 64<col> 65<col> 66</colgroup> 67<thead><tr> 68<th> 69 <p> 70 Type 71 </p> 72 </th> 73<th> 74 <p> 75 Name 76 </p> 77 </th> 78<th> 79 <p> 80 Description 81 </p> 82 </th> 83</tr></thead> 84<tbody> 85<tr> 86<td> 87 <p> 88 <code class="computeroutput"><span class="identifier">rtree</span><span class="special"><</span> 89 <span class="identifier">Value</span><span class="special">,</span> 90 <span class="identifier">Parameters</span><span class="special">,</span> 91 <span class="identifier">IndexableGetter</span><span class="special">,</span> 92 <span class="identifier">EqualTo</span><span class="special">,</span> 93 <span class="identifier">Allocator</span> <span class="special">></span> 94 <span class="special">&</span></code> 95 </p> 96 </td> 97<td> 98 <p> 99 <code class="computeroutput"><span class="identifier">tree</span></code> 100 </p> 101 </td> 102<td> 103 <p> 104 The spatial index. 105 </p> 106 </td> 107</tr> 108<tr> 109<td> 110 <p> 111 <code class="computeroutput"><span class="identifier">Value</span> <span class="keyword">const</span> 112 <span class="special">&</span></code> 113 </p> 114 </td> 115<td> 116 <p> 117 <code class="computeroutput"><span class="identifier">v</span></code> 118 </p> 119 </td> 120<td> 121 <p> 122 The value which will be removed from the index. 123 </p> 124 </td> 125</tr> 126</tbody> 127</table></div> 128<h6> 129<a name="geometry.reference.spatial_indexes.group__rtree__functions.remove_rtree_________value_const___.h3"></a> 130 <span class="phrase"><a name="geometry.reference.spatial_indexes.group__rtree__functions.remove_rtree_________value_const___.returns"></a></span><a class="link" href="remove_rtree_________value_const___.html#geometry.reference.spatial_indexes.group__rtree__functions.remove_rtree_________value_const___.returns">Returns</a> 131 </h6> 132<p> 133 1 if value was removed, 0 otherwise. 134 </p> 135</div> 136<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 137<td align="left"></td> 138<td align="right"><div class="copyright-footer">Copyright © 2009-2019 Barend Gehrels, Bruno Lalande, Mateusz Loskot, Adam 139 Wulkiewicz, Oracle and/or its affiliates<p> 140 Distributed under the Boost Software License, Version 1.0. (See accompanying 141 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>) 142 </p> 143</div></td> 144</tr></table> 145<hr> 146<div class="spirit-nav"> 147<a accesskey="p" href="insert_rtree_________convertibleorrange_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_________iterator__iterator_.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> 148</div> 149</body> 150</html> 151
