libs/geometry/doc/index/html_by_doxygen/group__rtree__functions.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   2 <html xmlns="http://www.w3.org/1999/xhtml">
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
   5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
   6 <meta name="generator" content="Doxygen 1.8.6"/>
   7 <title>Boost.Geometry.Index: R-tree free functions (boost::geometry::index::)</title>
   8 <link href="tabs.css" rel="stylesheet" type="text/css"/>
   9 <script type="text/javascript" src="jquery.js"></script>
  10 <script type="text/javascript" src="dynsections.js"></script>
  11 <link href="search/search.css" rel="stylesheet" type="text/css"/>
  12 <script type="text/javascript" src="search/search.js"></script>
  13 <script type="text/javascript">
  14   $(document).ready(function() { searchBox.OnSelectItem(0); });
  15 </script>
  16 <link href="doxygen.css" rel="stylesheet" type="text/css" />
  17 </head>
  18 <body>
  19 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  20 <div id="titlearea">
  21 <table cellspacing="0" cellpadding="0">
  22  <tbody>
  23  <tr style="height: 56px;">
  24   <td style="padding-left: 0.5em;">
  25    <div id="projectname">Boost.Geometry.Index
  26    </div>
  27   </td>
  28  </tr>
  29  </tbody>
  30 </table>
  31 </div>
  32 <!-- end header part -->
  33 <!-- Generated by Doxygen 1.8.6 -->
  34 <script type="text/javascript">
  35 var searchBox = new SearchBox("searchBox", "search",false,'Search');
  36 </script>
  37   <div id="navrow1" class="tabs">
  38     <ul class="tablist">
  39       <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  40       <li><a href="modules.html"><span>Modules</span></a></li>
  41       <li><a href="annotated.html"><span>Classes</span></a></li>
  42       <li><a href="files.html"><span>Files</span></a></li>
  43       <li>
  44         <div id="MSearchBox" class="MSearchBoxInactive">
  45         <span class="left">
  46           <img id="MSearchSelect" src="search/mag_sel.png"
  47                onmouseover="return searchBox.OnSearchSelectShow()"
  48                onmouseout="return searchBox.OnSearchSelectHide()"
  49                alt=""/>
  50           <input type="text" id="MSearchField" value="Search" accesskey="S"
  51                onfocus="searchBox.OnSearchFieldFocus(true)"
  52                onblur="searchBox.OnSearchFieldFocus(false)"
  53                onkeyup="searchBox.OnSearchFieldChange(event)"/>
  54           </span><span class="right">
  55             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  56           </span>
  57         </div>
  58       </li>
  59     </ul>
  60   </div>
  61 </div><!-- top -->
  62 <!-- window showing the filter options -->
  63 <div id="MSearchSelectWindow"
  64      onmouseover="return searchBox.OnSearchSelectShow()"
  65      onmouseout="return searchBox.OnSearchSelectHide()"
  66      onkeydown="return searchBox.OnSearchSelectKey(event)">
  67 <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Groups</a></div>
  68
  69 <!-- iframe showing the search results (closed by default) -->
  70 <div id="MSearchResultsWindow">
  71 <iframe src="javascript:void(0)" frameborder="0"
  72         name="MSearchResults" id="MSearchResults">
  73 </iframe>
  74 </div>
  75
  76 <div class="header">
  77   <div class="summary">
  78 <a href="#func-members">Functions</a>  </div>
  79   <div class="headertitle">
  80 <div class="title">R-tree free functions (boost::geometry::index::)</div>  </div>
  81 </div><!--header-->
  82 <div class="contents">
  83 <table class="memberdecls">
  84 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  85 Functions</h2></td></tr>
  86 <tr class="memitem:gada4f62111ed22eb2860ea30995c1ce60"><td class="memTemplParams" colspan="2">template&lt;typename Value , typename Parameters , typename IndexableGetter , typename EqualTo , typename Allocator &gt; </td></tr>
  87 <tr class="memitem:gada4f62111ed22eb2860ea30995c1ce60"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__rtree__functions.html#gada4f62111ed22eb2860ea30995c1ce60">boost::geometry::index::insert</a> (rtree&lt; Value, Parameters, IndexableGetter, EqualTo, Allocator &gt; &amp;tree, Value const &amp;v)</td></tr>
  88 <tr class="memdesc:gada4f62111ed22eb2860ea30995c1ce60"><td class="mdescLeft">&#160;</td><td class="mdescRight">Insert a value to the index.  <a href="#gada4f62111ed22eb2860ea30995c1ce60">More...</a><br/></td></tr>
  89 <tr class="separator:gada4f62111ed22eb2860ea30995c1ce60"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90 <tr class="memitem:ga056469ea699e609e67762fe1b789997f"><td class="memTemplParams" colspan="2">template&lt;typename Value , typename Parameters , typename IndexableGetter , typename EqualTo , typename Allocator , typename Iterator &gt; </td></tr>
  91 <tr class="memitem:ga056469ea699e609e67762fe1b789997f"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__rtree__functions.html#ga056469ea699e609e67762fe1b789997f">boost::geometry::index::insert</a> (rtree&lt; Value, Parameters, IndexableGetter, EqualTo, Allocator &gt; &amp;tree, Iterator first, Iterator last)</td></tr>
  92 <tr class="memdesc:ga056469ea699e609e67762fe1b789997f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Insert a range of values to the index.  <a href="#ga056469ea699e609e67762fe1b789997f">More...</a><br/></td></tr>
  93 <tr class="separator:ga056469ea699e609e67762fe1b789997f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  94 <tr class="memitem:gab4edad000d63eb103f2dad3813ceb2b3"><td class="memTemplParams" colspan="2">template&lt;typename Value , typename Parameters , typename IndexableGetter , typename EqualTo , typename Allocator , typename ConvertibleOrRange &gt; </td></tr>
  95 <tr class="memitem:gab4edad000d63eb103f2dad3813ceb2b3"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__rtree__functions.html#gab4edad000d63eb103f2dad3813ceb2b3">boost::geometry::index::insert</a> (rtree&lt; Value, Parameters, IndexableGetter, EqualTo, Allocator &gt; &amp;tree, ConvertibleOrRange const &amp;conv_or_rng)</td></tr>
  96 <tr class="memdesc:gab4edad000d63eb103f2dad3813ceb2b3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Insert a value created using convertible object or a range of values to the index.  <a href="#gab4edad000d63eb103f2dad3813ceb2b3">More...</a><br/></td></tr>
  97 <tr class="separator:gab4edad000d63eb103f2dad3813ceb2b3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  98 <tr class="memitem:gaf353d90fd933e6110b031f63166fb45a"><td class="memTemplParams" colspan="2">template&lt;typename Value , typename Parameters , typename IndexableGetter , typename EqualTo , typename Allocator &gt; </td></tr>
  99 <tr class="memitem:gaf353d90fd933e6110b031f63166fb45a"><td class="memTemplItemLeft" align="right" valign="top">rtree&lt; Value, Parameters, <br class="typebreak"/>
 100 IndexableGetter, EqualTo, <br class="typebreak"/>
 101 Allocator &gt;::size_type&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__rtree__functions.html#gaf353d90fd933e6110b031f63166fb45a">boost::geometry::index::remove</a> (rtree&lt; Value, Parameters, IndexableGetter, EqualTo, Allocator &gt; &amp;tree, Value const &amp;v)</td></tr>
 102 <tr class="memdesc:gaf353d90fd933e6110b031f63166fb45a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Remove a value from the container.  <a href="#gaf353d90fd933e6110b031f63166fb45a">More...</a><br/></td></tr>
 103 <tr class="separator:gaf353d90fd933e6110b031f63166fb45a"><td class="memSeparator" colspan="2">&#160;</td></tr>
 104 <tr class="memitem:gaa460a8985496cf133f63f245527ac6e7"><td class="memTemplParams" colspan="2">template&lt;typename Value , typename Parameters , typename IndexableGetter , typename EqualTo , typename Allocator , typename Iterator &gt; </td></tr>
 105 <tr class="memitem:gaa460a8985496cf133f63f245527ac6e7"><td class="memTemplItemLeft" align="right" valign="top">rtree&lt; Value, Parameters, <br class="typebreak"/>
 106 IndexableGetter, EqualTo, <br class="typebreak"/>
 107 Allocator &gt;::size_type&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__rtree__functions.html#gaa460a8985496cf133f63f245527ac6e7">boost::geometry::index::remove</a> (rtree&lt; Value, Parameters, IndexableGetter, EqualTo, Allocator &gt; &amp;tree, Iterator first, Iterator last)</td></tr>
 108 <tr class="memdesc:gaa460a8985496cf133f63f245527ac6e7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Remove a range of values from the container.  <a href="#gaa460a8985496cf133f63f245527ac6e7">More...</a><br/></td></tr>
 109 <tr class="separator:gaa460a8985496cf133f63f245527ac6e7"><td class="memSeparator" colspan="2">&#160;</td></tr>
 110 <tr class="memitem:ga700c922f8b4d5ebd073e999e12b55249"><td class="memTemplParams" colspan="2">template&lt;typename Value , typename Parameters , typename IndexableGetter , typename EqualTo , typename Allocator , typename ConvertibleOrRange &gt; </td></tr>
 111 <tr class="memitem:ga700c922f8b4d5ebd073e999e12b55249"><td class="memTemplItemLeft" align="right" valign="top">rtree&lt; Value, Parameters, <br class="typebreak"/>
 112 IndexableGetter, EqualTo, <br class="typebreak"/>
 113 Allocator &gt;::size_type&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__rtree__functions.html#ga700c922f8b4d5ebd073e999e12b55249">boost::geometry::index::remove</a> (rtree&lt; Value, Parameters, IndexableGetter, EqualTo, Allocator &gt; &amp;tree, ConvertibleOrRange const &amp;conv_or_rng)</td></tr>
 114 <tr class="memdesc:ga700c922f8b4d5ebd073e999e12b55249"><td class="mdescLeft">&#160;</td><td class="mdescRight">Remove a value corresponding to an object convertible to it or a range of values from the container.  <a href="#ga700c922f8b4d5ebd073e999e12b55249">More...</a><br/></td></tr>
 115 <tr class="separator:ga700c922f8b4d5ebd073e999e12b55249"><td class="memSeparator" colspan="2">&#160;</td></tr>
 116 <tr class="memitem:gadb43b211d5d743ebe2ef256328286e95"><td class="memTemplParams" colspan="2">template&lt;typename Value , typename Parameters , typename IndexableGetter , typename EqualTo , typename Allocator , typename Predicates , typename OutIter &gt; </td></tr>
 117 <tr class="memitem:gadb43b211d5d743ebe2ef256328286e95"><td class="memTemplItemLeft" align="right" valign="top">rtree&lt; Value, Parameters, <br class="typebreak"/>
 118 IndexableGetter, EqualTo, <br class="typebreak"/>
 119 Allocator &gt;::size_type&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__rtree__functions.html#gadb43b211d5d743ebe2ef256328286e95">boost::geometry::index::query</a> (rtree&lt; Value, Parameters, IndexableGetter, EqualTo, Allocator &gt; const &amp;tree, Predicates const &amp;predicates, OutIter out_it)</td></tr>
 120 <tr class="memdesc:gadb43b211d5d743ebe2ef256328286e95"><td class="mdescLeft">&#160;</td><td class="mdescRight">Finds values meeting passed predicates e.g. nearest to some Point and/or intersecting some Box.  <a href="#gadb43b211d5d743ebe2ef256328286e95">More...</a><br/></td></tr>
 121 <tr class="separator:gadb43b211d5d743ebe2ef256328286e95"><td class="memSeparator" colspan="2">&#160;</td></tr>
 122 <tr class="memitem:ga45c2b7b112bf730d10367e10df62aa3c"><td class="memTemplParams" colspan="2">template&lt;typename Value , typename Parameters , typename IndexableGetter , typename EqualTo , typename Allocator , typename Predicates &gt; </td></tr>
 123 <tr class="memitem:ga45c2b7b112bf730d10367e10df62aa3c"><td class="memTemplItemLeft" align="right" valign="top">rtree&lt; Value, Parameters, <br class="typebreak"/>
 124 IndexableGetter, EqualTo, <br class="typebreak"/>
 125 Allocator &gt;<br class="typebreak"/>
 126 ::const_query_iterator&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__rtree__functions.html#ga45c2b7b112bf730d10367e10df62aa3c">boost::geometry::index::qbegin</a> (rtree&lt; Value, Parameters, IndexableGetter, EqualTo, Allocator &gt; const &amp;tree, Predicates const &amp;predicates)</td></tr>
 127 <tr class="memdesc:ga45c2b7b112bf730d10367e10df62aa3c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the query iterator pointing at the begin of the query range.  <a href="#ga45c2b7b112bf730d10367e10df62aa3c">More...</a><br/></td></tr>
 128 <tr class="separator:ga45c2b7b112bf730d10367e10df62aa3c"><td class="memSeparator" colspan="2">&#160;</td></tr>
 129 <tr class="memitem:ga5c9a1eb0421bf2c702392247d48143e5"><td class="memTemplParams" colspan="2">template&lt;typename Value , typename Parameters , typename IndexableGetter , typename EqualTo , typename Allocator &gt; </td></tr>
 130 <tr class="memitem:ga5c9a1eb0421bf2c702392247d48143e5"><td class="memTemplItemLeft" align="right" valign="top">rtree&lt; Value, Parameters, <br class="typebreak"/>
 131 IndexableGetter, EqualTo, <br class="typebreak"/>
 132 Allocator &gt;<br class="typebreak"/>
 133 ::const_query_iterator&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__rtree__functions.html#ga5c9a1eb0421bf2c702392247d48143e5">boost::geometry::index::qend</a> (rtree&lt; Value, Parameters, IndexableGetter, EqualTo, Allocator &gt; const &amp;tree)</td></tr>
 134 <tr class="memdesc:ga5c9a1eb0421bf2c702392247d48143e5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the query iterator pointing at the end of the query range.  <a href="#ga5c9a1eb0421bf2c702392247d48143e5">More...</a><br/></td></tr>
 135 <tr class="separator:ga5c9a1eb0421bf2c702392247d48143e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
 136 <tr class="memitem:ga2467dc6ac90303496abd6ebd136eba18"><td class="memTemplParams" colspan="2">template&lt;typename Value , typename Parameters , typename IndexableGetter , typename EqualTo , typename Allocator &gt; </td></tr>
 137 <tr class="memitem:ga2467dc6ac90303496abd6ebd136eba18"><td class="memTemplItemLeft" align="right" valign="top">rtree&lt; Value, Parameters, <br class="typebreak"/>
 138 IndexableGetter, EqualTo, <br class="typebreak"/>
 139 Allocator &gt;::const_iterator&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__rtree__functions.html#ga2467dc6ac90303496abd6ebd136eba18">boost::geometry::index::begin</a> (rtree&lt; Value, Parameters, IndexableGetter, EqualTo, Allocator &gt; const &amp;tree)</td></tr>
 140 <tr class="memdesc:ga2467dc6ac90303496abd6ebd136eba18"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the iterator pointing at the begin of the rtree values range.  <a href="#ga2467dc6ac90303496abd6ebd136eba18">More...</a><br/></td></tr>
 141 <tr class="separator:ga2467dc6ac90303496abd6ebd136eba18"><td class="memSeparator" colspan="2">&#160;</td></tr>
 142 <tr class="memitem:ga8fd1e53d8492643cbc9840ff715bb736"><td class="memTemplParams" colspan="2">template&lt;typename Value , typename Parameters , typename IndexableGetter , typename EqualTo , typename Allocator &gt; </td></tr>
 143 <tr class="memitem:ga8fd1e53d8492643cbc9840ff715bb736"><td class="memTemplItemLeft" align="right" valign="top">rtree&lt; Value, Parameters, <br class="typebreak"/>
 144 IndexableGetter, EqualTo, <br class="typebreak"/>
 145 Allocator &gt;::const_iterator&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__rtree__functions.html#ga8fd1e53d8492643cbc9840ff715bb736">boost::geometry::index::end</a> (rtree&lt; Value, Parameters, IndexableGetter, EqualTo, Allocator &gt; const &amp;tree)</td></tr>
 146 <tr class="memdesc:ga8fd1e53d8492643cbc9840ff715bb736"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the iterator pointing at the end of the rtree values range.  <a href="#ga8fd1e53d8492643cbc9840ff715bb736">More...</a><br/></td></tr>
 147 <tr class="separator:ga8fd1e53d8492643cbc9840ff715bb736"><td class="memSeparator" colspan="2">&#160;</td></tr>
 148 <tr class="memitem:gabaca6c24c3838a8164aa3700c459e7a4"><td class="memTemplParams" colspan="2">template&lt;typename Value , typename Parameters , typename IndexableGetter , typename EqualTo , typename Allocator &gt; </td></tr>
 149 <tr class="memitem:gabaca6c24c3838a8164aa3700c459e7a4"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__rtree__functions.html#gabaca6c24c3838a8164aa3700c459e7a4">boost::geometry::index::clear</a> (rtree&lt; Value, Parameters, IndexableGetter, EqualTo, Allocator &gt; &amp;tree)</td></tr>
 150 <tr class="memdesc:gabaca6c24c3838a8164aa3700c459e7a4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Remove all values from the index.  <a href="#gabaca6c24c3838a8164aa3700c459e7a4">More...</a><br/></td></tr>
 151 <tr class="separator:gabaca6c24c3838a8164aa3700c459e7a4"><td class="memSeparator" colspan="2">&#160;</td></tr>
 152 <tr class="memitem:gaa19a09e7b5f0a86a4b74ef2342de1d68"><td class="memTemplParams" colspan="2">template&lt;typename Value , typename Parameters , typename IndexableGetter , typename EqualTo , typename Allocator &gt; </td></tr>
 153 <tr class="memitem:gaa19a09e7b5f0a86a4b74ef2342de1d68"><td class="memTemplItemLeft" align="right" valign="top">size_t&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__rtree__functions.html#gaa19a09e7b5f0a86a4b74ef2342de1d68">boost::geometry::index::size</a> (rtree&lt; Value, Parameters, IndexableGetter, EqualTo, Allocator &gt; const &amp;tree)</td></tr>
 154 <tr class="memdesc:gaa19a09e7b5f0a86a4b74ef2342de1d68"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the number of values stored in the index.  <a href="#gaa19a09e7b5f0a86a4b74ef2342de1d68">More...</a><br/></td></tr>
 155 <tr class="separator:gaa19a09e7b5f0a86a4b74ef2342de1d68"><td class="memSeparator" colspan="2">&#160;</td></tr>
 156 <tr class="memitem:gaba44e2fb12fdc7b528bfee56a88e0844"><td class="memTemplParams" colspan="2">template&lt;typename Value , typename Parameters , typename IndexableGetter , typename EqualTo , typename Allocator &gt; </td></tr>
 157 <tr class="memitem:gaba44e2fb12fdc7b528bfee56a88e0844"><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__rtree__functions.html#gaba44e2fb12fdc7b528bfee56a88e0844">boost::geometry::index::empty</a> (rtree&lt; Value, Parameters, IndexableGetter, EqualTo, Allocator &gt; const &amp;tree)</td></tr>
 158 <tr class="memdesc:gaba44e2fb12fdc7b528bfee56a88e0844"><td class="mdescLeft">&#160;</td><td class="mdescRight">Query if there are no values stored in the index.  <a href="#gaba44e2fb12fdc7b528bfee56a88e0844">More...</a><br/></td></tr>
 159 <tr class="separator:gaba44e2fb12fdc7b528bfee56a88e0844"><td class="memSeparator" colspan="2">&#160;</td></tr>
 160 <tr class="memitem:ga4e43e7720c66e88959ff511a7462a3ff"><td class="memTemplParams" colspan="2">template&lt;typename Value , typename Parameters , typename IndexableGetter , typename EqualTo , typename Allocator &gt; </td></tr>
 161 <tr class="memitem:ga4e43e7720c66e88959ff511a7462a3ff"><td class="memTemplItemLeft" align="right" valign="top">rtree&lt; Value, Parameters, <br class="typebreak"/>
 162 IndexableGetter, EqualTo, <br class="typebreak"/>
 163 Allocator &gt;::bounds_type&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__rtree__functions.html#ga4e43e7720c66e88959ff511a7462a3ff">boost::geometry::index::bounds</a> (rtree&lt; Value, Parameters, IndexableGetter, EqualTo, Allocator &gt; const &amp;tree)</td></tr>
 164 <tr class="memdesc:ga4e43e7720c66e88959ff511a7462a3ff"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the box containing all stored values or an invalid box if the index has no values.  <a href="#ga4e43e7720c66e88959ff511a7462a3ff">More...</a><br/></td></tr>
 165 <tr class="separator:ga4e43e7720c66e88959ff511a7462a3ff"><td class="memSeparator" colspan="2">&#160;</td></tr>
 166 <tr class="memitem:gaa1250318a78d7e27ba8f3537eb0ddb3f"><td class="memTemplParams" colspan="2">template&lt;typename Value , typename Parameters , typename IndexableGetter , typename EqualTo , typename Allocator &gt; </td></tr>
 167 <tr class="memitem:gaa1250318a78d7e27ba8f3537eb0ddb3f"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__rtree__functions.html#gaa1250318a78d7e27ba8f3537eb0ddb3f">boost::geometry::index::swap</a> (rtree&lt; Value, Parameters, IndexableGetter, EqualTo, Allocator &gt; &amp;l, rtree&lt; Value, Parameters, IndexableGetter, EqualTo, Allocator &gt; &amp;r)</td></tr>
 168 <tr class="memdesc:gaa1250318a78d7e27ba8f3537eb0ddb3f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Exchanges the contents of the container with those of other.  <a href="#gaa1250318a78d7e27ba8f3537eb0ddb3f">More...</a><br/></td></tr>
 169 <tr class="separator:gaa1250318a78d7e27ba8f3537eb0ddb3f"><td class="memSeparator" colspan="2">&#160;</td></tr>
 170 </table>
 171 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 172 <h2 class="groupheader">Function Documentation</h2>
 173 <a class="anchor" id="ga2467dc6ac90303496abd6ebd136eba18"></a>
 174 <div class="memitem">
 175 <div class="memproto">
 176 <div class="memtemplate">
 177 template&lt;typename Value , typename Parameters , typename IndexableGetter , typename EqualTo , typename Allocator &gt; </div>
 178 <table class="mlabels">
 179   <tr>
 180   <td class="mlabels-left">
 181       <table class="memname">
 182         <tr>
 183           <td class="memname">rtree&lt;Value, Parameters, IndexableGetter, EqualTo, Allocator&gt;::const_iterator boost::geometry::index::begin </td>
 184           <td>(</td>
 185           <td class="paramtype">rtree&lt; Value, Parameters, IndexableGetter, EqualTo, Allocator &gt; const &amp;&#160;</td>
 186           <td class="paramname"><em>tree</em></td><td>)</td>
 187           <td></td>
 188         </tr>
 189       </table>
 190   </td>
 191   <td class="mlabels-right">
 192 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 193   </tr>
 194 </table>
 195 </div><div class="memdoc">
 196
 197 <p>Returns the iterator pointing at the begin of the rtree values range. </p>
 198 <p>This method returns the iterator which may be used to iterate over all values stored in the rtree.</p>
 199 <dl class="section user"><dt>Example</dt><dd><pre class="fragment">std::for_each(bgi::begin(tree), bgi::end(tree), do_something());
 200 // the same as
 201 std::for_each(boost::begin(tree), boost::end(tree), do_something());
 202 </pre></dd></dl>
 203 <dl class="section user"><dt>Iterator category</dt><dd>ForwardIterator</dd></dl>
 204 <dl class="section user"><dt>Throws</dt><dd>If allocation throws.</dd></dl>
 205 <dl class="section warning"><dt>Warning</dt><dd>The modification of the rtree may invalidate the iterators.</dd></dl>
 206 <dl class="section return"><dt>Returns</dt><dd>The iterator pointing at the begin of the range. </dd></dl>
 207
 208 </div>
 209 </div>
 210 <a class="anchor" id="ga4e43e7720c66e88959ff511a7462a3ff"></a>
 211 <div class="memitem">
 212 <div class="memproto">
 213 <div class="memtemplate">
 214 template&lt;typename Value , typename Parameters , typename IndexableGetter , typename EqualTo , typename Allocator &gt; </div>
 215 <table class="mlabels">
 216   <tr>
 217   <td class="mlabels-left">
 218       <table class="memname">
 219         <tr>
 220           <td class="memname">rtree&lt;Value, Parameters, IndexableGetter, EqualTo, Allocator&gt;::bounds_type boost::geometry::index::bounds </td>
 221           <td>(</td>
 222           <td class="paramtype">rtree&lt; Value, Parameters, IndexableGetter, EqualTo, Allocator &gt; const &amp;&#160;</td>
 223           <td class="paramname"><em>tree</em></td><td>)</td>
 224           <td></td>
 225         </tr>
 226       </table>
 227   </td>
 228   <td class="mlabels-right">
 229 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 230   </tr>
 231 </table>
 232 </div><div class="memdoc">
 233
 234 <p>Get the box containing all stored values or an invalid box if the index has no values. </p>
 235 <p>It calls <code>rtree::envelope()</code>.</p>
 236 <dl class="params"><dt>Parameters</dt><dd>
 237   <table class="params">
 238     <tr><td class="paramname">tree</td><td>The spatial index.</td></tr>
 239   </table>
 240   </dd>
 241 </dl>
 242 <dl class="section return"><dt>Returns</dt><dd>The box containing all stored values or an invalid box. </dd></dl>
 243
 244 </div>
 245 </div>
 246 <a class="anchor" id="gabaca6c24c3838a8164aa3700c459e7a4"></a>
 247 <div class="memitem">
 248 <div class="memproto">
 249 <div class="memtemplate">
 250 template&lt;typename Value , typename Parameters , typename IndexableGetter , typename EqualTo , typename Allocator &gt; </div>
 251 <table class="mlabels">
 252   <tr>
 253   <td class="mlabels-left">
 254       <table class="memname">
 255         <tr>
 256           <td class="memname">void boost::geometry::index::clear </td>
 257           <td>(</td>
 258           <td class="paramtype">rtree&lt; Value, Parameters, IndexableGetter, EqualTo, Allocator &gt; &amp;&#160;</td>
 259           <td class="paramname"><em>tree</em></td><td>)</td>
 260           <td></td>
 261         </tr>
 262       </table>
 263   </td>
 264   <td class="mlabels-right">
 265 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 266   </tr>
 267 </table>
 268 </div><div class="memdoc">
 269
 270 <p>Remove all values from the index. </p>
 271 <p>It calls <code><a class="el" href="classboost_1_1geometry_1_1index_1_1rtree.html#a1bec40977c175983f585c4488cf8fe3c" title="Removes all values stored in the container. ">rtree::clear()</a></code>.</p>
 272 <dl class="params"><dt>Parameters</dt><dd>
 273   <table class="params">
 274     <tr><td class="paramname">tree</td><td>The spatial index. </td></tr>
 275   </table>
 276   </dd>
 277 </dl>
 278
 279 </div>
 280 </div>
 281 <a class="anchor" id="gaba44e2fb12fdc7b528bfee56a88e0844"></a>
 282 <div class="memitem">
 283 <div class="memproto">
 284 <div class="memtemplate">
 285 template&lt;typename Value , typename Parameters , typename IndexableGetter , typename EqualTo , typename Allocator &gt; </div>
 286 <table class="mlabels">
 287   <tr>
 288   <td class="mlabels-left">
 289       <table class="memname">
 290         <tr>
 291           <td class="memname">bool boost::geometry::index::empty </td>
 292           <td>(</td>
 293           <td class="paramtype">rtree&lt; Value, Parameters, IndexableGetter, EqualTo, Allocator &gt; const &amp;&#160;</td>
 294           <td class="paramname"><em>tree</em></td><td>)</td>
 295           <td></td>
 296         </tr>
 297       </table>
 298   </td>
 299   <td class="mlabels-right">
 300 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 301   </tr>
 302 </table>
 303 </div><div class="memdoc">
 304
 305 <p>Query if there are no values stored in the index. </p>
 306 <p>It calls <code><a class="el" href="classboost_1_1geometry_1_1index_1_1rtree.html#aa5302ce1c26105d722aac20793e83f0e" title="Query if the container is empty. ">rtree::empty()</a></code>.</p>
 307 <dl class="params"><dt>Parameters</dt><dd>
 308   <table class="params">
 309     <tr><td class="paramname">tree</td><td>The spatial index.</td></tr>
 310   </table>
 311   </dd>
 312 </dl>
 313 <dl class="section return"><dt>Returns</dt><dd>true if there are no values in the index. </dd></dl>
 314
 315 </div>
 316 </div>
 317 <a class="anchor" id="ga8fd1e53d8492643cbc9840ff715bb736"></a>
 318 <div class="memitem">
 319 <div class="memproto">
 320 <div class="memtemplate">
 321 template&lt;typename Value , typename Parameters , typename IndexableGetter , typename EqualTo , typename Allocator &gt; </div>
 322 <table class="mlabels">
 323   <tr>
 324   <td class="mlabels-left">
 325       <table class="memname">
 326         <tr>
 327           <td class="memname">rtree&lt;Value, Parameters, IndexableGetter, EqualTo, Allocator&gt;::const_iterator boost::geometry::index::end </td>
 328           <td>(</td>
 329           <td class="paramtype">rtree&lt; Value, Parameters, IndexableGetter, EqualTo, Allocator &gt; const &amp;&#160;</td>
 330           <td class="paramname"><em>tree</em></td><td>)</td>
 331           <td></td>
 332         </tr>
 333       </table>
 334   </td>
 335   <td class="mlabels-right">
 336 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 337   </tr>
 338 </table>
 339 </div><div class="memdoc">
 340
 341 <p>Returns the iterator pointing at the end of the rtree values range. </p>
 342 <p>This method returns the iterator which may be compared with the iterator returned by <a class="el" href="group__rtree__functions.html#ga2467dc6ac90303496abd6ebd136eba18" title="Returns the iterator pointing at the begin of the rtree values range. ">begin()</a> in order to check if the iteration has ended.</p>
 343 <dl class="section user"><dt>Example</dt><dd><pre class="fragment">std::for_each(bgi::begin(tree), bgi::end(tree), do_something());
 344 // the same as
 345 std::for_each(boost::begin(tree), boost::end(tree), do_something());
 346 </pre></dd></dl>
 347 <dl class="section user"><dt>Iterator category</dt><dd>ForwardIterator</dd></dl>
 348 <dl class="section user"><dt>Throws</dt><dd>Nothing.</dd></dl>
 349 <dl class="section warning"><dt>Warning</dt><dd>The modification of the rtree may invalidate the iterators.</dd></dl>
 350 <dl class="section return"><dt>Returns</dt><dd>The iterator pointing at the end of the range. </dd></dl>
 351
 352 </div>
 353 </div>
 354 <a class="anchor" id="gada4f62111ed22eb2860ea30995c1ce60"></a>
 355 <div class="memitem">
 356 <div class="memproto">
 357 <div class="memtemplate">
 358 template&lt;typename Value , typename Parameters , typename IndexableGetter , typename EqualTo , typename Allocator &gt; </div>
 359 <table class="mlabels">
 360   <tr>
 361   <td class="mlabels-left">
 362       <table class="memname">
 363         <tr>
 364           <td class="memname">void boost::geometry::index::insert </td>
 365           <td>(</td>
 366           <td class="paramtype">rtree&lt; Value, Parameters, IndexableGetter, EqualTo, Allocator &gt; &amp;&#160;</td>
 367           <td class="paramname"><em>tree</em>, </td>
 368         </tr>
 369         <tr>
 370           <td class="paramkey"></td>
 371           <td></td>
 372           <td class="paramtype">Value const &amp;&#160;</td>
 373           <td class="paramname"><em>v</em>&#160;</td>
 374         </tr>
 375         <tr>
 376           <td></td>
 377           <td>)</td>
 378           <td></td><td></td>
 379         </tr>
 380       </table>
 381   </td>
 382   <td class="mlabels-right">
 383 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 384   </tr>
 385 </table>
 386 </div><div class="memdoc">
 387
 388 <p>Insert a value to the index. </p>
 389 <p>It calls <code><a class="el" href="classboost_1_1geometry_1_1index_1_1rtree.html#ad47980467e66b8644df18a480dbf9d86" title="Insert a value to the index. ">rtree::insert(value_type const&amp;)</a></code>.</p>
 390 <dl class="params"><dt>Parameters</dt><dd>
 391   <table class="params">
 392     <tr><td class="paramname">tree</td><td>The spatial index. </td></tr>
 393     <tr><td class="paramname">v</td><td>The value which will be stored in the index. </td></tr>
 394   </table>
 395   </dd>
 396 </dl>
 397
 398 </div>
 399 </div>
 400 <a class="anchor" id="ga056469ea699e609e67762fe1b789997f"></a>
 401 <div class="memitem">
 402 <div class="memproto">
 403 <div class="memtemplate">
 404 template&lt;typename Value , typename Parameters , typename IndexableGetter , typename EqualTo , typename Allocator , typename Iterator &gt; </div>
 405 <table class="mlabels">
 406   <tr>
 407   <td class="mlabels-left">
 408       <table class="memname">
 409         <tr>
 410           <td class="memname">void boost::geometry::index::insert </td>
 411           <td>(</td>
 412           <td class="paramtype">rtree&lt; Value, Parameters, IndexableGetter, EqualTo, Allocator &gt; &amp;&#160;</td>
 413           <td class="paramname"><em>tree</em>, </td>
 414         </tr>
 415         <tr>
 416           <td class="paramkey"></td>
 417           <td></td>
 418           <td class="paramtype">Iterator&#160;</td>
 419           <td class="paramname"><em>first</em>, </td>
 420         </tr>
 421         <tr>
 422           <td class="paramkey"></td>
 423           <td></td>
 424           <td class="paramtype">Iterator&#160;</td>
 425           <td class="paramname"><em>last</em>&#160;</td>
 426         </tr>
 427         <tr>
 428           <td></td>
 429           <td>)</td>
 430           <td></td><td></td>
 431         </tr>
 432       </table>
 433   </td>
 434   <td class="mlabels-right">
 435 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 436   </tr>
 437 </table>
 438 </div><div class="memdoc">
 439
 440 <p>Insert a range of values to the index. </p>
 441 <p>It calls <code><a class="el" href="classboost_1_1geometry_1_1index_1_1rtree.html#a60d4c8790fd8810ff8b57f049e6bed8d" title="Insert a range of values to the index. ">rtree::insert(Iterator, Iterator)</a></code>.</p>
 442 <dl class="params"><dt>Parameters</dt><dd>
 443   <table class="params">
 444     <tr><td class="paramname">tree</td><td>The spatial index. </td></tr>
 445     <tr><td class="paramname">first</td><td>The beginning of the range of values. </td></tr>
 446     <tr><td class="paramname">last</td><td>The end of the range of values. </td></tr>
 447   </table>
 448   </dd>
 449 </dl>
 450
 451 </div>
 452 </div>
 453 <a class="anchor" id="gab4edad000d63eb103f2dad3813ceb2b3"></a>
 454 <div class="memitem">
 455 <div class="memproto">
 456 <div class="memtemplate">
 457 template&lt;typename Value , typename Parameters , typename IndexableGetter , typename EqualTo , typename Allocator , typename ConvertibleOrRange &gt; </div>
 458 <table class="mlabels">
 459   <tr>
 460   <td class="mlabels-left">
 461       <table class="memname">
 462         <tr>
 463           <td class="memname">void boost::geometry::index::insert </td>
 464           <td>(</td>
 465           <td class="paramtype">rtree&lt; Value, Parameters, IndexableGetter, EqualTo, Allocator &gt; &amp;&#160;</td>
 466           <td class="paramname"><em>tree</em>, </td>
 467         </tr>
 468         <tr>
 469           <td class="paramkey"></td>
 470           <td></td>
 471           <td class="paramtype">ConvertibleOrRange const &amp;&#160;</td>
 472           <td class="paramname"><em>conv_or_rng</em>&#160;</td>
 473         </tr>
 474         <tr>
 475           <td></td>
 476           <td>)</td>
 477           <td></td><td></td>
 478         </tr>
 479       </table>
 480   </td>
 481   <td class="mlabels-right">
 482 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 483   </tr>
 484 </table>
 485 </div><div class="memdoc">
 486
 487 <p>Insert a value created using convertible object or a range of values to the index. </p>
 488 <p>It calls <code><a class="el" href="classboost_1_1geometry_1_1index_1_1rtree.html#a5db294b14ebf1319edcfc92e78c8167e" title="Insert a value created using convertible object or a range of values to the index. ">rtree::insert(ConvertibleOrRange const&amp;)</a></code>.</p>
 489 <dl class="params"><dt>Parameters</dt><dd>
 490   <table class="params">
 491     <tr><td class="paramname">tree</td><td>The spatial index. </td></tr>
 492     <tr><td class="paramname">conv_or_rng</td><td>The object of type convertible to value_type or a range of values. </td></tr>
 493   </table>
 494   </dd>
 495 </dl>
 496
 497 </div>
 498 </div>
 499 <a class="anchor" id="ga45c2b7b112bf730d10367e10df62aa3c"></a>
 500 <div class="memitem">
 501 <div class="memproto">
 502 <div class="memtemplate">
 503 template&lt;typename Value , typename Parameters , typename IndexableGetter , typename EqualTo , typename Allocator , typename Predicates &gt; </div>
 504 <table class="mlabels">
 505   <tr>
 506   <td class="mlabels-left">
 507       <table class="memname">
 508         <tr>
 509           <td class="memname">rtree&lt;Value, Parameters, IndexableGetter, EqualTo, Allocator&gt;::const_query_iterator boost::geometry::index::qbegin </td>
 510           <td>(</td>
 511           <td class="paramtype">rtree&lt; Value, Parameters, IndexableGetter, EqualTo, Allocator &gt; const &amp;&#160;</td>
 512           <td class="paramname"><em>tree</em>, </td>
 513         </tr>
 514         <tr>
 515           <td class="paramkey"></td>
 516           <td></td>
 517           <td class="paramtype">Predicates const &amp;&#160;</td>
 518           <td class="paramname"><em>predicates</em>&#160;</td>
 519         </tr>
 520         <tr>
 521           <td></td>
 522           <td>)</td>
 523           <td></td><td></td>
 524         </tr>
 525       </table>
 526   </td>
 527   <td class="mlabels-right">
 528 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 529   </tr>
 530 </table>
 531 </div><div class="memdoc">
 532
 533 <p>Returns the query iterator pointing at the begin of the query range. </p>
 534 <p>This method returns the iterator which may be used to perform iterative queries. For the information about the predicates which may be passed to this method see <a class="el" href="group__rtree__functions.html#gadb43b211d5d743ebe2ef256328286e95" title="Finds values meeting passed predicates e.g. nearest to some Point and/or intersecting some Box...">query()</a>.</p>
 535 <dl class="section user"><dt>Example</dt><dd><pre class="fragment">std::for_each(bgi::qbegin(tree, bgi::nearest(pt, 3)), bgi::qend(tree), do_something());
 536 </pre></dd></dl>
 537 <dl class="section user"><dt>Iterator category</dt><dd>ForwardIterator</dd></dl>
 538 <dl class="section user"><dt>Throws</dt><dd>If predicates copy throws. If allocation throws.</dd></dl>
 539 <dl class="section warning"><dt>Warning</dt><dd>The modification of the rtree may invalidate the iterators.</dd></dl>
 540 <dl class="params"><dt>Parameters</dt><dd>
 541   <table class="params">
 542     <tr><td class="paramname">tree</td><td>The rtree. </td></tr>
 543     <tr><td class="paramname">predicates</td><td>Predicates.</td></tr>
 544   </table>
 545   </dd>
 546 </dl>
 547 <dl class="section return"><dt>Returns</dt><dd>The iterator pointing at the begin of the query range. </dd></dl>
 548
 549 </div>
 550 </div>
 551 <a class="anchor" id="ga5c9a1eb0421bf2c702392247d48143e5"></a>
 552 <div class="memitem">
 553 <div class="memproto">
 554 <div class="memtemplate">
 555 template&lt;typename Value , typename Parameters , typename IndexableGetter , typename EqualTo , typename Allocator &gt; </div>
 556 <table class="mlabels">
 557   <tr>
 558   <td class="mlabels-left">
 559       <table class="memname">
 560         <tr>
 561           <td class="memname">rtree&lt;Value, Parameters, IndexableGetter, EqualTo, Allocator&gt;::const_query_iterator boost::geometry::index::qend </td>
 562           <td>(</td>
 563           <td class="paramtype">rtree&lt; Value, Parameters, IndexableGetter, EqualTo, Allocator &gt; const &amp;&#160;</td>
 564           <td class="paramname"><em>tree</em></td><td>)</td>
 565           <td></td>
 566         </tr>
 567       </table>
 568   </td>
 569   <td class="mlabels-right">
 570 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 571   </tr>
 572 </table>
 573 </div><div class="memdoc">
 574
 575 <p>Returns the query iterator pointing at the end of the query range. </p>
 576 <p>This method returns the iterator which may be used to check if the query has ended.</p>
 577 <dl class="section user"><dt>Example</dt><dd><pre class="fragment">std::for_each(bgi::qbegin(tree, bgi::nearest(pt, 3)), bgi::qend(tree), do_something());
 578 </pre></dd></dl>
 579 <dl class="section user"><dt>Iterator category</dt><dd>ForwardIterator</dd></dl>
 580 <dl class="section user"><dt>Throws</dt><dd>Nothing</dd></dl>
 581 <dl class="section warning"><dt>Warning</dt><dd>The modification of the rtree may invalidate the iterators.</dd></dl>
 582 <dl class="section return"><dt>Returns</dt><dd>The iterator pointing at the end of the query range. </dd></dl>
 583
 584 </div>
 585 </div>
 586 <a class="anchor" id="gadb43b211d5d743ebe2ef256328286e95"></a>
 587 <div class="memitem">
 588 <div class="memproto">
 589 <div class="memtemplate">
 590 template&lt;typename Value , typename Parameters , typename IndexableGetter , typename EqualTo , typename Allocator , typename Predicates , typename OutIter &gt; </div>
 591 <table class="mlabels">
 592   <tr>
 593   <td class="mlabels-left">
 594       <table class="memname">
 595         <tr>
 596           <td class="memname">rtree&lt;Value, Parameters, IndexableGetter, EqualTo, Allocator&gt;::size_type boost::geometry::index::query </td>
 597           <td>(</td>
 598           <td class="paramtype">rtree&lt; Value, Parameters, IndexableGetter, EqualTo, Allocator &gt; const &amp;&#160;</td>
 599           <td class="paramname"><em>tree</em>, </td>
 600         </tr>
 601         <tr>
 602           <td class="paramkey"></td>
 603           <td></td>
 604           <td class="paramtype">Predicates const &amp;&#160;</td>
 605           <td class="paramname"><em>predicates</em>, </td>
 606         </tr>
 607         <tr>
 608           <td class="paramkey"></td>
 609           <td></td>
 610           <td class="paramtype">OutIter&#160;</td>
 611           <td class="paramname"><em>out_it</em>&#160;</td>
 612         </tr>
 613         <tr>
 614           <td></td>
 615           <td>)</td>
 616           <td></td><td></td>
 617         </tr>
 618       </table>
 619   </td>
 620   <td class="mlabels-right">
 621 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 622   </tr>
 623 </table>
 624 </div><div class="memdoc">
 625
 626 <p>Finds values meeting passed predicates e.g. nearest to some Point and/or intersecting some Box. </p>
 627 <p>This query function performs spatial and k-nearest neighbor searches. It allows to pass a set of predicates. Values will be returned only if all predicates are met.</p>
 628 <p><b>Spatial predicates</b></p>
 629 <p>Spatial predicates may be generated by one of the functions listed below: </p>
 630 <ul>
 631 <li><code><a class="el" href="group__predicates.html#gac52a6557110425d4ece53fbd6f9ff866" title="Generate contains() predicate. ">boost::geometry::index::contains()</a></code>, </li>
 632 <li><code><a class="el" href="group__predicates.html#ga02dbb7cca47de0b921ef96af464d9590" title="Generate covered_by() predicate. ">boost::geometry::index::covered_by()</a></code>, </li>
 633 <li><code><a class="el" href="group__predicates.html#ga0e92e4a20dd19185584fe85847439108" title="Generate covers() predicate. ">boost::geometry::index::covers()</a></code>, </li>
 634 <li><code><a class="el" href="group__predicates.html#ga0aa114ab16f40c8caeb3338adba5d6da" title="Generate disjoint() predicate. ">boost::geometry::index::disjoint()</a></code>, </li>
 635 <li><code><a class="el" href="group__predicates.html#ga78cb2ef221b951867c591ffb51b7d8c5" title="Generate intersects() predicate. ">boost::geometry::index::intersects()</a></code>, </li>
 636 <li><code><a class="el" href="group__predicates.html#ga4a6d33e6f61ad5bff3bdee50a972d54b" title="Generate overlaps() predicate. ">boost::geometry::index::overlaps()</a></code>, </li>
 637 <li><code><a class="el" href="group__predicates.html#gaabce901b82af2aab10ebbd0dda12f4d5" title="Generate within() predicate. ">boost::geometry::index::within()</a></code>,</li>
 638 </ul>
 639 <p>It is possible to negate spatial predicates: </p>
 640 <ul>
 641 <li><code>! <a class="el" href="group__predicates.html#gac52a6557110425d4ece53fbd6f9ff866" title="Generate contains() predicate. ">boost::geometry::index::contains()</a></code>, </li>
 642 <li><code>! <a class="el" href="group__predicates.html#ga02dbb7cca47de0b921ef96af464d9590" title="Generate covered_by() predicate. ">boost::geometry::index::covered_by()</a></code>, </li>
 643 <li><code>! <a class="el" href="group__predicates.html#ga0e92e4a20dd19185584fe85847439108" title="Generate covers() predicate. ">boost::geometry::index::covers()</a></code>, </li>
 644 <li><code>! <a class="el" href="group__predicates.html#ga0aa114ab16f40c8caeb3338adba5d6da" title="Generate disjoint() predicate. ">boost::geometry::index::disjoint()</a></code>, </li>
 645 <li><code>! <a class="el" href="group__predicates.html#ga78cb2ef221b951867c591ffb51b7d8c5" title="Generate intersects() predicate. ">boost::geometry::index::intersects()</a></code>, </li>
 646 <li><code>! <a class="el" href="group__predicates.html#ga4a6d33e6f61ad5bff3bdee50a972d54b" title="Generate overlaps() predicate. ">boost::geometry::index::overlaps()</a></code>, </li>
 647 <li><code>! <a class="el" href="group__predicates.html#gaabce901b82af2aab10ebbd0dda12f4d5" title="Generate within() predicate. ">boost::geometry::index::within()</a></code></li>
 648 </ul>
 649 <p><b>Satisfies predicate</b></p>
 650 <p>This is a special kind of predicate which allows to pass a user-defined function or function object which checks if Value should be returned by the query. It's generated by: </p>
 651 <ul>
 652 <li><code><a class="el" href="group__predicates.html#ga3213772dd3e54ad03340c2ca66b4f58c" title="Generate satisfies() predicate. ">boost::geometry::index::satisfies()</a></code>.</li>
 653 </ul>
 654 <p><b>Nearest predicate</b></p>
 655 <p>If the nearest predicate is passed a k-nearest neighbor search will be performed. This query will result in returning k values to the output iterator. Only one nearest predicate may be passed to the query. It may be generated by: </p>
 656 <ul>
 657 <li><code><a class="el" href="group__predicates.html#ga8772d9d3e5b12b3292f7d94d47310e3e" title="Generate nearest() predicate. ">boost::geometry::index::nearest()</a></code>.</li>
 658 </ul>
 659 <p><b>Connecting predicates</b></p>
 660 <p>Predicates may be passed together connected with <code>operator&amp;&amp;()</code>.</p>
 661 <dl class="section user"><dt>Example</dt><dd><pre class="fragment">// return elements intersecting box
 662 bgi::query(tree, bgi::intersects(box), std::back_inserter(result));
 663 // return elements intersecting poly but not within box
 664 bgi::query(tree, bgi::intersects(poly) &amp;&amp; !bgi::within(box), std::back_inserter(result));
 665 // return elements overlapping box and meeting my_fun value predicate
 666 bgi::query(tree, bgi::overlaps(box) &amp;&amp; bgi::satisfies(my_fun), std::back_inserter(result));
 667 // return 5 elements nearest to pt and elements are intersecting box
 668 bgi::query(tree, bgi::nearest(pt, 5) &amp;&amp; bgi::intersects(box), std::back_inserter(result));
 669
 670 // For each found value do_something (it is a type of function object)
 671 tree.query(bgi::intersects(box),
 672            boost::make_function_output_iterator(do_something()));
 673 </pre></dd></dl>
 674 <dl class="section user"><dt>Throws</dt><dd>If Value copy constructor or copy assignment throws.</dd></dl>
 675 <dl class="section warning"><dt>Warning</dt><dd>Only one <code><a class="el" href="group__predicates.html#ga8772d9d3e5b12b3292f7d94d47310e3e" title="Generate nearest() predicate. ">nearest()</a></code> perdicate may be passed to the query. Passing more of them results in compile-time error.</dd></dl>
 676 <dl class="params"><dt>Parameters</dt><dd>
 677   <table class="params">
 678     <tr><td class="paramname">tree</td><td>The rtree. </td></tr>
 679     <tr><td class="paramname">predicates</td><td>Predicates. </td></tr>
 680     <tr><td class="paramname">out_it</td><td>The output iterator, e.g. generated by std::back_inserter().</td></tr>
 681   </table>
 682   </dd>
 683 </dl>
 684 <dl class="section return"><dt>Returns</dt><dd>The number of values found. </dd></dl>
 685
 686 </div>
 687 </div>
 688 <a class="anchor" id="gaf353d90fd933e6110b031f63166fb45a"></a>
 689 <div class="memitem">
 690 <div class="memproto">
 691 <div class="memtemplate">
 692 template&lt;typename Value , typename Parameters , typename IndexableGetter , typename EqualTo , typename Allocator &gt; </div>
 693 <table class="mlabels">
 694   <tr>
 695   <td class="mlabels-left">
 696       <table class="memname">
 697         <tr>
 698           <td class="memname">rtree&lt;Value, Parameters, IndexableGetter, EqualTo, Allocator&gt;::size_type boost::geometry::index::remove </td>
 699           <td>(</td>
 700           <td class="paramtype">rtree&lt; Value, Parameters, IndexableGetter, EqualTo, Allocator &gt; &amp;&#160;</td>
 701           <td class="paramname"><em>tree</em>, </td>
 702         </tr>
 703         <tr>
 704           <td class="paramkey"></td>
 705           <td></td>
 706           <td class="paramtype">Value const &amp;&#160;</td>
 707           <td class="paramname"><em>v</em>&#160;</td>
 708         </tr>
 709         <tr>
 710           <td></td>
 711           <td>)</td>
 712           <td></td><td></td>
 713         </tr>
 714       </table>
 715   </td>
 716   <td class="mlabels-right">
 717 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 718   </tr>
 719 </table>
 720 </div><div class="memdoc">
 721
 722 <p>Remove a value from the container. </p>
 723 <p>Remove a value from the container. In contrast to the <code>std::set</code> or <code>std::map erase()</code> method this function removes only one value from the container.</p>
 724 <p>It calls <code><a class="el" href="classboost_1_1geometry_1_1index_1_1rtree.html#a1ce933b0b833faec5349bfc27bde15d4" title="Remove a value from the container. ">rtree::remove(value_type const&amp;)</a></code>.</p>
 725 <dl class="params"><dt>Parameters</dt><dd>
 726   <table class="params">
 727     <tr><td class="paramname">tree</td><td>The spatial index. </td></tr>
 728     <tr><td class="paramname">v</td><td>The value which will be removed from the index.</td></tr>
 729   </table>
 730   </dd>
 731 </dl>
 732 <dl class="section return"><dt>Returns</dt><dd>1 if value was removed, 0 otherwise. </dd></dl>
 733
 734 </div>
 735 </div>
 736 <a class="anchor" id="gaa460a8985496cf133f63f245527ac6e7"></a>
 737 <div class="memitem">
 738 <div class="memproto">
 739 <div class="memtemplate">
 740 template&lt;typename Value , typename Parameters , typename IndexableGetter , typename EqualTo , typename Allocator , typename Iterator &gt; </div>
 741 <table class="mlabels">
 742   <tr>
 743   <td class="mlabels-left">
 744       <table class="memname">
 745         <tr>
 746           <td class="memname">rtree&lt;Value, Parameters, IndexableGetter, EqualTo, Allocator&gt;::size_type boost::geometry::index::remove </td>
 747           <td>(</td>
 748           <td class="paramtype">rtree&lt; Value, Parameters, IndexableGetter, EqualTo, Allocator &gt; &amp;&#160;</td>
 749           <td class="paramname"><em>tree</em>, </td>
 750         </tr>
 751         <tr>
 752           <td class="paramkey"></td>
 753           <td></td>
 754           <td class="paramtype">Iterator&#160;</td>
 755           <td class="paramname"><em>first</em>, </td>
 756         </tr>
 757         <tr>
 758           <td class="paramkey"></td>
 759           <td></td>
 760           <td class="paramtype">Iterator&#160;</td>
 761           <td class="paramname"><em>last</em>&#160;</td>
 762         </tr>
 763         <tr>
 764           <td></td>
 765           <td>)</td>
 766           <td></td><td></td>
 767         </tr>
 768       </table>
 769   </td>
 770   <td class="mlabels-right">
 771 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 772   </tr>
 773 </table>
 774 </div><div class="memdoc">
 775
 776 <p>Remove a range of values from the container. </p>
 777 <p>Remove a range of values from the container. In contrast to the <code>std::set</code> or <code>std::map erase()</code> method it doesn't take iterators pointing to values stored in this container. It removes values equal to these passed as a range. Furthermore this function removes only one value for each one passed in the range, not all equal values.</p>
 778 <p>It calls <code><a class="el" href="classboost_1_1geometry_1_1index_1_1rtree.html#aa97084231d17564a94f0142d095cecaa" title="Remove a range of values from the container. ">rtree::remove(Iterator, Iterator)</a></code>.</p>
 779 <dl class="params"><dt>Parameters</dt><dd>
 780   <table class="params">
 781     <tr><td class="paramname">tree</td><td>The spatial index. </td></tr>
 782     <tr><td class="paramname">first</td><td>The beginning of the range of values. </td></tr>
 783     <tr><td class="paramname">last</td><td>The end of the range of values.</td></tr>
 784   </table>
 785   </dd>
 786 </dl>
 787 <dl class="section return"><dt>Returns</dt><dd>The number of removed values. </dd></dl>
 788
 789 </div>
 790 </div>
 791 <a class="anchor" id="ga700c922f8b4d5ebd073e999e12b55249"></a>
 792 <div class="memitem">
 793 <div class="memproto">
 794 <div class="memtemplate">
 795 template&lt;typename Value , typename Parameters , typename IndexableGetter , typename EqualTo , typename Allocator , typename ConvertibleOrRange &gt; </div>
 796 <table class="mlabels">
 797   <tr>
 798   <td class="mlabels-left">
 799       <table class="memname">
 800         <tr>
 801           <td class="memname">rtree&lt;Value, Parameters, IndexableGetter, EqualTo, Allocator&gt;::size_type boost::geometry::index::remove </td>
 802           <td>(</td>
 803           <td class="paramtype">rtree&lt; Value, Parameters, IndexableGetter, EqualTo, Allocator &gt; &amp;&#160;</td>
 804           <td class="paramname"><em>tree</em>, </td>
 805         </tr>
 806         <tr>
 807           <td class="paramkey"></td>
 808           <td></td>
 809           <td class="paramtype">ConvertibleOrRange const &amp;&#160;</td>
 810           <td class="paramname"><em>conv_or_rng</em>&#160;</td>
 811         </tr>
 812         <tr>
 813           <td></td>
 814           <td>)</td>
 815           <td></td><td></td>
 816         </tr>
 817       </table>
 818   </td>
 819   <td class="mlabels-right">
 820 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 821   </tr>
 822 </table>
 823 </div><div class="memdoc">
 824
 825 <p>Remove a value corresponding to an object convertible to it or a range of values from the container. </p>
 826 <p>Remove a value corresponding to an object convertible to it or a range of values from the container. In contrast to the <code>std::set</code> or <code>std::map erase()</code> method it removes values equal to these passed as a range. Furthermore this method removes only one value for each one passed in the range, not all equal values.</p>
 827 <p>It calls <code><a class="el" href="classboost_1_1geometry_1_1index_1_1rtree.html#a320cd1861ba7b43364ed53e1f93a4411" title="Remove value corresponding to an object convertible to it or a range of values from the container...">rtree::remove(ConvertibleOrRange const&amp;)</a></code>.</p>
 828 <dl class="params"><dt>Parameters</dt><dd>
 829   <table class="params">
 830     <tr><td class="paramname">tree</td><td>The spatial index. </td></tr>
 831     <tr><td class="paramname">conv_or_rng</td><td>The object of type convertible to value_type or the range of values.</td></tr>
 832   </table>
 833   </dd>
 834 </dl>
 835 <dl class="section return"><dt>Returns</dt><dd>The number of removed values. </dd></dl>
 836
 837 </div>
 838 </div>
 839 <a class="anchor" id="gaa19a09e7b5f0a86a4b74ef2342de1d68"></a>
 840 <div class="memitem">
 841 <div class="memproto">
 842 <div class="memtemplate">
 843 template&lt;typename Value , typename Parameters , typename IndexableGetter , typename EqualTo , typename Allocator &gt; </div>
 844 <table class="mlabels">
 845   <tr>
 846   <td class="mlabels-left">
 847       <table class="memname">
 848         <tr>
 849           <td class="memname">size_t boost::geometry::index::size </td>
 850           <td>(</td>
 851           <td class="paramtype">rtree&lt; Value, Parameters, IndexableGetter, EqualTo, Allocator &gt; const &amp;&#160;</td>
 852           <td class="paramname"><em>tree</em></td><td>)</td>
 853           <td></td>
 854         </tr>
 855       </table>
 856   </td>
 857   <td class="mlabels-right">
 858 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 859   </tr>
 860 </table>
 861 </div><div class="memdoc">
 862
 863 <p>Get the number of values stored in the index. </p>
 864 <p>It calls <code><a class="el" href="classboost_1_1geometry_1_1index_1_1rtree.html#ac9f152c8c96525e3735b81635d8171b1" title="Returns the number of stored values. ">rtree::size()</a></code>.</p>
 865 <dl class="params"><dt>Parameters</dt><dd>
 866   <table class="params">
 867     <tr><td class="paramname">tree</td><td>The spatial index.</td></tr>
 868   </table>
 869   </dd>
 870 </dl>
 871 <dl class="section return"><dt>Returns</dt><dd>The number of values stored in the index. </dd></dl>
 872
 873 </div>
 874 </div>
 875 <a class="anchor" id="gaa1250318a78d7e27ba8f3537eb0ddb3f"></a>
 876 <div class="memitem">
 877 <div class="memproto">
 878 <div class="memtemplate">
 879 template&lt;typename Value , typename Parameters , typename IndexableGetter , typename EqualTo , typename Allocator &gt; </div>
 880 <table class="mlabels">
 881   <tr>
 882   <td class="mlabels-left">
 883       <table class="memname">
 884         <tr>
 885           <td class="memname">void boost::geometry::index::swap </td>
 886           <td>(</td>
 887           <td class="paramtype">rtree&lt; Value, Parameters, IndexableGetter, EqualTo, Allocator &gt; &amp;&#160;</td>
 888           <td class="paramname"><em>l</em>, </td>
 889         </tr>
 890         <tr>
 891           <td class="paramkey"></td>
 892           <td></td>
 893           <td class="paramtype">rtree&lt; Value, Parameters, IndexableGetter, EqualTo, Allocator &gt; &amp;&#160;</td>
 894           <td class="paramname"><em>r</em>&#160;</td>
 895         </tr>
 896         <tr>
 897           <td></td>
 898           <td>)</td>
 899           <td></td><td></td>
 900         </tr>
 901       </table>
 902   </td>
 903   <td class="mlabels-right">
 904 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 905   </tr>
 906 </table>
 907 </div><div class="memdoc">
 908
 909 <p>Exchanges the contents of the container with those of other. </p>
 910 <p>It calls <code><a class="el" href="classboost_1_1geometry_1_1index_1_1rtree.html#aedb719dfece91d298e9ee56878524c9b" title="Swaps contents of two rtrees. ">rtree::swap()</a></code>.</p>
 911 <dl class="params"><dt>Parameters</dt><dd>
 912   <table class="params">
 913     <tr><td class="paramname">l</td><td>The first rtree. </td></tr>
 914     <tr><td class="paramname">r</td><td>The second rtree. </td></tr>
 915   </table>
 916   </dd>
 917 </dl>
 918
 919 </div>
 920 </div>
 921 </div><!-- contents -->
 922 <!-- start footer part -->
 923 <hr class="footer"/><address class="footer"><small>
 924 Generated on Thu Dec 22 2016 12:40:17 for Boost.Geometry.Index by &#160;<a href="http://www.doxygen.org/index.html">
 925 <img class="footer" src="doxygen.png" alt="doxygen"/>
 926 </a> 1.8.6
 927 </small></address>
 928 </body>
 929 </html>