libs/geometry/doc/html/geometry/reference/spatial_indexes/boost__geometry__index__rtree/remove_value_type_const___.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>remove(value_type 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="../boost__geometry__index__rtree.html" title="boost::geometry::index::rtree">
   9 <link rel="prev" href="insert_convertibleorrange_const___.html" title="insert(ConvertibleOrRange const &amp;)">
  10 <link rel="next" href="remove_iterator__iterator_.html" title="remove(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_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>
  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_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 &amp;)">remove(value_type
  28           const &amp;)</a>
  29 </h5></div></div></div>
  30 <p>
  31             <a class="indexterm" name="idm46186979902064"></a>
  32 Remove a value from the container.
  33           </p>
  34 <h6>
  35 <a name="geometry.reference.spatial_indexes.boost__geometry__index__rtree.remove_value_type_const___.h0"></a>
  36             <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>
  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 this method removes
  41             only one value from the container.
  42           </p>
  43 <h6>
  44 <a name="geometry.reference.spatial_indexes.boost__geometry__index__rtree.remove_value_type_const___.h1"></a>
  45             <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>
  46           </h6>
  47 <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">&amp;</span></code> <code class="computeroutput"><span class="identifier">value</span></code><code class="computeroutput"><span class="special">)</span></code>
  48 </pre>
  49 <h6>
  50 <a name="geometry.reference.spatial_indexes.boost__geometry__index__rtree.remove_value_type_const___.h2"></a>
  51             <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>
  52           </h6>
  53 <div class="informaltable"><table class="table">
  54 <colgroup>
  55 <col>
  56 <col>
  57 <col>
  58 </colgroup>
  59 <thead><tr>
  60 <th>
  61                     <p>
  62                       Type
  63                     </p>
  64                   </th>
  65 <th>
  66                     <p>
  67                       Name
  68                     </p>
  69                   </th>
  70 <th>
  71                     <p>
  72                       Description
  73                     </p>
  74                   </th>
  75 </tr></thead>
  76 <tbody><tr>
  77 <td>
  78                     <p>
  79                       <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">
  80                       <span class="keyword">const</span> <span class="special">&amp;</span></code>
  81                     </p>
  82                   </td>
  83 <td>
  84                     <p>
  85                       <code class="computeroutput"><span class="identifier">value</span></code>
  86                     </p>
  87                   </td>
  88 <td>
  89                     <p>
  90                       The value which will be removed from the container.
  91                     </p>
  92                   </td>
  93 </tr></tbody>
  94 </table></div>
  95 <h6>
  96 <a name="geometry.reference.spatial_indexes.boost__geometry__index__rtree.remove_value_type_const___.h3"></a>
  97             <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>
  98           </h6>
  99 <p>
 100             1 if the value was removed, 0 otherwise.
 101           </p>
 102 <h6>
 103 <a name="geometry.reference.spatial_indexes.boost__geometry__index__rtree.remove_value_type_const___.h4"></a>
 104             <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>
 105           </h6>
 106 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
 107 <li class="listitem">
 108                 If Value copy constructor or copy assignment throws.
 109               </li>
 110 <li class="listitem">
 111                 If allocation throws or returns invalid value.
 112               </li>
 113 </ul></div>
 114 <div class="warning"><table border="0" summary="Warning">
 115 <tr>
 116 <td rowspan="2" align="center" valign="top" width="25"><img alt="[Warning]" src="../../../../../../../../doc/src/images/warning.png"></td>
 117 <th align="left">Warning</th>
 118 </tr>
 119 <tr><td align="left" valign="top"><p>
 120               This operation only guarantees that there will be no memory leaks.
 121               After an exception is thrown the R-tree may be left in an inconsistent
 122               state, elements must not be inserted or removed. Other operations are
 123               allowed however some of them may return invalid data.
 124             </p></td></tr>
 125 </table></div>
 126 </div>
 127 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 128 <td align="left"></td>
 129 <td align="right"><div class="copyright-footer">Copyright &#169; 2009-2019 Barend Gehrels, Bruno Lalande, Mateusz Loskot, Adam
 130       Wulkiewicz, Oracle and/or its affiliates<p>
 131         Distributed under the Boost Software License, Version 1.0. (See accompanying
 132         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>)
 133       </p>
 134 </div></td>
 135 </tr></table>
 136 <hr>
 137 <div class="spirit-nav">
 138 <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>
 139 </div>
 140 </body>
 141 </html>