1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>end(rtree<...> 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="begin_rtree______const___.html" title="begin(rtree<...> const &)"> 10<link rel="next" href="clear_rtree________.html" title="clear(rtree<...> &)"> 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="begin_rtree______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="clear_rtree________.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.end_rtree______const___"></a><a name="group__rtree__functions_1ga8fd1e53d8492643cbc9840ff715bb736"></a><a class="link" href="end_rtree______const___.html" title="end(rtree<...> const &)">end(rtree<...> 28 const &)</a> 29</h5></div></div></div> 30<p> 31 <a class="indexterm" name="idm45635673972544"></a> 32Returns the iterator pointing at the end of the rtree values range. 33 </p> 34<h6> 35<a name="geometry.reference.spatial_indexes.group__rtree__functions.end_rtree______const___.h0"></a> 36 <span class="phrase"><a name="geometry.reference.spatial_indexes.group__rtree__functions.end_rtree______const___.description"></a></span><a class="link" href="end_rtree______const___.html#geometry.reference.spatial_indexes.group__rtree__functions.end_rtree______const___.description">Description</a> 37 </h6> 38<p> 39 This method returns the iterator which may be compared with the iterator 40 returned by <a class="link" href="begin_rtree______const___.html#group__rtree__functions_1ga2467dc6ac90303496abd6ebd136eba18">begin()</a> 41 in order to check if the iteration has ended. 42 </p> 43<h6> 44<a name="geometry.reference.spatial_indexes.group__rtree__functions.end_rtree______const___.h1"></a> 45 <span class="phrase"><a name="geometry.reference.spatial_indexes.group__rtree__functions.end_rtree______const___.synopsis"></a></span><a class="link" href="end_rtree______const___.html#geometry.reference.spatial_indexes.group__rtree__functions.end_rtree______const___.synopsis">Synopsis</a> 46 </h6> 47<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> 48 <code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Parameters</span></code><code class="computeroutput"><span class="special">,</span></code> 49 <code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">IndexableGetter</span></code><code class="computeroutput"><span class="special">,</span></code> 50 <code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">EqualTo</span></code><code class="computeroutput"><span class="special">,</span></code> 51 <code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Allocator</span></code><code class="computeroutput"><span class="special">></span></code> 52<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">const_iterator</span></code> <code class="computeroutput"><span class="identifier">end</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="keyword">const</span> <span class="special">&</span></code> <code class="computeroutput"><span class="identifier">tree</span></code><code class="computeroutput"><span class="special">)</span></code> 53</pre> 54<h6> 55<a name="geometry.reference.spatial_indexes.group__rtree__functions.end_rtree______const___.h2"></a> 56 <span class="phrase"><a name="geometry.reference.spatial_indexes.group__rtree__functions.end_rtree______const___.returns"></a></span><a class="link" href="end_rtree______const___.html#geometry.reference.spatial_indexes.group__rtree__functions.end_rtree______const___.returns">Returns</a> 57 </h6> 58<p> 59 The iterator pointing at the end of the range. 60 </p> 61<h6> 62<a name="geometry.reference.spatial_indexes.group__rtree__functions.end_rtree______const___.h3"></a> 63 <span class="phrase"><a name="geometry.reference.spatial_indexes.group__rtree__functions.end_rtree______const___.example"></a></span><a class="link" href="end_rtree______const___.html#geometry.reference.spatial_indexes.group__rtree__functions.end_rtree______const___.example">Example</a> 64 </h6> 65<p> 66</p> 67<pre class="programlisting"><span class="identifier">std</span><span class="special">::</span><span class="identifier">for_each</span><span class="special">(</span><span class="identifier">bgi</span><span class="special">::</span><span class="identifier">begin</span><span class="special">(</span><span class="identifier">tree</span><span class="special">),</span> <span class="identifier">bgi</span><span class="special">::</span><span class="identifier">end</span><span class="special">(</span><span class="identifier">tree</span><span class="special">),</span> <span class="identifier">do_something</span><span class="special">());</span> 68<span class="comment">// the same as</span> 69<span class="identifier">std</span><span class="special">::</span><span class="identifier">for_each</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">begin</span><span class="special">(</span><span class="identifier">tree</span><span class="special">),</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">end</span><span class="special">(</span><span class="identifier">tree</span><span class="special">),</span> <span class="identifier">do_something</span><span class="special">());</span> 70</pre> 71<p> 72 </p> 73<h6> 74<a name="geometry.reference.spatial_indexes.group__rtree__functions.end_rtree______const___.h4"></a> 75 <span class="phrase"><a name="geometry.reference.spatial_indexes.group__rtree__functions.end_rtree______const___.iterator_category"></a></span><a class="link" href="end_rtree______const___.html#geometry.reference.spatial_indexes.group__rtree__functions.end_rtree______const___.iterator_category">Iterator 76 category</a> 77 </h6> 78<p> 79 ForwardIterator 80 </p> 81<h6> 82<a name="geometry.reference.spatial_indexes.group__rtree__functions.end_rtree______const___.h5"></a> 83 <span class="phrase"><a name="geometry.reference.spatial_indexes.group__rtree__functions.end_rtree______const___.throws"></a></span><a class="link" href="end_rtree______const___.html#geometry.reference.spatial_indexes.group__rtree__functions.end_rtree______const___.throws">Throws</a> 84 </h6> 85<p> 86 Nothing. 87 </p> 88<div class="warning"><table border="0" summary="Warning"> 89<tr> 90<td rowspan="2" align="center" valign="top" width="25"><img alt="[Warning]" src="../../../../../../../../doc/src/images/warning.png"></td> 91<th align="left">Warning</th> 92</tr> 93<tr><td align="left" valign="top"><p> 94 The modification of the rtree may invalidate the iterators. 95 </p></td></tr> 96</table></div> 97</div> 98<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 99<td align="left"></td> 100<td align="right"><div class="copyright-footer">Copyright © 2009-2019 Barend Gehrels, Bruno Lalande, Mateusz Loskot, Adam 101 Wulkiewicz, Oracle and/or its affiliates<p> 102 Distributed under the Boost Software License, Version 1.0. (See accompanying 103 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>) 104 </p> 105</div></td> 106</tr></table> 107<hr> 108<div class="spirit-nav"> 109<a accesskey="p" href="begin_rtree______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="clear_rtree________.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> 110</div> 111</body> 112</html> 113