blob: 247af88360561246af4e9381a23a14c0afe36a28 [file] [log] [blame]
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>qbegin(Predicates const &amp;)</title>
<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="../../../../index.html" title="Chapter&#160;1.&#160;Geometry">
<link rel="up" href="../boost__geometry__index__rtree.html" title="boost::geometry::index::rtree">
<link rel="prev" href="query_predicates_const____outiter_.html" title="query(Predicates const &amp;, OutIter)">
<link rel="next" href="qend__.html" title="qend()">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td>
<td align="center"><a href="../../../../../../../../index.html">Home</a></td>
<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="query_predicates_const____outiter_.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="qend__.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry.reference.spatial_indexes.boost__geometry__index__rtree.qbegin_predicates_const___"></a><a name="classboost_1_1geometry_1_1index_1_1rtree_1a63d15f3b5b157a47045fcac3fec3b7a0"></a><a class="link" href="qbegin_predicates_const___.html" title="qbegin(Predicates const &amp;)">qbegin(Predicates
const &amp;)</a>
</h5></div></div></div>
<p>
<a class="indexterm" name="idp127277072"></a>
Returns the query iterator pointing at the begin of the query range.
</p>
<h6>
<a name="geometry.reference.spatial_indexes.boost__geometry__index__rtree.qbegin_predicates_const___.h0"></a>
<span class="phrase"><a name="geometry.reference.spatial_indexes.boost__geometry__index__rtree.qbegin_predicates_const___.description"></a></span><a class="link" href="qbegin_predicates_const___.html#geometry.reference.spatial_indexes.boost__geometry__index__rtree.qbegin_predicates_const___.description">Description</a>
</h6>
<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="link" href="query_predicates_const____outiter_.html#classboost_1_1geometry_1_1index_1_1rtree_1a7baa88eb4e7a5c640ab847513de45b3e">query()</a>.
</p>
<h6>
<a name="geometry.reference.spatial_indexes.boost__geometry__index__rtree.qbegin_predicates_const___.h1"></a>
<span class="phrase"><a name="geometry.reference.spatial_indexes.boost__geometry__index__rtree.qbegin_predicates_const___.synopsis"></a></span><a class="link" href="qbegin_predicates_const___.html#geometry.reference.spatial_indexes.boost__geometry__index__rtree.qbegin_predicates_const___.synopsis">Synopsis</a>
</h6>
<pre class="programlisting"><code class="computeroutput"><span class="keyword">template</span><span class="special">&lt;</span></code><code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Predicates</span></code><code class="computeroutput"><span class="special">&gt;</span></code>
<code class="literal"><a class="link" href="../boost__geometry__index__rtree.html#classboost_1_1geometry_1_1index_1_1rtree_1a83fce1047d890f327ea195ed252af176">const_query_iterator</a></code> <code class="computeroutput"><span class="identifier">qbegin</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">&amp;</span></code> <code class="computeroutput"><span class="identifier">predicates</span></code><code class="computeroutput"><span class="special">)</span></code>
</pre>
<h6>
<a name="geometry.reference.spatial_indexes.boost__geometry__index__rtree.qbegin_predicates_const___.h2"></a>
<span class="phrase"><a name="geometry.reference.spatial_indexes.boost__geometry__index__rtree.qbegin_predicates_const___.modifier_s_"></a></span><a class="link" href="qbegin_predicates_const___.html#geometry.reference.spatial_indexes.boost__geometry__index__rtree.qbegin_predicates_const___.modifier_s_">Modifier(s)</a>
</h6>
<p>
</p>
<pre class="programlisting"><span class="keyword">const</span></pre>
<p>
</p>
<h6>
<a name="geometry.reference.spatial_indexes.boost__geometry__index__rtree.qbegin_predicates_const___.h3"></a>
<span class="phrase"><a name="geometry.reference.spatial_indexes.boost__geometry__index__rtree.qbegin_predicates_const___.parameter_s_"></a></span><a class="link" href="qbegin_predicates_const___.html#geometry.reference.spatial_indexes.boost__geometry__index__rtree.qbegin_predicates_const___.parameter_s_">Parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Type
</p>
</th>
<th>
<p>
Name
</p>
</th>
<th>
<p>
Description
</p>
</th>
</tr></thead>
<tbody><tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">Predicates</span> <span class="keyword">const</span> <span class="special">&amp;</span></code>
</p>
</td>
<td>
<p>
<code class="computeroutput"><span class="identifier">predicates</span></code>
</p>
</td>
<td>
<p>
Predicates.
</p>
</td>
</tr></tbody>
</table></div>
<h6>
<a name="geometry.reference.spatial_indexes.boost__geometry__index__rtree.qbegin_predicates_const___.h4"></a>
<span class="phrase"><a name="geometry.reference.spatial_indexes.boost__geometry__index__rtree.qbegin_predicates_const___.returns"></a></span><a class="link" href="qbegin_predicates_const___.html#geometry.reference.spatial_indexes.boost__geometry__index__rtree.qbegin_predicates_const___.returns">Returns</a>
</h6>
<p>
The iterator pointing at the begin of the query range.
</p>
<h6>
<a name="geometry.reference.spatial_indexes.boost__geometry__index__rtree.qbegin_predicates_const___.h5"></a>
<span class="phrase"><a name="geometry.reference.spatial_indexes.boost__geometry__index__rtree.qbegin_predicates_const___.example"></a></span><a class="link" href="qbegin_predicates_const___.html#geometry.reference.spatial_indexes.boost__geometry__index__rtree.qbegin_predicates_const___.example">Example</a>
</h6>
<p>
</p>
<pre class="programlisting"><span class="keyword">for</span> <span class="special">(</span> <span class="identifier">Rtree</span><span class="special">::</span><span class="identifier">const_query_iterator</span> <span class="identifier">it</span> <span class="special">=</span> <span class="identifier">tree</span><span class="special">.</span><span class="identifier">qbegin</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">10000</span><span class="special">))</span> <span class="special">;</span>
<span class="identifier">it</span> <span class="special">!=</span> <span class="identifier">tree</span><span class="special">.</span><span class="identifier">qend</span><span class="special">()</span> <span class="special">;</span> <span class="special">++</span><span class="identifier">it</span> <span class="special">)</span>
<span class="special">{</span>
<span class="comment">// do something with value</span>
<span class="keyword">if</span> <span class="special">(</span> <span class="identifier">has_enough_nearest_values</span><span class="special">()</span> <span class="special">)</span>
<span class="keyword">break</span><span class="special">;</span>
<span class="special">}</span>
</pre>
<p>
</p>
<h6>
<a name="geometry.reference.spatial_indexes.boost__geometry__index__rtree.qbegin_predicates_const___.h6"></a>
<span class="phrase"><a name="geometry.reference.spatial_indexes.boost__geometry__index__rtree.qbegin_predicates_const___.throws"></a></span><a class="link" href="qbegin_predicates_const___.html#geometry.reference.spatial_indexes.boost__geometry__index__rtree.qbegin_predicates_const___.throws">Throws</a>
</h6>
<p>
If predicates copy throws. If allocation throws.
</p>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright &#169; 2009-2015 Barend Gehrels, Bruno Lalande,
Mateusz Loskot, Adam Wulkiewicz, Oracle and/or its affiliates<p>
Distributed under the Boost Software License, Version 1.0. (See accompanying
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>)
</p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="query_predicates_const____outiter_.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="qend__.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>