| <html> |
| <head> |
| <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> |
| <title>nearest(Geometry const &, unsigned)</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 1. Geometry"> |
| <link rel="up" href="../group__predicates.html" title="Predicates (boost::geometry::index::)"> |
| <link rel="prev" href="satisfies_unarypredicate_const___.html" title="satisfies(UnaryPredicate const &)"> |
| <link rel="next" href="../../strategies.html" title="Strategies"> |
| </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="satisfies_unarypredicate_const___.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../group__predicates.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="../../strategies.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.group__predicates.nearest_geometry_const____unsigned_"></a><a name="group__predicates_1ga8772d9d3e5b12b3292f7d94d47310e3e"></a><a class="link" href="nearest_geometry_const____unsigned_.html" title="nearest(Geometry const &, unsigned)">nearest(Geometry |
| const &, unsigned)</a> |
| </h5></div></div></div> |
| <p> |
| <a class="indexterm" name="idp130505024"></a> |
| Generate <a class="link" href="nearest_geometry_const____unsigned_.html#group__predicates_1ga8772d9d3e5b12b3292f7d94d47310e3e">nearest()</a> |
| predicate. |
| </p> |
| <h6> |
| <a name="geometry.reference.spatial_indexes.group__predicates.nearest_geometry_const____unsigned_.h0"></a> |
| <span class="phrase"><a name="geometry.reference.spatial_indexes.group__predicates.nearest_geometry_const____unsigned_.description"></a></span><a class="link" href="nearest_geometry_const____unsigned_.html#geometry.reference.spatial_indexes.group__predicates.nearest_geometry_const____unsigned_.description">Description</a> |
| </h6> |
| <p> |
| When nearest predicate is passed to the query, k-nearest neighbour search |
| will be performed. <code class="literal"><a class="link" href="nearest_geometry_const____unsigned_.html#group__predicates_1ga8772d9d3e5b12b3292f7d94d47310e3e">nearest()</a></code> |
| predicate takes a <code class="literal"><code class="computeroutput"><span class="identifier">Geometry</span></code></code> |
| from which distances to <code class="literal"><code class="computeroutput"><span class="identifier">Values</span></code></code> |
| are calculated and the maximum number of <code class="literal"><code class="computeroutput"><span class="identifier">Values</span></code></code> |
| that should be returned. Internally boost::geometry::comparable_distance() |
| is used to perform the calculation. |
| </p> |
| <h6> |
| <a name="geometry.reference.spatial_indexes.group__predicates.nearest_geometry_const____unsigned_.h1"></a> |
| <span class="phrase"><a name="geometry.reference.spatial_indexes.group__predicates.nearest_geometry_const____unsigned_.synopsis"></a></span><a class="link" href="nearest_geometry_const____unsigned_.html#geometry.reference.spatial_indexes.group__predicates.nearest_geometry_const____unsigned_.synopsis">Synopsis</a> |
| </h6> |
| <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">Geometry</span></code><code class="computeroutput"><span class="special">></span></code> |
| <span class="emphasis"><em>unspecified</em></span> <code class="computeroutput"><span class="identifier">nearest</span></code><code class="computeroutput"><span class="special">(</span></code><code class="computeroutput"><span class="identifier">Geometry</span> <span class="keyword">const</span> <span class="special">&</span></code> <code class="computeroutput"><span class="identifier">geometry</span></code><code class="computeroutput"><span class="special">,</span></code> <code class="computeroutput"><span class="keyword">unsigned</span></code> <code class="computeroutput"><span class="identifier">k</span></code><code class="computeroutput"><span class="special">)</span></code> |
| </pre> |
| <h6> |
| <a name="geometry.reference.spatial_indexes.group__predicates.nearest_geometry_const____unsigned_.h2"></a> |
| <span class="phrase"><a name="geometry.reference.spatial_indexes.group__predicates.nearest_geometry_const____unsigned_.parameter_s_"></a></span><a class="link" href="nearest_geometry_const____unsigned_.html#geometry.reference.spatial_indexes.group__predicates.nearest_geometry_const____unsigned_.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">Geometry</span> <span class="keyword">const</span> |
| <span class="special">&</span></code> |
| </p> |
| </td> |
| <td> |
| <p> |
| <code class="computeroutput"><span class="identifier">geometry</span></code> |
| </p> |
| </td> |
| <td> |
| <p> |
| The geometry from which distance is calculated. |
| </p> |
| </td> |
| </tr> |
| <tr> |
| <td> |
| <p> |
| <code class="computeroutput"><span class="keyword">unsigned</span></code> |
| </p> |
| </td> |
| <td> |
| <p> |
| <code class="computeroutput"><span class="identifier">k</span></code> |
| </p> |
| </td> |
| <td> |
| <p> |
| The maximum number of values to return. |
| </p> |
| </td> |
| </tr> |
| </tbody> |
| </table></div> |
| <h6> |
| <a name="geometry.reference.spatial_indexes.group__predicates.nearest_geometry_const____unsigned_.h3"></a> |
| <span class="phrase"><a name="geometry.reference.spatial_indexes.group__predicates.nearest_geometry_const____unsigned_.example"></a></span><a class="link" href="nearest_geometry_const____unsigned_.html#geometry.reference.spatial_indexes.group__predicates.nearest_geometry_const____unsigned_.example">Example</a> |
| </h6> |
| <p> |
| </p> |
| <pre class="programlisting"><span class="identifier">bgi</span><span class="special">::</span><span class="identifier">query</span><span class="special">(</span><span class="identifier">spatial_index</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">5</span><span class="special">),</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">back_inserter</span><span class="special">(</span><span class="identifier">result</span><span class="special">));</span> |
| <span class="identifier">bgi</span><span class="special">::</span><span class="identifier">query</span><span class="special">(</span><span class="identifier">spatial_index</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">5</span><span class="special">)</span> <span class="special">&&</span> <span class="identifier">bgi</span><span class="special">::</span><span class="identifier">intersects</span><span class="special">(</span><span class="identifier">box</span><span class="special">),</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">back_inserter</span><span class="special">(</span><span class="identifier">result</span><span class="special">));</span> |
| <span class="identifier">bgi</span><span class="special">::</span><span class="identifier">query</span><span class="special">(</span><span class="identifier">spatial_index</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">box</span><span class="special">,</span> <span class="number">5</span><span class="special">),</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">back_inserter</span><span class="special">(</span><span class="identifier">result</span><span class="special">));</span> |
| </pre> |
| <p> |
| </p> |
| <div class="warning"><table border="0" summary="Warning"> |
| <tr> |
| <td rowspan="2" align="center" valign="top" width="25"><img alt="[Warning]" src="../../../../../../../../doc/src/images/warning.png"></td> |
| <th align="left">Warning</th> |
| </tr> |
| <tr><td align="left" valign="top"><p> |
| Only one <code class="literal"><a class="link" href="nearest_geometry_const____unsigned_.html#group__predicates_1ga8772d9d3e5b12b3292f7d94d47310e3e">nearest()</a></code> |
| predicate may be used in a query. |
| </p></td></tr> |
| </table></div> |
| </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 © 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="satisfies_unarypredicate_const___.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../group__predicates.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="../../strategies.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> |
| </div> |
| </body> |
| </html> |
