1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>qbegin(rtree<...> const &, Predicates 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="query_rtree______const____predicates_const____outiter_.html" title="query(rtree<...> const &, Predicates const &, OutIter)"> 10<link rel="next" href="qend_rtree______const___.html" title="qend(rtree<...> const &)"> 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="query_rtree______const____predicates_const____outiter_.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="qend_rtree______const___.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.qbegin_rtree______const____predicates_const___"></a><a name="group__rtree__functions_1ga45c2b7b112bf730d10367e10df62aa3c"></a><a class="link" href="qbegin_rtree______const____predicates_const___.html" title="qbegin(rtree<...> const &, Predicates const &)">qbegin(rtree<...> 28 const &, Predicates const &)</a> 29</h5></div></div></div> 30<p> 31 <a class="indexterm" name="idm45635674251056"></a> 32Returns the query iterator pointing at the begin of the query range. 33 </p> 34<h6> 35<a name="geometry.reference.spatial_indexes.group__rtree__functions.qbegin_rtree______const____predicates_const___.h0"></a> 36 <span class="phrase"><a name="geometry.reference.spatial_indexes.group__rtree__functions.qbegin_rtree______const____predicates_const___.description"></a></span><a class="link" href="qbegin_rtree______const____predicates_const___.html#geometry.reference.spatial_indexes.group__rtree__functions.qbegin_rtree______const____predicates_const___.description">Description</a> 37 </h6> 38<p> 39 This method returns the iterator which may be used to perform iterative 40 queries. For the information about the predicates which may be passed 41 to this method see <a class="link" href="query_rtree______const____predicates_const____outiter_.html#group__rtree__functions_1gadb43b211d5d743ebe2ef256328286e95">query()</a>. 42 </p> 43<h6> 44<a name="geometry.reference.spatial_indexes.group__rtree__functions.qbegin_rtree______const____predicates_const___.h1"></a> 45 <span class="phrase"><a name="geometry.reference.spatial_indexes.group__rtree__functions.qbegin_rtree______const____predicates_const___.synopsis"></a></span><a class="link" href="qbegin_rtree______const____predicates_const___.html#geometry.reference.spatial_indexes.group__rtree__functions.qbegin_rtree______const____predicates_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="keyword">typename</span> <span class="identifier">Predicates</span></code><code class="computeroutput"><span class="special">></span></code> 53<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_query_iterator</span></code> <code class="computeroutput"><span class="identifier">qbegin</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> <code class="computeroutput"><span class="identifier">Predicates</span> <span class="keyword">const</span> <span class="special">&</span></code> <code class="computeroutput"><span class="identifier">predicates</span></code><code class="computeroutput"><span class="special">)</span></code> 54</pre> 55<h6> 56<a name="geometry.reference.spatial_indexes.group__rtree__functions.qbegin_rtree______const____predicates_const___.h2"></a> 57 <span class="phrase"><a name="geometry.reference.spatial_indexes.group__rtree__functions.qbegin_rtree______const____predicates_const___.parameter_s_"></a></span><a class="link" href="qbegin_rtree______const____predicates_const___.html#geometry.reference.spatial_indexes.group__rtree__functions.qbegin_rtree______const____predicates_const___.parameter_s_">Parameter(s)</a> 58 </h6> 59<div class="informaltable"><table class="table"> 60<colgroup> 61<col> 62<col> 63<col> 64</colgroup> 65<thead><tr> 66<th> 67 <p> 68 Type 69 </p> 70 </th> 71<th> 72 <p> 73 Name 74 </p> 75 </th> 76<th> 77 <p> 78 Description 79 </p> 80 </th> 81</tr></thead> 82<tbody> 83<tr> 84<td> 85 <p> 86 <code class="computeroutput"><span class="identifier">rtree</span><span class="special"><</span> 87 <span class="identifier">Value</span><span class="special">,</span> 88 <span class="identifier">Parameters</span><span class="special">,</span> 89 <span class="identifier">IndexableGetter</span><span class="special">,</span> 90 <span class="identifier">EqualTo</span><span class="special">,</span> 91 <span class="identifier">Allocator</span> <span class="special">></span> 92 <span class="keyword">const</span> <span class="special">&</span></code> 93 </p> 94 </td> 95<td> 96 <p> 97 <code class="computeroutput"><span class="identifier">tree</span></code> 98 </p> 99 </td> 100<td> 101 <p> 102 The rtree. 103 </p> 104 </td> 105</tr> 106<tr> 107<td> 108 <p> 109 <code class="computeroutput"><span class="identifier">Predicates</span> <span class="keyword">const</span> <span class="special">&</span></code> 110 </p> 111 </td> 112<td> 113 <p> 114 <code class="computeroutput"><span class="identifier">predicates</span></code> 115 </p> 116 </td> 117<td> 118 <p> 119 Predicates. 120 </p> 121 </td> 122</tr> 123</tbody> 124</table></div> 125<h6> 126<a name="geometry.reference.spatial_indexes.group__rtree__functions.qbegin_rtree______const____predicates_const___.h3"></a> 127 <span class="phrase"><a name="geometry.reference.spatial_indexes.group__rtree__functions.qbegin_rtree______const____predicates_const___.returns"></a></span><a class="link" href="qbegin_rtree______const____predicates_const___.html#geometry.reference.spatial_indexes.group__rtree__functions.qbegin_rtree______const____predicates_const___.returns">Returns</a> 128 </h6> 129<p> 130 The iterator pointing at the begin of the query range. 131 </p> 132<h6> 133<a name="geometry.reference.spatial_indexes.group__rtree__functions.qbegin_rtree______const____predicates_const___.h4"></a> 134 <span class="phrase"><a name="geometry.reference.spatial_indexes.group__rtree__functions.qbegin_rtree______const____predicates_const___.example"></a></span><a class="link" href="qbegin_rtree______const____predicates_const___.html#geometry.reference.spatial_indexes.group__rtree__functions.qbegin_rtree______const____predicates_const___.example">Example</a> 135 </h6> 136<p> 137</p> 138<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">qbegin</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">nearest</span><span class="special">(</span><span class="identifier">pt</span><span class="special">,</span> <span class="number">3</span><span class="special">)),</span> <span class="identifier">bgi</span><span class="special">::</span><span class="identifier">qend</span><span class="special">(</span><span class="identifier">tree</span><span class="special">),</span> <span class="identifier">do_something</span><span class="special">());</span> 139</pre> 140<p> 141 </p> 142<h6> 143<a name="geometry.reference.spatial_indexes.group__rtree__functions.qbegin_rtree______const____predicates_const___.h5"></a> 144 <span class="phrase"><a name="geometry.reference.spatial_indexes.group__rtree__functions.qbegin_rtree______const____predicates_const___.iterator_category"></a></span><a class="link" href="qbegin_rtree______const____predicates_const___.html#geometry.reference.spatial_indexes.group__rtree__functions.qbegin_rtree______const____predicates_const___.iterator_category">Iterator 145 category</a> 146 </h6> 147<p> 148 ForwardIterator 149 </p> 150<h6> 151<a name="geometry.reference.spatial_indexes.group__rtree__functions.qbegin_rtree______const____predicates_const___.h6"></a> 152 <span class="phrase"><a name="geometry.reference.spatial_indexes.group__rtree__functions.qbegin_rtree______const____predicates_const___.throws"></a></span><a class="link" href="qbegin_rtree______const____predicates_const___.html#geometry.reference.spatial_indexes.group__rtree__functions.qbegin_rtree______const____predicates_const___.throws">Throws</a> 153 </h6> 154<p> 155 If predicates copy throws. If allocation throws. 156 </p> 157<div class="warning"><table border="0" summary="Warning"> 158<tr> 159<td rowspan="2" align="center" valign="top" width="25"><img alt="[Warning]" src="../../../../../../../../doc/src/images/warning.png"></td> 160<th align="left">Warning</th> 161</tr> 162<tr><td align="left" valign="top"><p> 163 The modification of the rtree may invalidate the iterators. 164 </p></td></tr> 165</table></div> 166</div> 167<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 168<td align="left"></td> 169<td align="right"><div class="copyright-footer">Copyright © 2009-2019 Barend Gehrels, Bruno Lalande, Mateusz Loskot, Adam 170 Wulkiewicz, Oracle and/or its affiliates<p> 171 Distributed under the Boost Software License, Version 1.0. (See accompanying 172 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>) 173 </p> 174</div></td> 175</tr></table> 176<hr> 177<div class="spirit-nav"> 178<a accesskey="p" href="query_rtree______const____predicates_const____outiter_.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="qend_rtree______const___.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> 179</div> 180</body> 181</html> 182
