mirror of
https://github.com/boostorg/geometry.git
synced 2025-05-11 05:24:02 +00:00
9161 lines
527 KiB
HTML
9161 lines
527 KiB
HTML
<html>
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
|
|
<title>Reference</title>
|
|
<link rel="stylesheet" href="http://www.boost.org/doc/libs/release/doc/src/boostbook.css" type="text/css">
|
|
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
|
|
<link rel="home" href="../../index.html" title="Chapter 1. Geometry Index">
|
|
<link rel="up" href="../r_tree.html" title="R-tree">
|
|
<link rel="prev" href="nearest_neighbours_queries.html" title="Nearest neighbours queries">
|
|
</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="http://www.boost.org/doc/libs/release/boost.png"></td>
|
|
<td align="center"><a href="http://www.boost.org/doc/libs/release/index.html">Home</a></td>
|
|
<td align="center"><a href="http://www.boost.org/doc/libs/release/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="http://www.boost.org/doc/libs/release/more/index.htm">More</a></td>
|
|
</tr></table>
|
|
<hr>
|
|
<div class="spirit-nav">
|
|
<a accesskey="p" href="nearest_neighbours_queries.html"><img src="http://www.boost.org/doc/libs/release/doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../r_tree.html"><img src="http://www.boost.org/doc/libs/release/doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="http://www.boost.org/doc/libs/release/doc/src/images/home.png" alt="Home"></a>
|
|
</div>
|
|
<div class="section">
|
|
<div class="titlepage"><div><div><h3 class="title">
|
|
<a name="geometry_index.r_tree.reference"></a><a class="link" href="reference.html" title="Reference">Reference</a>
|
|
</h3></div></div></div>
|
|
<div class="toc"><dl>
|
|
<dt><span class="section"><a href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree">boost::geometry::index::rtree</a></span></dt>
|
|
<dt><span class="section"><a href="reference.html#geometry_index.r_tree.reference.group__rtree__functions">Functions
|
|
related to the rtree</a></span></dt>
|
|
<dt><span class="section"><a href="reference.html#geometry_index.r_tree.reference.parameters">R-tree
|
|
parameters</a></span></dt>
|
|
<dt><span class="section"><a href="reference.html#geometry_index.r_tree.reference.group__predicates">Spatial
|
|
predicates (boost::geometry::index::)</a></span></dt>
|
|
<dt><span class="section"><a href="reference.html#geometry_index.r_tree.reference.group__distance__predicates">Distance
|
|
predicates (boost::geometry::index::)</a></span></dt>
|
|
<dt><span class="section"><a href="reference.html#geometry_index.r_tree.reference.group__adaptors">Adaptors
|
|
(boost::geometry::index::adaptors::)</a></span></dt>
|
|
<dt><span class="section"><a href="reference.html#geometry_index.r_tree.reference.translators">Translators
|
|
(boost::geometry::index::translators::)</a></span></dt>
|
|
<dt><span class="section"><a href="reference.html#geometry_index.r_tree.reference.group__inserters">Inserters
|
|
(boost::geometry::index::)</a></span></dt>
|
|
</dl></div>
|
|
<div class="section">
|
|
<div class="titlepage"><div><div><h4 class="title">
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree"></a><a name="classboost_1_1geometry_1_1index_1_1rtree"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree" title="boost::geometry::index::rtree">boost::geometry::index::rtree</a>
|
|
</h4></div></div></div>
|
|
<p>
|
|
<a class="indexterm" name="idp9821064"></a><a class="indexterm" name="idp9821376"></a><a class="indexterm" name="idp9821688"></a><a class="indexterm" name="idp9822000"></a>
|
|
The R-tree spatial index.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.h0"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.description">Description</a>
|
|
</h6>
|
|
<p>
|
|
This is self-balancing spatial index capable to store various types of
|
|
Values and balancing algorithms.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.h1"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.parameters">Parameters</a>
|
|
</h6>
|
|
<p>
|
|
The user must pass a type defining the Parameters which will be used in
|
|
rtree creation process. This type is used e.g. to specify balancing algorithm
|
|
with specific parameters like min and max number of elements in node.
|
|
</p>
|
|
<p>
|
|
Predefined algorithms with compile-time parameters are:
|
|
</p>
|
|
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
|
|
<li class="listitem">
|
|
<code class="literal"><a class="link" href="reference.html#structboost_1_1geometry_1_1index_1_1linear">boost::geometry::index::linear</a></code>,
|
|
</li>
|
|
<li class="listitem">
|
|
<code class="literal"><a class="link" href="reference.html#structboost_1_1geometry_1_1index_1_1quadratic">boost::geometry::index::quadratic</a></code>,
|
|
</li>
|
|
<li class="listitem">
|
|
<code class="literal"><a class="link" href="reference.html#structboost_1_1geometry_1_1index_1_1rstar">boost::geometry::index::rstar</a></code>.
|
|
</li>
|
|
</ul></div>
|
|
<p>
|
|
Predefined algorithms with run-time parameters are:
|
|
</p>
|
|
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
|
|
<li class="listitem">
|
|
<code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1runtime_1_1linear">boost::geometry::index::runtime::linear</a></code>,
|
|
</li>
|
|
<li class="listitem">
|
|
<code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1runtime_1_1quadratic">boost::geometry::index::runtime::quadratic</a></code>,
|
|
</li>
|
|
<li class="listitem">
|
|
<code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1runtime_1_1rstar">boost::geometry::index::runtime::rstar</a></code>.
|
|
</li>
|
|
</ul></div>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.h2"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.translator"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.translator">Translator</a>
|
|
</h6>
|
|
<p>
|
|
The Translator translates from Value to Indexable each time r-tree requires
|
|
it. Which means that this operation is done for each Value access. Therefore
|
|
the Translator should return the Indexable by const reference instead of
|
|
a value. Default translator can translate all types adapted to Point or
|
|
Box concepts (called Indexables). It also handles <code class="literal"><code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special"><</span><span class="identifier">Indexable</span><span class="special">,</span>
|
|
<span class="identifier">T</span><span class="special">></span></code></code>
|
|
and <code class="literal"><code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">tuple</span><span class="special"><</span><span class="identifier">Indexable</span><span class="special">,</span>
|
|
<span class="special">...></span></code></code>. For example,
|
|
if <code class="literal"><code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special"><</span><span class="identifier">Box</span><span class="special">,</span> <span class="keyword">int</span><span class="special">></span></code></code>
|
|
is stored in the container, the default translator translates from <code class="literal"><code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special"><</span><span class="identifier">Box</span><span class="special">,</span> <span class="keyword">int</span><span class="special">></span> <span class="keyword">const</span><span class="special">&</span></code></code>
|
|
to <code class="literal"><code class="computeroutput"><span class="identifier">Box</span> <span class="keyword">const</span><span class="special">&</span></code></code>.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.h3"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.header"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.header">Header</a>
|
|
</h6>
|
|
<p>
|
|
<code class="computeroutput"><span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">geometry</span><span class="special">/</span><span class="identifier">extensions</span><span class="special">/</span><span class="identifier">index</span><span class="special">/</span><span class="identifier">rtree</span><span class="special">/</span><span class="identifier">rtree</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code>
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.h4"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.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">Value</span></code><code class="computeroutput"><span class="special">,</span></code>
|
|
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Parameters</span></code><code class="computeroutput"><span class="special">,</span></code>
|
|
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Translator</span></code> = <code class="literal"><a class="link" href="reference.html#structboost_1_1geometry_1_1index_1_1translator_1_1def">translator::def</a></code><code class="computeroutput"><span class="special"><</span><span class="identifier">Value</span><span class="special">></span></code><code class="computeroutput"><span class="special">,</span></code>
|
|
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Allocator</span></code> = <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">allocator</span><span class="special"><</span><span class="identifier">Value</span><span class="special">></span></code><code class="computeroutput"><span class="special">></span></code>
|
|
<code class="computeroutput"><span class="keyword">class</span> <span class="identifier">rtree</span></code>
|
|
<code class="computeroutput"><span class="special">{</span></code>
|
|
<code class="computeroutput"> <span class="comment">// ...</span></code>
|
|
<code class="computeroutput"><span class="special">};</span></code>
|
|
</pre>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.h5"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.template_parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.template_parameter_s_">Template
|
|
parameter(s)</a>
|
|
</h6>
|
|
<div class="informaltable"><table class="table">
|
|
<colgroup>
|
|
<col>
|
|
<col>
|
|
</colgroup>
|
|
<thead><tr>
|
|
<th>
|
|
<p>
|
|
Parameter
|
|
</p>
|
|
</th>
|
|
<th>
|
|
<p>
|
|
Description
|
|
</p>
|
|
</th>
|
|
</tr></thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">Value</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The type of objects stored in the container.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">Parameters</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
Compile-time parameters.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">Translator</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The type of the translator which translates from Value to Indexable.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">Allocator</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The allocator used to allocate/deallocate memory, construct/destroy
|
|
nodes and Values.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.h6"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.typedef_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.typedef_s_">Typedef(s)</a>
|
|
</h6>
|
|
<div class="informaltable"><table class="table">
|
|
<colgroup>
|
|
<col>
|
|
<col>
|
|
</colgroup>
|
|
<thead><tr>
|
|
<th>
|
|
<p>
|
|
Type
|
|
</p>
|
|
</th>
|
|
<th>
|
|
<p>
|
|
Description
|
|
</p>
|
|
</th>
|
|
</tr></thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<a name="classboost_1_1geometry_1_1index_1_1rtree_1a9979db9ef37591985256cb8ad31862bb"></a><code class="computeroutput"><span class="identifier">value_type</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The type of Value stored in the container.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<a name="classboost_1_1geometry_1_1index_1_1rtree_1af85d4e399a807b3e4e46d38a0b4ffc5a"></a><code class="computeroutput"><span class="identifier">parameters_type</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
R-tree parameters type.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<a name="classboost_1_1geometry_1_1index_1_1rtree_1adbc30a1fa986e2e856e0662111ac2d91"></a><code class="computeroutput"><span class="identifier">translator_type</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
Value to Indexable Translator type.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<a name="classboost_1_1geometry_1_1index_1_1rtree_1a9d35bc38fa697c6f600548fb5b38807d"></a><code class="computeroutput"><span class="identifier">allocator_type</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The type of allocator used by the container.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<a name="classboost_1_1geometry_1_1index_1_1rtree_1a5c1a657074c527ed65f858c1ab6b36e6"></a><code class="computeroutput"><span class="identifier">size_type</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
Unsigned integral type used by the container.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<a name="classboost_1_1geometry_1_1index_1_1rtree_1ac011da09678f034a7fab487a9b973bfc"></a><code class="computeroutput"><span class="identifier">indexable_type</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The Indexable type to which Value is translated.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<a name="classboost_1_1geometry_1_1index_1_1rtree_1a42d0c9efffbc6f3935b5b9c3dd31e50d"></a><code class="computeroutput"><span class="identifier">box_type</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The Box type used by the R-tree.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.h7"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.constructor_s__and_destructor"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.constructor_s__and_destructor">Constructor(s)
|
|
and destructor</a>
|
|
</h6>
|
|
<div class="informaltable"><table class="table">
|
|
<colgroup>
|
|
<col>
|
|
<col>
|
|
</colgroup>
|
|
<thead><tr>
|
|
<th>
|
|
<p>
|
|
Function
|
|
</p>
|
|
</th>
|
|
<th>
|
|
<p>
|
|
Description
|
|
</p>
|
|
</th>
|
|
</tr></thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1afa64d1b825b06d196b1164aec27c2d7b"><code class="computeroutput"><span class="identifier">rtree</span><span class="special">()</span></code></a>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The constructor.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a2cadbaa3a7157f7503eef3f2f6b889aa"><code class="computeroutput"><span class="identifier">rtree</span><span class="special">(</span><span class="identifier">parameters_type</span><span class="special">,</span>
|
|
<span class="identifier">translator_type</span> <span class="keyword">const</span>
|
|
<span class="special">&,</span> <span class="identifier">allocator_type</span><span class="special">)</span></code></a>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The constructor.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a64c67e0dec7ccce2dc52d918436c62e5"><code class="computeroutput"><span class="identifier">rtree</span><span class="special">(</span><span class="identifier">Iterator</span><span class="special">,</span>
|
|
<span class="identifier">Iterator</span><span class="special">)</span></code></a>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The constructor.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a0d15842e8bb86a87f073ffabb7cabd21"><code class="computeroutput"><span class="identifier">rtree</span><span class="special">(</span><span class="identifier">Range</span> <span class="keyword">const</span>
|
|
<span class="special">&)</span></code></a>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The constructor.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1ae8b10914ec434d1ee6877f5e1000b674"><code class="computeroutput"><span class="special">~</span><span class="identifier">rtree</span><span class="special">()</span></code></a>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The destructor.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a006904b4e7dcef1fd1efcb70a010964f"><code class="computeroutput"><span class="identifier">rtree</span><span class="special">(</span><span class="identifier">rtree</span> <span class="keyword">const</span>
|
|
<span class="special">&)</span></code></a>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The copy constructor.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1ac59521aa9a9b69104fa25c0f7b705354"><code class="computeroutput"><span class="identifier">rtree</span><span class="special">(</span><span class="identifier">rtree</span> <span class="keyword">const</span>
|
|
<span class="special">&,</span> <span class="identifier">allocator_type</span>
|
|
<span class="keyword">const</span> <span class="special">&)</span></code></a>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The copy constructor.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a050fca8af38fe25548d4c22830b55bf2"><code class="computeroutput"><span class="identifier">rtree</span><span class="special">(</span><span class="identifier">rtree</span> <span class="special">&&)</span></code></a>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The moving constructor.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1ae0b4e031554daa6e6e8d3a0f95630260"><code class="computeroutput"><span class="identifier">rtree</span><span class="special">(</span><span class="identifier">rtree</span> <span class="special">&&,</span>
|
|
<span class="identifier">allocator_type</span> <span class="keyword">const</span>
|
|
<span class="special">&)</span></code></a>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The moving constructor.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.h8"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member_s_">Member(s)</a>
|
|
</h6>
|
|
<div class="informaltable"><table class="table">
|
|
<colgroup>
|
|
<col>
|
|
<col>
|
|
</colgroup>
|
|
<thead><tr>
|
|
<th>
|
|
<p>
|
|
Function
|
|
</p>
|
|
</th>
|
|
<th>
|
|
<p>
|
|
Description
|
|
</p>
|
|
</th>
|
|
</tr></thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1ab823a214501cb0f9fd00ba12a1ade179"><code class="computeroutput"><span class="keyword">operator</span><span class="special">=(</span><span class="keyword">const</span> <span class="identifier">rtree</span>
|
|
<span class="special">&)</span></code></a>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The assignment operator.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a44bd4edee49db92c18b6bbbba77b42be"><code class="computeroutput"><span class="keyword">operator</span><span class="special">=(</span><span class="identifier">rtree</span> <span class="special">&&)</span></code></a>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The moving assignment.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1aad0285d25f96341a8dd6cc22feb3bd73"><code class="computeroutput"><span class="identifier">swap</span><span class="special">(</span><span class="identifier">rtree</span> <span class="special">&)</span></code></a>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
Swaps contents of two rtrees.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1af6d5bd81e46cb4ff89277c753133664c"><code class="computeroutput"><span class="identifier">insert</span><span class="special">(</span><span class="identifier">value_type</span> <span class="keyword">const</span>
|
|
<span class="special">&)</span></code></a>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
Insert a value to the index.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a5263a3faac7b4f0090d4ad1d44cc540d"><code class="computeroutput"><span class="identifier">insert</span><span class="special">(</span><span class="identifier">Iterator</span><span class="special">,</span>
|
|
<span class="identifier">Iterator</span><span class="special">)</span></code></a>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
Insert a range of values to the index.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1abb624abd9268b41e815d40342b2634c2"><code class="computeroutput"><span class="identifier">insert</span><span class="special">(</span><span class="identifier">Range</span> <span class="keyword">const</span>
|
|
<span class="special">&)</span></code></a>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
Insert a range of values to the index.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1af6ca6909354a997f89411ef40ea5688a"><code class="computeroutput"><span class="identifier">remove</span><span class="special">(</span><span class="identifier">value_type</span> <span class="keyword">const</span>
|
|
<span class="special">&)</span></code></a>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
Remove a value from the container.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a6e9123114697d65b16ebc49cd5371fbd"><code class="computeroutput"><span class="identifier">remove</span><span class="special">(</span><span class="identifier">Iterator</span><span class="special">,</span>
|
|
<span class="identifier">Iterator</span><span class="special">)</span></code></a>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
Remove a range of values from the container.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a5a57bb93b0b2d7ea1c659e925f918e9c"><code class="computeroutput"><span class="identifier">remove</span><span class="special">(</span><span class="identifier">Range</span> <span class="keyword">const</span>
|
|
<span class="special">&)</span></code></a>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
Remove a range of values from the container.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a930bf17d595a91d8ae924383a0387920"><code class="computeroutput"><span class="identifier">spatial_query</span><span class="special">(</span><span class="identifier">Predicates</span> <span class="keyword">const</span>
|
|
<span class="special">&,</span> <span class="identifier">OutIter</span><span class="special">)</span></code></a>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
Finds values meeting spatial predicates, e.g. intersecting some
|
|
Box.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a788295b315bd0ddeb93b1cc050fdf909"><code class="computeroutput"><span class="identifier">nearest_query</span><span class="special">(</span><span class="identifier">DistancesPredicates</span> <span class="keyword">const</span>
|
|
<span class="special">&,</span> <span class="identifier">value_type</span>
|
|
<span class="special">&)</span></code></a>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
Finds one value meeting distances predicates, e.g. nearest to
|
|
some Point.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a6552331dca4d67647ef2a03bd0fbedcc"><code class="computeroutput"><span class="identifier">nearest_query</span><span class="special">(</span><span class="identifier">DistancesPredicates</span> <span class="keyword">const</span>
|
|
<span class="special">&,</span> <span class="identifier">Predicates</span>
|
|
<span class="keyword">const</span> <span class="special">&,</span>
|
|
<span class="identifier">value_type</span> <span class="special">&)</span></code></a>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
Finds one value meeting distances predicates and spatial predicates,
|
|
e.g. nearest to some Point and intersecting some Box.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a3101652211c9f2d6ed8626dae6ff5f9d"><code class="computeroutput"><span class="identifier">nearest_query</span><span class="special">(</span><span class="identifier">DistancesPredicates</span> <span class="keyword">const</span>
|
|
<span class="special">&,</span> <span class="identifier">size_type</span><span class="special">,</span> <span class="identifier">OutIter</span><span class="special">)</span></code></a>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
Finds k values meeting distances predicates, e.g. k nearest values
|
|
to some Point.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a31c23b87b01f12282ef0df6404ab7301"><code class="computeroutput"><span class="identifier">nearest_query</span><span class="special">(</span><span class="identifier">DistancesPredicates</span> <span class="keyword">const</span>
|
|
<span class="special">&,</span> <span class="identifier">size_type</span><span class="special">,</span> <span class="identifier">Predicates</span>
|
|
<span class="keyword">const</span> <span class="special">&,</span>
|
|
<span class="identifier">OutIter</span><span class="special">)</span></code></a>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
Finds k values meeting distances predicates and spatial predicates,
|
|
e.g. k nearest values to some Point and intersecting some Box.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a89561a834563f2ed6fc782bad16143fd"><code class="computeroutput"><span class="identifier">size</span><span class="special">()</span></code></a>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
Returns the number of stored values.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1ae889567443b0ba0dbdb975564c55804c"><code class="computeroutput"><span class="identifier">empty</span><span class="special">()</span></code></a>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
Query if the container is empty.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1ae6027e42d28a4bf93e74b055c79e6b09"><code class="computeroutput"><span class="identifier">clear</span><span class="special">()</span></code></a>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
Removes all values stored in the container.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1adf62005332a5fa9119ff03185e0c5143"><code class="computeroutput"><span class="identifier">box</span><span class="special">()</span></code></a>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
Returns the box containing all values stored in the container.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a17fce1fac81f6460d2c3a5744f4963ee"><code class="computeroutput"><span class="identifier">count</span><span class="special">(</span><span class="identifier">ValueOrIndexable</span> <span class="keyword">const</span>
|
|
<span class="special">&)</span></code></a>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
Count Values or Indexables stored in the container.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a18910715f67608ff010556ac41f51606"><code class="computeroutput"><span class="identifier">parameters</span><span class="special">()</span></code></a>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
Returns parameters.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1abcbe5bb1a70a7fec518fe4dd8baa750c"><code class="computeroutput"><span class="identifier">translator</span><span class="special">()</span></code></a>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
Returns the translator object.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a1eeb303253f4cabe3a89a82ed41247ff"><code class="computeroutput"><span class="identifier">get_allocator</span><span class="special">()</span></code></a>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
Returns allocator used by the rtree.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
<div class="section">
|
|
<div class="titlepage"><div><div><h5 class="title">
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.rtree__"></a><a name="classboost_1_1geometry_1_1index_1_1rtree_1afa64d1b825b06d196b1164aec27c2d7b"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.rtree__" title="rtree()">rtree()</a>
|
|
</h5></div></div></div>
|
|
<p>
|
|
The constructor.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.rtree__.h0"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.rtree__.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.rtree__.synopsis">Synopsis</a>
|
|
</h6>
|
|
<pre class="programlisting"><code class="computeroutput"><span class="identifier">rtree</span></code><code class="computeroutput"><span class="special">(</span></code><code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1af85d4e399a807b3e4e46d38a0b4ffc5a">parameters_type</a></code> <code class="computeroutput"><span class="identifier">parameters</span></code> = <code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1af85d4e399a807b3e4e46d38a0b4ffc5a">parameters_type</a></code><code class="computeroutput"><span class="special">()</span></code><code class="computeroutput"><span class="special">,</span></code> <code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1adbc30a1fa986e2e856e0662111ac2d91">translator_type</a></code><code class="computeroutput"> <span class="keyword">const</span> <span class="special">&</span></code> <code class="computeroutput"><span class="identifier">translator</span></code> = <code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1adbc30a1fa986e2e856e0662111ac2d91">translator_type</a></code><code class="computeroutput"><span class="special">()</span></code><code class="computeroutput"><span class="special">)</span></code>
|
|
</pre>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.rtree__.h1"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.rtree__.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.rtree__.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="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1af85d4e399a807b3e4e46d38a0b4ffc5a">parameters_type</a></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">parameters</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The parameters object.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1adbc30a1fa986e2e856e0662111ac2d91">translator_type</a></code><code class="computeroutput">
|
|
<span class="keyword">const</span> <span class="special">&</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">translator</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The translator object.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.rtree__.h2"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.rtree__.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.rtree__.throws">Throws</a>
|
|
</h6>
|
|
<p>
|
|
If allocator default constructor throws.
|
|
</p>
|
|
</div>
|
|
<div class="section">
|
|
<div class="titlepage"><div><div><h5 class="title">
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.rtree_parameters_type__translator_type_const____allocator_type_"></a><a name="classboost_1_1geometry_1_1index_1_1rtree_1a2cadbaa3a7157f7503eef3f2f6b889aa"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.rtree_parameters_type__translator_type_const____allocator_type_" title="rtree(parameters_type, translator_type const &, allocator_type)">rtree(parameters_type,
|
|
translator_type const &, allocator_type)</a>
|
|
</h5></div></div></div>
|
|
<p>
|
|
The constructor.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.rtree_parameters_type__translator_type_const____allocator_type_.h0"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.rtree_parameters_type__translator_type_const____allocator_type_.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.rtree_parameters_type__translator_type_const____allocator_type_.synopsis">Synopsis</a>
|
|
</h6>
|
|
<pre class="programlisting"><code class="computeroutput"><span class="identifier">rtree</span></code><code class="computeroutput"><span class="special">(</span></code><code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1af85d4e399a807b3e4e46d38a0b4ffc5a">parameters_type</a></code> <code class="computeroutput"><span class="identifier">parameters</span></code><code class="computeroutput"><span class="special">,</span></code>
|
|
<code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1adbc30a1fa986e2e856e0662111ac2d91">translator_type</a></code><code class="computeroutput"> <span class="keyword">const</span> <span class="special">&</span></code> <code class="computeroutput"><span class="identifier">translator</span></code><code class="computeroutput"><span class="special">,</span></code>
|
|
<code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a9d35bc38fa697c6f600548fb5b38807d">allocator_type</a></code> <code class="computeroutput"><span class="identifier">allocator</span></code><code class="computeroutput"><span class="special">)</span></code>
|
|
</pre>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.rtree_parameters_type__translator_type_const____allocator_type_.h1"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.rtree_parameters_type__translator_type_const____allocator_type_.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.rtree_parameters_type__translator_type_const____allocator_type_.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="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1af85d4e399a807b3e4e46d38a0b4ffc5a">parameters_type</a></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">parameters</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The parameters object.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1adbc30a1fa986e2e856e0662111ac2d91">translator_type</a></code><code class="computeroutput">
|
|
<span class="keyword">const</span> <span class="special">&</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">translator</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The translator object.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a9d35bc38fa697c6f600548fb5b38807d">allocator_type</a></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">allocator</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The allocator object.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.rtree_parameters_type__translator_type_const____allocator_type_.h2"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.rtree_parameters_type__translator_type_const____allocator_type_.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.rtree_parameters_type__translator_type_const____allocator_type_.throws">Throws</a>
|
|
</h6>
|
|
<p>
|
|
If allocator copy constructor throws.
|
|
</p>
|
|
</div>
|
|
<div class="section">
|
|
<div class="titlepage"><div><div><h5 class="title">
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.rtree_iterator__iterator_"></a><a name="classboost_1_1geometry_1_1index_1_1rtree_1a64c67e0dec7ccce2dc52d918436c62e5"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.rtree_iterator__iterator_" title="rtree(Iterator, Iterator)">rtree(Iterator,
|
|
Iterator)</a>
|
|
</h5></div></div></div>
|
|
<p>
|
|
The constructor.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.rtree_iterator__iterator_.h0"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.rtree_iterator__iterator_.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.rtree_iterator__iterator_.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">Iterator</span></code><code class="computeroutput"><span class="special">></span></code>
|
|
<code class="computeroutput"><span class="identifier">rtree</span></code><code class="computeroutput"><span class="special">(</span></code><code class="computeroutput"><span class="identifier">Iterator</span></code> <code class="computeroutput"><span class="identifier">first</span></code><code class="computeroutput"><span class="special">,</span></code>
|
|
<code class="computeroutput"><span class="identifier">Iterator</span></code> <code class="computeroutput"><span class="identifier">last</span></code><code class="computeroutput"><span class="special">,</span></code>
|
|
<code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1af85d4e399a807b3e4e46d38a0b4ffc5a">parameters_type</a></code> <code class="computeroutput"><span class="identifier">parameters</span></code> = <code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1af85d4e399a807b3e4e46d38a0b4ffc5a">parameters_type</a></code><code class="computeroutput"><span class="special">()</span></code><code class="computeroutput"><span class="special">,</span></code>
|
|
<code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1adbc30a1fa986e2e856e0662111ac2d91">translator_type</a></code><code class="computeroutput"> <span class="keyword">const</span> <span class="special">&</span></code> <code class="computeroutput"><span class="identifier">translator</span></code> = <code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1adbc30a1fa986e2e856e0662111ac2d91">translator_type</a></code><code class="computeroutput"><span class="special">()</span></code><code class="computeroutput"><span class="special">,</span></code>
|
|
<code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a9d35bc38fa697c6f600548fb5b38807d">allocator_type</a></code> <code class="computeroutput"><span class="identifier">allocator</span></code> = <code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a9d35bc38fa697c6f600548fb5b38807d">allocator_type</a></code><code class="computeroutput"><span class="special">()</span></code><code class="computeroutput"><span class="special">)</span></code>
|
|
</pre>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.rtree_iterator__iterator_.h1"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.rtree_iterator__iterator_.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.rtree_iterator__iterator_.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">Iterator</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">first</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The beginning of the range of Values.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">Iterator</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">last</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The end of the range of Values.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1af85d4e399a807b3e4e46d38a0b4ffc5a">parameters_type</a></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">parameters</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The parameters object.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1adbc30a1fa986e2e856e0662111ac2d91">translator_type</a></code><code class="computeroutput">
|
|
<span class="keyword">const</span> <span class="special">&</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">translator</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The translator object.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a9d35bc38fa697c6f600548fb5b38807d">allocator_type</a></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">allocator</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The allocator object.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.rtree_iterator__iterator_.h2"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.rtree_iterator__iterator_.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.rtree_iterator__iterator_.throws">Throws</a>
|
|
</h6>
|
|
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
|
|
<li class="listitem">
|
|
If allocator copy constructor throws.
|
|
</li>
|
|
<li class="listitem">
|
|
If Value copy constructor or copy assignment throws.
|
|
</li>
|
|
<li class="listitem">
|
|
If allocation throws.
|
|
</li>
|
|
<li class="listitem">
|
|
When memory allocation for Node fails.
|
|
</li>
|
|
</ul></div>
|
|
</div>
|
|
<div class="section">
|
|
<div class="titlepage"><div><div><h5 class="title">
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.rtree_range_const___"></a><a name="classboost_1_1geometry_1_1index_1_1rtree_1a0d15842e8bb86a87f073ffabb7cabd21"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.rtree_range_const___" title="rtree(Range const &)">rtree(Range
|
|
const &)</a>
|
|
</h5></div></div></div>
|
|
<p>
|
|
The constructor.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.rtree_range_const___.h0"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.rtree_range_const___.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.rtree_range_const___.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">Range</span></code><code class="computeroutput"><span class="special">></span></code>
|
|
<code class="computeroutput"><span class="identifier">rtree</span></code><code class="computeroutput"><span class="special">(</span></code><code class="computeroutput"><span class="identifier">Range</span> <span class="keyword">const</span> <span class="special">&</span></code> <code class="computeroutput"><span class="identifier">rng</span></code><code class="computeroutput"><span class="special">,</span></code>
|
|
<code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1af85d4e399a807b3e4e46d38a0b4ffc5a">parameters_type</a></code> <code class="computeroutput"><span class="identifier">parameters</span></code> = <code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1af85d4e399a807b3e4e46d38a0b4ffc5a">parameters_type</a></code><code class="computeroutput"><span class="special">()</span></code><code class="computeroutput"><span class="special">,</span></code>
|
|
<code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1adbc30a1fa986e2e856e0662111ac2d91">translator_type</a></code><code class="computeroutput"> <span class="keyword">const</span> <span class="special">&</span></code> <code class="computeroutput"><span class="identifier">translator</span></code> = <code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1adbc30a1fa986e2e856e0662111ac2d91">translator_type</a></code><code class="computeroutput"><span class="special">()</span></code><code class="computeroutput"><span class="special">,</span></code>
|
|
<code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a9d35bc38fa697c6f600548fb5b38807d">allocator_type</a></code> <code class="computeroutput"><span class="identifier">allocator</span></code> = <code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a9d35bc38fa697c6f600548fb5b38807d">allocator_type</a></code><code class="computeroutput"><span class="special">()</span></code><code class="computeroutput"><span class="special">)</span></code>
|
|
</pre>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.rtree_range_const___.h1"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.rtree_range_const___.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.rtree_range_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">Range</span> <span class="keyword">const</span>
|
|
<span class="special">&</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">rng</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The range of Values.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1af85d4e399a807b3e4e46d38a0b4ffc5a">parameters_type</a></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">parameters</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The parameters object.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1adbc30a1fa986e2e856e0662111ac2d91">translator_type</a></code><code class="computeroutput">
|
|
<span class="keyword">const</span> <span class="special">&</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">translator</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The translator object.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a9d35bc38fa697c6f600548fb5b38807d">allocator_type</a></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">allocator</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The allocator object.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.rtree_range_const___.h2"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.rtree_range_const___.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.rtree_range_const___.throws">Throws</a>
|
|
</h6>
|
|
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
|
|
<li class="listitem">
|
|
If allocator copy constructor throws.
|
|
</li>
|
|
<li class="listitem">
|
|
If Value copy constructor or copy assignment throws.
|
|
</li>
|
|
<li class="listitem">
|
|
If allocation throws.
|
|
</li>
|
|
<li class="listitem">
|
|
When memory allocation for Node fails.
|
|
</li>
|
|
</ul></div>
|
|
</div>
|
|
<div class="section">
|
|
<div class="titlepage"><div><div><h5 class="title">
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree._rtree__"></a><a name="classboost_1_1geometry_1_1index_1_1rtree_1ae8b10914ec434d1ee6877f5e1000b674"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree._rtree__" title="~rtree()">~rtree()</a>
|
|
</h5></div></div></div>
|
|
<p>
|
|
The destructor.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree._rtree__.h0"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree._rtree__.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree._rtree__.synopsis">Synopsis</a>
|
|
</h6>
|
|
<pre class="programlisting"><code class="computeroutput"><span class="special">~</span><span class="identifier">rtree</span></code><code class="computeroutput"><span class="special">()</span></code>
|
|
</pre>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree._rtree__.h1"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree._rtree__.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree._rtree__.throws">Throws</a>
|
|
</h6>
|
|
<p>
|
|
Nothing.
|
|
</p>
|
|
</div>
|
|
<div class="section">
|
|
<div class="titlepage"><div><div><h5 class="title">
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.rtree_rtree_const___"></a><a name="classboost_1_1geometry_1_1index_1_1rtree_1a006904b4e7dcef1fd1efcb70a010964f"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.rtree_rtree_const___" title="rtree(rtree const &)">rtree(rtree
|
|
const &)</a>
|
|
</h5></div></div></div>
|
|
<p>
|
|
The copy constructor.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.rtree_rtree_const___.h0"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.rtree_rtree_const___.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.rtree_rtree_const___.description">Description</a>
|
|
</h6>
|
|
<p>
|
|
It uses parameters, translator and allocator from the source tree.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.rtree_rtree_const___.h1"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.rtree_rtree_const___.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.rtree_rtree_const___.synopsis">Synopsis</a>
|
|
</h6>
|
|
<pre class="programlisting"><code class="computeroutput"><span class="identifier">rtree</span></code><code class="computeroutput"><span class="special">(</span></code><code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree">rtree</a></code><code class="computeroutput"> <span class="keyword">const</span> <span class="special">&</span></code> <code class="computeroutput"><span class="identifier">src</span></code><code class="computeroutput"><span class="special">)</span></code>
|
|
</pre>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.rtree_rtree_const___.h2"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.rtree_rtree_const___.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.rtree_rtree_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="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree">rtree</a></code><code class="computeroutput">
|
|
<span class="keyword">const</span> <span class="special">&</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">src</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The rtree which content will be copied.
|
|
</p>
|
|
</td>
|
|
</tr></tbody>
|
|
</table></div>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.rtree_rtree_const___.h3"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.rtree_rtree_const___.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.rtree_rtree_const___.throws">Throws</a>
|
|
</h6>
|
|
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
|
|
<li class="listitem">
|
|
If allocator copy constructor throws.
|
|
</li>
|
|
<li class="listitem">
|
|
If Value copy constructor throws.
|
|
</li>
|
|
<li class="listitem">
|
|
If allocation throws.
|
|
</li>
|
|
<li class="listitem">
|
|
When memory allocation for Node fails.
|
|
</li>
|
|
</ul></div>
|
|
</div>
|
|
<div class="section">
|
|
<div class="titlepage"><div><div><h5 class="title">
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.rtree_rtree_const____allocator_type_const___"></a><a name="classboost_1_1geometry_1_1index_1_1rtree_1ac59521aa9a9b69104fa25c0f7b705354"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.rtree_rtree_const____allocator_type_const___" title="rtree(rtree const &, allocator_type const &)">rtree(rtree
|
|
const &, allocator_type const &)</a>
|
|
</h5></div></div></div>
|
|
<p>
|
|
The copy constructor.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.rtree_rtree_const____allocator_type_const___.h0"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.rtree_rtree_const____allocator_type_const___.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.rtree_rtree_const____allocator_type_const___.description">Description</a>
|
|
</h6>
|
|
<p>
|
|
It uses Parameters and translator from the source tree.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.rtree_rtree_const____allocator_type_const___.h1"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.rtree_rtree_const____allocator_type_const___.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.rtree_rtree_const____allocator_type_const___.synopsis">Synopsis</a>
|
|
</h6>
|
|
<pre class="programlisting"><code class="computeroutput"><span class="identifier">rtree</span></code><code class="computeroutput"><span class="special">(</span></code><code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree">rtree</a></code><code class="computeroutput"> <span class="keyword">const</span> <span class="special">&</span></code> <code class="computeroutput"><span class="identifier">src</span></code><code class="computeroutput"><span class="special">,</span></code> <code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a9d35bc38fa697c6f600548fb5b38807d">allocator_type</a></code><code class="computeroutput"> <span class="keyword">const</span> <span class="special">&</span></code> <code class="computeroutput"><span class="identifier">allocator</span></code><code class="computeroutput"><span class="special">)</span></code>
|
|
</pre>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.rtree_rtree_const____allocator_type_const___.h2"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.rtree_rtree_const____allocator_type_const___.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.rtree_rtree_const____allocator_type_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="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree">rtree</a></code><code class="computeroutput">
|
|
<span class="keyword">const</span> <span class="special">&</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">src</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The rtree which content will be copied.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a9d35bc38fa697c6f600548fb5b38807d">allocator_type</a></code><code class="computeroutput">
|
|
<span class="keyword">const</span> <span class="special">&</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">allocator</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The allocator which will be used.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.rtree_rtree_const____allocator_type_const___.h3"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.rtree_rtree_const____allocator_type_const___.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.rtree_rtree_const____allocator_type_const___.throws">Throws</a>
|
|
</h6>
|
|
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
|
|
<li class="listitem">
|
|
If allocator copy constructor throws.
|
|
</li>
|
|
<li class="listitem">
|
|
If Value copy constructor throws.
|
|
</li>
|
|
<li class="listitem">
|
|
If allocation throws.
|
|
</li>
|
|
<li class="listitem">
|
|
When memory allocation for Node fails.
|
|
</li>
|
|
</ul></div>
|
|
</div>
|
|
<div class="section">
|
|
<div class="titlepage"><div><div><h5 class="title">
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.rtree_rtree____"></a><a name="classboost_1_1geometry_1_1index_1_1rtree_1a050fca8af38fe25548d4c22830b55bf2"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.rtree_rtree____" title="rtree(rtree &&)">rtree(rtree
|
|
&&)</a>
|
|
</h5></div></div></div>
|
|
<p>
|
|
The moving constructor.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.rtree_rtree____.h0"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.rtree_rtree____.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.rtree_rtree____.description">Description</a>
|
|
</h6>
|
|
<p>
|
|
It uses parameters, translator and allocator from the source tree.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.rtree_rtree____.h1"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.rtree_rtree____.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.rtree_rtree____.synopsis">Synopsis</a>
|
|
</h6>
|
|
<pre class="programlisting"><code class="computeroutput"><span class="identifier">rtree</span></code><code class="computeroutput"><span class="special">(</span></code><code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree">rtree</a></code><code class="computeroutput"> <span class="special">&&</span></code> <code class="computeroutput"><span class="identifier">src</span></code><code class="computeroutput"><span class="special">)</span></code>
|
|
</pre>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.rtree_rtree____.h2"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.rtree_rtree____.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.rtree_rtree____.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="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree">rtree</a></code><code class="computeroutput">
|
|
<span class="special">&&</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">src</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The rtree which content will be moved.
|
|
</p>
|
|
</td>
|
|
</tr></tbody>
|
|
</table></div>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.rtree_rtree____.h3"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.rtree_rtree____.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.rtree_rtree____.throws">Throws</a>
|
|
</h6>
|
|
<p>
|
|
Nothing.
|
|
</p>
|
|
</div>
|
|
<div class="section">
|
|
<div class="titlepage"><div><div><h5 class="title">
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.rtree_rtree_____allocator_type_const___"></a><a name="classboost_1_1geometry_1_1index_1_1rtree_1ae0b4e031554daa6e6e8d3a0f95630260"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.rtree_rtree_____allocator_type_const___" title="rtree(rtree &&, allocator_type const &)">rtree(rtree
|
|
&&, allocator_type const &)</a>
|
|
</h5></div></div></div>
|
|
<p>
|
|
The moving constructor.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.rtree_rtree_____allocator_type_const___.h0"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.rtree_rtree_____allocator_type_const___.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.rtree_rtree_____allocator_type_const___.description">Description</a>
|
|
</h6>
|
|
<p>
|
|
It uses parameters and translator from the source tree.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.rtree_rtree_____allocator_type_const___.h1"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.rtree_rtree_____allocator_type_const___.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.rtree_rtree_____allocator_type_const___.synopsis">Synopsis</a>
|
|
</h6>
|
|
<pre class="programlisting"><code class="computeroutput"><span class="identifier">rtree</span></code><code class="computeroutput"><span class="special">(</span></code><code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree">rtree</a></code><code class="computeroutput"> <span class="special">&&</span></code> <code class="computeroutput"><span class="identifier">src</span></code><code class="computeroutput"><span class="special">,</span></code> <code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a9d35bc38fa697c6f600548fb5b38807d">allocator_type</a></code><code class="computeroutput"> <span class="keyword">const</span> <span class="special">&</span></code> <code class="computeroutput"><span class="identifier">allocator</span></code><code class="computeroutput"><span class="special">)</span></code>
|
|
</pre>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.rtree_rtree_____allocator_type_const___.h2"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.rtree_rtree_____allocator_type_const___.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.rtree_rtree_____allocator_type_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="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree">rtree</a></code><code class="computeroutput">
|
|
<span class="special">&&</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">src</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The rtree which content will be moved.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a9d35bc38fa697c6f600548fb5b38807d">allocator_type</a></code><code class="computeroutput">
|
|
<span class="keyword">const</span> <span class="special">&</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">allocator</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The allocator.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.rtree_rtree_____allocator_type_const___.h3"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.rtree_rtree_____allocator_type_const___.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.rtree_rtree_____allocator_type_const___.throws">Throws</a>
|
|
</h6>
|
|
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
|
|
<li class="listitem">
|
|
If allocator copy constructor throws.
|
|
</li>
|
|
<li class="listitem">
|
|
If Value copy constructor throws (only if allocators aren't equal).
|
|
</li>
|
|
<li class="listitem">
|
|
If allocation throws (only if allocators aren't equal).
|
|
</li>
|
|
<li class="listitem">
|
|
When memory allocation for Node fails (only if allocators aren't
|
|
equal).
|
|
</li>
|
|
</ul></div>
|
|
</div>
|
|
<div class="section">
|
|
<div class="titlepage"><div><div><h5 class="title">
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.operator__const_rtree___"></a><a name="classboost_1_1geometry_1_1index_1_1rtree_1ab823a214501cb0f9fd00ba12a1ade179"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.operator__const_rtree___" title="operator=(const rtree &)">operator=(const
|
|
rtree &)</a>
|
|
</h5></div></div></div>
|
|
<p>
|
|
The assignment operator.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.operator__const_rtree___.h0"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.operator__const_rtree___.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.operator__const_rtree___.description">Description</a>
|
|
</h6>
|
|
<p>
|
|
It uses parameters and translator from the source tree.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.operator__const_rtree___.h1"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.operator__const_rtree___.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.operator__const_rtree___.synopsis">Synopsis</a>
|
|
</h6>
|
|
<pre class="programlisting"><code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree">rtree</a></code><code class="computeroutput"> <span class="special">&</span></code> <code class="computeroutput"><span class="keyword">operator</span><span class="special">=</span></code><code class="computeroutput"><span class="special">(</span></code><code class="computeroutput"><span class="keyword">const</span> </code><code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree">rtree</a></code><code class="computeroutput"> <span class="special">&</span></code> <code class="computeroutput"><span class="identifier">src</span></code><code class="computeroutput"><span class="special">)</span></code>
|
|
</pre>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.operator__const_rtree___.h2"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.operator__const_rtree___.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.operator__const_rtree___.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="keyword">const</span> </code><code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree">rtree</a></code><code class="computeroutput">
|
|
<span class="special">&</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">src</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The rtree which content will be copied.
|
|
</p>
|
|
</td>
|
|
</tr></tbody>
|
|
</table></div>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.operator__const_rtree___.h3"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.operator__const_rtree___.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.operator__const_rtree___.throws">Throws</a>
|
|
</h6>
|
|
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
|
|
<li class="listitem">
|
|
If Value copy constructor throws.
|
|
</li>
|
|
<li class="listitem">
|
|
If allocation throws.
|
|
</li>
|
|
<li class="listitem">
|
|
When nodes allocation fails.
|
|
</li>
|
|
</ul></div>
|
|
</div>
|
|
<div class="section">
|
|
<div class="titlepage"><div><div><h5 class="title">
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.operator__rtree____"></a><a name="classboost_1_1geometry_1_1index_1_1rtree_1a44bd4edee49db92c18b6bbbba77b42be"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.operator__rtree____" title="operator=(rtree &&)">operator=(rtree
|
|
&&)</a>
|
|
</h5></div></div></div>
|
|
<p>
|
|
The moving assignment.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.operator__rtree____.h0"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.operator__rtree____.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.operator__rtree____.description">Description</a>
|
|
</h6>
|
|
<p>
|
|
It uses parameters and translator from the source tree.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.operator__rtree____.h1"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.operator__rtree____.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.operator__rtree____.synopsis">Synopsis</a>
|
|
</h6>
|
|
<pre class="programlisting"><code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree">rtree</a></code><code class="computeroutput"> <span class="special">&</span></code> <code class="computeroutput"><span class="keyword">operator</span><span class="special">=</span></code><code class="computeroutput"><span class="special">(</span></code><code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree">rtree</a></code><code class="computeroutput"> <span class="special">&&</span></code> <code class="computeroutput"><span class="identifier">src</span></code><code class="computeroutput"><span class="special">)</span></code>
|
|
</pre>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.operator__rtree____.h2"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.operator__rtree____.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.operator__rtree____.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="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree">rtree</a></code><code class="computeroutput">
|
|
<span class="special">&&</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">src</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The rtree which content will be moved.
|
|
</p>
|
|
</td>
|
|
</tr></tbody>
|
|
</table></div>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.operator__rtree____.h3"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.operator__rtree____.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.operator__rtree____.throws">Throws</a>
|
|
</h6>
|
|
<p>
|
|
Only if allocators aren't equal.
|
|
</p>
|
|
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
|
|
<li class="listitem">
|
|
If Value copy constructor throws.
|
|
</li>
|
|
<li class="listitem">
|
|
If allocation throws.
|
|
</li>
|
|
<li class="listitem">
|
|
When nodes allocation fails.
|
|
</li>
|
|
</ul></div>
|
|
</div>
|
|
<div class="section">
|
|
<div class="titlepage"><div><div><h5 class="title">
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.swap_rtree___"></a><a name="classboost_1_1geometry_1_1index_1_1rtree_1aad0285d25f96341a8dd6cc22feb3bd73"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.swap_rtree___" title="swap(rtree &)">swap(rtree
|
|
&)</a>
|
|
</h5></div></div></div>
|
|
<p>
|
|
Swaps contents of two rtrees.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.swap_rtree___.h0"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.swap_rtree___.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.swap_rtree___.description">Description</a>
|
|
</h6>
|
|
<p>
|
|
Parameters, translator and allocators are swapped as well.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.swap_rtree___.h1"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.swap_rtree___.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.swap_rtree___.synopsis">Synopsis</a>
|
|
</h6>
|
|
<pre class="programlisting"><code class="computeroutput"><span class="keyword">void</span></code> <code class="computeroutput"><span class="identifier">swap</span></code><code class="computeroutput"><span class="special">(</span></code><code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree">rtree</a></code><code class="computeroutput"> <span class="special">&</span></code> <code class="computeroutput"><span class="identifier">other</span></code><code class="computeroutput"><span class="special">)</span></code>
|
|
</pre>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.swap_rtree___.h2"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.swap_rtree___.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.swap_rtree___.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="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree">rtree</a></code><code class="computeroutput">
|
|
<span class="special">&</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">other</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The rtree which content will be swapped with this rtree content.
|
|
</p>
|
|
</td>
|
|
</tr></tbody>
|
|
</table></div>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.swap_rtree___.h3"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.swap_rtree___.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.swap_rtree___.throws">Throws</a>
|
|
</h6>
|
|
<p>
|
|
If allocators swap throws.
|
|
</p>
|
|
</div>
|
|
<div class="section">
|
|
<div class="titlepage"><div><div><h5 class="title">
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.insert_value_type_const___"></a><a name="classboost_1_1geometry_1_1index_1_1rtree_1af6d5bd81e46cb4ff89277c753133664c"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.insert_value_type_const___" title="insert(value_type const &)">insert(value_type
|
|
const &)</a>
|
|
</h5></div></div></div>
|
|
<p>
|
|
Insert a value to the index.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.insert_value_type_const___.h0"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.insert_value_type_const___.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.insert_value_type_const___.synopsis">Synopsis</a>
|
|
</h6>
|
|
<pre class="programlisting"><code class="computeroutput"><span class="keyword">void</span></code> <code class="computeroutput"><span class="identifier">insert</span></code><code class="computeroutput"><span class="special">(</span></code><code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a9979db9ef37591985256cb8ad31862bb">value_type</a></code><code class="computeroutput"> <span class="keyword">const</span> <span class="special">&</span></code> <code class="computeroutput"><span class="identifier">value</span></code><code class="computeroutput"><span class="special">)</span></code>
|
|
</pre>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.insert_value_type_const___.h1"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.insert_value_type_const___.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.insert_value_type_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="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a9979db9ef37591985256cb8ad31862bb">value_type</a></code><code class="computeroutput">
|
|
<span class="keyword">const</span> <span class="special">&</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">value</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The value which will be stored in the container.
|
|
</p>
|
|
</td>
|
|
</tr></tbody>
|
|
</table></div>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.insert_value_type_const___.h2"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.insert_value_type_const___.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.insert_value_type_const___.throws">Throws</a>
|
|
</h6>
|
|
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
|
|
<li class="listitem">
|
|
If Value copy constructor or copy assignment throws.
|
|
</li>
|
|
<li class="listitem">
|
|
If allocation throws.
|
|
</li>
|
|
<li class="listitem">
|
|
When nodes allocation fails.
|
|
</li>
|
|
</ul></div>
|
|
<div class="warning"><table border="0" summary="Warning">
|
|
<tr>
|
|
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Warning]" src="http://www.boost.org/doc/libs/release/doc/src/images/warning.png"></td>
|
|
<th align="left">Warning</th>
|
|
</tr>
|
|
<tr><td align="left" valign="top"><p>
|
|
This operation is not thread safe. If it throws, the R-tree may be
|
|
left in an inconsistent state, elements must not be inserted or removed,
|
|
methods may return invalid data.
|
|
</p></td></tr>
|
|
</table></div>
|
|
</div>
|
|
<div class="section">
|
|
<div class="titlepage"><div><div><h5 class="title">
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.insert_iterator__iterator_"></a><a name="classboost_1_1geometry_1_1index_1_1rtree_1a5263a3faac7b4f0090d4ad1d44cc540d"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.insert_iterator__iterator_" title="insert(Iterator, Iterator)">insert(Iterator,
|
|
Iterator)</a>
|
|
</h5></div></div></div>
|
|
<p>
|
|
Insert a range of values to the index.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.insert_iterator__iterator_.h0"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.insert_iterator__iterator_.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.insert_iterator__iterator_.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">Iterator</span></code><code class="computeroutput"><span class="special">></span></code>
|
|
<code class="computeroutput"><span class="keyword">void</span></code> <code class="computeroutput"><span class="identifier">insert</span></code><code class="computeroutput"><span class="special">(</span></code><code class="computeroutput"><span class="identifier">Iterator</span></code> <code class="computeroutput"><span class="identifier">first</span></code><code class="computeroutput"><span class="special">,</span></code> <code class="computeroutput"><span class="identifier">Iterator</span></code> <code class="computeroutput"><span class="identifier">last</span></code><code class="computeroutput"><span class="special">)</span></code>
|
|
</pre>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.insert_iterator__iterator_.h1"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.insert_iterator__iterator_.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.insert_iterator__iterator_.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">Iterator</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">first</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The beginning of the range of values.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">Iterator</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">last</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The end of the range of values.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.insert_iterator__iterator_.h2"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.insert_iterator__iterator_.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.insert_iterator__iterator_.throws">Throws</a>
|
|
</h6>
|
|
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
|
|
<li class="listitem">
|
|
If Value copy constructor or copy assignment throws.
|
|
</li>
|
|
<li class="listitem">
|
|
If allocation throws.
|
|
</li>
|
|
<li class="listitem">
|
|
When nodes allocation fails.
|
|
</li>
|
|
</ul></div>
|
|
<div class="warning"><table border="0" summary="Warning">
|
|
<tr>
|
|
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Warning]" src="http://www.boost.org/doc/libs/release/doc/src/images/warning.png"></td>
|
|
<th align="left">Warning</th>
|
|
</tr>
|
|
<tr><td align="left" valign="top"><p>
|
|
This operation is not thread safe. If it throws, the R-tree may be
|
|
left in an inconsistent state, elements must not be inserted or removed,
|
|
methods may return invalid data.
|
|
</p></td></tr>
|
|
</table></div>
|
|
</div>
|
|
<div class="section">
|
|
<div class="titlepage"><div><div><h5 class="title">
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.insert_range_const___"></a><a name="classboost_1_1geometry_1_1index_1_1rtree_1abb624abd9268b41e815d40342b2634c2"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.insert_range_const___" title="insert(Range const &)">insert(Range
|
|
const &)</a>
|
|
</h5></div></div></div>
|
|
<p>
|
|
Insert a range of values to the index.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.insert_range_const___.h0"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.insert_range_const___.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.insert_range_const___.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">Range</span></code><code class="computeroutput"><span class="special">></span></code>
|
|
<code class="computeroutput"><span class="keyword">void</span></code> <code class="computeroutput"><span class="identifier">insert</span></code><code class="computeroutput"><span class="special">(</span></code><code class="computeroutput"><span class="identifier">Range</span> <span class="keyword">const</span> <span class="special">&</span></code> <code class="computeroutput"><span class="identifier">rng</span></code><code class="computeroutput"><span class="special">)</span></code>
|
|
</pre>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.insert_range_const___.h1"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.insert_range_const___.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.insert_range_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">Range</span> <span class="keyword">const</span>
|
|
<span class="special">&</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">rng</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The range of values.
|
|
</p>
|
|
</td>
|
|
</tr></tbody>
|
|
</table></div>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.insert_range_const___.h2"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.insert_range_const___.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.insert_range_const___.throws">Throws</a>
|
|
</h6>
|
|
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
|
|
<li class="listitem">
|
|
If Value copy constructor or copy assignment throws.
|
|
</li>
|
|
<li class="listitem">
|
|
If allocation throws.
|
|
</li>
|
|
<li class="listitem">
|
|
When nodes allocation fails.
|
|
</li>
|
|
</ul></div>
|
|
<div class="warning"><table border="0" summary="Warning">
|
|
<tr>
|
|
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Warning]" src="http://www.boost.org/doc/libs/release/doc/src/images/warning.png"></td>
|
|
<th align="left">Warning</th>
|
|
</tr>
|
|
<tr><td align="left" valign="top"><p>
|
|
This operation is not thread safe. If it throws, the R-tree may be
|
|
left in an inconsistent state, elements must not be inserted or removed,
|
|
methods may return invalid data.
|
|
</p></td></tr>
|
|
</table></div>
|
|
</div>
|
|
<div class="section">
|
|
<div class="titlepage"><div><div><h5 class="title">
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.remove_value_type_const___"></a><a name="classboost_1_1geometry_1_1index_1_1rtree_1af6ca6909354a997f89411ef40ea5688a"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.remove_value_type_const___" title="remove(value_type const &)">remove(value_type
|
|
const &)</a>
|
|
</h5></div></div></div>
|
|
<p>
|
|
Remove a value from the container.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.remove_value_type_const___.h0"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.remove_value_type_const___.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.remove_value_type_const___.description">Description</a>
|
|
</h6>
|
|
<p>
|
|
In contrast to the <code class="literal"><code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">set</span></code></code>
|
|
or <code class="literal"><code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">map</span> <span class="identifier">erase</span><span class="special">()</span></code></code> method this method removes
|
|
only one value from the container.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.remove_value_type_const___.h1"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.remove_value_type_const___.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.remove_value_type_const___.synopsis">Synopsis</a>
|
|
</h6>
|
|
<pre class="programlisting"><code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a5c1a657074c527ed65f858c1ab6b36e6">size_type</a></code> <code class="computeroutput"><span class="identifier">remove</span></code><code class="computeroutput"><span class="special">(</span></code><code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a9979db9ef37591985256cb8ad31862bb">value_type</a></code><code class="computeroutput"> <span class="keyword">const</span> <span class="special">&</span></code> <code class="computeroutput"><span class="identifier">value</span></code><code class="computeroutput"><span class="special">)</span></code>
|
|
</pre>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.remove_value_type_const___.h2"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.remove_value_type_const___.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.remove_value_type_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="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a9979db9ef37591985256cb8ad31862bb">value_type</a></code><code class="computeroutput">
|
|
<span class="keyword">const</span> <span class="special">&</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">value</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The value which will be removed from the container.
|
|
</p>
|
|
</td>
|
|
</tr></tbody>
|
|
</table></div>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.remove_value_type_const___.h3"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.remove_value_type_const___.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.remove_value_type_const___.returns">Returns</a>
|
|
</h6>
|
|
<p>
|
|
1 if the value was removed, 0 otherwise.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.remove_value_type_const___.h4"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.remove_value_type_const___.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.remove_value_type_const___.throws">Throws</a>
|
|
</h6>
|
|
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
|
|
<li class="listitem">
|
|
If Value copy constructor or copy assignment throws.
|
|
</li>
|
|
<li class="listitem">
|
|
If allocation throws.
|
|
</li>
|
|
<li class="listitem">
|
|
When nodes allocation fails.
|
|
</li>
|
|
</ul></div>
|
|
<div class="warning"><table border="0" summary="Warning">
|
|
<tr>
|
|
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Warning]" src="http://www.boost.org/doc/libs/release/doc/src/images/warning.png"></td>
|
|
<th align="left">Warning</th>
|
|
</tr>
|
|
<tr><td align="left" valign="top"><p>
|
|
This operation is not thread safe. If it throws, the R-tree may be
|
|
left in an inconsistent state, elements must not be inserted or removed,
|
|
methods may return invalid data.
|
|
</p></td></tr>
|
|
</table></div>
|
|
</div>
|
|
<div class="section">
|
|
<div class="titlepage"><div><div><h5 class="title">
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.remove_iterator__iterator_"></a><a name="classboost_1_1geometry_1_1index_1_1rtree_1a6e9123114697d65b16ebc49cd5371fbd"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.remove_iterator__iterator_" title="remove(Iterator, Iterator)">remove(Iterator,
|
|
Iterator)</a>
|
|
</h5></div></div></div>
|
|
<p>
|
|
Remove a range of values from the container.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.remove_iterator__iterator_.h0"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.remove_iterator__iterator_.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.remove_iterator__iterator_.description">Description</a>
|
|
</h6>
|
|
<p>
|
|
In contrast to the <code class="literal"><code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">set</span></code></code>
|
|
or <code class="literal"><code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">map</span> <span class="identifier">erase</span><span class="special">()</span></code></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 method removes only one
|
|
value for each one passed in the range, not all equal values.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.remove_iterator__iterator_.h1"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.remove_iterator__iterator_.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.remove_iterator__iterator_.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">Iterator</span></code><code class="computeroutput"><span class="special">></span></code>
|
|
<code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a5c1a657074c527ed65f858c1ab6b36e6">size_type</a></code> <code class="computeroutput"><span class="identifier">remove</span></code><code class="computeroutput"><span class="special">(</span></code><code class="computeroutput"><span class="identifier">Iterator</span></code> <code class="computeroutput"><span class="identifier">first</span></code><code class="computeroutput"><span class="special">,</span></code> <code class="computeroutput"><span class="identifier">Iterator</span></code> <code class="computeroutput"><span class="identifier">last</span></code><code class="computeroutput"><span class="special">)</span></code>
|
|
</pre>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.remove_iterator__iterator_.h2"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.remove_iterator__iterator_.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.remove_iterator__iterator_.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">Iterator</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">first</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The beginning of the range of values.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">Iterator</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">last</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The end of the range of values.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.remove_iterator__iterator_.h3"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.remove_iterator__iterator_.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.remove_iterator__iterator_.returns">Returns</a>
|
|
</h6>
|
|
<p>
|
|
The number of removed values.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.remove_iterator__iterator_.h4"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.remove_iterator__iterator_.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.remove_iterator__iterator_.throws">Throws</a>
|
|
</h6>
|
|
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
|
|
<li class="listitem">
|
|
If Value copy constructor or copy assignment throws.
|
|
</li>
|
|
<li class="listitem">
|
|
If allocation throws.
|
|
</li>
|
|
<li class="listitem">
|
|
When nodes allocation fails.
|
|
</li>
|
|
</ul></div>
|
|
<div class="warning"><table border="0" summary="Warning">
|
|
<tr>
|
|
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Warning]" src="http://www.boost.org/doc/libs/release/doc/src/images/warning.png"></td>
|
|
<th align="left">Warning</th>
|
|
</tr>
|
|
<tr><td align="left" valign="top"><p>
|
|
This operation is not thread safe. If it throws, the R-tree may be
|
|
left in an inconsistent state, elements must not be inserted or removed,
|
|
methods may return invalid data.
|
|
</p></td></tr>
|
|
</table></div>
|
|
</div>
|
|
<div class="section">
|
|
<div class="titlepage"><div><div><h5 class="title">
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.remove_range_const___"></a><a name="classboost_1_1geometry_1_1index_1_1rtree_1a5a57bb93b0b2d7ea1c659e925f918e9c"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.remove_range_const___" title="remove(Range const &)">remove(Range
|
|
const &)</a>
|
|
</h5></div></div></div>
|
|
<p>
|
|
Remove a range of values from the container.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.remove_range_const___.h0"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.remove_range_const___.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.remove_range_const___.description">Description</a>
|
|
</h6>
|
|
<p>
|
|
In contrast to the <code class="literal"><code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">set</span></code></code>
|
|
or <code class="literal"><code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">map</span> <span class="identifier">erase</span><span class="special">()</span></code></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>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.remove_range_const___.h1"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.remove_range_const___.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.remove_range_const___.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">Range</span></code><code class="computeroutput"><span class="special">></span></code>
|
|
<code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a5c1a657074c527ed65f858c1ab6b36e6">size_type</a></code> <code class="computeroutput"><span class="identifier">remove</span></code><code class="computeroutput"><span class="special">(</span></code><code class="computeroutput"><span class="identifier">Range</span> <span class="keyword">const</span> <span class="special">&</span></code> <code class="computeroutput"><span class="identifier">rng</span></code><code class="computeroutput"><span class="special">)</span></code>
|
|
</pre>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.remove_range_const___.h2"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.remove_range_const___.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.remove_range_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">Range</span> <span class="keyword">const</span>
|
|
<span class="special">&</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">rng</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The range of values.
|
|
</p>
|
|
</td>
|
|
</tr></tbody>
|
|
</table></div>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.remove_range_const___.h3"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.remove_range_const___.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.remove_range_const___.returns">Returns</a>
|
|
</h6>
|
|
<p>
|
|
The number of removed values.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.remove_range_const___.h4"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.remove_range_const___.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.remove_range_const___.throws">Throws</a>
|
|
</h6>
|
|
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
|
|
<li class="listitem">
|
|
If Value copy constructor or copy assignment throws.
|
|
</li>
|
|
<li class="listitem">
|
|
If allocation throws.
|
|
</li>
|
|
<li class="listitem">
|
|
When nodes allocation fails.
|
|
</li>
|
|
</ul></div>
|
|
<div class="warning"><table border="0" summary="Warning">
|
|
<tr>
|
|
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Warning]" src="http://www.boost.org/doc/libs/release/doc/src/images/warning.png"></td>
|
|
<th align="left">Warning</th>
|
|
</tr>
|
|
<tr><td align="left" valign="top"><p>
|
|
This operation is not thread safe. If it throws, the R-tree may be
|
|
left in an inconsistent state, elements must not be inserted or removed,
|
|
methods may return invalid data.
|
|
</p></td></tr>
|
|
</table></div>
|
|
</div>
|
|
<div class="section">
|
|
<div class="titlepage"><div><div><h5 class="title">
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.spatial_query_predicates_const____outiter_"></a><a name="classboost_1_1geometry_1_1index_1_1rtree_1a930bf17d595a91d8ae924383a0387920"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.spatial_query_predicates_const____outiter_" title="spatial_query(Predicates const &, OutIter)">spatial_query(Predicates
|
|
const &, OutIter)</a>
|
|
</h5></div></div></div>
|
|
<p>
|
|
Finds values meeting spatial predicates, e.g. intersecting some Box.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.spatial_query_predicates_const____outiter_.h0"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.spatial_query_predicates_const____outiter_.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.spatial_query_predicates_const____outiter_.description">Description</a>
|
|
</h6>
|
|
<p>
|
|
<span class="bold"><strong>Spatial predicates</strong></span> may be a <code class="literal"><code class="computeroutput"><span class="identifier">Geometry</span></code></code>. In this case Values
|
|
intersecting the <code class="literal"><code class="computeroutput"><span class="identifier">Geometry</span></code></code>
|
|
are returned.
|
|
</p>
|
|
<p>
|
|
It may be generated by one of the functions listed below:
|
|
</p>
|
|
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
|
|
<li class="listitem">
|
|
<code class="literal"><a class="link" href="reference.html#group__predicates_1ga0a613a7f1d18ac33955bfdc2c5777c61">boost::geometry::index::covered_by()</a></code>,
|
|
</li>
|
|
<li class="listitem">
|
|
<code class="literal"><a class="link" href="reference.html#group__predicates_1ga351bb3b82e019ff45adf789385b8007d">boost::geometry::index::disjoint()</a></code>,
|
|
</li>
|
|
<li class="listitem">
|
|
<code class="literal"><a class="link" href="reference.html#group__predicates_1ga7301c50e0272976b9f1434536383e6d0">boost::geometry::index::intersects()</a></code>
|
|
- default,
|
|
</li>
|
|
<li class="listitem">
|
|
<code class="literal"><a class="link" href="reference.html#group__predicates_1ga5511236f56be1defcccbf11e742ccd88">boost::geometry::index::overlaps()</a></code>,
|
|
</li>
|
|
<li class="listitem">
|
|
<code class="literal"><a class="link" href="reference.html#group__predicates_1gabf9c4e76dd8a09a4c476f2f8fa8a0e4d">boost::geometry::index::within()</a></code>,
|
|
</li>
|
|
<li class="listitem">
|
|
<code class="literal"><code class="computeroutput"><span class="special">!</span> </code><a class="link" href="reference.html#group__predicates_1ga0a613a7f1d18ac33955bfdc2c5777c61">boost::geometry::index::covered_by()</a></code>,
|
|
</li>
|
|
<li class="listitem">
|
|
<code class="literal"><code class="computeroutput"><span class="special">!</span> </code><a class="link" href="reference.html#group__predicates_1ga351bb3b82e019ff45adf789385b8007d">boost::geometry::index::disjoint()</a></code>,
|
|
</li>
|
|
<li class="listitem">
|
|
<code class="literal"><code class="computeroutput"><span class="special">!</span> </code><a class="link" href="reference.html#group__predicates_1ga7301c50e0272976b9f1434536383e6d0">boost::geometry::index::intersects()</a></code>,
|
|
</li>
|
|
<li class="listitem">
|
|
<code class="literal"><code class="computeroutput"><span class="special">!</span> </code><a class="link" href="reference.html#group__predicates_1ga5511236f56be1defcccbf11e742ccd88">boost::geometry::index::overlaps()</a></code>,
|
|
</li>
|
|
<li class="listitem">
|
|
<code class="literal"><code class="computeroutput"><span class="special">!</span> </code><a class="link" href="reference.html#group__predicates_1gabf9c4e76dd8a09a4c476f2f8fa8a0e4d">boost::geometry::index::within()</a></code>
|
|
</li>
|
|
<li class="listitem">
|
|
<code class="literal"><a class="link" href="reference.html#group__predicates_1ga5c93efac97377136564623cbaf35d880">boost::geometry::index::value()</a></code>.
|
|
</li>
|
|
</ul></div>
|
|
<p>
|
|
Those predicates may be passed together in <code class="literal"><code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span></code></code>
|
|
or <code class="literal"><code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">tuple</span></code></code>.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.spatial_query_predicates_const____outiter_.h1"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.spatial_query_predicates_const____outiter_.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.spatial_query_predicates_const____outiter_.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">Predicates</span></code><code class="computeroutput"><span class="special">,</span></code> <code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">OutIter</span></code><code class="computeroutput"><span class="special">></span></code>
|
|
<code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a5c1a657074c527ed65f858c1ab6b36e6">size_type</a></code> <code class="computeroutput"><span class="identifier">spatial_query</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">pred</span></code><code class="computeroutput"><span class="special">,</span></code> <code class="computeroutput"><span class="identifier">OutIter</span></code> <code class="computeroutput"><span class="identifier">out_it</span></code><code class="computeroutput"><span class="special">)</span></code>
|
|
</pre>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.spatial_query_predicates_const____outiter_.h2"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.spatial_query_predicates_const____outiter_.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.spatial_query_predicates_const____outiter_.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">&</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">pred</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The spatial predicates or a Geometry.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">OutIter</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">out_it</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The output iterator of the result range. E.g. an iterator generated
|
|
by std::back_inserter(container)
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.spatial_query_predicates_const____outiter_.h3"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.spatial_query_predicates_const____outiter_.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.spatial_query_predicates_const____outiter_.returns">Returns</a>
|
|
</h6>
|
|
<p>
|
|
The number of values found.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.spatial_query_predicates_const____outiter_.h4"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.spatial_query_predicates_const____outiter_.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.spatial_query_predicates_const____outiter_.throws">Throws</a>
|
|
</h6>
|
|
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
|
|
<li class="listitem">
|
|
If Value copy constructor or copy assignment throws.
|
|
</li>
|
|
<li class="listitem">
|
|
If OutIter dereference or increment throws.
|
|
</li>
|
|
</ul></div>
|
|
</div>
|
|
<div class="section">
|
|
<div class="titlepage"><div><div><h5 class="title">
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.nearest_query_distancespredicates_const____value_type___"></a><a name="classboost_1_1geometry_1_1index_1_1rtree_1a788295b315bd0ddeb93b1cc050fdf909"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.nearest_query_distancespredicates_const____value_type___" title="nearest_query(DistancesPredicates const &, value_type &)">nearest_query(DistancesPredicates
|
|
const &, value_type &)</a>
|
|
</h5></div></div></div>
|
|
<p>
|
|
Finds one value meeting distances predicates, e.g. nearest to some Point.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.nearest_query_distancespredicates_const____value_type___.h0"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.nearest_query_distancespredicates_const____value_type___.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.nearest_query_distancespredicates_const____value_type___.description">Description</a>
|
|
</h6>
|
|
<p>
|
|
<span class="bold"><strong>Distances predicates</strong></span> may be a <code class="literal"><code class="computeroutput"><span class="identifier">Point</span></code></code>. In this the case the
|
|
Value closest to <code class="literal"><code class="computeroutput"><span class="identifier">Point</span></code></code>
|
|
is returned.
|
|
</p>
|
|
<p>
|
|
It is possible to define how distance to Value is calculated. This is
|
|
done by passing PointRelation. It can be generated by following functions:
|
|
</p>
|
|
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
|
|
<li class="listitem">
|
|
<code class="literal"><a class="link" href="reference.html#group__distance__predicates_1gace3c7dbc60840c2a61da36e975d56636">boost::geometry::index::to_nearest()</a></code>
|
|
- default,
|
|
</li>
|
|
<li class="listitem">
|
|
<code class="literal"><a class="link" href="reference.html#group__distance__predicates_1gaccbba95d864d8dcf8a694796c840fbe0">boost::geometry::index::to_centroid()</a></code>,
|
|
</li>
|
|
<li class="listitem">
|
|
<code class="literal"><a class="link" href="reference.html#group__distance__predicates_1ga67dddd8a7fcaae150970e1db0401de02">boost::geometry::index::to_furthest()</a></code>.
|
|
</li>
|
|
</ul></div>
|
|
<p>
|
|
It is possible to define define distances bounds, for example that some
|
|
distance must be between min_distance and max_distance. This is done
|
|
by passing DistancesPredicates which can be generated by following functions:
|
|
</p>
|
|
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
|
|
<li class="listitem">
|
|
<code class="literal"><a class="link" href="reference.html#group__distance__predicates_1ga1b0f969b575a94ca710b9345861f64db">boost::geometry::index::unbounded()</a></code>
|
|
- default,
|
|
</li>
|
|
<li class="listitem">
|
|
<code class="literal"><a class="link" href="reference.html#group__distance__predicates_1ga39c7c94776ab840e164848e53d376098">boost::geometry::index::min_bounded()</a></code>,
|
|
</li>
|
|
<li class="listitem">
|
|
<code class="literal"><a class="link" href="reference.html#group__distance__predicates_1ga843735643378288b0e14e19cc9b4e079">boost::geometry::index::max_bounded()</a></code>,
|
|
</li>
|
|
<li class="listitem">
|
|
<code class="literal"><a class="link" href="reference.html#group__distance__predicates_1ga20621ca608b1420c38182346b965f347">boost::geometry::index::bounded()</a></code>.
|
|
</li>
|
|
</ul></div>
|
|
<p>
|
|
MinRelation and MaxRelation describes bounds and can be generated by
|
|
following functions:
|
|
</p>
|
|
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
|
|
<li class="listitem">
|
|
<code class="literal"><a class="link" href="reference.html#group__distance__predicates_1gace3c7dbc60840c2a61da36e975d56636">boost::geometry::index::to_nearest()</a></code>,
|
|
</li>
|
|
<li class="listitem">
|
|
<code class="literal"><a class="link" href="reference.html#group__distance__predicates_1gaccbba95d864d8dcf8a694796c840fbe0">boost::geometry::index::to_centroid()</a></code>,
|
|
</li>
|
|
<li class="listitem">
|
|
<code class="literal"><a class="link" href="reference.html#group__distance__predicates_1ga67dddd8a7fcaae150970e1db0401de02">boost::geometry::index::to_furthest()</a></code>.
|
|
</li>
|
|
</ul></div>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.nearest_query_distancespredicates_const____value_type___.h1"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.nearest_query_distancespredicates_const____value_type___.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.nearest_query_distancespredicates_const____value_type___.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">DistancesPredicates</span></code><code class="computeroutput"><span class="special">></span></code>
|
|
<code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a5c1a657074c527ed65f858c1ab6b36e6">size_type</a></code> <code class="computeroutput"><span class="identifier">nearest_query</span></code><code class="computeroutput"><span class="special">(</span></code><code class="computeroutput"><span class="identifier">DistancesPredicates</span> <span class="keyword">const</span> <span class="special">&</span></code> <code class="computeroutput"><span class="identifier">dpred</span></code><code class="computeroutput"><span class="special">,</span></code> <code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a9979db9ef37591985256cb8ad31862bb">value_type</a></code><code class="computeroutput"> <span class="special">&</span></code> <code class="computeroutput"><span class="identifier">v</span></code><code class="computeroutput"><span class="special">)</span></code>
|
|
</pre>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.nearest_query_distancespredicates_const____value_type___.h2"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.nearest_query_distancespredicates_const____value_type___.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.nearest_query_distancespredicates_const____value_type___.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">DistancesPredicates</span>
|
|
<span class="keyword">const</span> <span class="special">&</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">dpred</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The distances predicates or a Point.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a9979db9ef37591985256cb8ad31862bb">value_type</a></code><code class="computeroutput">
|
|
<span class="special">&</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">v</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The reference to the object which will contain the result.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.nearest_query_distancespredicates_const____value_type___.h3"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.nearest_query_distancespredicates_const____value_type___.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.nearest_query_distancespredicates_const____value_type___.returns">Returns</a>
|
|
</h6>
|
|
<p>
|
|
The number of values found.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.nearest_query_distancespredicates_const____value_type___.h4"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.nearest_query_distancespredicates_const____value_type___.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.nearest_query_distancespredicates_const____value_type___.throws">Throws</a>
|
|
</h6>
|
|
<p>
|
|
If Value copy constructor or copy assignment throws.
|
|
</p>
|
|
</div>
|
|
<div class="section">
|
|
<div class="titlepage"><div><div><h5 class="title">
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.nearest_query_distancespredicates_const____predicates_const____value_type___"></a><a name="classboost_1_1geometry_1_1index_1_1rtree_1a6552331dca4d67647ef2a03bd0fbedcc"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.nearest_query_distancespredicates_const____predicates_const____value_type___" title="nearest_query(DistancesPredicates const &, Predicates const &, value_type &)">nearest_query(DistancesPredicates
|
|
const &, Predicates const &, value_type &)</a>
|
|
</h5></div></div></div>
|
|
<p>
|
|
Finds one value meeting distances predicates and spatial predicates,
|
|
e.g. nearest to some Point and intersecting some Box.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.nearest_query_distancespredicates_const____predicates_const____value_type___.h0"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.nearest_query_distancespredicates_const____predicates_const____value_type___.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.nearest_query_distancespredicates_const____predicates_const____value_type___.description">Description</a>
|
|
</h6>
|
|
<p>
|
|
<span class="bold"><strong>Distances predicates</strong></span> may be a <code class="literal"><code class="computeroutput"><span class="identifier">Point</span></code></code>. In this the case the
|
|
Value closest to <code class="literal"><code class="computeroutput"><span class="identifier">Point</span></code></code>
|
|
is returned.
|
|
</p>
|
|
<p>
|
|
It is possible to define how distance to Value is calculated. This is
|
|
done by passing PointRelation. It can be generated by following functions:
|
|
</p>
|
|
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
|
|
<li class="listitem">
|
|
<code class="literal"><a class="link" href="reference.html#group__distance__predicates_1gace3c7dbc60840c2a61da36e975d56636">boost::geometry::index::to_nearest()</a></code>
|
|
- default,
|
|
</li>
|
|
<li class="listitem">
|
|
<code class="literal"><a class="link" href="reference.html#group__distance__predicates_1gaccbba95d864d8dcf8a694796c840fbe0">boost::geometry::index::to_centroid()</a></code>,
|
|
</li>
|
|
<li class="listitem">
|
|
<code class="literal"><a class="link" href="reference.html#group__distance__predicates_1ga67dddd8a7fcaae150970e1db0401de02">boost::geometry::index::to_furthest()</a></code>.
|
|
</li>
|
|
</ul></div>
|
|
<p>
|
|
It is possible to define define distances bounds, for example that some
|
|
distance must be between min_distance and max_distance. This is done
|
|
by passing DistancesPredicates which can be generated by following functions:
|
|
</p>
|
|
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
|
|
<li class="listitem">
|
|
<code class="literal"><a class="link" href="reference.html#group__distance__predicates_1ga1b0f969b575a94ca710b9345861f64db">boost::geometry::index::unbounded()</a></code>
|
|
- default,
|
|
</li>
|
|
<li class="listitem">
|
|
<code class="literal"><a class="link" href="reference.html#group__distance__predicates_1ga39c7c94776ab840e164848e53d376098">boost::geometry::index::min_bounded()</a></code>,
|
|
</li>
|
|
<li class="listitem">
|
|
<code class="literal"><a class="link" href="reference.html#group__distance__predicates_1ga843735643378288b0e14e19cc9b4e079">boost::geometry::index::max_bounded()</a></code>,
|
|
</li>
|
|
<li class="listitem">
|
|
<code class="literal"><a class="link" href="reference.html#group__distance__predicates_1ga20621ca608b1420c38182346b965f347">boost::geometry::index::bounded()</a></code>.
|
|
</li>
|
|
</ul></div>
|
|
<p>
|
|
MinRelation and MaxRelation describes bounds and can be generated by
|
|
following functions:
|
|
</p>
|
|
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
|
|
<li class="listitem">
|
|
<code class="literal"><a class="link" href="reference.html#group__distance__predicates_1gace3c7dbc60840c2a61da36e975d56636">boost::geometry::index::to_nearest()</a></code>,
|
|
</li>
|
|
<li class="listitem">
|
|
<code class="literal"><a class="link" href="reference.html#group__distance__predicates_1gaccbba95d864d8dcf8a694796c840fbe0">boost::geometry::index::to_centroid()</a></code>,
|
|
</li>
|
|
<li class="listitem">
|
|
<code class="literal"><a class="link" href="reference.html#group__distance__predicates_1ga67dddd8a7fcaae150970e1db0401de02">boost::geometry::index::to_furthest()</a></code>.
|
|
</li>
|
|
</ul></div>
|
|
<p>
|
|
<span class="bold"><strong>Spatial predicates</strong></span> may be a <code class="literal"><code class="computeroutput"><span class="identifier">Geometry</span></code></code>. In this case Values
|
|
intersecting the <code class="literal"><code class="computeroutput"><span class="identifier">Geometry</span></code></code>
|
|
are returned.
|
|
</p>
|
|
<p>
|
|
It may be generated by one of the functions listed below:
|
|
</p>
|
|
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
|
|
<li class="listitem">
|
|
<code class="literal"><a class="link" href="reference.html#group__predicates_1ga0a613a7f1d18ac33955bfdc2c5777c61">boost::geometry::index::covered_by()</a></code>,
|
|
</li>
|
|
<li class="listitem">
|
|
<code class="literal"><a class="link" href="reference.html#group__predicates_1ga351bb3b82e019ff45adf789385b8007d">boost::geometry::index::disjoint()</a></code>,
|
|
</li>
|
|
<li class="listitem">
|
|
<code class="literal"><a class="link" href="reference.html#group__predicates_1ga7301c50e0272976b9f1434536383e6d0">boost::geometry::index::intersects()</a></code>
|
|
- default,
|
|
</li>
|
|
<li class="listitem">
|
|
<code class="literal"><a class="link" href="reference.html#group__predicates_1ga5511236f56be1defcccbf11e742ccd88">boost::geometry::index::overlaps()</a></code>,
|
|
</li>
|
|
<li class="listitem">
|
|
<code class="literal"><a class="link" href="reference.html#group__predicates_1gabf9c4e76dd8a09a4c476f2f8fa8a0e4d">boost::geometry::index::within()</a></code>,
|
|
</li>
|
|
<li class="listitem">
|
|
<code class="literal"><code class="computeroutput"><span class="special">!</span> </code><a class="link" href="reference.html#group__predicates_1ga0a613a7f1d18ac33955bfdc2c5777c61">boost::geometry::index::covered_by()</a></code>,
|
|
</li>
|
|
<li class="listitem">
|
|
<code class="literal"><code class="computeroutput"><span class="special">!</span> </code><a class="link" href="reference.html#group__predicates_1ga351bb3b82e019ff45adf789385b8007d">boost::geometry::index::disjoint()</a></code>,
|
|
</li>
|
|
<li class="listitem">
|
|
<code class="literal"><code class="computeroutput"><span class="special">!</span> </code><a class="link" href="reference.html#group__predicates_1ga7301c50e0272976b9f1434536383e6d0">boost::geometry::index::intersects()</a></code>,
|
|
</li>
|
|
<li class="listitem">
|
|
<code class="literal"><code class="computeroutput"><span class="special">!</span> </code><a class="link" href="reference.html#group__predicates_1ga5511236f56be1defcccbf11e742ccd88">boost::geometry::index::overlaps()</a></code>,
|
|
</li>
|
|
<li class="listitem">
|
|
<code class="literal"><code class="computeroutput"><span class="special">!</span> </code><a class="link" href="reference.html#group__predicates_1gabf9c4e76dd8a09a4c476f2f8fa8a0e4d">boost::geometry::index::within()</a></code>
|
|
</li>
|
|
<li class="listitem">
|
|
<code class="literal"><a class="link" href="reference.html#group__predicates_1ga5c93efac97377136564623cbaf35d880">boost::geometry::index::value()</a></code>.
|
|
</li>
|
|
</ul></div>
|
|
<p>
|
|
Those predicates may be passed together in <code class="literal"><code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span></code></code>
|
|
or <code class="literal"><code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">tuple</span></code></code>.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.nearest_query_distancespredicates_const____predicates_const____value_type___.h1"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.nearest_query_distancespredicates_const____predicates_const____value_type___.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.nearest_query_distancespredicates_const____predicates_const____value_type___.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">DistancesPredicates</span></code><code class="computeroutput"><span class="special">,</span></code> <code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Predicates</span></code><code class="computeroutput"><span class="special">></span></code>
|
|
<code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a5c1a657074c527ed65f858c1ab6b36e6">size_type</a></code> <code class="computeroutput"><span class="identifier">nearest_query</span></code><code class="computeroutput"><span class="special">(</span></code><code class="computeroutput"><span class="identifier">DistancesPredicates</span> <span class="keyword">const</span> <span class="special">&</span></code> <code class="computeroutput"><span class="identifier">dpred</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">pred</span></code><code class="computeroutput"><span class="special">,</span></code>
|
|
<code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a9979db9ef37591985256cb8ad31862bb">value_type</a></code><code class="computeroutput"> <span class="special">&</span></code> <code class="computeroutput"><span class="identifier">v</span></code><code class="computeroutput"><span class="special">)</span></code>
|
|
</pre>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.nearest_query_distancespredicates_const____predicates_const____value_type___.h2"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.nearest_query_distancespredicates_const____predicates_const____value_type___.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.nearest_query_distancespredicates_const____predicates_const____value_type___.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">DistancesPredicates</span>
|
|
<span class="keyword">const</span> <span class="special">&</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">dpred</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The distances predicates or a Point.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">Predicates</span> <span class="keyword">const</span> <span class="special">&</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">pred</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The spatial predicates or a Geometry
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a9979db9ef37591985256cb8ad31862bb">value_type</a></code><code class="computeroutput">
|
|
<span class="special">&</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">v</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The reference to the object which will contain the result.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.nearest_query_distancespredicates_const____predicates_const____value_type___.h3"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.nearest_query_distancespredicates_const____predicates_const____value_type___.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.nearest_query_distancespredicates_const____predicates_const____value_type___.returns">Returns</a>
|
|
</h6>
|
|
<p>
|
|
The number of values found.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.nearest_query_distancespredicates_const____predicates_const____value_type___.h4"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.nearest_query_distancespredicates_const____predicates_const____value_type___.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.nearest_query_distancespredicates_const____predicates_const____value_type___.throws">Throws</a>
|
|
</h6>
|
|
<p>
|
|
If Value copy constructor or copy assignment throws.
|
|
</p>
|
|
</div>
|
|
<div class="section">
|
|
<div class="titlepage"><div><div><h5 class="title">
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.nearest_query_distancespredicates_const____size_type__outiter_"></a><a name="classboost_1_1geometry_1_1index_1_1rtree_1a3101652211c9f2d6ed8626dae6ff5f9d"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.nearest_query_distancespredicates_const____size_type__outiter_" title="nearest_query(DistancesPredicates const &, size_type, OutIter)">nearest_query(DistancesPredicates
|
|
const &, size_type, OutIter)</a>
|
|
</h5></div></div></div>
|
|
<p>
|
|
Finds k values meeting distances predicates, e.g. k nearest values to
|
|
some Point.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.nearest_query_distancespredicates_const____size_type__outiter_.h0"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.nearest_query_distancespredicates_const____size_type__outiter_.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.nearest_query_distancespredicates_const____size_type__outiter_.description">Description</a>
|
|
</h6>
|
|
<p>
|
|
<span class="bold"><strong>Distances predicates</strong></span> may be a <code class="literal"><code class="computeroutput"><span class="identifier">Point</span></code></code>. In this the case the
|
|
Value closest to <code class="literal"><code class="computeroutput"><span class="identifier">Point</span></code></code>
|
|
is returned.
|
|
</p>
|
|
<p>
|
|
It is possible to define how distance to Value is calculated. This is
|
|
done by passing PointRelation. It can be generated by following functions:
|
|
</p>
|
|
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
|
|
<li class="listitem">
|
|
<code class="literal"><a class="link" href="reference.html#group__distance__predicates_1gace3c7dbc60840c2a61da36e975d56636">boost::geometry::index::to_nearest()</a></code>
|
|
- default,
|
|
</li>
|
|
<li class="listitem">
|
|
<code class="literal"><a class="link" href="reference.html#group__distance__predicates_1gaccbba95d864d8dcf8a694796c840fbe0">boost::geometry::index::to_centroid()</a></code>,
|
|
</li>
|
|
<li class="listitem">
|
|
<code class="literal"><a class="link" href="reference.html#group__distance__predicates_1ga67dddd8a7fcaae150970e1db0401de02">boost::geometry::index::to_furthest()</a></code>.
|
|
</li>
|
|
</ul></div>
|
|
<p>
|
|
It is possible to define define distances bounds, for example that some
|
|
distance must be between min_distance and max_distance. This is done
|
|
by passing DistancesPredicates which can be generated by following functions:
|
|
</p>
|
|
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
|
|
<li class="listitem">
|
|
<code class="literal"><a class="link" href="reference.html#group__distance__predicates_1ga1b0f969b575a94ca710b9345861f64db">boost::geometry::index::unbounded()</a></code>
|
|
- default,
|
|
</li>
|
|
<li class="listitem">
|
|
<code class="literal"><a class="link" href="reference.html#group__distance__predicates_1ga39c7c94776ab840e164848e53d376098">boost::geometry::index::min_bounded()</a></code>,
|
|
</li>
|
|
<li class="listitem">
|
|
<code class="literal"><a class="link" href="reference.html#group__distance__predicates_1ga843735643378288b0e14e19cc9b4e079">boost::geometry::index::max_bounded()</a></code>,
|
|
</li>
|
|
<li class="listitem">
|
|
<code class="literal"><a class="link" href="reference.html#group__distance__predicates_1ga20621ca608b1420c38182346b965f347">boost::geometry::index::bounded()</a></code>.
|
|
</li>
|
|
</ul></div>
|
|
<p>
|
|
MinRelation and MaxRelation describes bounds and can be generated by
|
|
following functions:
|
|
</p>
|
|
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
|
|
<li class="listitem">
|
|
<code class="literal"><a class="link" href="reference.html#group__distance__predicates_1gace3c7dbc60840c2a61da36e975d56636">boost::geometry::index::to_nearest()</a></code>,
|
|
</li>
|
|
<li class="listitem">
|
|
<code class="literal"><a class="link" href="reference.html#group__distance__predicates_1gaccbba95d864d8dcf8a694796c840fbe0">boost::geometry::index::to_centroid()</a></code>,
|
|
</li>
|
|
<li class="listitem">
|
|
<code class="literal"><a class="link" href="reference.html#group__distance__predicates_1ga67dddd8a7fcaae150970e1db0401de02">boost::geometry::index::to_furthest()</a></code>.
|
|
</li>
|
|
</ul></div>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.nearest_query_distancespredicates_const____size_type__outiter_.h1"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.nearest_query_distancespredicates_const____size_type__outiter_.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.nearest_query_distancespredicates_const____size_type__outiter_.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">DistancesPredicates</span></code><code class="computeroutput"><span class="special">,</span></code> <code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">OutIter</span></code><code class="computeroutput"><span class="special">></span></code>
|
|
<code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a5c1a657074c527ed65f858c1ab6b36e6">size_type</a></code> <code class="computeroutput"><span class="identifier">nearest_query</span></code><code class="computeroutput"><span class="special">(</span></code><code class="computeroutput"><span class="identifier">DistancesPredicates</span> <span class="keyword">const</span> <span class="special">&</span></code> <code class="computeroutput"><span class="identifier">dpred</span></code><code class="computeroutput"><span class="special">,</span></code>
|
|
<code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a5c1a657074c527ed65f858c1ab6b36e6">size_type</a></code> <code class="computeroutput"><span class="identifier">k</span></code><code class="computeroutput"><span class="special">,</span></code>
|
|
<code class="computeroutput"><span class="identifier">OutIter</span></code> <code class="computeroutput"><span class="identifier">out_it</span></code><code class="computeroutput"><span class="special">)</span></code>
|
|
</pre>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.nearest_query_distancespredicates_const____size_type__outiter_.h2"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.nearest_query_distancespredicates_const____size_type__outiter_.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.nearest_query_distancespredicates_const____size_type__outiter_.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">DistancesPredicates</span>
|
|
<span class="keyword">const</span> <span class="special">&</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">dpred</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The distances predicates or a Point.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a5c1a657074c527ed65f858c1ab6b36e6">size_type</a></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">k</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The max number of values.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">OutIter</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">out_it</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The output iterator of the result range. E.g. a back_insert_iterator.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.nearest_query_distancespredicates_const____size_type__outiter_.h3"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.nearest_query_distancespredicates_const____size_type__outiter_.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.nearest_query_distancespredicates_const____size_type__outiter_.returns">Returns</a>
|
|
</h6>
|
|
<p>
|
|
The number of values found.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.nearest_query_distancespredicates_const____size_type__outiter_.h4"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.nearest_query_distancespredicates_const____size_type__outiter_.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.nearest_query_distancespredicates_const____size_type__outiter_.throws">Throws</a>
|
|
</h6>
|
|
<p>
|
|
If Value copy constructor or copy assignment throws. If OutIter dereference
|
|
or increment throws.
|
|
</p>
|
|
</div>
|
|
<div class="section">
|
|
<div class="titlepage"><div><div><h5 class="title">
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.nearest_query_distancespredicates_const____size_type__predicates_const____outiter_"></a><a name="classboost_1_1geometry_1_1index_1_1rtree_1a31c23b87b01f12282ef0df6404ab7301"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.nearest_query_distancespredicates_const____size_type__predicates_const____outiter_" title="nearest_query(DistancesPredicates const &, size_type, Predicates const &, OutIter)">nearest_query(DistancesPredicates
|
|
const &, size_type, Predicates const &, OutIter)</a>
|
|
</h5></div></div></div>
|
|
<p>
|
|
Finds k values meeting distances predicates and spatial predicates, e.g.
|
|
k nearest values to some Point and intersecting some Box.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.nearest_query_distancespredicates_const____size_type__predicates_const____outiter_.h0"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.nearest_query_distancespredicates_const____size_type__predicates_const____outiter_.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.nearest_query_distancespredicates_const____size_type__predicates_const____outiter_.description">Description</a>
|
|
</h6>
|
|
<p>
|
|
<span class="bold"><strong>Distances predicates</strong></span> may be a <code class="literal"><code class="computeroutput"><span class="identifier">Point</span></code></code>. In this the case the
|
|
Value closest to <code class="literal"><code class="computeroutput"><span class="identifier">Point</span></code></code>
|
|
is returned.
|
|
</p>
|
|
<p>
|
|
It is possible to define how distance to Value is calculated. This is
|
|
done by passing PointRelation. It can be generated by following functions:
|
|
</p>
|
|
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
|
|
<li class="listitem">
|
|
<code class="literal"><a class="link" href="reference.html#group__distance__predicates_1gace3c7dbc60840c2a61da36e975d56636">boost::geometry::index::to_nearest()</a></code>
|
|
- default,
|
|
</li>
|
|
<li class="listitem">
|
|
<code class="literal"><a class="link" href="reference.html#group__distance__predicates_1gaccbba95d864d8dcf8a694796c840fbe0">boost::geometry::index::to_centroid()</a></code>,
|
|
</li>
|
|
<li class="listitem">
|
|
<code class="literal"><a class="link" href="reference.html#group__distance__predicates_1ga67dddd8a7fcaae150970e1db0401de02">boost::geometry::index::to_furthest()</a></code>.
|
|
</li>
|
|
</ul></div>
|
|
<p>
|
|
It is possible to define define distances bounds, for example that some
|
|
distance must be between min_distance and max_distance. This is done
|
|
by passing DistancesPredicates which can be generated by following functions:
|
|
</p>
|
|
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
|
|
<li class="listitem">
|
|
<code class="literal"><a class="link" href="reference.html#group__distance__predicates_1ga1b0f969b575a94ca710b9345861f64db">boost::geometry::index::unbounded()</a></code>
|
|
- default,
|
|
</li>
|
|
<li class="listitem">
|
|
<code class="literal"><a class="link" href="reference.html#group__distance__predicates_1ga39c7c94776ab840e164848e53d376098">boost::geometry::index::min_bounded()</a></code>,
|
|
</li>
|
|
<li class="listitem">
|
|
<code class="literal"><a class="link" href="reference.html#group__distance__predicates_1ga843735643378288b0e14e19cc9b4e079">boost::geometry::index::max_bounded()</a></code>,
|
|
</li>
|
|
<li class="listitem">
|
|
<code class="literal"><a class="link" href="reference.html#group__distance__predicates_1ga20621ca608b1420c38182346b965f347">boost::geometry::index::bounded()</a></code>.
|
|
</li>
|
|
</ul></div>
|
|
<p>
|
|
MinRelation and MaxRelation describes bounds and can be generated by
|
|
following functions:
|
|
</p>
|
|
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
|
|
<li class="listitem">
|
|
<code class="literal"><a class="link" href="reference.html#group__distance__predicates_1gace3c7dbc60840c2a61da36e975d56636">boost::geometry::index::to_nearest()</a></code>,
|
|
</li>
|
|
<li class="listitem">
|
|
<code class="literal"><a class="link" href="reference.html#group__distance__predicates_1gaccbba95d864d8dcf8a694796c840fbe0">boost::geometry::index::to_centroid()</a></code>,
|
|
</li>
|
|
<li class="listitem">
|
|
<code class="literal"><a class="link" href="reference.html#group__distance__predicates_1ga67dddd8a7fcaae150970e1db0401de02">boost::geometry::index::to_furthest()</a></code>.
|
|
</li>
|
|
</ul></div>
|
|
<p>
|
|
<span class="bold"><strong>Spatial predicates</strong></span> may be a <code class="literal"><code class="computeroutput"><span class="identifier">Geometry</span></code></code>. In this case Values
|
|
intersecting the <code class="literal"><code class="computeroutput"><span class="identifier">Geometry</span></code></code>
|
|
are returned.
|
|
</p>
|
|
<p>
|
|
It may be generated by one of the functions listed below:
|
|
</p>
|
|
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
|
|
<li class="listitem">
|
|
<code class="literal"><a class="link" href="reference.html#group__predicates_1ga0a613a7f1d18ac33955bfdc2c5777c61">boost::geometry::index::covered_by()</a></code>,
|
|
</li>
|
|
<li class="listitem">
|
|
<code class="literal"><a class="link" href="reference.html#group__predicates_1ga351bb3b82e019ff45adf789385b8007d">boost::geometry::index::disjoint()</a></code>,
|
|
</li>
|
|
<li class="listitem">
|
|
<code class="literal"><a class="link" href="reference.html#group__predicates_1ga7301c50e0272976b9f1434536383e6d0">boost::geometry::index::intersects()</a></code>
|
|
- default,
|
|
</li>
|
|
<li class="listitem">
|
|
<code class="literal"><a class="link" href="reference.html#group__predicates_1ga5511236f56be1defcccbf11e742ccd88">boost::geometry::index::overlaps()</a></code>,
|
|
</li>
|
|
<li class="listitem">
|
|
<code class="literal"><a class="link" href="reference.html#group__predicates_1gabf9c4e76dd8a09a4c476f2f8fa8a0e4d">boost::geometry::index::within()</a></code>,
|
|
</li>
|
|
<li class="listitem">
|
|
<code class="literal"><code class="computeroutput"><span class="special">!</span> </code><a class="link" href="reference.html#group__predicates_1ga0a613a7f1d18ac33955bfdc2c5777c61">boost::geometry::index::covered_by()</a></code>,
|
|
</li>
|
|
<li class="listitem">
|
|
<code class="literal"><code class="computeroutput"><span class="special">!</span> </code><a class="link" href="reference.html#group__predicates_1ga351bb3b82e019ff45adf789385b8007d">boost::geometry::index::disjoint()</a></code>,
|
|
</li>
|
|
<li class="listitem">
|
|
<code class="literal"><code class="computeroutput"><span class="special">!</span> </code><a class="link" href="reference.html#group__predicates_1ga7301c50e0272976b9f1434536383e6d0">boost::geometry::index::intersects()</a></code>,
|
|
</li>
|
|
<li class="listitem">
|
|
<code class="literal"><code class="computeroutput"><span class="special">!</span> </code><a class="link" href="reference.html#group__predicates_1ga5511236f56be1defcccbf11e742ccd88">boost::geometry::index::overlaps()</a></code>,
|
|
</li>
|
|
<li class="listitem">
|
|
<code class="literal"><code class="computeroutput"><span class="special">!</span> </code><a class="link" href="reference.html#group__predicates_1gabf9c4e76dd8a09a4c476f2f8fa8a0e4d">boost::geometry::index::within()</a></code>
|
|
</li>
|
|
<li class="listitem">
|
|
<code class="literal"><a class="link" href="reference.html#group__predicates_1ga5c93efac97377136564623cbaf35d880">boost::geometry::index::value()</a></code>.
|
|
</li>
|
|
</ul></div>
|
|
<p>
|
|
Those predicates may be passed together in <code class="literal"><code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span></code></code>
|
|
or <code class="literal"><code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">tuple</span></code></code>.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.nearest_query_distancespredicates_const____size_type__predicates_const____outiter_.h1"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.nearest_query_distancespredicates_const____size_type__predicates_const____outiter_.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.nearest_query_distancespredicates_const____size_type__predicates_const____outiter_.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">DistancesPredicates</span></code><code class="computeroutput"><span class="special">,</span></code>
|
|
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Predicates</span></code><code class="computeroutput"><span class="special">,</span></code>
|
|
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">OutIter</span></code><code class="computeroutput"><span class="special">></span></code>
|
|
<code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a5c1a657074c527ed65f858c1ab6b36e6">size_type</a></code> <code class="computeroutput"><span class="identifier">nearest_query</span></code><code class="computeroutput"><span class="special">(</span></code><code class="computeroutput"><span class="identifier">DistancesPredicates</span> <span class="keyword">const</span> <span class="special">&</span></code> <code class="computeroutput"><span class="identifier">dpred</span></code><code class="computeroutput"><span class="special">,</span></code>
|
|
<code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a5c1a657074c527ed65f858c1ab6b36e6">size_type</a></code> <code class="computeroutput"><span class="identifier">k</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">pred</span></code><code class="computeroutput"><span class="special">,</span></code>
|
|
<code class="computeroutput"><span class="identifier">OutIter</span></code> <code class="computeroutput"><span class="identifier">out_it</span></code><code class="computeroutput"><span class="special">)</span></code>
|
|
</pre>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.nearest_query_distancespredicates_const____size_type__predicates_const____outiter_.h2"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.nearest_query_distancespredicates_const____size_type__predicates_const____outiter_.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.nearest_query_distancespredicates_const____size_type__predicates_const____outiter_.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">DistancesPredicates</span>
|
|
<span class="keyword">const</span> <span class="special">&</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">dpred</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The distances predicates or a Point
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a5c1a657074c527ed65f858c1ab6b36e6">size_type</a></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">k</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The max number of values.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">Predicates</span> <span class="keyword">const</span> <span class="special">&</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">pred</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The spatial predicates or a Geometry.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">OutIter</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">out_it</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The output iterator of the result range. E.g. a back_insert_iterator.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.nearest_query_distancespredicates_const____size_type__predicates_const____outiter_.h3"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.nearest_query_distancespredicates_const____size_type__predicates_const____outiter_.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.nearest_query_distancespredicates_const____size_type__predicates_const____outiter_.returns">Returns</a>
|
|
</h6>
|
|
<p>
|
|
The number of values found.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.nearest_query_distancespredicates_const____size_type__predicates_const____outiter_.h4"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.nearest_query_distancespredicates_const____size_type__predicates_const____outiter_.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.nearest_query_distancespredicates_const____size_type__predicates_const____outiter_.throws">Throws</a>
|
|
</h6>
|
|
<p>
|
|
If Value copy constructor or copy assignment throws. If OutIter dereference
|
|
or increment throws.
|
|
</p>
|
|
</div>
|
|
<div class="section">
|
|
<div class="titlepage"><div><div><h5 class="title">
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.size__"></a><a name="classboost_1_1geometry_1_1index_1_1rtree_1a89561a834563f2ed6fc782bad16143fd"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.size__" title="size()">size()</a>
|
|
</h5></div></div></div>
|
|
<p>
|
|
Returns the number of stored values.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.size__.h0"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.size__.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.size__.synopsis">Synopsis</a>
|
|
</h6>
|
|
<pre class="programlisting"><code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a5c1a657074c527ed65f858c1ab6b36e6">size_type</a></code> <code class="computeroutput"><span class="identifier">size</span></code><code class="computeroutput"><span class="special">()</span></code>
|
|
</pre>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.size__.h1"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.size__.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.size__.returns">Returns</a>
|
|
</h6>
|
|
<p>
|
|
The number of stored values.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.size__.h2"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.size__.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.size__.throws">Throws</a>
|
|
</h6>
|
|
<p>
|
|
Nothing.
|
|
</p>
|
|
</div>
|
|
<div class="section">
|
|
<div class="titlepage"><div><div><h5 class="title">
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.empty__"></a><a name="classboost_1_1geometry_1_1index_1_1rtree_1ae889567443b0ba0dbdb975564c55804c"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.empty__" title="empty()">empty()</a>
|
|
</h5></div></div></div>
|
|
<p>
|
|
Query if the container is empty.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.empty__.h0"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.empty__.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.empty__.synopsis">Synopsis</a>
|
|
</h6>
|
|
<pre class="programlisting"><code class="computeroutput"><span class="keyword">bool</span></code> <code class="computeroutput"><span class="identifier">empty</span></code><code class="computeroutput"><span class="special">()</span></code>
|
|
</pre>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.empty__.h1"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.empty__.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.empty__.returns">Returns</a>
|
|
</h6>
|
|
<p>
|
|
true if the container is empty.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.empty__.h2"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.empty__.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.empty__.throws">Throws</a>
|
|
</h6>
|
|
<p>
|
|
Nothing.
|
|
</p>
|
|
</div>
|
|
<div class="section">
|
|
<div class="titlepage"><div><div><h5 class="title">
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.clear__"></a><a name="classboost_1_1geometry_1_1index_1_1rtree_1ae6027e42d28a4bf93e74b055c79e6b09"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.clear__" title="clear()">clear()</a>
|
|
</h5></div></div></div>
|
|
<p>
|
|
Removes all values stored in the container.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.clear__.h0"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.clear__.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.clear__.synopsis">Synopsis</a>
|
|
</h6>
|
|
<pre class="programlisting"><code class="computeroutput"><span class="keyword">void</span></code> <code class="computeroutput"><span class="identifier">clear</span></code><code class="computeroutput"><span class="special">()</span></code>
|
|
</pre>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.clear__.h1"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.clear__.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.clear__.throws">Throws</a>
|
|
</h6>
|
|
<p>
|
|
Nothing.
|
|
</p>
|
|
</div>
|
|
<div class="section">
|
|
<div class="titlepage"><div><div><h5 class="title">
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.box__"></a><a name="classboost_1_1geometry_1_1index_1_1rtree_1adf62005332a5fa9119ff03185e0c5143"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.box__" title="box()">box()</a>
|
|
</h5></div></div></div>
|
|
<p>
|
|
Returns the box containing all values stored in the container.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.box__.h0"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.box__.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.box__.description">Description</a>
|
|
</h6>
|
|
<p>
|
|
Returns the box containing all values stored in the container. If the
|
|
container is empty the result of <code class="literal"><code class="computeroutput"><span class="identifier">geometry</span><span class="special">::</span><span class="identifier">assign_inverse</span><span class="special">()</span></code></code> is returned.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.box__.h1"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.box__.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.box__.synopsis">Synopsis</a>
|
|
</h6>
|
|
<pre class="programlisting"><code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a42d0c9efffbc6f3935b5b9c3dd31e50d">box_type</a></code> <code class="computeroutput"><span class="identifier">box</span></code><code class="computeroutput"><span class="special">()</span></code>
|
|
</pre>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.box__.h2"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.box__.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.box__.returns">Returns</a>
|
|
</h6>
|
|
<p>
|
|
The box containing all values stored in the container or an invalid box
|
|
if there are no values in the container.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.box__.h3"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.box__.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.box__.throws">Throws</a>
|
|
</h6>
|
|
<p>
|
|
Nothing.
|
|
</p>
|
|
</div>
|
|
<div class="section">
|
|
<div class="titlepage"><div><div><h5 class="title">
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.count_valueorindexable_const___"></a><a name="classboost_1_1geometry_1_1index_1_1rtree_1a17fce1fac81f6460d2c3a5744f4963ee"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.count_valueorindexable_const___" title="count(ValueOrIndexable const &)">count(ValueOrIndexable
|
|
const &)</a>
|
|
</h5></div></div></div>
|
|
<p>
|
|
Count Values or Indexables stored in the container.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.count_valueorindexable_const___.h0"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.count_valueorindexable_const___.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.count_valueorindexable_const___.description">Description</a>
|
|
</h6>
|
|
<p>
|
|
For indexable_type it returns the number of values which indexables equals
|
|
the parameter. For value_type it returns the number of values which equals
|
|
the parameter.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.count_valueorindexable_const___.h1"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.count_valueorindexable_const___.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.count_valueorindexable_const___.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">ValueOrIndexable</span></code><code class="computeroutput"><span class="special">></span></code>
|
|
<code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a5c1a657074c527ed65f858c1ab6b36e6">size_type</a></code> <code class="computeroutput"><span class="identifier">count</span></code><code class="computeroutput"><span class="special">(</span></code><code class="computeroutput"><span class="identifier">ValueOrIndexable</span> <span class="keyword">const</span> <span class="special">&</span></code> <code class="computeroutput"><span class="identifier">vori</span></code><code class="computeroutput"><span class="special">)</span></code>
|
|
</pre>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.count_valueorindexable_const___.h2"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.count_valueorindexable_const___.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.count_valueorindexable_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">ValueOrIndexable</span>
|
|
<span class="keyword">const</span> <span class="special">&</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">vori</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The value or indexable which will be counted.
|
|
</p>
|
|
</td>
|
|
</tr></tbody>
|
|
</table></div>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.count_valueorindexable_const___.h3"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.count_valueorindexable_const___.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.count_valueorindexable_const___.returns">Returns</a>
|
|
</h6>
|
|
<p>
|
|
The number of values found.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.count_valueorindexable_const___.h4"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.count_valueorindexable_const___.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.count_valueorindexable_const___.throws">Throws</a>
|
|
</h6>
|
|
<p>
|
|
Nothing.
|
|
</p>
|
|
</div>
|
|
<div class="section">
|
|
<div class="titlepage"><div><div><h5 class="title">
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.parameters__"></a><a name="classboost_1_1geometry_1_1index_1_1rtree_1a18910715f67608ff010556ac41f51606"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.parameters__" title="parameters()">parameters()</a>
|
|
</h5></div></div></div>
|
|
<p>
|
|
Returns parameters.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.parameters__.h0"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.parameters__.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.parameters__.synopsis">Synopsis</a>
|
|
</h6>
|
|
<pre class="programlisting"><code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1af85d4e399a807b3e4e46d38a0b4ffc5a">parameters_type</a></code><code class="computeroutput"> <span class="keyword">const</span> <span class="special">&</span></code> <code class="computeroutput"><span class="identifier">parameters</span></code><code class="computeroutput"><span class="special">()</span></code>
|
|
</pre>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.parameters__.h1"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.parameters__.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.parameters__.returns">Returns</a>
|
|
</h6>
|
|
<p>
|
|
The parameters object.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.parameters__.h2"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.parameters__.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.parameters__.throws">Throws</a>
|
|
</h6>
|
|
<p>
|
|
Nothing.
|
|
</p>
|
|
</div>
|
|
<div class="section">
|
|
<div class="titlepage"><div><div><h5 class="title">
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.translator__"></a><a name="classboost_1_1geometry_1_1index_1_1rtree_1abcbe5bb1a70a7fec518fe4dd8baa750c"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.translator__" title="translator()">translator()</a>
|
|
</h5></div></div></div>
|
|
<p>
|
|
Returns the translator object.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.translator__.h0"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.translator__.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.translator__.synopsis">Synopsis</a>
|
|
</h6>
|
|
<pre class="programlisting"><code class="computeroutput"><span class="keyword">const</span> </code><code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1adbc30a1fa986e2e856e0662111ac2d91">translator_type</a></code><code class="computeroutput"> <span class="special">&</span></code> <code class="computeroutput"><span class="identifier">translator</span></code><code class="computeroutput"><span class="special">()</span></code>
|
|
</pre>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.translator__.h1"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.translator__.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.translator__.returns">Returns</a>
|
|
</h6>
|
|
<p>
|
|
The translator object.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.translator__.h2"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.translator__.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.translator__.throws">Throws</a>
|
|
</h6>
|
|
<p>
|
|
Nothing.
|
|
</p>
|
|
</div>
|
|
<div class="section">
|
|
<div class="titlepage"><div><div><h5 class="title">
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.get_allocator__"></a><a name="classboost_1_1geometry_1_1index_1_1rtree_1a1eeb303253f4cabe3a89a82ed41247ff"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.get_allocator__" title="get_allocator()">get_allocator()</a>
|
|
</h5></div></div></div>
|
|
<p>
|
|
Returns allocator used by the rtree.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.get_allocator__.h0"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.get_allocator__.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.get_allocator__.synopsis">Synopsis</a>
|
|
</h6>
|
|
<pre class="programlisting"><code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a9d35bc38fa697c6f600548fb5b38807d">allocator_type</a></code> <code class="computeroutput"><span class="identifier">get_allocator</span></code><code class="computeroutput"><span class="special">()</span></code>
|
|
</pre>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.get_allocator__.h1"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.get_allocator__.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.get_allocator__.returns">Returns</a>
|
|
</h6>
|
|
<p>
|
|
The allocator.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.get_allocator__.h2"></a>
|
|
<span><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.get_allocator__.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.get_allocator__.throws">Throws</a>
|
|
</h6>
|
|
<p>
|
|
If allocator copy constructor throws.
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div class="section">
|
|
<div class="titlepage"><div><div><h4 class="title">
|
|
<a name="geometry_index.r_tree.reference.group__rtree__functions"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions" title="Functions related to the rtree">Functions
|
|
related to the rtree</a>
|
|
</h4></div></div></div>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__rtree__functions.h0"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__rtree__functions.functions"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.functions">Functions</a>
|
|
</h6>
|
|
<div class="informaltable"><table class="table">
|
|
<colgroup>
|
|
<col>
|
|
<col>
|
|
</colgroup>
|
|
<thead><tr>
|
|
<th>
|
|
<p>
|
|
Function
|
|
</p>
|
|
</th>
|
|
<th>
|
|
<p>
|
|
Description
|
|
</p>
|
|
</th>
|
|
</tr></thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<a class="link" href="reference.html#group__rtree__functions_1gac0ac9ed0e01f7494a5a3059e75d3c5cc"><code class="computeroutput"><span class="identifier">insert</span><span class="special">(</span><span class="identifier">rtree</span><span class="special"><...></span>
|
|
<span class="special">&,</span> <span class="identifier">Value</span>
|
|
<span class="keyword">const</span> <span class="special">&)</span></code></a>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
Insert a value to the index.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<a class="link" href="reference.html#group__rtree__functions_1gaf8f4fa09c12b96ace3bbb38823a9191b"><code class="computeroutput"><span class="identifier">insert</span><span class="special">(</span><span class="identifier">rtree</span><span class="special"><...></span>
|
|
<span class="special">&,</span> <span class="identifier">Iterator</span><span class="special">,</span> <span class="identifier">Iterator</span><span class="special">)</span></code></a>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
Insert a range of values to the index.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<a class="link" href="reference.html#group__rtree__functions_1ga97ec330c1c021a1ac2d896a488c2eb9c"><code class="computeroutput"><span class="identifier">insert</span><span class="special">(</span><span class="identifier">rtree</span><span class="special"><...></span>
|
|
<span class="special">&,</span> <span class="identifier">Range</span>
|
|
<span class="keyword">const</span> <span class="special">&)</span></code></a>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
Insert a range of values to the index.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<a class="link" href="reference.html#group__rtree__functions_1gad40492a5b99c3eebbd51901574762527"><code class="computeroutput"><span class="identifier">remove</span><span class="special">(</span><span class="identifier">rtree</span><span class="special"><...></span>
|
|
<span class="special">&,</span> <span class="identifier">Value</span>
|
|
<span class="keyword">const</span> <span class="special">&)</span></code></a>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
Remove a value from the container.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<a class="link" href="reference.html#group__rtree__functions_1ga0219361de8b15c539af3f9bd027938ce"><code class="computeroutput"><span class="identifier">remove</span><span class="special">(</span><span class="identifier">rtree</span><span class="special"><...></span>
|
|
<span class="special">&,</span> <span class="identifier">Iterator</span><span class="special">,</span> <span class="identifier">Iterator</span><span class="special">)</span></code></a>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
Remove a range of values from the container.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<a class="link" href="reference.html#group__rtree__functions_1ga5885d6c90a91f238f72ab9b5ef24daf9"><code class="computeroutput"><span class="identifier">remove</span><span class="special">(</span><span class="identifier">rtree</span><span class="special"><...></span>
|
|
<span class="special">&,</span> <span class="identifier">Range</span>
|
|
<span class="keyword">const</span> <span class="special">&)</span></code></a>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
Remove a range of values from the container.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<a class="link" href="reference.html#group__rtree__functions_1gadcec162d2391c2c9cc4215a5578d1721"><code class="computeroutput"><span class="identifier">spatial_query</span><span class="special">(</span><span class="identifier">rtree</span><span class="special"><...></span>
|
|
<span class="keyword">const</span> <span class="special">&,</span>
|
|
<span class="identifier">Predicates</span> <span class="keyword">const</span>
|
|
<span class="special">&,</span> <span class="identifier">OutIter</span><span class="special">)</span></code></a>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
Find values meeting spatial predicates.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<a class="link" href="reference.html#group__rtree__functions_1gacabbd521b88b67a700e1246e5889d343"><code class="computeroutput"><span class="identifier">nearest_query</span><span class="special">(</span><span class="identifier">rtree</span><span class="special"><...></span>
|
|
<span class="keyword">const</span> <span class="special">&,</span>
|
|
<span class="identifier">DistancesPredicates</span> <span class="keyword">const</span> <span class="special">&,</span>
|
|
<span class="identifier">Value</span> <span class="special">&)</span></code></a>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
Find the value meeting distances predicates.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<a class="link" href="reference.html#group__rtree__functions_1gaf963f417d4ab54a2782928020dd8c3ad"><code class="computeroutput"><span class="identifier">nearest_query</span><span class="special">(</span><span class="identifier">rtree</span><span class="special"><...></span>
|
|
<span class="keyword">const</span> <span class="special">&,</span>
|
|
<span class="identifier">DistancesPredicates</span> <span class="keyword">const</span> <span class="special">&,</span>
|
|
<span class="identifier">Predicates</span> <span class="keyword">const</span>
|
|
<span class="special">&,</span> <span class="identifier">Value</span>
|
|
<span class="special">&)</span></code></a>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
Find the value meeting distances and spatial predicates.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<a class="link" href="reference.html#group__rtree__functions_1ga74550ecb22e4ac69a445c1a6b0be9a1b"><code class="computeroutput"><span class="identifier">nearest_query</span><span class="special">(</span><span class="identifier">rtree</span><span class="special"><...></span>
|
|
<span class="keyword">const</span> <span class="special">&,</span>
|
|
<span class="identifier">DistancesPredicates</span> <span class="keyword">const</span> <span class="special">&,</span>
|
|
<span class="keyword">typename</span> <span class="identifier">rtree</span><span class="special"><...>::</span><span class="identifier">size_type</span><span class="special">,</span> <span class="identifier">OutIter</span><span class="special">)</span></code></a>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
Find k values meeting distances predicates.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<a class="link" href="reference.html#group__rtree__functions_1ga8057af533a3e28e09337bab2c7a146aa"><code class="computeroutput"><span class="identifier">nearest_query</span><span class="special">(</span><span class="identifier">rtree</span><span class="special"><...></span>
|
|
<span class="keyword">const</span> <span class="special">&,</span>
|
|
<span class="identifier">DistancesPredicates</span> <span class="keyword">const</span> <span class="special">&,</span>
|
|
<span class="keyword">typename</span> <span class="identifier">rtree</span><span class="special"><...>::</span><span class="identifier">size_type</span><span class="special">,</span> <span class="identifier">Predicates</span>
|
|
<span class="keyword">const</span> <span class="special">&,</span>
|
|
<span class="identifier">OutIter</span><span class="special">)</span></code></a>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
Find k values meeting distances and spatial predicates.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<a class="link" href="reference.html#group__rtree__functions_1ga0c65d7b29b1edf72f1d236ccf211f63c"><code class="computeroutput"><span class="identifier">clear</span><span class="special">(</span><span class="identifier">rtree</span><span class="special"><...></span>
|
|
<span class="special">&)</span></code></a>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
Remove all values from the index.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<a class="link" href="reference.html#group__rtree__functions_1gaec0b88a9d8b408753e3069134f1598c7"><code class="computeroutput"><span class="identifier">size</span><span class="special">(</span><span class="identifier">rtree</span><span class="special"><...></span>
|
|
<span class="keyword">const</span> <span class="special">&)</span></code></a>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
Get the number of values stored in the index.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<a class="link" href="reference.html#group__rtree__functions_1ga459e3d404fec7cbd66794714cbdd129e"><code class="computeroutput"><span class="identifier">empty</span><span class="special">(</span><span class="identifier">rtree</span><span class="special"><...></span>
|
|
<span class="keyword">const</span> <span class="special">&)</span></code></a>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
Query if there are no values stored in the index.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<a class="link" href="reference.html#group__rtree__functions_1ga46aead88abd7f18f0e1eedb991bbb39d"><code class="computeroutput"><span class="identifier">box</span><span class="special">(</span><span class="identifier">rtree</span><span class="special"><...></span>
|
|
<span class="keyword">const</span> <span class="special">&)</span></code></a>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
Get the box containing all stored values or an invalid box if
|
|
the index has no values.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<a class="link" href="reference.html#group__rtree__functions_1gab3425094aa846b167789ac76114696f6"><code class="computeroutput"><span class="identifier">envelope</span><span class="special">(</span><span class="identifier">index</span><span class="special">::</span><span class="identifier">rtree</span><span class="special"><...></span>
|
|
<span class="keyword">const</span> <span class="special">&,</span>
|
|
<span class="identifier">Box</span> <span class="special">&)</span></code></a>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
Get the box containing all stored values or an invalid box if
|
|
the index has no values.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<a class="link" href="reference.html#group__rtree__functions_1gaab92d20f98edefccee1e76c1349a5127"><code class="computeroutput"><span class="identifier">return_envelope</span><span class="special">(</span><span class="identifier">index</span><span class="special">::</span><span class="identifier">rtree</span><span class="special"><...></span>
|
|
<span class="keyword">const</span> <span class="special">&)</span></code></a>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
Get the box containing all stored values or an invalid box if
|
|
the index has no values.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
<div class="section">
|
|
<div class="titlepage"><div><div><h5 class="title">
|
|
<a name="geometry_index.r_tree.reference.group__rtree__functions.insert_rtree_________value_const___"></a><a name="group__rtree__functions_1gac0ac9ed0e01f7494a5a3059e75d3c5cc"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.insert_rtree_________value_const___" title="insert(rtree<...> &, Value const &)">insert(rtree<...>
|
|
&, Value const &)</a>
|
|
</h5></div></div></div>
|
|
<p>
|
|
Insert a value to the index.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__rtree__functions.insert_rtree_________value_const___.h0"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__rtree__functions.insert_rtree_________value_const___.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.insert_rtree_________value_const___.description">Description</a>
|
|
</h6>
|
|
<p>
|
|
It calls <code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1af6d5bd81e46cb4ff89277c753133664c">rtree::insert(value_type
|
|
const&)</a></code>.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__rtree__functions.insert_rtree_________value_const___.h1"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__rtree__functions.insert_rtree_________value_const___.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.insert_rtree_________value_const___.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">Value</span></code><code class="computeroutput"><span class="special">,</span></code>
|
|
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Options</span></code><code class="computeroutput"><span class="special">,</span></code>
|
|
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Translator</span></code><code class="computeroutput"><span class="special">,</span></code>
|
|
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Allocator</span></code><code class="computeroutput"><span class="special">></span></code>
|
|
<code class="computeroutput"><span class="keyword">void</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">geometry</span><span class="special">::</span><span class="identifier">index</span><span class="special">::</span><span class="identifier">insert</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">Options</span><span class="special">,</span> <span class="identifier">Translator</span><span class="special">,</span> <span class="identifier">Allocator</span> <span class="special">></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">Value</span> <span class="keyword">const</span> <span class="special">&</span></code> <code class="computeroutput"><span class="identifier">v</span></code><code class="computeroutput"><span class="special">)</span></code>
|
|
</pre>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__rtree__functions.insert_rtree_________value_const___.h2"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__rtree__functions.insert_rtree_________value_const___.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.insert_rtree_________value_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">rtree</span><span class="special"><</span>
|
|
<span class="identifier">Value</span><span class="special">,</span>
|
|
<span class="identifier">Options</span><span class="special">,</span>
|
|
<span class="identifier">Translator</span><span class="special">,</span>
|
|
<span class="identifier">Allocator</span> <span class="special">></span>
|
|
<span class="special">&</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">tree</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The spatial index.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">Value</span> <span class="keyword">const</span>
|
|
<span class="special">&</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">v</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The value which will be stored in the index.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
</div>
|
|
<div class="section">
|
|
<div class="titlepage"><div><div><h5 class="title">
|
|
<a name="geometry_index.r_tree.reference.group__rtree__functions.insert_rtree_________iterator__iterator_"></a><a name="group__rtree__functions_1gaf8f4fa09c12b96ace3bbb38823a9191b"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.insert_rtree_________iterator__iterator_" title="insert(rtree<...> &, Iterator, Iterator)">insert(rtree<...>
|
|
&, Iterator, Iterator)</a>
|
|
</h5></div></div></div>
|
|
<p>
|
|
Insert a range of values to the index.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__rtree__functions.insert_rtree_________iterator__iterator_.h0"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__rtree__functions.insert_rtree_________iterator__iterator_.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.insert_rtree_________iterator__iterator_.description">Description</a>
|
|
</h6>
|
|
<p>
|
|
It calls <code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a5263a3faac7b4f0090d4ad1d44cc540d">rtree::insert(Iterator,
|
|
Iterator)</a></code>.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__rtree__functions.insert_rtree_________iterator__iterator_.h1"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__rtree__functions.insert_rtree_________iterator__iterator_.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.insert_rtree_________iterator__iterator_.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">Value</span></code><code class="computeroutput"><span class="special">,</span></code>
|
|
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Options</span></code><code class="computeroutput"><span class="special">,</span></code>
|
|
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Translator</span></code><code class="computeroutput"><span class="special">,</span></code>
|
|
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Allocator</span></code><code class="computeroutput"><span class="special">,</span></code>
|
|
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Iterator</span></code><code class="computeroutput"><span class="special">></span></code>
|
|
<code class="computeroutput"><span class="keyword">void</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">geometry</span><span class="special">::</span><span class="identifier">index</span><span class="special">::</span><span class="identifier">insert</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">Options</span><span class="special">,</span> <span class="identifier">Translator</span><span class="special">,</span> <span class="identifier">Allocator</span> <span class="special">></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">Iterator</span></code> <code class="computeroutput"><span class="identifier">first</span></code><code class="computeroutput"><span class="special">,</span></code>
|
|
<code class="computeroutput"><span class="identifier">Iterator</span></code> <code class="computeroutput"><span class="identifier">last</span></code><code class="computeroutput"><span class="special">)</span></code>
|
|
</pre>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__rtree__functions.insert_rtree_________iterator__iterator_.h2"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__rtree__functions.insert_rtree_________iterator__iterator_.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.insert_rtree_________iterator__iterator_.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">rtree</span><span class="special"><</span>
|
|
<span class="identifier">Value</span><span class="special">,</span>
|
|
<span class="identifier">Options</span><span class="special">,</span>
|
|
<span class="identifier">Translator</span><span class="special">,</span>
|
|
<span class="identifier">Allocator</span> <span class="special">></span>
|
|
<span class="special">&</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">tree</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The spatial index.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">Iterator</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">first</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The beginning of the range of values.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">Iterator</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">last</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The end of the range of values.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
</div>
|
|
<div class="section">
|
|
<div class="titlepage"><div><div><h5 class="title">
|
|
<a name="geometry_index.r_tree.reference.group__rtree__functions.insert_rtree_________range_const___"></a><a name="group__rtree__functions_1ga97ec330c1c021a1ac2d896a488c2eb9c"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.insert_rtree_________range_const___" title="insert(rtree<...> &, Range const &)">insert(rtree<...>
|
|
&, Range const &)</a>
|
|
</h5></div></div></div>
|
|
<p>
|
|
Insert a range of values to the index.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__rtree__functions.insert_rtree_________range_const___.h0"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__rtree__functions.insert_rtree_________range_const___.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.insert_rtree_________range_const___.description">Description</a>
|
|
</h6>
|
|
<p>
|
|
It calls <code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1abb624abd9268b41e815d40342b2634c2">rtree::insert(Range
|
|
const&)</a></code>.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__rtree__functions.insert_rtree_________range_const___.h1"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__rtree__functions.insert_rtree_________range_const___.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.insert_rtree_________range_const___.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">Value</span></code><code class="computeroutput"><span class="special">,</span></code>
|
|
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Options</span></code><code class="computeroutput"><span class="special">,</span></code>
|
|
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Translator</span></code><code class="computeroutput"><span class="special">,</span></code>
|
|
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Allocator</span></code><code class="computeroutput"><span class="special">,</span></code>
|
|
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Range</span></code><code class="computeroutput"><span class="special">></span></code>
|
|
<code class="computeroutput"><span class="keyword">void</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">geometry</span><span class="special">::</span><span class="identifier">index</span><span class="special">::</span><span class="identifier">insert</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">Options</span><span class="special">,</span> <span class="identifier">Translator</span><span class="special">,</span> <span class="identifier">Allocator</span> <span class="special">></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">Range</span> <span class="keyword">const</span> <span class="special">&</span></code> <code class="computeroutput"><span class="identifier">rng</span></code><code class="computeroutput"><span class="special">)</span></code>
|
|
</pre>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__rtree__functions.insert_rtree_________range_const___.h2"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__rtree__functions.insert_rtree_________range_const___.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.insert_rtree_________range_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">rtree</span><span class="special"><</span>
|
|
<span class="identifier">Value</span><span class="special">,</span>
|
|
<span class="identifier">Options</span><span class="special">,</span>
|
|
<span class="identifier">Translator</span><span class="special">,</span>
|
|
<span class="identifier">Allocator</span> <span class="special">></span>
|
|
<span class="special">&</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">tree</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The spatial index.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">Range</span> <span class="keyword">const</span>
|
|
<span class="special">&</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">rng</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The range of values.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
</div>
|
|
<div class="section">
|
|
<div class="titlepage"><div><div><h5 class="title">
|
|
<a name="geometry_index.r_tree.reference.group__rtree__functions.remove_rtree_________value_const___"></a><a name="group__rtree__functions_1gad40492a5b99c3eebbd51901574762527"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.remove_rtree_________value_const___" title="remove(rtree<...> &, Value const &)">remove(rtree<...>
|
|
&, Value const &)</a>
|
|
</h5></div></div></div>
|
|
<p>
|
|
Remove a value from the container.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__rtree__functions.remove_rtree_________value_const___.h0"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__rtree__functions.remove_rtree_________value_const___.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.remove_rtree_________value_const___.description">Description</a>
|
|
</h6>
|
|
<p>
|
|
Remove a value from the container. In contrast to the <code class="literal"><code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">set</span></code></code> or <code class="literal"><code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">map</span> <span class="identifier">erase</span><span class="special">()</span></code></code> method this function removes
|
|
only one value from the container.
|
|
</p>
|
|
<p>
|
|
It calls <code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1af6ca6909354a997f89411ef40ea5688a">rtree::remove(value_type
|
|
const&)</a></code>.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__rtree__functions.remove_rtree_________value_const___.h1"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__rtree__functions.remove_rtree_________value_const___.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.remove_rtree_________value_const___.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">Value</span></code><code class="computeroutput"><span class="special">,</span></code>
|
|
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Options</span></code><code class="computeroutput"><span class="special">,</span></code>
|
|
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Translator</span></code><code class="computeroutput"><span class="special">,</span></code>
|
|
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Allocator</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">Options</span><span class="special">,</span> <span class="identifier">Translator</span><span class="special">,</span> <span class="identifier">Allocator</span><span class="special">>::</span><span class="identifier">size_type</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">geometry</span><span class="special">::</span><span class="identifier">index</span><span class="special">::</span><span class="identifier">remove</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">Options</span><span class="special">,</span> <span class="identifier">Translator</span><span class="special">,</span> <span class="identifier">Allocator</span> <span class="special">></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">Value</span> <span class="keyword">const</span> <span class="special">&</span></code> <code class="computeroutput"><span class="identifier">v</span></code><code class="computeroutput"><span class="special">)</span></code>
|
|
</pre>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__rtree__functions.remove_rtree_________value_const___.h2"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__rtree__functions.remove_rtree_________value_const___.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.remove_rtree_________value_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">rtree</span><span class="special"><</span>
|
|
<span class="identifier">Value</span><span class="special">,</span>
|
|
<span class="identifier">Options</span><span class="special">,</span>
|
|
<span class="identifier">Translator</span><span class="special">,</span>
|
|
<span class="identifier">Allocator</span> <span class="special">></span>
|
|
<span class="special">&</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">tree</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The spatial index.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">Value</span> <span class="keyword">const</span>
|
|
<span class="special">&</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">v</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The value which will be removed from the index.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__rtree__functions.remove_rtree_________value_const___.h3"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__rtree__functions.remove_rtree_________value_const___.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.remove_rtree_________value_const___.returns">Returns</a>
|
|
</h6>
|
|
<p>
|
|
1 if value was removed, 0 otherwise.
|
|
</p>
|
|
</div>
|
|
<div class="section">
|
|
<div class="titlepage"><div><div><h5 class="title">
|
|
<a name="geometry_index.r_tree.reference.group__rtree__functions.remove_rtree_________iterator__iterator_"></a><a name="group__rtree__functions_1ga0219361de8b15c539af3f9bd027938ce"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.remove_rtree_________iterator__iterator_" title="remove(rtree<...> &, Iterator, Iterator)">remove(rtree<...>
|
|
&, Iterator, Iterator)</a>
|
|
</h5></div></div></div>
|
|
<p>
|
|
Remove a range of values from the container.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__rtree__functions.remove_rtree_________iterator__iterator_.h0"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__rtree__functions.remove_rtree_________iterator__iterator_.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.remove_rtree_________iterator__iterator_.description">Description</a>
|
|
</h6>
|
|
<p>
|
|
Remove a range of values from the container. In contrast to the <code class="literal"><code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">set</span></code></code> or <code class="literal"><code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">map</span> <span class="identifier">erase</span><span class="special">()</span></code></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>
|
|
<p>
|
|
It calls <code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a6e9123114697d65b16ebc49cd5371fbd">rtree::remove(Iterator,
|
|
Iterator)</a></code>.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__rtree__functions.remove_rtree_________iterator__iterator_.h1"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__rtree__functions.remove_rtree_________iterator__iterator_.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.remove_rtree_________iterator__iterator_.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">Value</span></code><code class="computeroutput"><span class="special">,</span></code>
|
|
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Options</span></code><code class="computeroutput"><span class="special">,</span></code>
|
|
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Translator</span></code><code class="computeroutput"><span class="special">,</span></code>
|
|
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Allocator</span></code><code class="computeroutput"><span class="special">,</span></code>
|
|
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Iterator</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">Options</span><span class="special">,</span> <span class="identifier">Translator</span><span class="special">,</span> <span class="identifier">Allocator</span><span class="special">>::</span><span class="identifier">size_type</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">geometry</span><span class="special">::</span><span class="identifier">index</span><span class="special">::</span><span class="identifier">remove</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">Options</span><span class="special">,</span> <span class="identifier">Translator</span><span class="special">,</span> <span class="identifier">Allocator</span> <span class="special">></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">Iterator</span></code> <code class="computeroutput"><span class="identifier">first</span></code><code class="computeroutput"><span class="special">,</span></code>
|
|
<code class="computeroutput"><span class="identifier">Iterator</span></code> <code class="computeroutput"><span class="identifier">last</span></code><code class="computeroutput"><span class="special">)</span></code>
|
|
</pre>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__rtree__functions.remove_rtree_________iterator__iterator_.h2"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__rtree__functions.remove_rtree_________iterator__iterator_.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.remove_rtree_________iterator__iterator_.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">rtree</span><span class="special"><</span>
|
|
<span class="identifier">Value</span><span class="special">,</span>
|
|
<span class="identifier">Options</span><span class="special">,</span>
|
|
<span class="identifier">Translator</span><span class="special">,</span>
|
|
<span class="identifier">Allocator</span> <span class="special">></span>
|
|
<span class="special">&</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">tree</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The spatial index.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">Iterator</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">first</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The beginning of the range of values.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">Iterator</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">last</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The end of the range of values.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__rtree__functions.remove_rtree_________iterator__iterator_.h3"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__rtree__functions.remove_rtree_________iterator__iterator_.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.remove_rtree_________iterator__iterator_.returns">Returns</a>
|
|
</h6>
|
|
<p>
|
|
The number of removed values.
|
|
</p>
|
|
</div>
|
|
<div class="section">
|
|
<div class="titlepage"><div><div><h5 class="title">
|
|
<a name="geometry_index.r_tree.reference.group__rtree__functions.remove_rtree_________range_const___"></a><a name="group__rtree__functions_1ga5885d6c90a91f238f72ab9b5ef24daf9"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.remove_rtree_________range_const___" title="remove(rtree<...> &, Range const &)">remove(rtree<...>
|
|
&, Range const &)</a>
|
|
</h5></div></div></div>
|
|
<p>
|
|
Remove a range of values from the container.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__rtree__functions.remove_rtree_________range_const___.h0"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__rtree__functions.remove_rtree_________range_const___.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.remove_rtree_________range_const___.description">Description</a>
|
|
</h6>
|
|
<p>
|
|
Remove a range of values from the container. In contrast to the <code class="literal"><code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">set</span></code></code> or <code class="literal"><code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">map</span> <span class="identifier">erase</span><span class="special">()</span></code></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>
|
|
<p>
|
|
It calls <code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a5a57bb93b0b2d7ea1c659e925f918e9c">rtree::remove(Range
|
|
const&)</a></code>.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__rtree__functions.remove_rtree_________range_const___.h1"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__rtree__functions.remove_rtree_________range_const___.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.remove_rtree_________range_const___.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">Value</span></code><code class="computeroutput"><span class="special">,</span></code>
|
|
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Options</span></code><code class="computeroutput"><span class="special">,</span></code>
|
|
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Translator</span></code><code class="computeroutput"><span class="special">,</span></code>
|
|
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Allocator</span></code><code class="computeroutput"><span class="special">,</span></code>
|
|
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Range</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">Options</span><span class="special">,</span> <span class="identifier">Translator</span><span class="special">,</span> <span class="identifier">Allocator</span><span class="special">>::</span><span class="identifier">size_type</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">geometry</span><span class="special">::</span><span class="identifier">index</span><span class="special">::</span><span class="identifier">remove</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">Options</span><span class="special">,</span> <span class="identifier">Translator</span><span class="special">,</span> <span class="identifier">Allocator</span> <span class="special">></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">Range</span> <span class="keyword">const</span> <span class="special">&</span></code> <code class="computeroutput"><span class="identifier">rng</span></code><code class="computeroutput"><span class="special">)</span></code>
|
|
</pre>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__rtree__functions.remove_rtree_________range_const___.h2"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__rtree__functions.remove_rtree_________range_const___.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.remove_rtree_________range_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">rtree</span><span class="special"><</span>
|
|
<span class="identifier">Value</span><span class="special">,</span>
|
|
<span class="identifier">Options</span><span class="special">,</span>
|
|
<span class="identifier">Translator</span><span class="special">,</span>
|
|
<span class="identifier">Allocator</span> <span class="special">></span>
|
|
<span class="special">&</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">tree</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The spatial index.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">Range</span> <span class="keyword">const</span>
|
|
<span class="special">&</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">rng</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The range of values.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__rtree__functions.remove_rtree_________range_const___.h3"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__rtree__functions.remove_rtree_________range_const___.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.remove_rtree_________range_const___.returns">Returns</a>
|
|
</h6>
|
|
<p>
|
|
The number of removed values.
|
|
</p>
|
|
</div>
|
|
<div class="section">
|
|
<div class="titlepage"><div><div><h5 class="title">
|
|
<a name="geometry_index.r_tree.reference.group__rtree__functions.spatial_query_rtree______const____predicates_const____outiter_"></a><a name="group__rtree__functions_1gadcec162d2391c2c9cc4215a5578d1721"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.spatial_query_rtree______const____predicates_const____outiter_" title="spatial_query(rtree<...> const &, Predicates const &, OutIter)">spatial_query(rtree<...>
|
|
const &, Predicates const &, OutIter)</a>
|
|
</h5></div></div></div>
|
|
<p>
|
|
Find values meeting spatial predicates.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__rtree__functions.spatial_query_rtree______const____predicates_const____outiter_.h0"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__rtree__functions.spatial_query_rtree______const____predicates_const____outiter_.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.spatial_query_rtree______const____predicates_const____outiter_.description">Description</a>
|
|
</h6>
|
|
<p>
|
|
It calls <code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a930bf17d595a91d8ae924383a0387920">rtree::spatial_query</a></code>
|
|
with parameters <code class="literal"><code class="computeroutput"><span class="special">(</span><span class="identifier">Predicates</span> <span class="keyword">const</span><span class="special">&,</span> <span class="identifier">OutIter</span><span class="special">)</span></code></code>.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__rtree__functions.spatial_query_rtree______const____predicates_const____outiter_.h1"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__rtree__functions.spatial_query_rtree______const____predicates_const____outiter_.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.spatial_query_rtree______const____predicates_const____outiter_.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">Value</span></code><code class="computeroutput"><span class="special">,</span></code>
|
|
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Options</span></code><code class="computeroutput"><span class="special">,</span></code>
|
|
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Translator</span></code><code class="computeroutput"><span class="special">,</span></code>
|
|
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Allocator</span></code><code class="computeroutput"><span class="special">,</span></code>
|
|
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Predicates</span></code><code class="computeroutput"><span class="special">,</span></code>
|
|
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">OutIter</span></code><code class="computeroutput"><span class="special">></span></code>
|
|
<code class="computeroutput"><span class="identifier">size_t</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">geometry</span><span class="special">::</span><span class="identifier">index</span><span class="special">::</span><span class="identifier">spatial_query</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">Options</span><span class="special">,</span> <span class="identifier">Translator</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">pred</span></code><code class="computeroutput"><span class="special">,</span></code>
|
|
<code class="computeroutput"><span class="identifier">OutIter</span></code> <code class="computeroutput"><span class="identifier">out_it</span></code><code class="computeroutput"><span class="special">)</span></code>
|
|
</pre>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__rtree__functions.spatial_query_rtree______const____predicates_const____outiter_.h2"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__rtree__functions.spatial_query_rtree______const____predicates_const____outiter_.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.spatial_query_rtree______const____predicates_const____outiter_.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">rtree</span><span class="special"><</span>
|
|
<span class="identifier">Value</span><span class="special">,</span>
|
|
<span class="identifier">Options</span><span class="special">,</span>
|
|
<span class="identifier">Translator</span><span class="special">,</span>
|
|
<span class="identifier">Allocator</span> <span class="special">></span>
|
|
<span class="keyword">const</span> <span class="special">&</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">tree</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The spatial index.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">Predicates</span> <span class="keyword">const</span> <span class="special">&</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">pred</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The spatial predicates.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">OutIter</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">out_it</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The output iterator of the result range.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__rtree__functions.spatial_query_rtree______const____predicates_const____outiter_.h3"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__rtree__functions.spatial_query_rtree______const____predicates_const____outiter_.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.spatial_query_rtree______const____predicates_const____outiter_.returns">Returns</a>
|
|
</h6>
|
|
<p>
|
|
The number of found values.
|
|
</p>
|
|
</div>
|
|
<div class="section">
|
|
<div class="titlepage"><div><div><h5 class="title">
|
|
<a name="geometry_index.r_tree.reference.group__rtree__functions.nearest_query_rtree______const____distancespredicates_const____value___"></a><a name="group__rtree__functions_1gacabbd521b88b67a700e1246e5889d343"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.nearest_query_rtree______const____distancespredicates_const____value___" title="nearest_query(rtree<...> const &, DistancesPredicates const &, Value &)">nearest_query(rtree<...>
|
|
const &, DistancesPredicates const &, Value &)</a>
|
|
</h5></div></div></div>
|
|
<p>
|
|
Find the value meeting distances predicates.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__rtree__functions.nearest_query_rtree______const____distancespredicates_const____value___.h0"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__rtree__functions.nearest_query_rtree______const____distancespredicates_const____value___.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.nearest_query_rtree______const____distancespredicates_const____value___.description">Description</a>
|
|
</h6>
|
|
<p>
|
|
It calls <code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a788295b315bd0ddeb93b1cc050fdf909">rtree::nearest_query</a></code>
|
|
with parameters <code class="literal"><code class="computeroutput"><span class="special">(</span><span class="identifier">DistancesPredicates</span> <span class="keyword">const</span><span class="special">&</span> <span class="identifier">dpred</span><span class="special">,</span> <span class="identifier">value_type</span>
|
|
<span class="special">&</span> <span class="identifier">v</span><span class="special">)</span></code></code>.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__rtree__functions.nearest_query_rtree______const____distancespredicates_const____value___.h1"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__rtree__functions.nearest_query_rtree______const____distancespredicates_const____value___.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.nearest_query_rtree______const____distancespredicates_const____value___.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">Value</span></code><code class="computeroutput"><span class="special">,</span></code>
|
|
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Options</span></code><code class="computeroutput"><span class="special">,</span></code>
|
|
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Translator</span></code><code class="computeroutput"><span class="special">,</span></code>
|
|
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Allocator</span></code><code class="computeroutput"><span class="special">,</span></code>
|
|
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">DistancesPredicates</span></code><code class="computeroutput"><span class="special">></span></code>
|
|
<code class="computeroutput"><span class="identifier">size_t</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">geometry</span><span class="special">::</span><span class="identifier">index</span><span class="special">::</span><span class="identifier">nearest_query</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">Options</span><span class="special">,</span> <span class="identifier">Translator</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">DistancesPredicates</span> <span class="keyword">const</span> <span class="special">&</span></code> <code class="computeroutput"><span class="identifier">dpred</span></code><code class="computeroutput"><span class="special">,</span></code>
|
|
<code class="computeroutput"><span class="identifier">Value</span> <span class="special">&</span></code> <code class="computeroutput"><span class="identifier">v</span></code><code class="computeroutput"><span class="special">)</span></code>
|
|
</pre>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__rtree__functions.nearest_query_rtree______const____distancespredicates_const____value___.h2"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__rtree__functions.nearest_query_rtree______const____distancespredicates_const____value___.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.nearest_query_rtree______const____distancespredicates_const____value___.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">rtree</span><span class="special"><</span>
|
|
<span class="identifier">Value</span><span class="special">,</span>
|
|
<span class="identifier">Options</span><span class="special">,</span>
|
|
<span class="identifier">Translator</span><span class="special">,</span>
|
|
<span class="identifier">Allocator</span> <span class="special">></span>
|
|
<span class="keyword">const</span> <span class="special">&</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">tree</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The spatial index.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">DistancesPredicates</span>
|
|
<span class="keyword">const</span> <span class="special">&</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">dpred</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The distances predicates.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">Value</span> <span class="special">&</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">v</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The result.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__rtree__functions.nearest_query_rtree______const____distancespredicates_const____value___.h3"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__rtree__functions.nearest_query_rtree______const____distancespredicates_const____value___.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.nearest_query_rtree______const____distancespredicates_const____value___.returns">Returns</a>
|
|
</h6>
|
|
<p>
|
|
The number of found values.
|
|
</p>
|
|
</div>
|
|
<div class="section">
|
|
<div class="titlepage"><div><div><h5 class="title">
|
|
<a name="geometry_index.r_tree.reference.group__rtree__functions.nearest_query_rtree______const____distancespredicates_const____predicates_const____value___"></a><a name="group__rtree__functions_1gaf963f417d4ab54a2782928020dd8c3ad"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.nearest_query_rtree______const____distancespredicates_const____predicates_const____value___" title="nearest_query(rtree<...> const &, DistancesPredicates const &, Predicates const &, Value &)">nearest_query(rtree<...>
|
|
const &, DistancesPredicates const &, Predicates const &, Value
|
|
&)</a>
|
|
</h5></div></div></div>
|
|
<p>
|
|
Find the value meeting distances and spatial predicates.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__rtree__functions.nearest_query_rtree______const____distancespredicates_const____predicates_const____value___.h0"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__rtree__functions.nearest_query_rtree______const____distancespredicates_const____predicates_const____value___.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.nearest_query_rtree______const____distancespredicates_const____predicates_const____value___.description">Description</a>
|
|
</h6>
|
|
<p>
|
|
It calls <code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a788295b315bd0ddeb93b1cc050fdf909">rtree::nearest_query</a></code>
|
|
with parameters <code class="literal"><code class="computeroutput"><span class="special">(</span><span class="identifier">DistancesPredicates</span> <span class="keyword">const</span><span class="special">&</span> <span class="identifier">dpred</span><span class="special">,</span> <span class="identifier">Predicates</span>
|
|
<span class="keyword">const</span><span class="special">&</span>
|
|
<span class="identifier">pred</span><span class="special">,</span>
|
|
<span class="identifier">value_type</span> <span class="special">&</span>
|
|
<span class="identifier">v</span><span class="special">)</span></code></code>.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__rtree__functions.nearest_query_rtree______const____distancespredicates_const____predicates_const____value___.h1"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__rtree__functions.nearest_query_rtree______const____distancespredicates_const____predicates_const____value___.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.nearest_query_rtree______const____distancespredicates_const____predicates_const____value___.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">Value</span></code><code class="computeroutput"><span class="special">,</span></code>
|
|
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Options</span></code><code class="computeroutput"><span class="special">,</span></code>
|
|
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Translator</span></code><code class="computeroutput"><span class="special">,</span></code>
|
|
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Allocator</span></code><code class="computeroutput"><span class="special">,</span></code>
|
|
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">DistancesPredicates</span></code><code class="computeroutput"><span class="special">,</span></code>
|
|
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Predicates</span></code><code class="computeroutput"><span class="special">></span></code>
|
|
<code class="computeroutput"><span class="identifier">size_t</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">geometry</span><span class="special">::</span><span class="identifier">index</span><span class="special">::</span><span class="identifier">nearest_query</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">Options</span><span class="special">,</span> <span class="identifier">Translator</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">DistancesPredicates</span> <span class="keyword">const</span> <span class="special">&</span></code> <code class="computeroutput"><span class="identifier">dpred</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">pred</span></code><code class="computeroutput"><span class="special">,</span></code>
|
|
<code class="computeroutput"><span class="identifier">Value</span> <span class="special">&</span></code> <code class="computeroutput"><span class="identifier">v</span></code><code class="computeroutput"><span class="special">)</span></code>
|
|
</pre>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__rtree__functions.nearest_query_rtree______const____distancespredicates_const____predicates_const____value___.h2"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__rtree__functions.nearest_query_rtree______const____distancespredicates_const____predicates_const____value___.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.nearest_query_rtree______const____distancespredicates_const____predicates_const____value___.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">rtree</span><span class="special"><</span>
|
|
<span class="identifier">Value</span><span class="special">,</span>
|
|
<span class="identifier">Options</span><span class="special">,</span>
|
|
<span class="identifier">Translator</span><span class="special">,</span>
|
|
<span class="identifier">Allocator</span> <span class="special">></span>
|
|
<span class="keyword">const</span> <span class="special">&</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">tree</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The spatial index.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">DistancesPredicates</span>
|
|
<span class="keyword">const</span> <span class="special">&</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">dpred</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The distances predicates.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">Predicates</span> <span class="keyword">const</span> <span class="special">&</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">pred</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The spatial predicates.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">Value</span> <span class="special">&</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">v</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The result.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__rtree__functions.nearest_query_rtree______const____distancespredicates_const____predicates_const____value___.h3"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__rtree__functions.nearest_query_rtree______const____distancespredicates_const____predicates_const____value___.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.nearest_query_rtree______const____distancespredicates_const____predicates_const____value___.returns">Returns</a>
|
|
</h6>
|
|
<p>
|
|
The number of found values.
|
|
</p>
|
|
</div>
|
|
<div class="section">
|
|
<div class="titlepage"><div><div><h5 class="title">
|
|
<a name="geometry_index.r_tree.reference.group__rtree__functions.nearest_query_rtree______const____distancespredicates_const____typename_rtree_______size_type__outiter_"></a><a name="group__rtree__functions_1ga74550ecb22e4ac69a445c1a6b0be9a1b"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.nearest_query_rtree______const____distancespredicates_const____typename_rtree_______size_type__outiter_" title="nearest_query(rtree<...> const &, DistancesPredicates const &, typename rtree<...>::size_type, OutIter)">nearest_query(rtree<...>
|
|
const &, DistancesPredicates const &, typename rtree<...>::size_type,
|
|
OutIter)</a>
|
|
</h5></div></div></div>
|
|
<p>
|
|
Find k values meeting distances predicates.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__rtree__functions.nearest_query_rtree______const____distancespredicates_const____typename_rtree_______size_type__outiter_.h0"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__rtree__functions.nearest_query_rtree______const____distancespredicates_const____typename_rtree_______size_type__outiter_.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.nearest_query_rtree______const____distancespredicates_const____typename_rtree_______size_type__outiter_.description">Description</a>
|
|
</h6>
|
|
<p>
|
|
It calls <code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a788295b315bd0ddeb93b1cc050fdf909">rtree::nearest_query</a></code>
|
|
with parameters <code class="literal"><code class="computeroutput"><span class="special">(</span><span class="identifier">DistancesPredicates</span> <span class="keyword">const</span>
|
|
<span class="special">&</span> <span class="identifier">dpred</span><span class="special">,</span> <span class="identifier">size_type</span>
|
|
<span class="identifier">k</span><span class="special">,</span>
|
|
<span class="identifier">OutIter</span> <span class="identifier">out_it</span><span class="special">)</span></code></code>.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__rtree__functions.nearest_query_rtree______const____distancespredicates_const____typename_rtree_______size_type__outiter_.h1"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__rtree__functions.nearest_query_rtree______const____distancespredicates_const____typename_rtree_______size_type__outiter_.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.nearest_query_rtree______const____distancespredicates_const____typename_rtree_______size_type__outiter_.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">Value</span></code><code class="computeroutput"><span class="special">,</span></code>
|
|
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Options</span></code><code class="computeroutput"><span class="special">,</span></code>
|
|
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Translator</span></code><code class="computeroutput"><span class="special">,</span></code>
|
|
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Allocator</span></code><code class="computeroutput"><span class="special">,</span></code>
|
|
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">DistancesPredicates</span></code><code class="computeroutput"><span class="special">,</span></code>
|
|
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">OutIter</span></code><code class="computeroutput"><span class="special">></span></code>
|
|
<code class="computeroutput"><span class="identifier">size_t</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">geometry</span><span class="special">::</span><span class="identifier">index</span><span class="special">::</span><span class="identifier">nearest_query</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">Options</span><span class="special">,</span> <span class="identifier">Translator</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">DistancesPredicates</span> <span class="keyword">const</span> <span class="special">&</span></code> <code class="computeroutput"><span class="identifier">dpred</span></code><code class="computeroutput"><span class="special">,</span></code>
|
|
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">rtree</span><span class="special"><</span> <span class="identifier">Value</span><span class="special">,</span> <span class="identifier">Options</span><span class="special">,</span> <span class="identifier">Translator</span><span class="special">,</span> <span class="identifier">Allocator</span> <span class="special">>::</span><span class="identifier">size_type</span></code> <code class="computeroutput"><span class="identifier">k</span></code><code class="computeroutput"><span class="special">,</span></code>
|
|
<code class="computeroutput"><span class="identifier">OutIter</span></code> <code class="computeroutput"><span class="identifier">out_it</span></code><code class="computeroutput"><span class="special">)</span></code>
|
|
</pre>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__rtree__functions.nearest_query_rtree______const____distancespredicates_const____typename_rtree_______size_type__outiter_.h2"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__rtree__functions.nearest_query_rtree______const____distancespredicates_const____typename_rtree_______size_type__outiter_.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.nearest_query_rtree______const____distancespredicates_const____typename_rtree_______size_type__outiter_.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">rtree</span><span class="special"><</span>
|
|
<span class="identifier">Value</span><span class="special">,</span>
|
|
<span class="identifier">Options</span><span class="special">,</span>
|
|
<span class="identifier">Translator</span><span class="special">,</span>
|
|
<span class="identifier">Allocator</span> <span class="special">></span>
|
|
<span class="keyword">const</span> <span class="special">&</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">tree</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The spatial index.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">DistancesPredicates</span>
|
|
<span class="keyword">const</span> <span class="special">&</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">dpred</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The distances predicates.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">rtree</span><span class="special"><</span> <span class="identifier">Value</span><span class="special">,</span> <span class="identifier">Options</span><span class="special">,</span> <span class="identifier">Translator</span><span class="special">,</span> <span class="identifier">Allocator</span>
|
|
<span class="special">>::</span><span class="identifier">size_type</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">k</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The max number of values.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">OutIter</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">out_it</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The output iterator of the result range.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__rtree__functions.nearest_query_rtree______const____distancespredicates_const____typename_rtree_______size_type__outiter_.h3"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__rtree__functions.nearest_query_rtree______const____distancespredicates_const____typename_rtree_______size_type__outiter_.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.nearest_query_rtree______const____distancespredicates_const____typename_rtree_______size_type__outiter_.returns">Returns</a>
|
|
</h6>
|
|
<p>
|
|
The number of found values.
|
|
</p>
|
|
</div>
|
|
<div class="section">
|
|
<div class="titlepage"><div><div><h5 class="title">
|
|
<a name="geometry_index.r_tree.reference.group__rtree__functions.nearest_query_rtree______const____distancespredicates_const____typename_rtree_______size_type__predicates_const____outiter_"></a><a name="group__rtree__functions_1ga8057af533a3e28e09337bab2c7a146aa"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.nearest_query_rtree______const____distancespredicates_const____typename_rtree_______size_type__predicates_const____outiter_" title="nearest_query(rtree<...> const &, DistancesPredicates const &, typename rtree<...>::size_type, Predicates const &, OutIter)">nearest_query(rtree<...>
|
|
const &, DistancesPredicates const &, typename rtree<...>::size_type,
|
|
Predicates const &, OutIter)</a>
|
|
</h5></div></div></div>
|
|
<p>
|
|
Find k values meeting distances and spatial predicates.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__rtree__functions.nearest_query_rtree______const____distancespredicates_const____typename_rtree_______size_type__predicates_const____outiter_.h0"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__rtree__functions.nearest_query_rtree______const____distancespredicates_const____typename_rtree_______size_type__predicates_const____outiter_.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.nearest_query_rtree______const____distancespredicates_const____typename_rtree_______size_type__predicates_const____outiter_.description">Description</a>
|
|
</h6>
|
|
<p>
|
|
It calls <code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a788295b315bd0ddeb93b1cc050fdf909">rtree::nearest_query</a></code>
|
|
with parameters <code class="literal"><code class="computeroutput"><span class="special">(</span><span class="identifier">DistancesPredicates</span> <span class="keyword">const</span>
|
|
<span class="special">&</span> <span class="identifier">dpred</span><span class="special">,</span> <span class="identifier">size_type</span>
|
|
<span class="identifier">k</span><span class="special">,</span>
|
|
<span class="identifier">Predicates</span> <span class="keyword">const</span>
|
|
<span class="special">&</span> <span class="identifier">pred</span><span class="special">,</span> <span class="identifier">OutIter</span>
|
|
<span class="identifier">out_it</span><span class="special">)</span></code></code>.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__rtree__functions.nearest_query_rtree______const____distancespredicates_const____typename_rtree_______size_type__predicates_const____outiter_.h1"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__rtree__functions.nearest_query_rtree______const____distancespredicates_const____typename_rtree_______size_type__predicates_const____outiter_.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.nearest_query_rtree______const____distancespredicates_const____typename_rtree_______size_type__predicates_const____outiter_.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">Value</span></code><code class="computeroutput"><span class="special">,</span></code>
|
|
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Options</span></code><code class="computeroutput"><span class="special">,</span></code>
|
|
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Translator</span></code><code class="computeroutput"><span class="special">,</span></code>
|
|
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Allocator</span></code><code class="computeroutput"><span class="special">,</span></code>
|
|
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">DistancesPredicates</span></code><code class="computeroutput"><span class="special">,</span></code>
|
|
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Predicates</span></code><code class="computeroutput"><span class="special">,</span></code>
|
|
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">OutIter</span></code><code class="computeroutput"><span class="special">></span></code>
|
|
<code class="computeroutput"><span class="identifier">size_t</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">geometry</span><span class="special">::</span><span class="identifier">index</span><span class="special">::</span><span class="identifier">nearest_query</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">Options</span><span class="special">,</span> <span class="identifier">Translator</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">DistancesPredicates</span> <span class="keyword">const</span> <span class="special">&</span></code> <code class="computeroutput"><span class="identifier">dpred</span></code><code class="computeroutput"><span class="special">,</span></code>
|
|
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">rtree</span><span class="special"><</span> <span class="identifier">Value</span><span class="special">,</span> <span class="identifier">Options</span><span class="special">,</span> <span class="identifier">Translator</span><span class="special">,</span> <span class="identifier">Allocator</span> <span class="special">>::</span><span class="identifier">size_type</span></code> <code class="computeroutput"><span class="identifier">k</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">pred</span></code><code class="computeroutput"><span class="special">,</span></code>
|
|
<code class="computeroutput"><span class="identifier">OutIter</span></code> <code class="computeroutput"><span class="identifier">out_it</span></code><code class="computeroutput"><span class="special">)</span></code>
|
|
</pre>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__rtree__functions.nearest_query_rtree______const____distancespredicates_const____typename_rtree_______size_type__predicates_const____outiter_.h2"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__rtree__functions.nearest_query_rtree______const____distancespredicates_const____typename_rtree_______size_type__predicates_const____outiter_.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.nearest_query_rtree______const____distancespredicates_const____typename_rtree_______size_type__predicates_const____outiter_.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">rtree</span><span class="special"><</span>
|
|
<span class="identifier">Value</span><span class="special">,</span>
|
|
<span class="identifier">Options</span><span class="special">,</span>
|
|
<span class="identifier">Translator</span><span class="special">,</span>
|
|
<span class="identifier">Allocator</span> <span class="special">></span>
|
|
<span class="keyword">const</span> <span class="special">&</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">tree</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The spatial index.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">DistancesPredicates</span>
|
|
<span class="keyword">const</span> <span class="special">&</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">dpred</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The distances predicates.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">rtree</span><span class="special"><</span> <span class="identifier">Value</span><span class="special">,</span> <span class="identifier">Options</span><span class="special">,</span> <span class="identifier">Translator</span><span class="special">,</span> <span class="identifier">Allocator</span>
|
|
<span class="special">>::</span><span class="identifier">size_type</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">k</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The max number of values.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">Predicates</span> <span class="keyword">const</span> <span class="special">&</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">pred</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The spatial predicates.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">OutIter</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">out_it</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The output iterator of the result range.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__rtree__functions.nearest_query_rtree______const____distancespredicates_const____typename_rtree_______size_type__predicates_const____outiter_.h3"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__rtree__functions.nearest_query_rtree______const____distancespredicates_const____typename_rtree_______size_type__predicates_const____outiter_.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.nearest_query_rtree______const____distancespredicates_const____typename_rtree_______size_type__predicates_const____outiter_.returns">Returns</a>
|
|
</h6>
|
|
<p>
|
|
The number of found values.
|
|
</p>
|
|
</div>
|
|
<div class="section">
|
|
<div class="titlepage"><div><div><h5 class="title">
|
|
<a name="geometry_index.r_tree.reference.group__rtree__functions.clear_rtree________"></a><a name="group__rtree__functions_1ga0c65d7b29b1edf72f1d236ccf211f63c"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.clear_rtree________" title="clear(rtree<...> &)">clear(rtree<...>
|
|
&)</a>
|
|
</h5></div></div></div>
|
|
<p>
|
|
Remove all values from the index.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__rtree__functions.clear_rtree________.h0"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__rtree__functions.clear_rtree________.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.clear_rtree________.description">Description</a>
|
|
</h6>
|
|
<p>
|
|
It calls <code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1ae6027e42d28a4bf93e74b055c79e6b09">rtree::clear()</a></code>.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__rtree__functions.clear_rtree________.h1"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__rtree__functions.clear_rtree________.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.clear_rtree________.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">Value</span></code><code class="computeroutput"><span class="special">,</span></code>
|
|
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Options</span></code><code class="computeroutput"><span class="special">,</span></code>
|
|
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Translator</span></code><code class="computeroutput"><span class="special">,</span></code>
|
|
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Allocator</span></code><code class="computeroutput"><span class="special">></span></code>
|
|
<code class="computeroutput"><span class="keyword">void</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">geometry</span><span class="special">::</span><span class="identifier">index</span><span class="special">::</span><span class="identifier">clear</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">Options</span><span class="special">,</span> <span class="identifier">Translator</span><span class="special">,</span> <span class="identifier">Allocator</span> <span class="special">></span> <span class="special">&</span></code> <code class="computeroutput"><span class="identifier">tree</span></code><code class="computeroutput"><span class="special">)</span></code>
|
|
</pre>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__rtree__functions.clear_rtree________.h2"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__rtree__functions.clear_rtree________.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.clear_rtree________.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">rtree</span><span class="special"><</span>
|
|
<span class="identifier">Value</span><span class="special">,</span>
|
|
<span class="identifier">Options</span><span class="special">,</span>
|
|
<span class="identifier">Translator</span><span class="special">,</span>
|
|
<span class="identifier">Allocator</span> <span class="special">></span>
|
|
<span class="special">&</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">tree</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The spatial index.
|
|
</p>
|
|
</td>
|
|
</tr></tbody>
|
|
</table></div>
|
|
</div>
|
|
<div class="section">
|
|
<div class="titlepage"><div><div><h5 class="title">
|
|
<a name="geometry_index.r_tree.reference.group__rtree__functions.size_rtree______const___"></a><a name="group__rtree__functions_1gaec0b88a9d8b408753e3069134f1598c7"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.size_rtree______const___" title="size(rtree<...> const &)">size(rtree<...>
|
|
const &)</a>
|
|
</h5></div></div></div>
|
|
<p>
|
|
Get the number of values stored in the index.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__rtree__functions.size_rtree______const___.h0"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__rtree__functions.size_rtree______const___.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.size_rtree______const___.description">Description</a>
|
|
</h6>
|
|
<p>
|
|
It calls <code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a89561a834563f2ed6fc782bad16143fd">rtree::size()</a></code>.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__rtree__functions.size_rtree______const___.h1"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__rtree__functions.size_rtree______const___.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.size_rtree______const___.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">Value</span></code><code class="computeroutput"><span class="special">,</span></code>
|
|
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Options</span></code><code class="computeroutput"><span class="special">,</span></code>
|
|
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Translator</span></code><code class="computeroutput"><span class="special">,</span></code>
|
|
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Allocator</span></code><code class="computeroutput"><span class="special">></span></code>
|
|
<code class="computeroutput"><span class="identifier">size_t</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">geometry</span><span class="special">::</span><span class="identifier">index</span><span class="special">::</span><span class="identifier">size</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">Options</span><span class="special">,</span> <span class="identifier">Translator</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>
|
|
</pre>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__rtree__functions.size_rtree______const___.h2"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__rtree__functions.size_rtree______const___.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.size_rtree______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">rtree</span><span class="special"><</span>
|
|
<span class="identifier">Value</span><span class="special">,</span>
|
|
<span class="identifier">Options</span><span class="special">,</span>
|
|
<span class="identifier">Translator</span><span class="special">,</span>
|
|
<span class="identifier">Allocator</span> <span class="special">></span>
|
|
<span class="keyword">const</span> <span class="special">&</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">tree</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The spatial index.
|
|
</p>
|
|
</td>
|
|
</tr></tbody>
|
|
</table></div>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__rtree__functions.size_rtree______const___.h3"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__rtree__functions.size_rtree______const___.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.size_rtree______const___.returns">Returns</a>
|
|
</h6>
|
|
<p>
|
|
The number of values stored in the index.
|
|
</p>
|
|
</div>
|
|
<div class="section">
|
|
<div class="titlepage"><div><div><h5 class="title">
|
|
<a name="geometry_index.r_tree.reference.group__rtree__functions.empty_rtree______const___"></a><a name="group__rtree__functions_1ga459e3d404fec7cbd66794714cbdd129e"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.empty_rtree______const___" title="empty(rtree<...> const &)">empty(rtree<...>
|
|
const &)</a>
|
|
</h5></div></div></div>
|
|
<p>
|
|
Query if there are no values stored in the index.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__rtree__functions.empty_rtree______const___.h0"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__rtree__functions.empty_rtree______const___.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.empty_rtree______const___.description">Description</a>
|
|
</h6>
|
|
<p>
|
|
It calls <code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1ae889567443b0ba0dbdb975564c55804c">rtree::empty()</a></code>.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__rtree__functions.empty_rtree______const___.h1"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__rtree__functions.empty_rtree______const___.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.empty_rtree______const___.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">Value</span></code><code class="computeroutput"><span class="special">,</span></code>
|
|
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Options</span></code><code class="computeroutput"><span class="special">,</span></code>
|
|
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Translator</span></code><code class="computeroutput"><span class="special">,</span></code>
|
|
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Allocator</span></code><code class="computeroutput"><span class="special">></span></code>
|
|
<code class="computeroutput"><span class="keyword">bool</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">geometry</span><span class="special">::</span><span class="identifier">index</span><span class="special">::</span><span class="identifier">empty</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">Options</span><span class="special">,</span> <span class="identifier">Translator</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>
|
|
</pre>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__rtree__functions.empty_rtree______const___.h2"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__rtree__functions.empty_rtree______const___.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.empty_rtree______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">rtree</span><span class="special"><</span>
|
|
<span class="identifier">Value</span><span class="special">,</span>
|
|
<span class="identifier">Options</span><span class="special">,</span>
|
|
<span class="identifier">Translator</span><span class="special">,</span>
|
|
<span class="identifier">Allocator</span> <span class="special">></span>
|
|
<span class="keyword">const</span> <span class="special">&</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">tree</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The spatial index.
|
|
</p>
|
|
</td>
|
|
</tr></tbody>
|
|
</table></div>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__rtree__functions.empty_rtree______const___.h3"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__rtree__functions.empty_rtree______const___.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.empty_rtree______const___.returns">Returns</a>
|
|
</h6>
|
|
<p>
|
|
true if there are no values in the index.
|
|
</p>
|
|
</div>
|
|
<div class="section">
|
|
<div class="titlepage"><div><div><h5 class="title">
|
|
<a name="geometry_index.r_tree.reference.group__rtree__functions.box_rtree______const___"></a><a name="group__rtree__functions_1ga46aead88abd7f18f0e1eedb991bbb39d"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.box_rtree______const___" title="box(rtree<...> const &)">box(rtree<...>
|
|
const &)</a>
|
|
</h5></div></div></div>
|
|
<p>
|
|
Get the box containing all stored values or an invalid box if the index
|
|
has no values.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__rtree__functions.box_rtree______const___.h0"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__rtree__functions.box_rtree______const___.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.box_rtree______const___.description">Description</a>
|
|
</h6>
|
|
<p>
|
|
It calls <code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1adf62005332a5fa9119ff03185e0c5143">rtree::box()</a></code>.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__rtree__functions.box_rtree______const___.h1"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__rtree__functions.box_rtree______const___.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.box_rtree______const___.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">Value</span></code><code class="computeroutput"><span class="special">,</span></code>
|
|
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Options</span></code><code class="computeroutput"><span class="special">,</span></code>
|
|
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Translator</span></code><code class="computeroutput"><span class="special">,</span></code>
|
|
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Allocator</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">Options</span><span class="special">,</span> <span class="identifier">Translator</span><span class="special">,</span> <span class="identifier">Allocator</span><span class="special">>::</span><span class="identifier">box_type</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">geometry</span><span class="special">::</span><span class="identifier">index</span><span class="special">::</span><span class="identifier">box</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">Options</span><span class="special">,</span> <span class="identifier">Translator</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>
|
|
</pre>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__rtree__functions.box_rtree______const___.h2"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__rtree__functions.box_rtree______const___.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.box_rtree______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">rtree</span><span class="special"><</span>
|
|
<span class="identifier">Value</span><span class="special">,</span>
|
|
<span class="identifier">Options</span><span class="special">,</span>
|
|
<span class="identifier">Translator</span><span class="special">,</span>
|
|
<span class="identifier">Allocator</span> <span class="special">></span>
|
|
<span class="keyword">const</span> <span class="special">&</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">tree</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The spatial index.
|
|
</p>
|
|
</td>
|
|
</tr></tbody>
|
|
</table></div>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__rtree__functions.box_rtree______const___.h3"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__rtree__functions.box_rtree______const___.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.box_rtree______const___.returns">Returns</a>
|
|
</h6>
|
|
<p>
|
|
The box containing all stored values or an invalid box.
|
|
</p>
|
|
</div>
|
|
<div class="section">
|
|
<div class="titlepage"><div><div><h5 class="title">
|
|
<a name="geometry_index.r_tree.reference.group__rtree__functions.envelope_index__rtree______const____box___"></a><a name="group__rtree__functions_1gab3425094aa846b167789ac76114696f6"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.envelope_index__rtree______const____box___" title="envelope(index::rtree<...> const &, Box &)">envelope(index::rtree<...>
|
|
const &, Box &)</a>
|
|
</h5></div></div></div>
|
|
<p>
|
|
Get the box containing all stored values or an invalid box if the index
|
|
has no values.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__rtree__functions.envelope_index__rtree______const____box___.h0"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__rtree__functions.envelope_index__rtree______const____box___.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.envelope_index__rtree______const____box___.description">Description</a>
|
|
</h6>
|
|
<p>
|
|
It calls <code class="literal"><a class="link" href="reference.html#group__rtree__functions_1ga46aead88abd7f18f0e1eedb991bbb39d">rtree::box()</a></code>.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__rtree__functions.envelope_index__rtree______const____box___.h1"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__rtree__functions.envelope_index__rtree______const____box___.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.envelope_index__rtree______const____box___.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">Value</span></code><code class="computeroutput"><span class="special">,</span></code>
|
|
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Options</span></code><code class="computeroutput"><span class="special">,</span></code>
|
|
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Translator</span></code><code class="computeroutput"><span class="special">,</span></code>
|
|
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Allocator</span></code><code class="computeroutput"><span class="special">,</span></code>
|
|
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Box</span></code><code class="computeroutput"><span class="special">></span></code>
|
|
<code class="computeroutput"><span class="keyword">void</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">geometry</span><span class="special">::</span><span class="identifier">envelope</span></code><code class="computeroutput"><span class="special">(</span></code><code class="computeroutput"><span class="identifier">index</span><span class="special">::</span><span class="identifier">rtree</span><span class="special"><</span> <span class="identifier">Value</span><span class="special">,</span> <span class="identifier">Options</span><span class="special">,</span> <span class="identifier">Translator</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">Box</span> <span class="special">&</span></code> <code class="computeroutput"><span class="identifier">box</span></code><code class="computeroutput"><span class="special">)</span></code>
|
|
</pre>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__rtree__functions.envelope_index__rtree______const____box___.h2"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__rtree__functions.envelope_index__rtree______const____box___.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.envelope_index__rtree______const____box___.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">index</span><span class="special">::</span><span class="identifier">rtree</span><span class="special"><</span>
|
|
<span class="identifier">Value</span><span class="special">,</span>
|
|
<span class="identifier">Options</span><span class="special">,</span>
|
|
<span class="identifier">Translator</span><span class="special">,</span>
|
|
<span class="identifier">Allocator</span> <span class="special">></span>
|
|
<span class="keyword">const</span> <span class="special">&</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">tree</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The spatial index.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">Box</span> <span class="special">&</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">box</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The object to which box containing all stored values or an
|
|
invalid box will be assigned.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
</div>
|
|
<div class="section">
|
|
<div class="titlepage"><div><div><h5 class="title">
|
|
<a name="geometry_index.r_tree.reference.group__rtree__functions.return_envelope_index__rtree______const___"></a><a name="group__rtree__functions_1gaab92d20f98edefccee1e76c1349a5127"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.return_envelope_index__rtree______const___" title="return_envelope(index::rtree<...> const &)">return_envelope(index::rtree<...>
|
|
const &)</a>
|
|
</h5></div></div></div>
|
|
<p>
|
|
Get the box containing all stored values or an invalid box if the index
|
|
has no values.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__rtree__functions.return_envelope_index__rtree______const___.h0"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__rtree__functions.return_envelope_index__rtree______const___.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.return_envelope_index__rtree______const___.description">Description</a>
|
|
</h6>
|
|
<p>
|
|
It calls <code class="literal"><a class="link" href="reference.html#group__rtree__functions_1ga46aead88abd7f18f0e1eedb991bbb39d">rtree::box()</a></code>.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__rtree__functions.return_envelope_index__rtree______const___.h1"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__rtree__functions.return_envelope_index__rtree______const___.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.return_envelope_index__rtree______const___.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">Box</span></code><code class="computeroutput"><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>
|
|
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Options</span></code><code class="computeroutput"><span class="special">,</span></code>
|
|
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Translator</span></code><code class="computeroutput"><span class="special">,</span></code>
|
|
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Allocator</span></code><code class="computeroutput"><span class="special">></span></code>
|
|
<code class="computeroutput"><span class="identifier">Box</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">geometry</span><span class="special">::</span><span class="identifier">return_envelope</span></code><code class="computeroutput"><span class="special">(</span></code><code class="computeroutput"><span class="identifier">index</span><span class="special">::</span><span class="identifier">rtree</span><span class="special"><</span> <span class="identifier">Value</span><span class="special">,</span> <span class="identifier">Options</span><span class="special">,</span> <span class="identifier">Translator</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>
|
|
</pre>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__rtree__functions.return_envelope_index__rtree______const___.h2"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__rtree__functions.return_envelope_index__rtree______const___.template_parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.return_envelope_index__rtree______const___.template_parameter_s_">Template
|
|
parameter(s)</a>
|
|
</h6>
|
|
<div class="informaltable"><table class="table">
|
|
<colgroup>
|
|
<col>
|
|
<col>
|
|
</colgroup>
|
|
<thead><tr>
|
|
<th>
|
|
<p>
|
|
Parameter
|
|
</p>
|
|
</th>
|
|
<th>
|
|
<p>
|
|
Description
|
|
</p>
|
|
</th>
|
|
</tr></thead>
|
|
<tbody><tr>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">Box</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The type of returned Box.
|
|
</p>
|
|
</td>
|
|
</tr></tbody>
|
|
</table></div>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__rtree__functions.return_envelope_index__rtree______const___.h3"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__rtree__functions.return_envelope_index__rtree______const___.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.return_envelope_index__rtree______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">index</span><span class="special">::</span><span class="identifier">rtree</span><span class="special"><</span>
|
|
<span class="identifier">Value</span><span class="special">,</span>
|
|
<span class="identifier">Options</span><span class="special">,</span>
|
|
<span class="identifier">Translator</span><span class="special">,</span>
|
|
<span class="identifier">Allocator</span> <span class="special">></span>
|
|
<span class="keyword">const</span> <span class="special">&</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">tree</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The spatial index.
|
|
</p>
|
|
</td>
|
|
</tr></tbody>
|
|
</table></div>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__rtree__functions.return_envelope_index__rtree______const___.h4"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__rtree__functions.return_envelope_index__rtree______const___.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.return_envelope_index__rtree______const___.returns">Returns</a>
|
|
</h6>
|
|
<p>
|
|
The box containing all stored values or an invalid box.
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div class="section">
|
|
<div class="titlepage"><div><div><h4 class="title">
|
|
<a name="geometry_index.r_tree.reference.parameters"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.parameters" title="R-tree parameters">R-tree
|
|
parameters</a>
|
|
</h4></div></div></div>
|
|
<div class="section">
|
|
<div class="titlepage"><div><div><h5 class="title">
|
|
<a name="geometry_index.r_tree.reference.parameters.boost_geometry_index_linear"></a><a name="structboost_1_1geometry_1_1index_1_1linear"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.parameters.boost_geometry_index_linear" title="boost::geometry::index::linear">boost::geometry::index::linear</a>
|
|
</h5></div></div></div>
|
|
<p>
|
|
<a class="indexterm" name="idp11719952"></a><a class="indexterm" name="idp11720280"></a><a class="indexterm" name="idp11720624"></a><a class="indexterm" name="idp11720968"></a>
|
|
Linear r-tree creation algorithm parameters.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.parameters.boost_geometry_index_linear.h0"></a>
|
|
<span><a name="geometry_index.r_tree.reference.parameters.boost_geometry_index_linear.header"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.parameters.boost_geometry_index_linear.header">Header</a>
|
|
</h6>
|
|
<p>
|
|
<code class="computeroutput"><span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">geometry</span><span class="special">/</span><span class="identifier">extensions</span><span class="special">/</span><span class="identifier">index</span><span class="special">/</span><span class="identifier">rtree</span><span class="special">/</span><span class="identifier">options</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code>
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.parameters.boost_geometry_index_linear.h1"></a>
|
|
<span><a name="geometry_index.r_tree.reference.parameters.boost_geometry_index_linear.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.parameters.boost_geometry_index_linear.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="identifier">size_t</span> <span class="identifier">MaxElements</span></code><code class="computeroutput"><span class="special">,</span></code> <code class="computeroutput"><span class="identifier">size_t</span> <span class="identifier">MinElements</span></code><code class="computeroutput"><span class="special">></span></code>
|
|
<code class="computeroutput"><span class="keyword">struct</span> <span class="identifier">linear</span></code>
|
|
<code class="computeroutput"><span class="special">{</span></code>
|
|
<code class="computeroutput"> <span class="comment">// ...</span></code>
|
|
<code class="computeroutput"><span class="special">};</span></code>
|
|
</pre>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.parameters.boost_geometry_index_linear.h2"></a>
|
|
<span><a name="geometry_index.r_tree.reference.parameters.boost_geometry_index_linear.template_parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.parameters.boost_geometry_index_linear.template_parameter_s_">Template
|
|
parameter(s)</a>
|
|
</h6>
|
|
<div class="informaltable"><table class="table">
|
|
<colgroup>
|
|
<col>
|
|
<col>
|
|
</colgroup>
|
|
<thead><tr>
|
|
<th>
|
|
<p>
|
|
Parameter
|
|
</p>
|
|
</th>
|
|
<th>
|
|
<p>
|
|
Description
|
|
</p>
|
|
</th>
|
|
</tr></thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">size_t</span> <span class="identifier">MaxElements</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
Maximum number of elements in nodes.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">size_t</span> <span class="identifier">MinElements</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
Minimum number of elements in nodes.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
</div>
|
|
<div class="section">
|
|
<div class="titlepage"><div><div><h5 class="title">
|
|
<a name="geometry_index.r_tree.reference.parameters.boost_geometry_index_quadratic"></a><a name="structboost_1_1geometry_1_1index_1_1quadratic"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.parameters.boost_geometry_index_quadratic" title="boost::geometry::index::quadratic">boost::geometry::index::quadratic</a>
|
|
</h5></div></div></div>
|
|
<p>
|
|
<a class="indexterm" name="idp11746048"></a><a class="indexterm" name="idp11746376"></a><a class="indexterm" name="idp11746720"></a><a class="indexterm" name="idp11747064"></a>
|
|
Quadratic r-tree creation algorithm parameters.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.parameters.boost_geometry_index_quadratic.h0"></a>
|
|
<span><a name="geometry_index.r_tree.reference.parameters.boost_geometry_index_quadratic.header"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.parameters.boost_geometry_index_quadratic.header">Header</a>
|
|
</h6>
|
|
<p>
|
|
<code class="computeroutput"><span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">geometry</span><span class="special">/</span><span class="identifier">extensions</span><span class="special">/</span><span class="identifier">index</span><span class="special">/</span><span class="identifier">rtree</span><span class="special">/</span><span class="identifier">options</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code>
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.parameters.boost_geometry_index_quadratic.h1"></a>
|
|
<span><a name="geometry_index.r_tree.reference.parameters.boost_geometry_index_quadratic.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.parameters.boost_geometry_index_quadratic.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="identifier">size_t</span> <span class="identifier">MaxElements</span></code><code class="computeroutput"><span class="special">,</span></code> <code class="computeroutput"><span class="identifier">size_t</span> <span class="identifier">MinElements</span></code><code class="computeroutput"><span class="special">></span></code>
|
|
<code class="computeroutput"><span class="keyword">struct</span> <span class="identifier">quadratic</span></code>
|
|
<code class="computeroutput"><span class="special">{</span></code>
|
|
<code class="computeroutput"> <span class="comment">// ...</span></code>
|
|
<code class="computeroutput"><span class="special">};</span></code>
|
|
</pre>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.parameters.boost_geometry_index_quadratic.h2"></a>
|
|
<span><a name="geometry_index.r_tree.reference.parameters.boost_geometry_index_quadratic.template_parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.parameters.boost_geometry_index_quadratic.template_parameter_s_">Template
|
|
parameter(s)</a>
|
|
</h6>
|
|
<div class="informaltable"><table class="table">
|
|
<colgroup>
|
|
<col>
|
|
<col>
|
|
</colgroup>
|
|
<thead><tr>
|
|
<th>
|
|
<p>
|
|
Parameter
|
|
</p>
|
|
</th>
|
|
<th>
|
|
<p>
|
|
Description
|
|
</p>
|
|
</th>
|
|
</tr></thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">size_t</span> <span class="identifier">MaxElements</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
Maximum number of elements in nodes.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">size_t</span> <span class="identifier">MinElements</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
Minimum number of elements in nodes.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
</div>
|
|
<div class="section">
|
|
<div class="titlepage"><div><div><h5 class="title">
|
|
<a name="geometry_index.r_tree.reference.parameters.boost_geometry_index_rstar"></a><a name="structboost_1_1geometry_1_1index_1_1rstar"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.parameters.boost_geometry_index_rstar" title="boost::geometry::index::rstar">boost::geometry::index::rstar</a>
|
|
</h5></div></div></div>
|
|
<p>
|
|
<a class="indexterm" name="idp11772064"></a><a class="indexterm" name="idp11772392"></a><a class="indexterm" name="idp11772736"></a><a class="indexterm" name="idp11773080"></a>
|
|
R*-tree creation algorithm parameters.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.parameters.boost_geometry_index_rstar.h0"></a>
|
|
<span><a name="geometry_index.r_tree.reference.parameters.boost_geometry_index_rstar.header"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.parameters.boost_geometry_index_rstar.header">Header</a>
|
|
</h6>
|
|
<p>
|
|
<code class="computeroutput"><span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">geometry</span><span class="special">/</span><span class="identifier">extensions</span><span class="special">/</span><span class="identifier">index</span><span class="special">/</span><span class="identifier">rtree</span><span class="special">/</span><span class="identifier">options</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code>
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.parameters.boost_geometry_index_rstar.h1"></a>
|
|
<span><a name="geometry_index.r_tree.reference.parameters.boost_geometry_index_rstar.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.parameters.boost_geometry_index_rstar.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="identifier">size_t</span> <span class="identifier">MaxElements</span></code><code class="computeroutput"><span class="special">,</span></code>
|
|
<code class="computeroutput"><span class="identifier">size_t</span> <span class="identifier">MinElements</span></code><code class="computeroutput"><span class="special">,</span></code>
|
|
<code class="computeroutput"><span class="identifier">size_t</span> <span class="identifier">OverlapCostThreshold</span></code> = <code class="computeroutput"><span class="number">0</span></code><code class="computeroutput"><span class="special">,</span></code>
|
|
<code class="computeroutput"><span class="identifier">size_t</span> <span class="identifier">ReinsertedElements</span></code> = <code class="literal"><a class="link" href="../../">options::detail::default_rstar_reinserted_elements</a></code><code class="computeroutput"><span class="special"><</span><span class="identifier">MaxElements</span><span class="special">>::</span><span class="identifier">value</span></code><code class="computeroutput"><span class="special">></span></code>
|
|
<code class="computeroutput"><span class="keyword">struct</span> <span class="identifier">rstar</span></code>
|
|
<code class="computeroutput"><span class="special">{</span></code>
|
|
<code class="computeroutput"> <span class="comment">// ...</span></code>
|
|
<code class="computeroutput"><span class="special">};</span></code>
|
|
</pre>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.parameters.boost_geometry_index_rstar.h2"></a>
|
|
<span><a name="geometry_index.r_tree.reference.parameters.boost_geometry_index_rstar.template_parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.parameters.boost_geometry_index_rstar.template_parameter_s_">Template
|
|
parameter(s)</a>
|
|
</h6>
|
|
<div class="informaltable"><table class="table">
|
|
<colgroup>
|
|
<col>
|
|
<col>
|
|
</colgroup>
|
|
<thead><tr>
|
|
<th>
|
|
<p>
|
|
Parameter
|
|
</p>
|
|
</th>
|
|
<th>
|
|
<p>
|
|
Description
|
|
</p>
|
|
</th>
|
|
</tr></thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">size_t</span> <span class="identifier">MaxElements</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
Maximum number of elements in nodes.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">size_t</span> <span class="identifier">MinElements</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
Minimum number of elements in nodes.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">size_t</span> <span class="identifier">OverlapCostThreshold</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The number of leaf node children elements above which nearly
|
|
minimum overlap cost is calculated instead of minimum overlap
|
|
cost. If 0 minimum overlap cost is always calculated.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">size_t</span> <span class="identifier">ReinsertedElements</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
Number of elements reinserted by forced reinsertions algorithm.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
</div>
|
|
<div class="section">
|
|
<div class="titlepage"><div><div><h5 class="title">
|
|
<a name="geometry_index.r_tree.reference.parameters.boost_geometry_index_runtime_linear"></a><a name="classboost_1_1geometry_1_1index_1_1runtime_1_1linear"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.parameters.boost_geometry_index_runtime_linear" title="boost::geometry::index::runtime::linear">boost::geometry::index::runtime::linear</a>
|
|
</h5></div></div></div>
|
|
<p>
|
|
<a class="indexterm" name="idp11807784"></a><a class="indexterm" name="idp11808112"></a><a class="indexterm" name="idp11808456"></a><a class="indexterm" name="idp11808800"></a><a class="indexterm" name="idp11809144"></a>
|
|
Linear r-tree creation algorithm parameters.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.parameters.boost_geometry_index_runtime_linear.h0"></a>
|
|
<span><a name="geometry_index.r_tree.reference.parameters.boost_geometry_index_runtime_linear.header"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.parameters.boost_geometry_index_runtime_linear.header">Header</a>
|
|
</h6>
|
|
<p>
|
|
<code class="computeroutput"><span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">geometry</span><span class="special">/</span><span class="identifier">extensions</span><span class="special">/</span><span class="identifier">index</span><span class="special">/</span><span class="identifier">rtree</span><span class="special">/</span><span class="identifier">options</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code>
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.parameters.boost_geometry_index_runtime_linear.h1"></a>
|
|
<span><a name="geometry_index.r_tree.reference.parameters.boost_geometry_index_runtime_linear.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.parameters.boost_geometry_index_runtime_linear.synopsis">Synopsis</a>
|
|
</h6>
|
|
<pre class="programlisting"><code class="computeroutput"><span class="keyword">class</span> <span class="identifier">linear</span></code>
|
|
<code class="computeroutput"><span class="special">{</span></code>
|
|
<code class="computeroutput"> <span class="comment">// ...</span></code>
|
|
<code class="computeroutput"><span class="special">};</span></code>
|
|
</pre>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.parameters.boost_geometry_index_runtime_linear.h2"></a>
|
|
<span><a name="geometry_index.r_tree.reference.parameters.boost_geometry_index_runtime_linear.constructor_s__and_destructor"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.parameters.boost_geometry_index_runtime_linear.constructor_s__and_destructor">Constructor(s)
|
|
and destructor</a>
|
|
</h6>
|
|
<div class="informaltable"><table class="table">
|
|
<colgroup>
|
|
<col>
|
|
<col>
|
|
</colgroup>
|
|
<thead><tr>
|
|
<th>
|
|
<p>
|
|
Function
|
|
</p>
|
|
</th>
|
|
<th>
|
|
<p>
|
|
Description
|
|
</p>
|
|
</th>
|
|
</tr></thead>
|
|
<tbody><tr>
|
|
<td>
|
|
<p>
|
|
<a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1runtime_1_1linear_1a31efc1a8faba0fd037066bc1bc72b6fd"><code class="computeroutput"><span class="identifier">linear</span><span class="special">(</span><span class="identifier">size_t</span><span class="special">,</span>
|
|
<span class="identifier">size_t</span><span class="special">)</span></code></a>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The constructor.
|
|
</p>
|
|
</td>
|
|
</tr></tbody>
|
|
</table></div>
|
|
<div class="section">
|
|
<div class="titlepage"><div><div><h6 class="title">
|
|
<a name="geometry_index.r_tree.reference.parameters.boost_geometry_index_runtime_linear.linear_size_t__size_t_"></a><a name="classboost_1_1geometry_1_1index_1_1runtime_1_1linear_1a31efc1a8faba0fd037066bc1bc72b6fd"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.parameters.boost_geometry_index_runtime_linear.linear_size_t__size_t_" title="linear(size_t, size_t)">linear(size_t,
|
|
size_t)</a>
|
|
</h6></div></div></div>
|
|
<p>
|
|
The constructor.
|
|
</p>
|
|
<h7><a name="geometry_index.r_tree.reference.parameters.boost_geometry_index_runtime_linear.linear_size_t__size_t_.h0"></a>
|
|
<span><a name="geometry_index.r_tree.reference.parameters.boost_geometry_index_runtime_linear.linear_size_t__size_t_.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.parameters.boost_geometry_index_runtime_linear.linear_size_t__size_t_.synopsis">Synopsis</a>
|
|
</h7><pre class="programlisting"><code class="computeroutput"><span class="identifier">linear</span></code><code class="computeroutput"><span class="special">(</span></code><code class="computeroutput"><span class="identifier">size_t</span></code> <code class="computeroutput"><span class="identifier">max_elements</span></code><code class="computeroutput"><span class="special">,</span></code> <code class="computeroutput"><span class="identifier">size_t</span></code> <code class="computeroutput"><span class="identifier">min_elements</span></code><code class="computeroutput"><span class="special">)</span></code>
|
|
</pre>
|
|
<h7><a name="geometry_index.r_tree.reference.parameters.boost_geometry_index_runtime_linear.linear_size_t__size_t_.h1"></a>
|
|
<span><a name="geometry_index.r_tree.reference.parameters.boost_geometry_index_runtime_linear.linear_size_t__size_t_.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.parameters.boost_geometry_index_runtime_linear.linear_size_t__size_t_.parameter_s_">Parameter(s)</a>
|
|
</h7><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">size_t</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">max_elements</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
Maximum number of elements in nodes.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">size_t</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">min_elements</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
Minimum number of elements in nodes.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
</div>
|
|
</div>
|
|
<div class="section">
|
|
<div class="titlepage"><div><div><h5 class="title">
|
|
<a name="geometry_index.r_tree.reference.parameters.boost_geometry_index_runtime_quadratic"></a><a name="classboost_1_1geometry_1_1index_1_1runtime_1_1quadratic"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.parameters.boost_geometry_index_runtime_quadratic" title="boost::geometry::index::runtime::quadratic">boost::geometry::index::runtime::quadratic</a>
|
|
</h5></div></div></div>
|
|
<p>
|
|
<a class="indexterm" name="idp11848672"></a><a class="indexterm" name="idp11849000"></a><a class="indexterm" name="idp11849344"></a><a class="indexterm" name="idp11849688"></a><a class="indexterm" name="idp11850032"></a>
|
|
Quadratic r-tree creation algorithm parameters.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.parameters.boost_geometry_index_runtime_quadratic.h0"></a>
|
|
<span><a name="geometry_index.r_tree.reference.parameters.boost_geometry_index_runtime_quadratic.header"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.parameters.boost_geometry_index_runtime_quadratic.header">Header</a>
|
|
</h6>
|
|
<p>
|
|
<code class="computeroutput"><span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">geometry</span><span class="special">/</span><span class="identifier">extensions</span><span class="special">/</span><span class="identifier">index</span><span class="special">/</span><span class="identifier">rtree</span><span class="special">/</span><span class="identifier">options</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code>
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.parameters.boost_geometry_index_runtime_quadratic.h1"></a>
|
|
<span><a name="geometry_index.r_tree.reference.parameters.boost_geometry_index_runtime_quadratic.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.parameters.boost_geometry_index_runtime_quadratic.synopsis">Synopsis</a>
|
|
</h6>
|
|
<pre class="programlisting"><code class="computeroutput"><span class="keyword">class</span> <span class="identifier">quadratic</span></code>
|
|
<code class="computeroutput"><span class="special">{</span></code>
|
|
<code class="computeroutput"> <span class="comment">// ...</span></code>
|
|
<code class="computeroutput"><span class="special">};</span></code>
|
|
</pre>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.parameters.boost_geometry_index_runtime_quadratic.h2"></a>
|
|
<span><a name="geometry_index.r_tree.reference.parameters.boost_geometry_index_runtime_quadratic.constructor_s__and_destructor"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.parameters.boost_geometry_index_runtime_quadratic.constructor_s__and_destructor">Constructor(s)
|
|
and destructor</a>
|
|
</h6>
|
|
<div class="informaltable"><table class="table">
|
|
<colgroup>
|
|
<col>
|
|
<col>
|
|
</colgroup>
|
|
<thead><tr>
|
|
<th>
|
|
<p>
|
|
Function
|
|
</p>
|
|
</th>
|
|
<th>
|
|
<p>
|
|
Description
|
|
</p>
|
|
</th>
|
|
</tr></thead>
|
|
<tbody><tr>
|
|
<td>
|
|
<p>
|
|
<a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1runtime_1_1quadratic_1ae14911a22f8f91807254c58744b81563"><code class="computeroutput"><span class="identifier">quadratic</span><span class="special">(</span><span class="identifier">size_t</span><span class="special">,</span>
|
|
<span class="identifier">size_t</span><span class="special">)</span></code></a>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The constructor.
|
|
</p>
|
|
</td>
|
|
</tr></tbody>
|
|
</table></div>
|
|
<div class="section">
|
|
<div class="titlepage"><div><div><h6 class="title">
|
|
<a name="geometry_index.r_tree.reference.parameters.boost_geometry_index_runtime_quadratic.quadratic_size_t__size_t_"></a><a name="classboost_1_1geometry_1_1index_1_1runtime_1_1quadratic_1ae14911a22f8f91807254c58744b81563"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.parameters.boost_geometry_index_runtime_quadratic.quadratic_size_t__size_t_" title="quadratic(size_t, size_t)">quadratic(size_t,
|
|
size_t)</a>
|
|
</h6></div></div></div>
|
|
<p>
|
|
The constructor.
|
|
</p>
|
|
<h7><a name="geometry_index.r_tree.reference.parameters.boost_geometry_index_runtime_quadratic.quadratic_size_t__size_t_.h0"></a>
|
|
<span><a name="geometry_index.r_tree.reference.parameters.boost_geometry_index_runtime_quadratic.quadratic_size_t__size_t_.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.parameters.boost_geometry_index_runtime_quadratic.quadratic_size_t__size_t_.synopsis">Synopsis</a>
|
|
</h7><pre class="programlisting"><code class="computeroutput"><span class="identifier">quadratic</span></code><code class="computeroutput"><span class="special">(</span></code><code class="computeroutput"><span class="identifier">size_t</span></code> <code class="computeroutput"><span class="identifier">max_elements</span></code><code class="computeroutput"><span class="special">,</span></code> <code class="computeroutput"><span class="identifier">size_t</span></code> <code class="computeroutput"><span class="identifier">min_elements</span></code><code class="computeroutput"><span class="special">)</span></code>
|
|
</pre>
|
|
<h7><a name="geometry_index.r_tree.reference.parameters.boost_geometry_index_runtime_quadratic.quadratic_size_t__size_t_.h1"></a>
|
|
<span><a name="geometry_index.r_tree.reference.parameters.boost_geometry_index_runtime_quadratic.quadratic_size_t__size_t_.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.parameters.boost_geometry_index_runtime_quadratic.quadratic_size_t__size_t_.parameter_s_">Parameter(s)</a>
|
|
</h7><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">size_t</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">max_elements</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
Maximum number of elements in nodes.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">size_t</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">min_elements</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
Minimum number of elements in nodes.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
</div>
|
|
</div>
|
|
<div class="section">
|
|
<div class="titlepage"><div><div><h5 class="title">
|
|
<a name="geometry_index.r_tree.reference.parameters.boost_geometry_index_runtime_rstar"></a><a name="classboost_1_1geometry_1_1index_1_1runtime_1_1rstar"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.parameters.boost_geometry_index_runtime_rstar" title="boost::geometry::index::runtime::rstar">boost::geometry::index::runtime::rstar</a>
|
|
</h5></div></div></div>
|
|
<p>
|
|
<a class="indexterm" name="idp11889800"></a><a class="indexterm" name="idp11890128"></a><a class="indexterm" name="idp11890472"></a><a class="indexterm" name="idp11890816"></a><a class="indexterm" name="idp11891160"></a>
|
|
R*-tree creation algorithm parameters.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.parameters.boost_geometry_index_runtime_rstar.h0"></a>
|
|
<span><a name="geometry_index.r_tree.reference.parameters.boost_geometry_index_runtime_rstar.header"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.parameters.boost_geometry_index_runtime_rstar.header">Header</a>
|
|
</h6>
|
|
<p>
|
|
<code class="computeroutput"><span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">geometry</span><span class="special">/</span><span class="identifier">extensions</span><span class="special">/</span><span class="identifier">index</span><span class="special">/</span><span class="identifier">rtree</span><span class="special">/</span><span class="identifier">options</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code>
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.parameters.boost_geometry_index_runtime_rstar.h1"></a>
|
|
<span><a name="geometry_index.r_tree.reference.parameters.boost_geometry_index_runtime_rstar.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.parameters.boost_geometry_index_runtime_rstar.synopsis">Synopsis</a>
|
|
</h6>
|
|
<pre class="programlisting"><code class="computeroutput"><span class="keyword">class</span> <span class="identifier">rstar</span></code>
|
|
<code class="computeroutput"><span class="special">{</span></code>
|
|
<code class="computeroutput"> <span class="comment">// ...</span></code>
|
|
<code class="computeroutput"><span class="special">};</span></code>
|
|
</pre>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.parameters.boost_geometry_index_runtime_rstar.h2"></a>
|
|
<span><a name="geometry_index.r_tree.reference.parameters.boost_geometry_index_runtime_rstar.constructor_s__and_destructor"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.parameters.boost_geometry_index_runtime_rstar.constructor_s__and_destructor">Constructor(s)
|
|
and destructor</a>
|
|
</h6>
|
|
<div class="informaltable"><table class="table">
|
|
<colgroup>
|
|
<col>
|
|
<col>
|
|
</colgroup>
|
|
<thead><tr>
|
|
<th>
|
|
<p>
|
|
Function
|
|
</p>
|
|
</th>
|
|
<th>
|
|
<p>
|
|
Description
|
|
</p>
|
|
</th>
|
|
</tr></thead>
|
|
<tbody><tr>
|
|
<td>
|
|
<p>
|
|
<a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1runtime_1_1rstar_1add502ea66da6579bb3556d20b46b428e"><code class="computeroutput"><span class="identifier">rstar</span><span class="special">(</span><span class="identifier">size_t</span><span class="special">,</span>
|
|
<span class="identifier">size_t</span><span class="special">)</span></code></a>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The constructor.
|
|
</p>
|
|
</td>
|
|
</tr></tbody>
|
|
</table></div>
|
|
<div class="section">
|
|
<div class="titlepage"><div><div><h6 class="title">
|
|
<a name="geometry_index.r_tree.reference.parameters.boost_geometry_index_runtime_rstar.rstar_size_t__size_t_"></a><a name="classboost_1_1geometry_1_1index_1_1runtime_1_1rstar_1add502ea66da6579bb3556d20b46b428e"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.parameters.boost_geometry_index_runtime_rstar.rstar_size_t__size_t_" title="rstar(size_t, size_t)">rstar(size_t,
|
|
size_t)</a>
|
|
</h6></div></div></div>
|
|
<p>
|
|
The constructor.
|
|
</p>
|
|
<h7><a name="geometry_index.r_tree.reference.parameters.boost_geometry_index_runtime_rstar.rstar_size_t__size_t_.h0"></a>
|
|
<span><a name="geometry_index.r_tree.reference.parameters.boost_geometry_index_runtime_rstar.rstar_size_t__size_t_.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.parameters.boost_geometry_index_runtime_rstar.rstar_size_t__size_t_.synopsis">Synopsis</a>
|
|
</h7><pre class="programlisting"><code class="computeroutput"><span class="identifier">rstar</span></code><code class="computeroutput"><span class="special">(</span></code><code class="computeroutput"><span class="identifier">size_t</span></code> <code class="computeroutput"><span class="identifier">max_elements</span></code><code class="computeroutput"><span class="special">,</span></code>
|
|
<code class="computeroutput"><span class="identifier">size_t</span></code> <code class="computeroutput"><span class="identifier">min_elements</span></code><code class="computeroutput"><span class="special">,</span></code>
|
|
<code class="computeroutput"><span class="identifier">size_t</span></code> <code class="computeroutput"><span class="identifier">overlap_cost_threshold</span></code> = <code class="computeroutput"><span class="number">0</span></code><code class="computeroutput"><span class="special">,</span></code>
|
|
<code class="computeroutput"><span class="identifier">size_t</span></code> <code class="computeroutput"><span class="identifier">reinserted_elements</span></code> = <code class="computeroutput"><span class="identifier">detail</span><span class="special">::</span><span class="identifier">default_rstar_reinserted_elements</span><span class="special">()</span></code><code class="computeroutput"><span class="special">)</span></code>
|
|
</pre>
|
|
<h7><a name="geometry_index.r_tree.reference.parameters.boost_geometry_index_runtime_rstar.rstar_size_t__size_t_.h1"></a>
|
|
<span><a name="geometry_index.r_tree.reference.parameters.boost_geometry_index_runtime_rstar.rstar_size_t__size_t_.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.parameters.boost_geometry_index_runtime_rstar.rstar_size_t__size_t_.parameter_s_">Parameter(s)</a>
|
|
</h7><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">size_t</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">max_elements</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
Maximum number of elements in nodes.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">size_t</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">min_elements</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
Minimum number of elements in nodes.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">size_t</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">overlap_cost_threshold</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The number of leaf node children elements above which nearly
|
|
minimum overlap cost is calculated instead of minimum overlap
|
|
cost. If 0 minimum overlap cost is always calculated.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">size_t</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">reinserted_elements</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
Number of elements reinserted by forced reinsertions algorithm.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="section">
|
|
<div class="titlepage"><div><div><h4 class="title">
|
|
<a name="geometry_index.r_tree.reference.group__predicates"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates" title="Spatial predicates (boost::geometry::index::)">Spatial
|
|
predicates (boost::geometry::index::)</a>
|
|
</h4></div></div></div>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__predicates.h0"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__predicates.functions"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.functions">Functions</a>
|
|
</h6>
|
|
<div class="informaltable"><table class="table">
|
|
<colgroup>
|
|
<col>
|
|
<col>
|
|
</colgroup>
|
|
<thead><tr>
|
|
<th>
|
|
<p>
|
|
Function
|
|
</p>
|
|
</th>
|
|
<th>
|
|
<p>
|
|
Description
|
|
</p>
|
|
</th>
|
|
</tr></thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<a class="link" href="reference.html#group__predicates_1ga150fd87dc53e5472f8905bb5827428e2"><code class="computeroutput"><span class="identifier">empty</span><span class="special">()</span></code></a>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
Generate empty predicate.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<a class="link" href="reference.html#group__predicates_1ga5c93efac97377136564623cbaf35d880"><code class="computeroutput"><span class="identifier">value</span><span class="special">(</span><span class="identifier">ValuePredicate</span> <span class="keyword">const</span>
|
|
<span class="special">&)</span></code></a>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
Generate value predicate.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<a class="link" href="reference.html#group__predicates_1ga0a613a7f1d18ac33955bfdc2c5777c61"><code class="computeroutput"><span class="identifier">covered_by</span><span class="special">(</span><span class="identifier">Geometry</span> <span class="keyword">const</span>
|
|
<span class="special">&)</span></code></a>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
Generate <code class="literal"><a class="link" href="reference.html#group__predicates_1ga0a613a7f1d18ac33955bfdc2c5777c61">covered_by()</a></code>
|
|
predicate.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<a class="link" href="reference.html#group__predicates_1ga351bb3b82e019ff45adf789385b8007d"><code class="computeroutput"><span class="identifier">disjoint</span><span class="special">(</span><span class="identifier">Geometry</span> <span class="keyword">const</span>
|
|
<span class="special">&)</span></code></a>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
Generate <code class="literal"><a class="link" href="reference.html#group__predicates_1ga351bb3b82e019ff45adf789385b8007d">disjoint()</a></code>
|
|
predicate.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<a class="link" href="reference.html#group__predicates_1ga7301c50e0272976b9f1434536383e6d0"><code class="computeroutput"><span class="identifier">intersects</span><span class="special">(</span><span class="identifier">Geometry</span> <span class="keyword">const</span>
|
|
<span class="special">&)</span></code></a>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
Generate <code class="literal"><a class="link" href="reference.html#group__predicates_1ga7301c50e0272976b9f1434536383e6d0">intersects()</a></code>
|
|
predicate.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<a class="link" href="reference.html#group__predicates_1ga5511236f56be1defcccbf11e742ccd88"><code class="computeroutput"><span class="identifier">overlaps</span><span class="special">(</span><span class="identifier">Geometry</span> <span class="keyword">const</span>
|
|
<span class="special">&)</span></code></a>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
Generate <code class="literal"><a class="link" href="reference.html#group__predicates_1ga5511236f56be1defcccbf11e742ccd88">overlaps()</a></code>
|
|
predicate.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<a class="link" href="reference.html#group__predicates_1gabf9c4e76dd8a09a4c476f2f8fa8a0e4d"><code class="computeroutput"><span class="identifier">within</span><span class="special">(</span><span class="identifier">Geometry</span> <span class="keyword">const</span>
|
|
<span class="special">&)</span></code></a>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
Generate <code class="literal"><a class="link" href="reference.html#group__predicates_1gabf9c4e76dd8a09a4c476f2f8fa8a0e4d">within()</a></code>
|
|
predicate.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
<div class="section">
|
|
<div class="titlepage"><div><div><h5 class="title">
|
|
<a name="geometry_index.r_tree.reference.group__predicates.empty__"></a><a name="group__predicates_1ga150fd87dc53e5472f8905bb5827428e2"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.empty__" title="empty()">empty()</a>
|
|
</h5></div></div></div>
|
|
<p>
|
|
Generate empty predicate.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__predicates.empty__.h0"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__predicates.empty__.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.empty__.synopsis">Synopsis</a>
|
|
</h6>
|
|
<pre class="programlisting"><code class="computeroutput"><span class="identifier">detail</span><span class="special">::</span><span class="identifier">empty</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">geometry</span><span class="special">::</span><span class="identifier">index</span><span class="special">::</span><span class="identifier">empty</span></code><code class="computeroutput"><span class="special">()</span></code>
|
|
</pre>
|
|
</div>
|
|
<div class="section">
|
|
<div class="titlepage"><div><div><h5 class="title">
|
|
<a name="geometry_index.r_tree.reference.group__predicates.value_valuepredicate_const___"></a><a name="group__predicates_1ga5c93efac97377136564623cbaf35d880"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.value_valuepredicate_const___" title="value(ValuePredicate const &)">value(ValuePredicate
|
|
const &)</a>
|
|
</h5></div></div></div>
|
|
<p>
|
|
Generate value predicate.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__predicates.value_valuepredicate_const___.h0"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__predicates.value_valuepredicate_const___.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.value_valuepredicate_const___.description">Description</a>
|
|
</h6>
|
|
<p>
|
|
A wrapper around user-defined functor describing if Value should be returned
|
|
by spatial query.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__predicates.value_valuepredicate_const___.h1"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__predicates.value_valuepredicate_const___.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.value_valuepredicate_const___.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">ValuePredicate</span></code><code class="computeroutput"><span class="special">></span></code>
|
|
<code class="computeroutput"><span class="identifier">detail</span><span class="special">::</span><span class="identifier">value</span><span class="special"><</span><span class="identifier">ValuePredicate</span><span class="special">></span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">geometry</span><span class="special">::</span><span class="identifier">index</span><span class="special">::</span><span class="identifier">value</span></code><code class="computeroutput"><span class="special">(</span></code><code class="computeroutput"><span class="identifier">ValuePredicate</span> <span class="keyword">const</span> <span class="special">&</span></code> <code class="computeroutput"><span class="identifier">vpred</span></code><code class="computeroutput"><span class="special">)</span></code>
|
|
</pre>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__predicates.value_valuepredicate_const___.h2"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__predicates.value_valuepredicate_const___.template_parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.value_valuepredicate_const___.template_parameter_s_">Template
|
|
parameter(s)</a>
|
|
</h6>
|
|
<div class="informaltable"><table class="table">
|
|
<colgroup>
|
|
<col>
|
|
<col>
|
|
</colgroup>
|
|
<thead><tr>
|
|
<th>
|
|
<p>
|
|
Parameter
|
|
</p>
|
|
</th>
|
|
<th>
|
|
<p>
|
|
Description
|
|
</p>
|
|
</th>
|
|
</tr></thead>
|
|
<tbody><tr>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">ValuePredicate</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
Functor type.
|
|
</p>
|
|
</td>
|
|
</tr></tbody>
|
|
</table></div>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__predicates.value_valuepredicate_const___.h3"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__predicates.value_valuepredicate_const___.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.value_valuepredicate_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">ValuePredicate</span> <span class="keyword">const</span> <span class="special">&</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">vpred</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The functor.
|
|
</p>
|
|
</td>
|
|
</tr></tbody>
|
|
</table></div>
|
|
</div>
|
|
<div class="section">
|
|
<div class="titlepage"><div><div><h5 class="title">
|
|
<a name="geometry_index.r_tree.reference.group__predicates.covered_by_geometry_const___"></a><a name="group__predicates_1ga0a613a7f1d18ac33955bfdc2c5777c61"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.covered_by_geometry_const___" title="covered_by(Geometry const &)">covered_by(Geometry
|
|
const &)</a>
|
|
</h5></div></div></div>
|
|
<p>
|
|
Generate <code class="literal"><a class="link" href="reference.html#group__predicates_1ga0a613a7f1d18ac33955bfdc2c5777c61">covered_by()</a></code>
|
|
predicate.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__predicates.covered_by_geometry_const___.h0"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__predicates.covered_by_geometry_const___.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.covered_by_geometry_const___.description">Description</a>
|
|
</h6>
|
|
<p>
|
|
Generate a predicate defining Value and Geometry relationship. Value
|
|
will be returned by the query if <code class="literal"><code class="computeroutput"><span class="identifier">bg</span><span class="special">::</span><span class="identifier">covered_by</span><span class="special">(</span><span class="identifier">Indexable</span><span class="special">,</span> <span class="identifier">Geometry</span><span class="special">)</span></code></code> returns true.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__predicates.covered_by_geometry_const___.h1"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__predicates.covered_by_geometry_const___.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.covered_by_geometry_const___.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>
|
|
<code class="computeroutput"><span class="identifier">detail</span><span class="special">::</span><span class="identifier">covered_by</span><span class="special"><</span><span class="identifier">Geometry</span><span class="special">></span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">geometry</span><span class="special">::</span><span class="identifier">index</span><span class="special">::</span><span class="identifier">covered_by</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">g</span></code><code class="computeroutput"><span class="special">)</span></code>
|
|
</pre>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__predicates.covered_by_geometry_const___.h2"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__predicates.covered_by_geometry_const___.template_parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.covered_by_geometry_const___.template_parameter_s_">Template
|
|
parameter(s)</a>
|
|
</h6>
|
|
<div class="informaltable"><table class="table">
|
|
<colgroup>
|
|
<col>
|
|
<col>
|
|
</colgroup>
|
|
<thead><tr>
|
|
<th>
|
|
<p>
|
|
Parameter
|
|
</p>
|
|
</th>
|
|
<th>
|
|
<p>
|
|
Description
|
|
</p>
|
|
</th>
|
|
</tr></thead>
|
|
<tbody><tr>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">Geometry</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The Geometry type.
|
|
</p>
|
|
</td>
|
|
</tr></tbody>
|
|
</table></div>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__predicates.covered_by_geometry_const___.h3"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__predicates.covered_by_geometry_const___.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.covered_by_geometry_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">Geometry</span> <span class="keyword">const</span>
|
|
<span class="special">&</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">g</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The Geometry object.
|
|
</p>
|
|
</td>
|
|
</tr></tbody>
|
|
</table></div>
|
|
</div>
|
|
<div class="section">
|
|
<div class="titlepage"><div><div><h5 class="title">
|
|
<a name="geometry_index.r_tree.reference.group__predicates.disjoint_geometry_const___"></a><a name="group__predicates_1ga351bb3b82e019ff45adf789385b8007d"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.disjoint_geometry_const___" title="disjoint(Geometry const &)">disjoint(Geometry
|
|
const &)</a>
|
|
</h5></div></div></div>
|
|
<p>
|
|
Generate <code class="literal"><a class="link" href="reference.html#group__predicates_1ga351bb3b82e019ff45adf789385b8007d">disjoint()</a></code>
|
|
predicate.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__predicates.disjoint_geometry_const___.h0"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__predicates.disjoint_geometry_const___.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.disjoint_geometry_const___.description">Description</a>
|
|
</h6>
|
|
<p>
|
|
Generate a predicate defining Value and Geometry relationship. Value
|
|
will be returned by the query if <code class="literal"><code class="computeroutput"><span class="identifier">bg</span><span class="special">::</span><span class="identifier">disjoint</span><span class="special">(</span><span class="identifier">Indexable</span><span class="special">,</span> <span class="identifier">Geometry</span><span class="special">)</span></code></code> returns true.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__predicates.disjoint_geometry_const___.h1"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__predicates.disjoint_geometry_const___.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.disjoint_geometry_const___.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>
|
|
<code class="computeroutput"><span class="identifier">detail</span><span class="special">::</span><span class="identifier">disjoint</span><span class="special"><</span><span class="identifier">Geometry</span><span class="special">></span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">geometry</span><span class="special">::</span><span class="identifier">index</span><span class="special">::</span><span class="identifier">disjoint</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">g</span></code><code class="computeroutput"><span class="special">)</span></code>
|
|
</pre>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__predicates.disjoint_geometry_const___.h2"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__predicates.disjoint_geometry_const___.template_parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.disjoint_geometry_const___.template_parameter_s_">Template
|
|
parameter(s)</a>
|
|
</h6>
|
|
<div class="informaltable"><table class="table">
|
|
<colgroup>
|
|
<col>
|
|
<col>
|
|
</colgroup>
|
|
<thead><tr>
|
|
<th>
|
|
<p>
|
|
Parameter
|
|
</p>
|
|
</th>
|
|
<th>
|
|
<p>
|
|
Description
|
|
</p>
|
|
</th>
|
|
</tr></thead>
|
|
<tbody><tr>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">Geometry</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The Geometry type.
|
|
</p>
|
|
</td>
|
|
</tr></tbody>
|
|
</table></div>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__predicates.disjoint_geometry_const___.h3"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__predicates.disjoint_geometry_const___.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.disjoint_geometry_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">Geometry</span> <span class="keyword">const</span>
|
|
<span class="special">&</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">g</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The Geometry object.
|
|
</p>
|
|
</td>
|
|
</tr></tbody>
|
|
</table></div>
|
|
</div>
|
|
<div class="section">
|
|
<div class="titlepage"><div><div><h5 class="title">
|
|
<a name="geometry_index.r_tree.reference.group__predicates.intersects_geometry_const___"></a><a name="group__predicates_1ga7301c50e0272976b9f1434536383e6d0"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.intersects_geometry_const___" title="intersects(Geometry const &)">intersects(Geometry
|
|
const &)</a>
|
|
</h5></div></div></div>
|
|
<p>
|
|
Generate <code class="literal"><a class="link" href="reference.html#group__predicates_1ga7301c50e0272976b9f1434536383e6d0">intersects()</a></code>
|
|
predicate.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__predicates.intersects_geometry_const___.h0"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__predicates.intersects_geometry_const___.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.intersects_geometry_const___.description">Description</a>
|
|
</h6>
|
|
<p>
|
|
Generate a predicate defining Value and Geometry relationship. Value
|
|
will be returned by the query if <code class="literal"><code class="computeroutput"><span class="identifier">bg</span><span class="special">::</span><span class="identifier">intersects</span><span class="special">(</span><span class="identifier">Indexable</span><span class="special">,</span> <span class="identifier">Geometry</span><span class="special">)</span></code></code> returns true.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__predicates.intersects_geometry_const___.h1"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__predicates.intersects_geometry_const___.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.intersects_geometry_const___.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>
|
|
<code class="computeroutput"><span class="identifier">detail</span><span class="special">::</span><span class="identifier">intersects</span><span class="special"><</span><span class="identifier">Geometry</span><span class="special">></span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">geometry</span><span class="special">::</span><span class="identifier">index</span><span class="special">::</span><span class="identifier">intersects</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">g</span></code><code class="computeroutput"><span class="special">)</span></code>
|
|
</pre>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__predicates.intersects_geometry_const___.h2"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__predicates.intersects_geometry_const___.template_parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.intersects_geometry_const___.template_parameter_s_">Template
|
|
parameter(s)</a>
|
|
</h6>
|
|
<div class="informaltable"><table class="table">
|
|
<colgroup>
|
|
<col>
|
|
<col>
|
|
</colgroup>
|
|
<thead><tr>
|
|
<th>
|
|
<p>
|
|
Parameter
|
|
</p>
|
|
</th>
|
|
<th>
|
|
<p>
|
|
Description
|
|
</p>
|
|
</th>
|
|
</tr></thead>
|
|
<tbody><tr>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">Geometry</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The Geometry type.
|
|
</p>
|
|
</td>
|
|
</tr></tbody>
|
|
</table></div>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__predicates.intersects_geometry_const___.h3"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__predicates.intersects_geometry_const___.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.intersects_geometry_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">Geometry</span> <span class="keyword">const</span>
|
|
<span class="special">&</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">g</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The Geometry object.
|
|
</p>
|
|
</td>
|
|
</tr></tbody>
|
|
</table></div>
|
|
</div>
|
|
<div class="section">
|
|
<div class="titlepage"><div><div><h5 class="title">
|
|
<a name="geometry_index.r_tree.reference.group__predicates.overlaps_geometry_const___"></a><a name="group__predicates_1ga5511236f56be1defcccbf11e742ccd88"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.overlaps_geometry_const___" title="overlaps(Geometry const &)">overlaps(Geometry
|
|
const &)</a>
|
|
</h5></div></div></div>
|
|
<p>
|
|
Generate <code class="literal"><a class="link" href="reference.html#group__predicates_1ga5511236f56be1defcccbf11e742ccd88">overlaps()</a></code>
|
|
predicate.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__predicates.overlaps_geometry_const___.h0"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__predicates.overlaps_geometry_const___.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.overlaps_geometry_const___.description">Description</a>
|
|
</h6>
|
|
<p>
|
|
Generate a predicate defining Value and Geometry relationship. Value
|
|
will be returned by the query if <code class="literal"><code class="computeroutput"><span class="identifier">bg</span><span class="special">::</span><span class="identifier">overlaps</span><span class="special">(</span><span class="identifier">Indexable</span><span class="special">,</span> <span class="identifier">Geometry</span><span class="special">)</span></code></code> returns true.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__predicates.overlaps_geometry_const___.h1"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__predicates.overlaps_geometry_const___.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.overlaps_geometry_const___.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>
|
|
<code class="computeroutput"><span class="identifier">detail</span><span class="special">::</span><span class="identifier">overlaps</span><span class="special"><</span><span class="identifier">Geometry</span><span class="special">></span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">geometry</span><span class="special">::</span><span class="identifier">index</span><span class="special">::</span><span class="identifier">overlaps</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">g</span></code><code class="computeroutput"><span class="special">)</span></code>
|
|
</pre>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__predicates.overlaps_geometry_const___.h2"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__predicates.overlaps_geometry_const___.template_parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.overlaps_geometry_const___.template_parameter_s_">Template
|
|
parameter(s)</a>
|
|
</h6>
|
|
<div class="informaltable"><table class="table">
|
|
<colgroup>
|
|
<col>
|
|
<col>
|
|
</colgroup>
|
|
<thead><tr>
|
|
<th>
|
|
<p>
|
|
Parameter
|
|
</p>
|
|
</th>
|
|
<th>
|
|
<p>
|
|
Description
|
|
</p>
|
|
</th>
|
|
</tr></thead>
|
|
<tbody><tr>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">Geometry</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The Geometry type.
|
|
</p>
|
|
</td>
|
|
</tr></tbody>
|
|
</table></div>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__predicates.overlaps_geometry_const___.h3"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__predicates.overlaps_geometry_const___.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.overlaps_geometry_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">Geometry</span> <span class="keyword">const</span>
|
|
<span class="special">&</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">g</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The Geometry object.
|
|
</p>
|
|
</td>
|
|
</tr></tbody>
|
|
</table></div>
|
|
</div>
|
|
<div class="section">
|
|
<div class="titlepage"><div><div><h5 class="title">
|
|
<a name="geometry_index.r_tree.reference.group__predicates.within_geometry_const___"></a><a name="group__predicates_1gabf9c4e76dd8a09a4c476f2f8fa8a0e4d"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.within_geometry_const___" title="within(Geometry const &)">within(Geometry
|
|
const &)</a>
|
|
</h5></div></div></div>
|
|
<p>
|
|
Generate <code class="literal"><a class="link" href="reference.html#group__predicates_1gabf9c4e76dd8a09a4c476f2f8fa8a0e4d">within()</a></code>
|
|
predicate.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__predicates.within_geometry_const___.h0"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__predicates.within_geometry_const___.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.within_geometry_const___.description">Description</a>
|
|
</h6>
|
|
<p>
|
|
Generate a predicate defining Value and Geometry relationship. Value
|
|
will be returned by the query if <code class="literal"><code class="computeroutput"><span class="identifier">bg</span><span class="special">::</span><span class="identifier">within</span><span class="special">(</span><span class="identifier">Indexable</span><span class="special">,</span> <span class="identifier">Geometry</span><span class="special">)</span></code></code> returns true.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__predicates.within_geometry_const___.h1"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__predicates.within_geometry_const___.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.within_geometry_const___.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>
|
|
<code class="computeroutput"><span class="identifier">detail</span><span class="special">::</span><span class="identifier">within</span><span class="special"><</span><span class="identifier">Geometry</span><span class="special">></span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">geometry</span><span class="special">::</span><span class="identifier">index</span><span class="special">::</span><span class="identifier">within</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">g</span></code><code class="computeroutput"><span class="special">)</span></code>
|
|
</pre>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__predicates.within_geometry_const___.h2"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__predicates.within_geometry_const___.template_parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.within_geometry_const___.template_parameter_s_">Template
|
|
parameter(s)</a>
|
|
</h6>
|
|
<div class="informaltable"><table class="table">
|
|
<colgroup>
|
|
<col>
|
|
<col>
|
|
</colgroup>
|
|
<thead><tr>
|
|
<th>
|
|
<p>
|
|
Parameter
|
|
</p>
|
|
</th>
|
|
<th>
|
|
<p>
|
|
Description
|
|
</p>
|
|
</th>
|
|
</tr></thead>
|
|
<tbody><tr>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">Geometry</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The Geometry type.
|
|
</p>
|
|
</td>
|
|
</tr></tbody>
|
|
</table></div>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__predicates.within_geometry_const___.h3"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__predicates.within_geometry_const___.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.within_geometry_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">Geometry</span> <span class="keyword">const</span>
|
|
<span class="special">&</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">g</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The Geometry object.
|
|
</p>
|
|
</td>
|
|
</tr></tbody>
|
|
</table></div>
|
|
</div>
|
|
</div>
|
|
<div class="section">
|
|
<div class="titlepage"><div><div><h4 class="title">
|
|
<a name="geometry_index.r_tree.reference.group__distance__predicates"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates" title="Distance predicates (boost::geometry::index::)">Distance
|
|
predicates (boost::geometry::index::)</a>
|
|
</h4></div></div></div>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__distance__predicates.h0"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__distance__predicates.functions"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.functions">Functions</a>
|
|
</h6>
|
|
<div class="informaltable"><table class="table">
|
|
<colgroup>
|
|
<col>
|
|
<col>
|
|
</colgroup>
|
|
<thead><tr>
|
|
<th>
|
|
<p>
|
|
Function
|
|
</p>
|
|
</th>
|
|
<th>
|
|
<p>
|
|
Description
|
|
</p>
|
|
</th>
|
|
</tr></thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<a class="link" href="reference.html#group__distance__predicates_1gace3c7dbc60840c2a61da36e975d56636"><code class="computeroutput"><span class="identifier">to_nearest</span><span class="special">(</span><span class="identifier">T</span> <span class="keyword">const</span>
|
|
<span class="special">&)</span></code></a>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
Generate <a class="link" href="reference.html#group__distance__predicates_1gace3c7dbc60840c2a61da36e975d56636">to_nearest()</a>
|
|
Point-Indexable relationship.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<a class="link" href="reference.html#group__distance__predicates_1gaccbba95d864d8dcf8a694796c840fbe0"><code class="computeroutput"><span class="identifier">to_centroid</span><span class="special">(</span><span class="identifier">T</span> <span class="keyword">const</span>
|
|
<span class="special">&)</span></code></a>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
Generate <a class="link" href="reference.html#group__distance__predicates_1gaccbba95d864d8dcf8a694796c840fbe0">to_centroid()</a>
|
|
Point-Indexable relationship.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<a class="link" href="reference.html#group__distance__predicates_1ga67dddd8a7fcaae150970e1db0401de02"><code class="computeroutput"><span class="identifier">to_furthest</span><span class="special">(</span><span class="identifier">T</span> <span class="keyword">const</span>
|
|
<span class="special">&)</span></code></a>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
Generate <a class="link" href="reference.html#group__distance__predicates_1ga67dddd8a7fcaae150970e1db0401de02">to_furthest()</a>
|
|
Point-Indexable relationship.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<a class="link" href="reference.html#group__distance__predicates_1ga1b0f969b575a94ca710b9345861f64db"><code class="computeroutput"><span class="identifier">unbounded</span><span class="special">(</span><span class="identifier">PointRelation</span> <span class="keyword">const</span>
|
|
<span class="special">&)</span></code></a>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
Generate <a class="link" href="reference.html#group__distance__predicates_1ga1b0f969b575a94ca710b9345861f64db">unbounded()</a>
|
|
distance predicate.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<a class="link" href="reference.html#group__distance__predicates_1ga39c7c94776ab840e164848e53d376098"><code class="computeroutput"><span class="identifier">min_bounded</span><span class="special">(</span><span class="identifier">PointRelation</span> <span class="keyword">const</span>
|
|
<span class="special">&,</span> <span class="identifier">MinRelation</span>
|
|
<span class="keyword">const</span> <span class="special">&)</span></code></a>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
Generate <a class="link" href="reference.html#group__distance__predicates_1ga39c7c94776ab840e164848e53d376098">min_bounded()</a>
|
|
distance predicate.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<a class="link" href="reference.html#group__distance__predicates_1ga843735643378288b0e14e19cc9b4e079"><code class="computeroutput"><span class="identifier">max_bounded</span><span class="special">(</span><span class="identifier">PointRelation</span> <span class="keyword">const</span>
|
|
<span class="special">&,</span> <span class="identifier">MaxRelation</span>
|
|
<span class="keyword">const</span> <span class="special">&)</span></code></a>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
Generate <a class="link" href="reference.html#group__distance__predicates_1ga843735643378288b0e14e19cc9b4e079">max_bounded()</a>
|
|
distance predicate.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<a class="link" href="reference.html#group__distance__predicates_1ga20621ca608b1420c38182346b965f347"><code class="computeroutput"><span class="identifier">bounded</span><span class="special">(</span><span class="identifier">PointRelation</span> <span class="keyword">const</span>
|
|
<span class="special">&,</span> <span class="identifier">MinRelation</span>
|
|
<span class="keyword">const</span> <span class="special">&,</span>
|
|
<span class="identifier">MaxRelation</span> <span class="keyword">const</span>
|
|
<span class="special">&)</span></code></a>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
Generate <a class="link" href="reference.html#group__distance__predicates_1ga20621ca608b1420c38182346b965f347">bounded()</a>
|
|
distance predicate.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
<div class="section">
|
|
<div class="titlepage"><div><div><h5 class="title">
|
|
<a name="geometry_index.r_tree.reference.group__distance__predicates.to_nearest_t_const___"></a><a name="group__distance__predicates_1gace3c7dbc60840c2a61da36e975d56636"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.to_nearest_t_const___" title="to_nearest(T const &)">to_nearest(T
|
|
const &)</a>
|
|
</h5></div></div></div>
|
|
<p>
|
|
Generate <a class="link" href="reference.html#group__distance__predicates_1gace3c7dbc60840c2a61da36e975d56636">to_nearest()</a>
|
|
Point-Indexable relationship.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__distance__predicates.to_nearest_t_const___.h0"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__distance__predicates.to_nearest_t_const___.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.to_nearest_t_const___.description">Description</a>
|
|
</h6>
|
|
<p>
|
|
Generate a nearest query Point and Value's Indexable relationship while
|
|
calculating distances. This function may be used to define that knn query
|
|
should calculate distances as smallest as possible between query Point
|
|
and Indexable's points. In other words it should be the distance to the
|
|
nearest Indexable's point. This function may be also used to define distances
|
|
bounds which indicates that Indexable's nearest point should be closer
|
|
or further than value v. This is default relation.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__distance__predicates.to_nearest_t_const___.h1"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__distance__predicates.to_nearest_t_const___.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.to_nearest_t_const___.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">T</span></code><code class="computeroutput"><span class="special">></span></code>
|
|
<code class="computeroutput"><span class="identifier">detail</span><span class="special">::</span><span class="identifier">to_nearest</span><span class="special"><</span><span class="identifier">T</span><span class="special">></span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">geometry</span><span class="special">::</span><span class="identifier">index</span><span class="special">::</span><span class="identifier">to_nearest</span></code><code class="computeroutput"><span class="special">(</span></code><code class="computeroutput"><span class="identifier">T</span> <span class="keyword">const</span> <span class="special">&</span></code> <code class="computeroutput"><span class="identifier">v</span></code><code class="computeroutput"><span class="special">)</span></code>
|
|
</pre>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__distance__predicates.to_nearest_t_const___.h2"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__distance__predicates.to_nearest_t_const___.template_parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.to_nearest_t_const___.template_parameter_s_">Template
|
|
parameter(s)</a>
|
|
</h6>
|
|
<div class="informaltable"><table class="table">
|
|
<colgroup>
|
|
<col>
|
|
<col>
|
|
</colgroup>
|
|
<thead><tr>
|
|
<th>
|
|
<p>
|
|
Parameter
|
|
</p>
|
|
</th>
|
|
<th>
|
|
<p>
|
|
Description
|
|
</p>
|
|
</th>
|
|
</tr></thead>
|
|
<tbody><tr>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">T</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
Type of wrapped object. This may be a Point for PointRelation
|
|
or some Value for MinRelation or MaxRelation
|
|
</p>
|
|
</td>
|
|
</tr></tbody>
|
|
</table></div>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__distance__predicates.to_nearest_t_const___.h3"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__distance__predicates.to_nearest_t_const___.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.to_nearest_t_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">T</span> <span class="keyword">const</span>
|
|
<span class="special">&</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">v</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
Point or bound value.
|
|
</p>
|
|
</td>
|
|
</tr></tbody>
|
|
</table></div>
|
|
</div>
|
|
<div class="section">
|
|
<div class="titlepage"><div><div><h5 class="title">
|
|
<a name="geometry_index.r_tree.reference.group__distance__predicates.to_centroid_t_const___"></a><a name="group__distance__predicates_1gaccbba95d864d8dcf8a694796c840fbe0"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.to_centroid_t_const___" title="to_centroid(T const &)">to_centroid(T
|
|
const &)</a>
|
|
</h5></div></div></div>
|
|
<p>
|
|
Generate <a class="link" href="reference.html#group__distance__predicates_1gaccbba95d864d8dcf8a694796c840fbe0">to_centroid()</a>
|
|
Point-Indexable relationship.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__distance__predicates.to_centroid_t_const___.h0"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__distance__predicates.to_centroid_t_const___.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.to_centroid_t_const___.description">Description</a>
|
|
</h6>
|
|
<p>
|
|
Generate a nearest query Point and Value's Indexable relationship while
|
|
calculating distances. This function may be used to define that knn query
|
|
should calculate distances between query Point and Indexable's centroid.
|
|
This function may be also used to define distances bounds which indicates
|
|
that Indexable's centroid should be closer or further than value v.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__distance__predicates.to_centroid_t_const___.h1"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__distance__predicates.to_centroid_t_const___.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.to_centroid_t_const___.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">T</span></code><code class="computeroutput"><span class="special">></span></code>
|
|
<code class="computeroutput"><span class="identifier">detail</span><span class="special">::</span><span class="identifier">to_centroid</span><span class="special"><</span><span class="identifier">T</span><span class="special">></span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">geometry</span><span class="special">::</span><span class="identifier">index</span><span class="special">::</span><span class="identifier">to_centroid</span></code><code class="computeroutput"><span class="special">(</span></code><code class="computeroutput"><span class="identifier">T</span> <span class="keyword">const</span> <span class="special">&</span></code> <code class="computeroutput"><span class="identifier">v</span></code><code class="computeroutput"><span class="special">)</span></code>
|
|
</pre>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__distance__predicates.to_centroid_t_const___.h2"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__distance__predicates.to_centroid_t_const___.template_parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.to_centroid_t_const___.template_parameter_s_">Template
|
|
parameter(s)</a>
|
|
</h6>
|
|
<div class="informaltable"><table class="table">
|
|
<colgroup>
|
|
<col>
|
|
<col>
|
|
</colgroup>
|
|
<thead><tr>
|
|
<th>
|
|
<p>
|
|
Parameter
|
|
</p>
|
|
</th>
|
|
<th>
|
|
<p>
|
|
Description
|
|
</p>
|
|
</th>
|
|
</tr></thead>
|
|
<tbody><tr>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">T</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
Type of wrapped object. This may be a Point for PointRelation
|
|
or some Value for MinRelation or MaxRelation
|
|
</p>
|
|
</td>
|
|
</tr></tbody>
|
|
</table></div>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__distance__predicates.to_centroid_t_const___.h3"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__distance__predicates.to_centroid_t_const___.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.to_centroid_t_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">T</span> <span class="keyword">const</span>
|
|
<span class="special">&</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">v</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
Point or bound value.
|
|
</p>
|
|
</td>
|
|
</tr></tbody>
|
|
</table></div>
|
|
</div>
|
|
<div class="section">
|
|
<div class="titlepage"><div><div><h5 class="title">
|
|
<a name="geometry_index.r_tree.reference.group__distance__predicates.to_furthest_t_const___"></a><a name="group__distance__predicates_1ga67dddd8a7fcaae150970e1db0401de02"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.to_furthest_t_const___" title="to_furthest(T const &)">to_furthest(T
|
|
const &)</a>
|
|
</h5></div></div></div>
|
|
<p>
|
|
Generate <a class="link" href="reference.html#group__distance__predicates_1ga67dddd8a7fcaae150970e1db0401de02">to_furthest()</a>
|
|
Point-Indexable relationship.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__distance__predicates.to_furthest_t_const___.h0"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__distance__predicates.to_furthest_t_const___.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.to_furthest_t_const___.description">Description</a>
|
|
</h6>
|
|
<p>
|
|
Generate a nearest query Point and Value's Indexable relationship while
|
|
calculating distances. This function may be used to define that knn query
|
|
should calculate distances as biggest as possible between query Point
|
|
and Indexable's points. In other words it should be the distance to the
|
|
furthest Indexable's point. This function may be also used to define
|
|
distances bounds which indicates that Indexable's furthest point should
|
|
be closer or further than value v.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__distance__predicates.to_furthest_t_const___.h1"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__distance__predicates.to_furthest_t_const___.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.to_furthest_t_const___.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">T</span></code><code class="computeroutput"><span class="special">></span></code>
|
|
<code class="computeroutput"><span class="identifier">detail</span><span class="special">::</span><span class="identifier">to_furthest</span><span class="special"><</span><span class="identifier">T</span><span class="special">></span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">geometry</span><span class="special">::</span><span class="identifier">index</span><span class="special">::</span><span class="identifier">to_furthest</span></code><code class="computeroutput"><span class="special">(</span></code><code class="computeroutput"><span class="identifier">T</span> <span class="keyword">const</span> <span class="special">&</span></code> <code class="computeroutput"><span class="identifier">v</span></code><code class="computeroutput"><span class="special">)</span></code>
|
|
</pre>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__distance__predicates.to_furthest_t_const___.h2"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__distance__predicates.to_furthest_t_const___.template_parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.to_furthest_t_const___.template_parameter_s_">Template
|
|
parameter(s)</a>
|
|
</h6>
|
|
<div class="informaltable"><table class="table">
|
|
<colgroup>
|
|
<col>
|
|
<col>
|
|
</colgroup>
|
|
<thead><tr>
|
|
<th>
|
|
<p>
|
|
Parameter
|
|
</p>
|
|
</th>
|
|
<th>
|
|
<p>
|
|
Description
|
|
</p>
|
|
</th>
|
|
</tr></thead>
|
|
<tbody><tr>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">T</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
Type of wrapped object. This may be a Point for PointRelation
|
|
or some Value for MinRelation or MaxRelation
|
|
</p>
|
|
</td>
|
|
</tr></tbody>
|
|
</table></div>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__distance__predicates.to_furthest_t_const___.h3"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__distance__predicates.to_furthest_t_const___.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.to_furthest_t_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">T</span> <span class="keyword">const</span>
|
|
<span class="special">&</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">v</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
Point or bound value.
|
|
</p>
|
|
</td>
|
|
</tr></tbody>
|
|
</table></div>
|
|
</div>
|
|
<div class="section">
|
|
<div class="titlepage"><div><div><h5 class="title">
|
|
<a name="geometry_index.r_tree.reference.group__distance__predicates.unbounded_pointrelation_const___"></a><a name="group__distance__predicates_1ga1b0f969b575a94ca710b9345861f64db"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.unbounded_pointrelation_const___" title="unbounded(PointRelation const &)">unbounded(PointRelation
|
|
const &)</a>
|
|
</h5></div></div></div>
|
|
<p>
|
|
Generate <a class="link" href="reference.html#group__distance__predicates_1ga1b0f969b575a94ca710b9345861f64db">unbounded()</a>
|
|
distance predicate.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__distance__predicates.unbounded_pointrelation_const___.h0"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__distance__predicates.unbounded_pointrelation_const___.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.unbounded_pointrelation_const___.description">Description</a>
|
|
</h6>
|
|
<p>
|
|
Generate a distance predicate. This defines distances bounds which are
|
|
used by knn query. This function indicates that there is no distance
|
|
bounds and Values should be returned if distances between Point and Indexable
|
|
are the smallest. Distance calculation is defined by PointRelation. This
|
|
is default nearest predicate.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__distance__predicates.unbounded_pointrelation_const___.h1"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__distance__predicates.unbounded_pointrelation_const___.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.unbounded_pointrelation_const___.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">PointRelation</span></code><code class="computeroutput"><span class="special">></span></code>
|
|
<code class="computeroutput"><span class="identifier">detail</span><span class="special">::</span><span class="identifier">unbounded</span><span class="special"><</span><span class="identifier">PointRelation</span><span class="special">></span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">geometry</span><span class="special">::</span><span class="identifier">index</span><span class="special">::</span><span class="identifier">unbounded</span></code><code class="computeroutput"><span class="special">(</span></code><code class="computeroutput"><span class="identifier">PointRelation</span> <span class="keyword">const</span> <span class="special">&</span></code> <code class="computeroutput"><span class="identifier">pr</span></code><code class="computeroutput"><span class="special">)</span></code>
|
|
</pre>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__distance__predicates.unbounded_pointrelation_const___.h2"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__distance__predicates.unbounded_pointrelation_const___.template_parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.unbounded_pointrelation_const___.template_parameter_s_">Template
|
|
parameter(s)</a>
|
|
</h6>
|
|
<div class="informaltable"><table class="table">
|
|
<colgroup>
|
|
<col>
|
|
<col>
|
|
</colgroup>
|
|
<thead><tr>
|
|
<th>
|
|
<p>
|
|
Parameter
|
|
</p>
|
|
</th>
|
|
<th>
|
|
<p>
|
|
Description
|
|
</p>
|
|
</th>
|
|
</tr></thead>
|
|
<tbody><tr>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">PointRelation</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
PointRelation type.
|
|
</p>
|
|
</td>
|
|
</tr></tbody>
|
|
</table></div>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__distance__predicates.unbounded_pointrelation_const___.h3"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__distance__predicates.unbounded_pointrelation_const___.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.unbounded_pointrelation_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">PointRelation</span> <span class="keyword">const</span> <span class="special">&</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">pr</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The point relation. This may be generated by <code class="literal"><a class="link" href="reference.html#group__distance__predicates_1gace3c7dbc60840c2a61da36e975d56636">index::to_nearest()</a></code>,
|
|
<code class="literal"><a class="link" href="reference.html#group__distance__predicates_1gaccbba95d864d8dcf8a694796c840fbe0">index::to_centroid()</a></code>
|
|
or <code class="literal"><a class="link" href="reference.html#group__distance__predicates_1ga67dddd8a7fcaae150970e1db0401de02">index::to_furthest()</a></code>
|
|
with <code class="literal"><code class="computeroutput"><span class="identifier">Point</span></code></code>
|
|
passed as a parameter.
|
|
</p>
|
|
</td>
|
|
</tr></tbody>
|
|
</table></div>
|
|
</div>
|
|
<div class="section">
|
|
<div class="titlepage"><div><div><h5 class="title">
|
|
<a name="geometry_index.r_tree.reference.group__distance__predicates.min_bounded_pointrelation_const____minrelation_const___"></a><a name="group__distance__predicates_1ga39c7c94776ab840e164848e53d376098"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.min_bounded_pointrelation_const____minrelation_const___" title="min_bounded(PointRelation const &, MinRelation const &)">min_bounded(PointRelation
|
|
const &, MinRelation const &)</a>
|
|
</h5></div></div></div>
|
|
<p>
|
|
Generate <a class="link" href="reference.html#group__distance__predicates_1ga39c7c94776ab840e164848e53d376098">min_bounded()</a>
|
|
distance predicate.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__distance__predicates.min_bounded_pointrelation_const____minrelation_const___.h0"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__distance__predicates.min_bounded_pointrelation_const____minrelation_const___.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.min_bounded_pointrelation_const____minrelation_const___.description">Description</a>
|
|
</h6>
|
|
<p>
|
|
Generate a distance predicate. This defines distances bounds which are
|
|
used by knn query. This function indicates that Values should be returned
|
|
only if distances between Point and Indexable are greater or equal to
|
|
some min_distance passed in MinRelation. Check for closest Value is defined
|
|
by PointRelation. So it is possible e.g. to return Values with centroids
|
|
closest to some Point but only if nearest points are further than some
|
|
distance.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__distance__predicates.min_bounded_pointrelation_const____minrelation_const___.h1"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__distance__predicates.min_bounded_pointrelation_const____minrelation_const___.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.min_bounded_pointrelation_const____minrelation_const___.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">PointRelation</span></code><code class="computeroutput"><span class="special">,</span></code> <code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">MinRelation</span></code><code class="computeroutput"><span class="special">></span></code>
|
|
<code class="computeroutput"><span class="identifier">detail</span><span class="special">::</span><span class="identifier">min_bounded</span><span class="special"><</span><span class="identifier">PointRelation</span><span class="special">,</span> <span class="identifier">MinRelation</span><span class="special">></span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">geometry</span><span class="special">::</span><span class="identifier">index</span><span class="special">::</span><span class="identifier">min_bounded</span></code><code class="computeroutput"><span class="special">(</span></code><code class="computeroutput"><span class="identifier">PointRelation</span> <span class="keyword">const</span> <span class="special">&</span></code> <code class="computeroutput"><span class="identifier">pr</span></code><code class="computeroutput"><span class="special">,</span></code> <code class="computeroutput"><span class="identifier">MinRelation</span> <span class="keyword">const</span> <span class="special">&</span></code> <code class="computeroutput"><span class="identifier">minr</span></code><code class="computeroutput"><span class="special">)</span></code>
|
|
</pre>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__distance__predicates.min_bounded_pointrelation_const____minrelation_const___.h2"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__distance__predicates.min_bounded_pointrelation_const____minrelation_const___.template_parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.min_bounded_pointrelation_const____minrelation_const___.template_parameter_s_">Template
|
|
parameter(s)</a>
|
|
</h6>
|
|
<div class="informaltable"><table class="table">
|
|
<colgroup>
|
|
<col>
|
|
<col>
|
|
</colgroup>
|
|
<thead><tr>
|
|
<th>
|
|
<p>
|
|
Parameter
|
|
</p>
|
|
</th>
|
|
<th>
|
|
<p>
|
|
Description
|
|
</p>
|
|
</th>
|
|
</tr></thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">PointRelation</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
PointRelation type.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">MinRelation</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
MinRelation type.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__distance__predicates.min_bounded_pointrelation_const____minrelation_const___.h3"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__distance__predicates.min_bounded_pointrelation_const____minrelation_const___.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.min_bounded_pointrelation_const____minrelation_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">PointRelation</span> <span class="keyword">const</span> <span class="special">&</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">pr</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The point relation. This may be generated by <code class="literal"><a class="link" href="reference.html#group__distance__predicates_1gace3c7dbc60840c2a61da36e975d56636">to_nearest()</a></code>,
|
|
<code class="literal"><a class="link" href="reference.html#group__distance__predicates_1gaccbba95d864d8dcf8a694796c840fbe0">to_centroid()</a></code>
|
|
or <code class="literal"><a class="link" href="reference.html#group__distance__predicates_1ga67dddd8a7fcaae150970e1db0401de02">to_furthest()</a></code>
|
|
with <code class="literal"><code class="computeroutput"><span class="identifier">Point</span></code></code>
|
|
passed as a parameter.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">MinRelation</span> <span class="keyword">const</span> <span class="special">&</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">minr</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The minimum bound relation. This may be generated by <code class="literal"><a class="link" href="reference.html#group__distance__predicates_1gace3c7dbc60840c2a61da36e975d56636">to_nearest()</a></code>,
|
|
<code class="literal"><a class="link" href="reference.html#group__distance__predicates_1gaccbba95d864d8dcf8a694796c840fbe0">to_centroid()</a></code>
|
|
or <code class="literal"><a class="link" href="reference.html#group__distance__predicates_1ga67dddd8a7fcaae150970e1db0401de02">to_furthest()</a></code>
|
|
with distance value passed as a parameter.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
</div>
|
|
<div class="section">
|
|
<div class="titlepage"><div><div><h5 class="title">
|
|
<a name="geometry_index.r_tree.reference.group__distance__predicates.max_bounded_pointrelation_const____maxrelation_const___"></a><a name="group__distance__predicates_1ga843735643378288b0e14e19cc9b4e079"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.max_bounded_pointrelation_const____maxrelation_const___" title="max_bounded(PointRelation const &, MaxRelation const &)">max_bounded(PointRelation
|
|
const &, MaxRelation const &)</a>
|
|
</h5></div></div></div>
|
|
<p>
|
|
Generate <a class="link" href="reference.html#group__distance__predicates_1ga843735643378288b0e14e19cc9b4e079">max_bounded()</a>
|
|
distance predicate.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__distance__predicates.max_bounded_pointrelation_const____maxrelation_const___.h0"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__distance__predicates.max_bounded_pointrelation_const____maxrelation_const___.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.max_bounded_pointrelation_const____maxrelation_const___.description">Description</a>
|
|
</h6>
|
|
<p>
|
|
Generate a distance predicate. This defines distances bounds which are
|
|
used by knn query. This function indicates that Values should be returned
|
|
only if distances between Point and Indexable are lesser or equal to
|
|
some max_distance passed in MaxRelation. Check for closest Value is defined
|
|
by PointRelation. So it is possible e.g. to return Values with centroids
|
|
closest to some Point but only if nearest points are closer than some
|
|
distance.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__distance__predicates.max_bounded_pointrelation_const____maxrelation_const___.h1"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__distance__predicates.max_bounded_pointrelation_const____maxrelation_const___.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.max_bounded_pointrelation_const____maxrelation_const___.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">PointRelation</span></code><code class="computeroutput"><span class="special">,</span></code> <code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">MaxRelation</span></code><code class="computeroutput"><span class="special">></span></code>
|
|
<code class="computeroutput"><span class="identifier">detail</span><span class="special">::</span><span class="identifier">max_bounded</span><span class="special"><</span><span class="identifier">PointRelation</span><span class="special">,</span> <span class="identifier">MaxRelation</span><span class="special">></span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">geometry</span><span class="special">::</span><span class="identifier">index</span><span class="special">::</span><span class="identifier">max_bounded</span></code><code class="computeroutput"><span class="special">(</span></code><code class="computeroutput"><span class="identifier">PointRelation</span> <span class="keyword">const</span> <span class="special">&</span></code> <code class="computeroutput"><span class="identifier">pr</span></code><code class="computeroutput"><span class="special">,</span></code> <code class="computeroutput"><span class="identifier">MaxRelation</span> <span class="keyword">const</span> <span class="special">&</span></code> <code class="computeroutput"><span class="identifier">maxr</span></code><code class="computeroutput"><span class="special">)</span></code>
|
|
</pre>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__distance__predicates.max_bounded_pointrelation_const____maxrelation_const___.h2"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__distance__predicates.max_bounded_pointrelation_const____maxrelation_const___.template_parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.max_bounded_pointrelation_const____maxrelation_const___.template_parameter_s_">Template
|
|
parameter(s)</a>
|
|
</h6>
|
|
<div class="informaltable"><table class="table">
|
|
<colgroup>
|
|
<col>
|
|
<col>
|
|
</colgroup>
|
|
<thead><tr>
|
|
<th>
|
|
<p>
|
|
Parameter
|
|
</p>
|
|
</th>
|
|
<th>
|
|
<p>
|
|
Description
|
|
</p>
|
|
</th>
|
|
</tr></thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">PointRelation</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
PointRelation type.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">MaxRelation</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
MaxRelation type.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__distance__predicates.max_bounded_pointrelation_const____maxrelation_const___.h3"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__distance__predicates.max_bounded_pointrelation_const____maxrelation_const___.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.max_bounded_pointrelation_const____maxrelation_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">PointRelation</span> <span class="keyword">const</span> <span class="special">&</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">pr</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The point relation. This may be generated by <code class="literal"><a class="link" href="reference.html#group__distance__predicates_1gace3c7dbc60840c2a61da36e975d56636">to_nearest()</a></code>,
|
|
<code class="literal"><a class="link" href="reference.html#group__distance__predicates_1gaccbba95d864d8dcf8a694796c840fbe0">to_centroid()</a></code>
|
|
or <code class="literal"><a class="link" href="reference.html#group__distance__predicates_1ga67dddd8a7fcaae150970e1db0401de02">to_furthest()</a></code>
|
|
with <code class="literal"><code class="computeroutput"><span class="identifier">Point</span></code></code>
|
|
passed as a parameter.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">MaxRelation</span> <span class="keyword">const</span> <span class="special">&</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">maxr</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The maximum bound relation. This may be generated by <code class="literal"><a class="link" href="reference.html#group__distance__predicates_1gace3c7dbc60840c2a61da36e975d56636">to_nearest()</a></code>,
|
|
<code class="literal"><a class="link" href="reference.html#group__distance__predicates_1gaccbba95d864d8dcf8a694796c840fbe0">to_centroid()</a></code>
|
|
or <code class="literal"><a class="link" href="reference.html#group__distance__predicates_1ga67dddd8a7fcaae150970e1db0401de02">to_furthest()</a></code>
|
|
with distance value passed as a parameter.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
</div>
|
|
<div class="section">
|
|
<div class="titlepage"><div><div><h5 class="title">
|
|
<a name="geometry_index.r_tree.reference.group__distance__predicates.bounded_pointrelation_const____minrelation_const____maxrelation_const___"></a><a name="group__distance__predicates_1ga20621ca608b1420c38182346b965f347"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.bounded_pointrelation_const____minrelation_const____maxrelation_const___" title="bounded(PointRelation const &, MinRelation const &, MaxRelation const &)">bounded(PointRelation
|
|
const &, MinRelation const &, MaxRelation const &)</a>
|
|
</h5></div></div></div>
|
|
<p>
|
|
Generate <a class="link" href="reference.html#group__distance__predicates_1ga20621ca608b1420c38182346b965f347">bounded()</a>
|
|
distance predicate.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__distance__predicates.bounded_pointrelation_const____minrelation_const____maxrelation_const___.h0"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__distance__predicates.bounded_pointrelation_const____minrelation_const____maxrelation_const___.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.bounded_pointrelation_const____minrelation_const____maxrelation_const___.description">Description</a>
|
|
</h6>
|
|
<p>
|
|
Generate a distance predicate. This defines distances bounds which are
|
|
used by knn query. This function indicates that Values should be returned
|
|
only if distances between Point and Indexable are greater or equal to
|
|
some min_distance passed in MinRelation and lesser or equal to some max_distance
|
|
passed in MaxRelation. Check for closest Value is defined by PointRelation.
|
|
So it is possible e.g. to return Values with centroids closest to some
|
|
Point but only if nearest points are further than some distance and closer
|
|
than some other distance.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__distance__predicates.bounded_pointrelation_const____minrelation_const____maxrelation_const___.h1"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__distance__predicates.bounded_pointrelation_const____minrelation_const____maxrelation_const___.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.bounded_pointrelation_const____minrelation_const____maxrelation_const___.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">PointRelation</span></code><code class="computeroutput"><span class="special">,</span></code>
|
|
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">MinRelation</span></code><code class="computeroutput"><span class="special">,</span></code>
|
|
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">MaxRelation</span></code><code class="computeroutput"><span class="special">></span></code>
|
|
<code class="computeroutput"><span class="identifier">detail</span><span class="special">::</span><span class="identifier">bounded</span><span class="special"><</span><span class="identifier">PointRelation</span><span class="special">,</span> <span class="identifier">MinRelation</span><span class="special">,</span> <span class="identifier">MaxRelation</span><span class="special">></span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">geometry</span><span class="special">::</span><span class="identifier">index</span><span class="special">::</span><span class="identifier">bounded</span></code><code class="computeroutput"><span class="special">(</span></code><code class="computeroutput"><span class="identifier">PointRelation</span> <span class="keyword">const</span> <span class="special">&</span></code> <code class="computeroutput"><span class="identifier">pr</span></code><code class="computeroutput"><span class="special">,</span></code>
|
|
<code class="computeroutput"><span class="identifier">MinRelation</span> <span class="keyword">const</span> <span class="special">&</span></code> <code class="computeroutput"><span class="identifier">minr</span></code><code class="computeroutput"><span class="special">,</span></code>
|
|
<code class="computeroutput"><span class="identifier">MaxRelation</span> <span class="keyword">const</span> <span class="special">&</span></code> <code class="computeroutput"><span class="identifier">maxr</span></code><code class="computeroutput"><span class="special">)</span></code>
|
|
</pre>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__distance__predicates.bounded_pointrelation_const____minrelation_const____maxrelation_const___.h2"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__distance__predicates.bounded_pointrelation_const____minrelation_const____maxrelation_const___.template_parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.bounded_pointrelation_const____minrelation_const____maxrelation_const___.template_parameter_s_">Template
|
|
parameter(s)</a>
|
|
</h6>
|
|
<div class="informaltable"><table class="table">
|
|
<colgroup>
|
|
<col>
|
|
<col>
|
|
</colgroup>
|
|
<thead><tr>
|
|
<th>
|
|
<p>
|
|
Parameter
|
|
</p>
|
|
</th>
|
|
<th>
|
|
<p>
|
|
Description
|
|
</p>
|
|
</th>
|
|
</tr></thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">PointRelation</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
PointRelation type.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">MinRelation</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
MinRelation type.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">MaxRelation</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
MaxRelation type.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__distance__predicates.bounded_pointrelation_const____minrelation_const____maxrelation_const___.h3"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__distance__predicates.bounded_pointrelation_const____minrelation_const____maxrelation_const___.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.bounded_pointrelation_const____minrelation_const____maxrelation_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">PointRelation</span> <span class="keyword">const</span> <span class="special">&</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">pr</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The point relation. This may be generated by <code class="literal"><a class="link" href="reference.html#group__distance__predicates_1gace3c7dbc60840c2a61da36e975d56636">to_nearest()</a></code>,
|
|
<code class="literal"><a class="link" href="reference.html#group__distance__predicates_1gaccbba95d864d8dcf8a694796c840fbe0">to_centroid()</a></code>
|
|
or <code class="literal"><a class="link" href="reference.html#group__distance__predicates_1ga67dddd8a7fcaae150970e1db0401de02">to_furthest()</a></code>
|
|
with <code class="literal"><code class="computeroutput"><span class="identifier">Point</span></code></code>
|
|
passed as a parameter.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">MinRelation</span> <span class="keyword">const</span> <span class="special">&</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">minr</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The minimum bound relation. This may be generated by <code class="literal"><a class="link" href="reference.html#group__distance__predicates_1gace3c7dbc60840c2a61da36e975d56636">to_nearest()</a></code>,
|
|
<code class="literal"><a class="link" href="reference.html#group__distance__predicates_1gaccbba95d864d8dcf8a694796c840fbe0">to_centroid()</a></code>
|
|
or <code class="literal"><a class="link" href="reference.html#group__distance__predicates_1ga67dddd8a7fcaae150970e1db0401de02">to_furthest()</a></code>
|
|
with distance value passed as a parameter.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">MaxRelation</span> <span class="keyword">const</span> <span class="special">&</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">maxr</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The maximum bound relation. This may be generated by <code class="literal"><a class="link" href="reference.html#group__distance__predicates_1gace3c7dbc60840c2a61da36e975d56636">to_nearest()</a></code>,
|
|
<code class="literal"><a class="link" href="reference.html#group__distance__predicates_1gaccbba95d864d8dcf8a694796c840fbe0">to_centroid()</a></code>
|
|
or <code class="literal"><a class="link" href="reference.html#group__distance__predicates_1ga67dddd8a7fcaae150970e1db0401de02">to_furthest()</a></code>
|
|
with distance value passed as a parameter.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
</div>
|
|
</div>
|
|
<div class="section">
|
|
<div class="titlepage"><div><div><h4 class="title">
|
|
<a name="geometry_index.r_tree.reference.group__adaptors"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__adaptors" title="Adaptors (boost::geometry::index::adaptors::)">Adaptors
|
|
(boost::geometry::index::adaptors::)</a>
|
|
</h4></div></div></div>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__adaptors.h0"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__adaptors.functions"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__adaptors.functions">Functions</a>
|
|
</h6>
|
|
<div class="informaltable"><table class="table">
|
|
<colgroup>
|
|
<col>
|
|
<col>
|
|
</colgroup>
|
|
<thead><tr>
|
|
<th>
|
|
<p>
|
|
Function
|
|
</p>
|
|
</th>
|
|
<th>
|
|
<p>
|
|
Description
|
|
</p>
|
|
</th>
|
|
</tr></thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<a class="link" href="reference.html#group__adaptors_1ga8e094e1f312fc00336a3536f51a69468"><code class="computeroutput"><span class="identifier">nearest_queried</span><span class="special">(</span><span class="identifier">DistancesPredicates</span> <span class="keyword">const</span>
|
|
<span class="special">&,</span> <span class="identifier">size_t</span><span class="special">,</span> <span class="identifier">Predicates</span>
|
|
<span class="keyword">const</span> <span class="special">&)</span></code></a>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The nearest query index adaptor generator.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<a class="link" href="reference.html#group__adaptors_1ga3478395ded5855dc0b6c2f36a89de9f6"><code class="computeroutput"><span class="identifier">nearest_queried</span><span class="special">(</span><span class="identifier">DistancesPredicates</span> <span class="keyword">const</span>
|
|
<span class="special">&,</span> <span class="identifier">size_t</span><span class="special">)</span></code></a>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The nearest query index adaptor generator.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<a class="link" href="reference.html#group__adaptors_1ga3068771f0f9cca706269ec35a809db2a"><code class="computeroutput"><span class="identifier">spatial_queried</span><span class="special">(</span><span class="identifier">Predicates</span> <span class="keyword">const</span>
|
|
<span class="special">&)</span></code></a>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The spatial query index adaptor generator.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
<div class="section">
|
|
<div class="titlepage"><div><div><h5 class="title">
|
|
<a name="geometry_index.r_tree.reference.group__adaptors.nearest_queried_distancespredicates_const____size_t__predicates_const___"></a><a name="group__adaptors_1ga8e094e1f312fc00336a3536f51a69468"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__adaptors.nearest_queried_distancespredicates_const____size_t__predicates_const___" title="nearest_queried(DistancesPredicates const &, size_t, Predicates const &)">nearest_queried(DistancesPredicates
|
|
const &, size_t, Predicates const &)</a>
|
|
</h5></div></div></div>
|
|
<p>
|
|
The nearest query index adaptor generator.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__adaptors.nearest_queried_distancespredicates_const____size_t__predicates_const___.h0"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__adaptors.nearest_queried_distancespredicates_const____size_t__predicates_const___.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__adaptors.nearest_queried_distancespredicates_const____size_t__predicates_const___.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">DistancesPredicates</span></code><code class="computeroutput"><span class="special">,</span></code> <code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Predicates</span></code><code class="computeroutput"><span class="special">></span></code>
|
|
<code class="computeroutput"><span class="identifier">detail</span><span class="special">::</span><span class="identifier">nearest_query</span><span class="special"><</span><span class="identifier">DistancesPredicates</span><span class="special">,</span> <span class="identifier">Predicates</span><span class="special">></span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">geometry</span><span class="special">::</span><span class="identifier">index</span><span class="special">::</span><span class="identifier">adaptors</span><span class="special">::</span><span class="identifier">nearest_queried</span></code><code class="computeroutput"><span class="special">(</span></code><code class="computeroutput"><span class="identifier">DistancesPredicates</span> <span class="keyword">const</span> <span class="special">&</span></code> <code class="computeroutput"><span class="identifier">dpred</span></code><code class="computeroutput"><span class="special">,</span></code>
|
|
<code class="computeroutput"><span class="identifier">size_t</span></code> <code class="computeroutput"><span class="identifier">k</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">pred</span></code><code class="computeroutput"><span class="special">)</span></code>
|
|
</pre>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__adaptors.nearest_queried_distancespredicates_const____size_t__predicates_const___.h1"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__adaptors.nearest_queried_distancespredicates_const____size_t__predicates_const___.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__adaptors.nearest_queried_distancespredicates_const____size_t__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">DistancesPredicates</span>
|
|
<span class="keyword">const</span> <span class="special">&</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">dpred</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
Distance predicates.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">size_t</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">k</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The number of values to find.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">Predicates</span> <span class="keyword">const</span> <span class="special">&</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">pred</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
Spatial predicates.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
</div>
|
|
<div class="section">
|
|
<div class="titlepage"><div><div><h5 class="title">
|
|
<a name="geometry_index.r_tree.reference.group__adaptors.nearest_queried_distancespredicates_const____size_t_"></a><a name="group__adaptors_1ga3478395ded5855dc0b6c2f36a89de9f6"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__adaptors.nearest_queried_distancespredicates_const____size_t_" title="nearest_queried(DistancesPredicates const &, size_t)">nearest_queried(DistancesPredicates
|
|
const &, size_t)</a>
|
|
</h5></div></div></div>
|
|
<p>
|
|
The nearest query index adaptor generator.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__adaptors.nearest_queried_distancespredicates_const____size_t_.h0"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__adaptors.nearest_queried_distancespredicates_const____size_t_.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__adaptors.nearest_queried_distancespredicates_const____size_t_.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">DistancesPredicates</span></code><code class="computeroutput"><span class="special">></span></code>
|
|
<code class="computeroutput"><span class="identifier">detail</span><span class="special">::</span><span class="identifier">nearest_query</span><span class="special"><</span><span class="identifier">DistancesPredicates</span><span class="special">,</span> <span class="identifier">index</span><span class="special">::</span><span class="identifier">detail</span><span class="special">::</span><span class="identifier">empty</span><span class="special">></span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">geometry</span><span class="special">::</span><span class="identifier">index</span><span class="special">::</span><span class="identifier">adaptors</span><span class="special">::</span><span class="identifier">nearest_queried</span></code><code class="computeroutput"><span class="special">(</span></code><code class="computeroutput"><span class="identifier">DistancesPredicates</span> <span class="keyword">const</span> <span class="special">&</span></code> <code class="computeroutput"><span class="identifier">dpred</span></code><code class="computeroutput"><span class="special">,</span></code> <code class="computeroutput"><span class="identifier">size_t</span></code> <code class="computeroutput"><span class="identifier">k</span></code><code class="computeroutput"><span class="special">)</span></code>
|
|
</pre>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__adaptors.nearest_queried_distancespredicates_const____size_t_.h1"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__adaptors.nearest_queried_distancespredicates_const____size_t_.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__adaptors.nearest_queried_distancespredicates_const____size_t_.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">DistancesPredicates</span>
|
|
<span class="keyword">const</span> <span class="special">&</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">dpred</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
Distance predicates.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">size_t</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">k</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The number of values to find.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
</div>
|
|
<div class="section">
|
|
<div class="titlepage"><div><div><h5 class="title">
|
|
<a name="geometry_index.r_tree.reference.group__adaptors.spatial_queried_predicates_const___"></a><a name="group__adaptors_1ga3068771f0f9cca706269ec35a809db2a"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__adaptors.spatial_queried_predicates_const___" title="spatial_queried(Predicates const &)">spatial_queried(Predicates
|
|
const &)</a>
|
|
</h5></div></div></div>
|
|
<p>
|
|
The spatial query index adaptor generator.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__adaptors.spatial_queried_predicates_const___.h0"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__adaptors.spatial_queried_predicates_const___.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__adaptors.spatial_queried_predicates_const___.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">Predicates</span></code><code class="computeroutput"><span class="special">></span></code>
|
|
<code class="computeroutput"><span class="identifier">detail</span><span class="special">::</span><span class="identifier">spatial_query</span><span class="special"><</span><span class="identifier">Predicates</span><span class="special">></span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">geometry</span><span class="special">::</span><span class="identifier">index</span><span class="special">::</span><span class="identifier">adaptors</span><span class="special">::</span><span class="identifier">spatial_queried</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">pred</span></code><code class="computeroutput"><span class="special">)</span></code>
|
|
</pre>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__adaptors.spatial_queried_predicates_const___.h1"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__adaptors.spatial_queried_predicates_const___.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__adaptors.spatial_queried_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">&</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">pred</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
Spatial predicates.
|
|
</p>
|
|
</td>
|
|
</tr></tbody>
|
|
</table></div>
|
|
</div>
|
|
</div>
|
|
<div class="section">
|
|
<div class="titlepage"><div><div><h4 class="title">
|
|
<a name="geometry_index.r_tree.reference.translators"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.translators" title="Translators (boost::geometry::index::translators::)">Translators
|
|
(boost::geometry::index::translators::)</a>
|
|
</h4></div></div></div>
|
|
<div class="section">
|
|
<div class="titlepage"><div><div><h5 class="title">
|
|
<a name="geometry_index.r_tree.reference.translators.boost_geometry_index_translator_def"></a><a name="structboost_1_1geometry_1_1index_1_1translator_1_1def"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.translators.boost_geometry_index_translator_def" title="boost::geometry::index::translator::def">boost::geometry::index::translator::def</a>
|
|
</h5></div></div></div>
|
|
<p>
|
|
<a class="indexterm" name="idp12570712"></a><a class="indexterm" name="idp12571040"></a><a class="indexterm" name="idp12571384"></a><a class="indexterm" name="idp12571728"></a><a class="indexterm" name="idp12572072"></a>
|
|
The default translator.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.translators.boost_geometry_index_translator_def.h0"></a>
|
|
<span><a name="geometry_index.r_tree.reference.translators.boost_geometry_index_translator_def.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.translators.boost_geometry_index_translator_def.description">Description</a>
|
|
</h6>
|
|
<p>
|
|
It translates Value object to Indexable object. The default version handles
|
|
Values which are Indexables. This translator is also specialized for
|
|
std::pair<Indexable, Second> and boost::tuple<Indexable, ...>.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.translators.boost_geometry_index_translator_def.h1"></a>
|
|
<span><a name="geometry_index.r_tree.reference.translators.boost_geometry_index_translator_def.header"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.translators.boost_geometry_index_translator_def.header">Header</a>
|
|
</h6>
|
|
<p>
|
|
<code class="computeroutput"><span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">geometry</span><span class="special">/</span><span class="identifier">extensions</span><span class="special">/</span><span class="identifier">index</span><span class="special">/</span><span class="identifier">translator</span><span class="special">/</span><span class="identifier">def</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code>
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.translators.boost_geometry_index_translator_def.h2"></a>
|
|
<span><a name="geometry_index.r_tree.reference.translators.boost_geometry_index_translator_def.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.translators.boost_geometry_index_translator_def.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">Value</span></code><code class="computeroutput"><span class="special">></span></code>
|
|
<code class="computeroutput"><span class="keyword">struct</span> <span class="identifier">def</span></code>
|
|
<code class="computeroutput"><span class="special">{</span></code>
|
|
<code class="computeroutput"> <span class="comment">// ...</span></code>
|
|
<code class="computeroutput"><span class="special">};</span></code>
|
|
</pre>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.translators.boost_geometry_index_translator_def.h3"></a>
|
|
<span><a name="geometry_index.r_tree.reference.translators.boost_geometry_index_translator_def.template_parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.translators.boost_geometry_index_translator_def.template_parameter_s_">Template
|
|
parameter(s)</a>
|
|
</h6>
|
|
<div class="informaltable"><table class="table">
|
|
<colgroup>
|
|
<col>
|
|
<col>
|
|
</colgroup>
|
|
<thead><tr>
|
|
<th>
|
|
<p>
|
|
Parameter
|
|
</p>
|
|
</th>
|
|
<th>
|
|
<p>
|
|
Description
|
|
</p>
|
|
</th>
|
|
</tr></thead>
|
|
<tbody><tr>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">Value</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The Value type which may be translated directly to the Indexable.
|
|
</p>
|
|
</td>
|
|
</tr></tbody>
|
|
</table></div>
|
|
</div>
|
|
<div class="section">
|
|
<div class="titlepage"><div><div><h5 class="title">
|
|
<a name="geometry_index.r_tree.reference.translators.boost_geometry_index_translator_index"></a><a name="classboost_1_1geometry_1_1index_1_1translator_1_1index"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.translators.boost_geometry_index_translator_index" title="boost::geometry::index::translator::index">boost::geometry::index::translator::index</a>
|
|
</h5></div></div></div>
|
|
<p>
|
|
<a class="indexterm" name="idp12595984"></a><a class="indexterm" name="idp12596312"></a><a class="indexterm" name="idp12596656"></a><a class="indexterm" name="idp12597000"></a><a class="indexterm" name="idp12597344"></a>
|
|
The index translator.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.translators.boost_geometry_index_translator_index.h0"></a>
|
|
<span><a name="geometry_index.r_tree.reference.translators.boost_geometry_index_translator_index.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.translators.boost_geometry_index_translator_index.description">Description</a>
|
|
</h6>
|
|
<p>
|
|
This translator translates from index of an element in an external Container
|
|
to the Indexable. The container should have operator[](size_type) defined.
|
|
Index translator uses <a class="link" href="reference.html#structboost_1_1geometry_1_1index_1_1translator_1_1def">translator::def</a><...>
|
|
to translate from Container::value_type to the Indexable which means
|
|
that it can handle Indexables, std::pairs and boost::tuples stored in
|
|
an external Container.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.translators.boost_geometry_index_translator_index.h1"></a>
|
|
<span><a name="geometry_index.r_tree.reference.translators.boost_geometry_index_translator_index.header"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.translators.boost_geometry_index_translator_index.header">Header</a>
|
|
</h6>
|
|
<p>
|
|
<code class="computeroutput"><span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">geometry</span><span class="special">/</span><span class="identifier">extensions</span><span class="special">/</span><span class="identifier">index</span><span class="special">/</span><span class="identifier">translator</span><span class="special">/</span><span class="identifier">index</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code>
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.translators.boost_geometry_index_translator_index.h2"></a>
|
|
<span><a name="geometry_index.r_tree.reference.translators.boost_geometry_index_translator_index.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.translators.boost_geometry_index_translator_index.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">Container</span></code><code class="computeroutput"><span class="special">></span></code>
|
|
<code class="computeroutput"><span class="keyword">class</span> <span class="identifier">index</span></code>
|
|
<code class="computeroutput"><span class="special">{</span></code>
|
|
<code class="computeroutput"> <span class="comment">// ...</span></code>
|
|
<code class="computeroutput"><span class="special">};</span></code>
|
|
</pre>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.translators.boost_geometry_index_translator_index.h3"></a>
|
|
<span><a name="geometry_index.r_tree.reference.translators.boost_geometry_index_translator_index.template_parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.translators.boost_geometry_index_translator_index.template_parameter_s_">Template
|
|
parameter(s)</a>
|
|
</h6>
|
|
<div class="informaltable"><table class="table">
|
|
<colgroup>
|
|
<col>
|
|
<col>
|
|
</colgroup>
|
|
<thead><tr>
|
|
<th>
|
|
<p>
|
|
Parameter
|
|
</p>
|
|
</th>
|
|
<th>
|
|
<p>
|
|
Description
|
|
</p>
|
|
</th>
|
|
</tr></thead>
|
|
<tbody><tr>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">Container</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The Container type.
|
|
</p>
|
|
</td>
|
|
</tr></tbody>
|
|
</table></div>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.translators.boost_geometry_index_translator_index.h4"></a>
|
|
<span><a name="geometry_index.r_tree.reference.translators.boost_geometry_index_translator_index.constructor_s__and_destructor"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.translators.boost_geometry_index_translator_index.constructor_s__and_destructor">Constructor(s)
|
|
and destructor</a>
|
|
</h6>
|
|
<div class="informaltable"><table class="table">
|
|
<colgroup>
|
|
<col>
|
|
<col>
|
|
</colgroup>
|
|
<thead><tr>
|
|
<th>
|
|
<p>
|
|
Function
|
|
</p>
|
|
</th>
|
|
<th>
|
|
<p>
|
|
Description
|
|
</p>
|
|
</th>
|
|
</tr></thead>
|
|
<tbody><tr>
|
|
<td>
|
|
<p>
|
|
<a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1translator_1_1index_1a87e7e498c20aa3bf38e350a6ab19e736"><code class="computeroutput"><span class="identifier">index</span><span class="special">(</span><span class="identifier">Container</span> <span class="keyword">const</span>
|
|
<span class="special">&)</span></code></a>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The constructor.
|
|
</p>
|
|
</td>
|
|
</tr></tbody>
|
|
</table></div>
|
|
<div class="section">
|
|
<div class="titlepage"><div><div><h6 class="title">
|
|
<a name="geometry_index.r_tree.reference.translators.boost_geometry_index_translator_index.index_container_const___"></a><a name="classboost_1_1geometry_1_1index_1_1translator_1_1index_1a87e7e498c20aa3bf38e350a6ab19e736"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.translators.boost_geometry_index_translator_index.index_container_const___" title="index(Container const &)">index(Container
|
|
const &)</a>
|
|
</h6></div></div></div>
|
|
<p>
|
|
The constructor.
|
|
</p>
|
|
<h7><a name="geometry_index.r_tree.reference.translators.boost_geometry_index_translator_index.index_container_const___.h0"></a>
|
|
<span><a name="geometry_index.r_tree.reference.translators.boost_geometry_index_translator_index.index_container_const___.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.translators.boost_geometry_index_translator_index.index_container_const___.synopsis">Synopsis</a>
|
|
</h7><pre class="programlisting"><code class="computeroutput"><span class="identifier">index</span></code><code class="computeroutput"><span class="special">(</span></code><code class="computeroutput"><span class="identifier">Container</span> <span class="keyword">const</span> <span class="special">&</span></code> <code class="computeroutput"><span class="identifier">c</span></code><code class="computeroutput"><span class="special">)</span></code>
|
|
</pre>
|
|
<h7><a name="geometry_index.r_tree.reference.translators.boost_geometry_index_translator_index.index_container_const___.h1"></a>
|
|
<span><a name="geometry_index.r_tree.reference.translators.boost_geometry_index_translator_index.index_container_const___.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.translators.boost_geometry_index_translator_index.index_container_const___.parameter_s_">Parameter(s)</a>
|
|
</h7><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">Container</span> <span class="keyword">const</span> <span class="special">&</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">c</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The container which stores indexed values.
|
|
</p>
|
|
</td>
|
|
</tr></tbody>
|
|
</table></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="section">
|
|
<div class="titlepage"><div><div><h4 class="title">
|
|
<a name="geometry_index.r_tree.reference.group__inserters"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__inserters" title="Inserters (boost::geometry::index::)">Inserters
|
|
(boost::geometry::index::)</a>
|
|
</h4></div></div></div>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__inserters.h0"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__inserters.functions"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__inserters.functions">Functions</a>
|
|
</h6>
|
|
<div class="informaltable"><table class="table">
|
|
<colgroup>
|
|
<col>
|
|
<col>
|
|
</colgroup>
|
|
<thead><tr>
|
|
<th>
|
|
<p>
|
|
Function
|
|
</p>
|
|
</th>
|
|
<th>
|
|
<p>
|
|
Description
|
|
</p>
|
|
</th>
|
|
</tr></thead>
|
|
<tbody><tr>
|
|
<td>
|
|
<p>
|
|
<a class="link" href="reference.html#group__inserters_1gab22c33d31b9805250e54ee6d6d240a47"><code class="computeroutput"><span class="identifier">inserter</span><span class="special">(</span><span class="identifier">Container</span> <span class="special">&)</span></code></a>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
Insert iterator generator.
|
|
</p>
|
|
</td>
|
|
</tr></tbody>
|
|
</table></div>
|
|
<div class="section">
|
|
<div class="titlepage"><div><div><h5 class="title">
|
|
<a name="geometry_index.r_tree.reference.group__inserters.inserter_container___"></a><a name="group__inserters_1gab22c33d31b9805250e54ee6d6d240a47"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__inserters.inserter_container___" title="inserter(Container &)">inserter(Container
|
|
&)</a>
|
|
</h5></div></div></div>
|
|
<p>
|
|
Insert iterator generator.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__inserters.inserter_container___.h0"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__inserters.inserter_container___.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__inserters.inserter_container___.description">Description</a>
|
|
</h6>
|
|
<p>
|
|
Returns insert iterator capable to insert values to the container (spatial
|
|
index) which has member function insert(value_type const&) defined.
|
|
</p>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__inserters.inserter_container___.h1"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__inserters.inserter_container___.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__inserters.inserter_container___.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">Container</span></code><code class="computeroutput"><span class="special">></span></code>
|
|
<code class="computeroutput"><span class="identifier">insert_iterator</span><span class="special"><</span><span class="identifier">Container</span><span class="special">></span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">geometry</span><span class="special">::</span><span class="identifier">index</span><span class="special">::</span><span class="identifier">inserter</span></code><code class="computeroutput"><span class="special">(</span></code><code class="computeroutput"><span class="identifier">Container</span> <span class="special">&</span></code> <code class="computeroutput"><span class="identifier">c</span></code><code class="computeroutput"><span class="special">)</span></code>
|
|
</pre>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__inserters.inserter_container___.h2"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__inserters.inserter_container___.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__inserters.inserter_container___.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">Container</span> <span class="special">&</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">c</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
The reference to the container (spatial index) to which values
|
|
will be inserted.
|
|
</p>
|
|
</td>
|
|
</tr></tbody>
|
|
</table></div>
|
|
<h6>
|
|
<a name="geometry_index.r_tree.reference.group__inserters.inserter_container___.h3"></a>
|
|
<span><a name="geometry_index.r_tree.reference.group__inserters.inserter_container___.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__inserters.inserter_container___.returns">Returns</a>
|
|
</h6>
|
|
<p>
|
|
The insert iterator inserting values to the container.
|
|
</p>
|
|
</div>
|
|
</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 © 2011, 2012 Adam Wulkiewicz<br>Copyright © 2008 Federico J. Fernandez<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="nearest_neighbours_queries.html"><img src="http://www.boost.org/doc/libs/release/doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../r_tree.html"><img src="http://www.boost.org/doc/libs/release/doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="http://www.boost.org/doc/libs/release/doc/src/images/home.png" alt="Home"></a>
|
|
</div>
|
|
</body>
|
|
</html>
|