libs/geometry/doc/html/geometry/reference/spatial_indexes/group__rtree__functions/remove_rtree_________convertibleorrange_const___.html

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