boost_mirror/geometry
1
0
Fork 0
mirror of https://github.com/boostorg/geometry.git synced 2025-05-10 15:44:07 +00:00
Code Issues Packages Projects Releases Wiki Activity
geometry/doc/html/geometry_index/r_tree/reference.html
Adam Wulkiewicz 9ec3d2289e Added the rest of generated files. 
[SVN r82423]
2013-01-09 18:41:55 +00:00

7340 lines
347 KiB
HTML
Raw Blame History

<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.77.1">
<link rel="home" href="../../index.html" title="Chapter&#160;1.&#160;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 (boost::geometry::index::)</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 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="id902772"></a><a class="indexterm" name="id902776"></a><a class="indexterm" name="id902781"></a><a class="indexterm" name="id902786"></a>
The R-tree spatial index.
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.h0"></a>
<span class="phrase"><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>
The R-tree spatial index. This is self-balancing spatial index capable
to store various types of Values and balancing algorithms.
</p>
<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. Predefined
algorithms with compile-time parameters are: bgi::linear&lt;MinElements,
MaxElements&gt;, bgi::quadratic&lt;MinElements, MaxElements&gt;, bgi::rstar&lt;MinElements,
MaxElements, OverlapCostThreshold = 0, ReinsertedElements = MaxElements
* 0.3&gt;. Predefined algorithms with run-time parameters are: bgi::runtime::linear,
bgi::runtime::quadratic, bgi::runtime::rstar.
</p>
<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 (which are Indexables). It also handles std::pair&lt;Indexable,
T&gt;, pointers, smart pointers, and iterators. E.g. If std::pair&lt;Box,
int&gt; is stored, the default translator translates from std::pair&lt;Box,
int&gt; const&amp; to Box const&amp;.
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.h1"></a>
<span class="phrase"><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">&lt;.</span><span class="identifier">hpp</span><span class="special">&gt;</span></code>
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.h2"></a>
<span class="phrase"><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>
<p>
</p>
<pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">Value</span><span class="special">,</span>
<span class="keyword">typename</span> <span class="identifier">Parameters</span><span class="special">,</span>
<span class="keyword">typename</span> <span class="identifier">Translator</span> <span class="special">=</span> <span class="identifier">translator</span><span class="special">::</span><span class="identifier">def</span><span class="special">&lt;</span><span class="identifier">Value</span><span class="special">&gt;,</span>
<span class="keyword">typename</span> <span class="identifier">Allocator</span> <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">allocator</span><span class="special">&lt;</span><span class="identifier">Value</span><span class="special">&gt;&gt;</span>
<span class="keyword">class</span> <span class="identifier">rtree</span>
<span class="special">{</span>
<span class="comment">// ...</span>
<span class="special">};</span>
</pre>
<p>
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.h3"></a>
<span class="phrase"><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.h4"></a>
<span class="phrase"><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>
<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>
<code class="computeroutput"><span class="identifier">parameters_type</span></code>
</p>
</td>
<td>
<p>
R-tree parameters type.
</p>
</td>
</tr>
<tr>
<td>
<p>
<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>
<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>
<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>
<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>
<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.h5"></a>
<span class="phrase"><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#geometry_index.r_tree.reference.boost_geometry_index_rtree.member0" title="rtree()"><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#geometry_index.r_tree.reference.boost_geometry_index_rtree.member1" title="rtree(parameters_type, translator_type const &amp;, allocator_type)"><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">&amp;,</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#geometry_index.r_tree.reference.boost_geometry_index_rtree.member2" title="rtree(Iterator, Iterator)"><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#geometry_index.r_tree.reference.boost_geometry_index_rtree.member3" title="rtree(Range const &amp;)"><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">&amp;)</span></code></a>
</p>
</td>
<td>
<p>
The constructor.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member4" title="~rtree()"><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#geometry_index.r_tree.reference.boost_geometry_index_rtree.member5" title="rtree(rtree const &amp;)"><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">&amp;)</span></code></a>
</p>
</td>
<td>
<p>
The copy constructor.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member6" title="rtree(rtree const &amp;, allocator_type const &amp;)"><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">&amp;,</span> <span class="identifier">allocator_type</span>
<span class="keyword">const</span> <span class="special">&amp;)</span></code></a>
</p>
</td>
<td>
<p>
The copy constructor.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member7" title="rtree(rtree &amp;&amp;)"><code class="computeroutput"><span class="identifier">rtree</span><span class="special">(</span><span class="identifier">rtree</span> <span class="special">&amp;&amp;)</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.h6"></a>
<span class="phrase"><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#geometry_index.r_tree.reference.boost_geometry_index_rtree.member8" title="operator=(const rtree &amp;)"><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">&amp;)</span></code></a>
</p>
</td>
<td>
<p>
The assignment operator.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member9" title="operator=(rtree &amp;&amp;)"><code class="computeroutput"><span class="keyword">operator</span><span class="special">=(</span><span class="identifier">rtree</span> <span class="special">&amp;&amp;)</span></code></a>
</p>
</td>
<td>
<p>
The moving assignment.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member10" title="swap(rtree &amp;)"><code class="computeroutput"><span class="identifier">swap</span><span class="special">(</span><span class="identifier">rtree</span> <span class="special">&amp;)</span></code></a>
</p>
</td>
<td>
<p>
Swaps contents of two rtrees.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member11" title="insert(value_type const &amp;)"><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">&amp;)</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#geometry_index.r_tree.reference.boost_geometry_index_rtree.member12" title="insert(Iterator, Iterator)"><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#geometry_index.r_tree.reference.boost_geometry_index_rtree.member13" title="insert(Range const &amp;)"><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">&amp;)</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#geometry_index.r_tree.reference.boost_geometry_index_rtree.member14" title="remove(value_type const &amp;)"><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">&amp;)</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#geometry_index.r_tree.reference.boost_geometry_index_rtree.member15" title="remove(Iterator, Iterator)"><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#geometry_index.r_tree.reference.boost_geometry_index_rtree.member16" title="remove(Range const &amp;)"><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">&amp;)</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#geometry_index.r_tree.reference.boost_geometry_index_rtree.member17" title="spatial_query(Predicates const &amp;, OutIter)"><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">&amp;,</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#geometry_index.r_tree.reference.boost_geometry_index_rtree.member18" title="nearest_query(DistancesPredicates const &amp;, value_type &amp;)"><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">&amp;,</span> <span class="identifier">value_type</span>
<span class="special">&amp;)</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#geometry_index.r_tree.reference.boost_geometry_index_rtree.member19" title="nearest_query(DistancesPredicates const &amp;, Predicates const &amp;, value_type &amp;)"><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">&amp;,</span> <span class="identifier">Predicates</span>
<span class="keyword">const</span> <span class="special">&amp;,</span>
<span class="identifier">value_type</span> <span class="special">&amp;)</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#geometry_index.r_tree.reference.boost_geometry_index_rtree.member20" title="nearest_query(DistancesPredicates const &amp;, size_t, OutIter)"><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">&amp;,</span> <span class="identifier">size_t</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#geometry_index.r_tree.reference.boost_geometry_index_rtree.member21" title="nearest_query(DistancesPredicates const &amp;, size_t, Predicates const &amp;, OutIter)"><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">&amp;,</span> <span class="identifier">size_t</span><span class="special">,</span> <span class="identifier">Predicates</span>
<span class="keyword">const</span> <span class="special">&amp;,</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#geometry_index.r_tree.reference.boost_geometry_index_rtree.member22" title="size()"><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#geometry_index.r_tree.reference.boost_geometry_index_rtree.member23" title="empty()"><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#geometry_index.r_tree.reference.boost_geometry_index_rtree.member24" title="clear()"><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#geometry_index.r_tree.reference.boost_geometry_index_rtree.member25" title="box()"><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#geometry_index.r_tree.reference.boost_geometry_index_rtree.member26" title="count(ValueOrIndexable const &amp;)"><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">&amp;)</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#geometry_index.r_tree.reference.boost_geometry_index_rtree.member27" title="parameters()"><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#geometry_index.r_tree.reference.boost_geometry_index_rtree.member28" title="translator()"><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#geometry_index.r_tree.reference.boost_geometry_index_rtree.member29" title="get_allocator()"><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>
<p>
<br>
</p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member0"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member0" title="rtree()">rtree()</a>
</h5></div></div></div>
<p>
The constructor.
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member0.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member0.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member0.synopsis">Synopsis</a>
</h6>
<p>
</p>
<pre class="programlisting"><span class="identifier">rtree</span><span class="special">(</span><span class="identifier">parameters_type</span> <span class="identifier">parameters</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">&amp;</span> <span class="identifier">translator</span> <span class="special">=</span> <span class="identifier">translator_type</span><span class="special">())</span></pre>
<p>
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member0.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member0.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member0.parameters">Parameters</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">parameters_type</span></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="computeroutput"><span class="identifier">translator_type</span> <span class="keyword">const</span> <span class="special">&amp;</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.member0.h2"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member0.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member0.throws">Throws</a>
</h6>
<p>
If allocator default constructor throws.
</p>
</div>
<p>
<br>
</p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member1"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member1" title="rtree(parameters_type, translator_type const &amp;, allocator_type)">rtree(parameters_type,
translator_type const &amp;, allocator_type)</a>
</h5></div></div></div>
<p>
The constructor.
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member1.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member1.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member1.synopsis">Synopsis</a>
</h6>
<p>
</p>
<pre class="programlisting"><span class="identifier">rtree</span><span class="special">(</span><span class="identifier">parameters_type</span> <span class="identifier">parameters</span><span class="special">,</span>
<span class="identifier">translator_type</span> <span class="keyword">const</span> <span class="special">&amp;</span> <span class="identifier">translator</span><span class="special">,</span>
<span class="identifier">allocator_type</span> <span class="identifier">allocator</span><span class="special">)</span></pre>
<p>
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member1.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member1.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member1.parameters">Parameters</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">parameters_type</span></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="computeroutput"><span class="identifier">translator_type</span> <span class="keyword">const</span> <span class="special">&amp;</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="computeroutput"><span class="identifier">allocator_type</span></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.member1.h2"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member1.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member1.throws">Throws</a>
</h6>
<p>
If allocator copy constructor throws.
</p>
</div>
<p>
<br>
</p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member2"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member2" 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.member2.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member2.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member2.synopsis">Synopsis</a>
</h6>
<p>
</p>
<pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">Iterator</span><span class="special">&gt;</span>
<span class="identifier">rtree</span><span class="special">(</span><span class="identifier">Iterator</span> <span class="identifier">first</span><span class="special">,</span>
<span class="identifier">Iterator</span> <span class="identifier">last</span><span class="special">,</span>
<span class="identifier">parameters_type</span> <span class="identifier">parameters</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">&amp;</span> <span class="identifier">translator</span> <span class="special">=</span> <span class="identifier">translator_type</span><span class="special">(),</span>
<span class="identifier">allocator_type</span> <span class="identifier">allocator</span> <span class="special">=</span> <span class="identifier">allocator_type</span><span class="special">())</span></pre>
<p>
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member2.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member2.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member2.parameters">Parameters</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="computeroutput"><span class="identifier">parameters_type</span></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="computeroutput"><span class="identifier">translator_type</span> <span class="keyword">const</span> <span class="special">&amp;</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="computeroutput"><span class="identifier">allocator_type</span></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.member2.h2"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member2.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member2.throws">Throws</a>
</h6>
<p>
If allocator copy constructor throws. If Value copy constructor or copy
assignment throws. When nodes allocation fails.
</p>
</div>
<p>
<br>
</p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member3"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member3" title="rtree(Range const &amp;)">rtree(Range
const &amp;)</a>
</h5></div></div></div>
<p>
The constructor.
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member3.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member3.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member3.synopsis">Synopsis</a>
</h6>
<p>
</p>
<pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">Range</span><span class="special">&gt;</span>
<span class="identifier">rtree</span><span class="special">(</span><span class="identifier">Range</span> <span class="keyword">const</span> <span class="special">&amp;</span> <span class="identifier">rng</span><span class="special">,</span>
<span class="identifier">parameters_type</span> <span class="identifier">parameters</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">&amp;</span> <span class="identifier">translator</span> <span class="special">=</span> <span class="identifier">translator_type</span><span class="special">(),</span>
<span class="identifier">allocator_type</span> <span class="identifier">allocator</span> <span class="special">=</span> <span class="identifier">allocator_type</span><span class="special">())</span></pre>
<p>
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member3.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member3.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member3.parameters">Parameters</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">&amp;</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="computeroutput"><span class="identifier">parameters_type</span></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="computeroutput"><span class="identifier">translator_type</span> <span class="keyword">const</span> <span class="special">&amp;</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="computeroutput"><span class="identifier">allocator_type</span></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.member3.h2"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member3.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member3.throws">Throws</a>
</h6>
<p>
If allocator copy constructor throws. If Value copy constructor or copy
assignment throws. When nodes allocation fails.
</p>
</div>
<p>
<br>
</p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member4"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member4" title="~rtree()">~rtree()</a>
</h5></div></div></div>
<p>
The destructor.
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member4.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member4.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member4.synopsis">Synopsis</a>
</h6>
<p>
</p>
<pre class="programlisting"><span class="special">~</span><span class="identifier">rtree</span><span class="special">()</span></pre>
<p>
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member4.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member4.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member4.throws">Throws</a>
</h6>
<p>
Nothing.
</p>
</div>
<p>
<br>
</p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member5"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member5" title="rtree(rtree const &amp;)">rtree(rtree
const &amp;)</a>
</h5></div></div></div>
<p>
The copy constructor.
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member5.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member5.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member5.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.member5.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member5.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member5.synopsis">Synopsis</a>
</h6>
<p>
</p>
<pre class="programlisting"><span class="identifier">rtree</span><span class="special">(</span><span class="identifier">rtree</span> <span class="keyword">const</span> <span class="special">&amp;</span> <span class="identifier">src</span><span class="special">)</span></pre>
<p>
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member5.h2"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member5.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member5.parameters">Parameters</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="keyword">const</span>
<span class="special">&amp;</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.member5.h3"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member5.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member5.throws">Throws</a>
</h6>
<p>
If allocator copy constructor throws. If Value copy constructor throws.
When nodes allocation fails.
</p>
</div>
<p>
<br>
</p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member6"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member6" title="rtree(rtree const &amp;, allocator_type const &amp;)">rtree(rtree
const &amp;, allocator_type const &amp;)</a>
</h5></div></div></div>
<p>
The copy constructor.
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member6.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member6.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member6.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.member6.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member6.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member6.synopsis">Synopsis</a>
</h6>
<p>
</p>
<pre class="programlisting"><span class="identifier">rtree</span><span class="special">(</span><span class="identifier">rtree</span> <span class="keyword">const</span> <span class="special">&amp;</span> <span class="identifier">src</span><span class="special">,</span> <span class="identifier">allocator_type</span> <span class="keyword">const</span> <span class="special">&amp;</span> <span class="identifier">allocator</span><span class="special">)</span></pre>
<p>
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member6.h2"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member6.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member6.parameters">Parameters</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="keyword">const</span>
<span class="special">&amp;</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="computeroutput"><span class="identifier">allocator_type</span> <span class="keyword">const</span> <span class="special">&amp;</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.member6.h3"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member6.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member6.throws">Throws</a>
</h6>
<p>
If allocator copy constructor throws. If Value copy constructor throws.
When nodes allocation fails.
</p>
</div>
<p>
<br>
</p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member7"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member7" title="rtree(rtree &amp;&amp;)">rtree(rtree
&amp;&amp;)</a>
</h5></div></div></div>
<p>
The moving constructor.
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member7.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member7.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member7.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.member7.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member7.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member7.synopsis">Synopsis</a>
</h6>
<p>
</p>
<pre class="programlisting"><span class="identifier">rtree</span><span class="special">(</span><span class="identifier">rtree</span> <span class="special">&amp;&amp;</span> <span class="identifier">src</span><span class="special">)</span></pre>
<p>
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member7.h2"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member7.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member7.parameters">Parameters</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">&amp;&amp;</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.member7.h3"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member7.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member7.throws">Throws</a>
</h6>
<p>
If allocator move constructor throws.
</p>
</div>
<p>
<br>
</p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member8"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member8" title="operator=(const rtree &amp;)">operator=(const
rtree &amp;)</a>
</h5></div></div></div>
<p>
The assignment operator.
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member8.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member8.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member8.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.member8.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member8.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member8.synopsis">Synopsis</a>
</h6>
<p>
</p>
<pre class="programlisting"><span class="identifier">rtree</span> <span class="special">&amp;</span> <span class="keyword">operator</span><span class="special">=(</span><span class="keyword">const</span> <span class="identifier">rtree</span> <span class="special">&amp;</span> <span class="identifier">src</span><span class="special">)</span></pre>
<p>
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member8.h2"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member8.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member8.parameters">Parameters</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> <span class="identifier">rtree</span>
<span class="special">&amp;</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.member8.h3"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member8.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member8.throws">Throws</a>
</h6>
<p>
If Value copy constructor throws. When nodes allocation fails.
</p>
</div>
<p>
<br>
</p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member9"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member9" title="operator=(rtree &amp;&amp;)">operator=(rtree
&amp;&amp;)</a>
</h5></div></div></div>
<p>
The moving assignment.
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member9.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member9.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member9.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.member9.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member9.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member9.synopsis">Synopsis</a>
</h6>
<p>
</p>
<pre class="programlisting"><span class="identifier">rtree</span> <span class="special">&amp;</span> <span class="keyword">operator</span><span class="special">=(</span><span class="identifier">rtree</span> <span class="special">&amp;&amp;</span> <span class="identifier">src</span><span class="special">)</span></pre>
<p>
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member9.h2"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member9.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member9.parameters">Parameters</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">&amp;&amp;</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.member9.h3"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member9.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member9.throws">Throws</a>
</h6>
<p>
Only if allocators aren't equal. If Value copy constructor throws. When
nodes allocation fails.
</p>
</div>
<p>
<br>
</p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member10"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member10" title="swap(rtree &amp;)">swap(rtree
&amp;)</a>
</h5></div></div></div>
<p>
Swaps contents of two rtrees.
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member10.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member10.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member10.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.member10.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member10.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member10.synopsis">Synopsis</a>
</h6>
<p>
</p>
<pre class="programlisting"><span class="keyword">void</span> <span class="identifier">swap</span><span class="special">(</span><span class="identifier">rtree</span> <span class="special">&amp;</span> <span class="identifier">other</span><span class="special">)</span></pre>
<p>
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member10.h2"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member10.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member10.parameters">Parameters</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">&amp;</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.member10.h3"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member10.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member10.throws">Throws</a>
</h6>
<p>
If allocators swap throws.
</p>
</div>
<p>
<br>
</p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member11"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member11" title="insert(value_type const &amp;)">insert(value_type
const &amp;)</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.member11.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member11.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member11.synopsis">Synopsis</a>
</h6>
<p>
</p>
<pre class="programlisting"><span class="keyword">void</span> <span class="identifier">insert</span><span class="special">(</span><span class="identifier">value_type</span> <span class="keyword">const</span> <span class="special">&amp;</span> <span class="identifier">value</span><span class="special">)</span></pre>
<p>
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member11.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member11.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member11.parameters">Parameters</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">value_type</span> <span class="keyword">const</span> <span class="special">&amp;</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.member11.h2"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member11.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member11.throws">Throws</a>
</h6>
<p>
If Value copy constructor or copy assignment throws. When nodes allocation
fails.
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member11.h3"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member11.exception_safety"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member11.exception_safety">Exception-safety</a>
</h6>
<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>
</div>
<p>
<br>
</p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member12"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member12" 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.member12.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member12.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member12.synopsis">Synopsis</a>
</h6>
<p>
</p>
<pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">Iterator</span><span class="special">&gt;</span>
<span class="keyword">void</span> <span class="identifier">insert</span><span class="special">(</span><span class="identifier">Iterator</span> <span class="identifier">first</span><span class="special">,</span> <span class="identifier">Iterator</span> <span class="identifier">last</span><span class="special">)</span></pre>
<p>
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member12.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member12.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member12.parameters">Parameters</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.member12.h2"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member12.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member12.throws">Throws</a>
</h6>
<p>
If Value copy constructor or copy assignment throws. When nodes allocation
fails.
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member12.h3"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member12.exception_safety"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member12.exception_safety">Exception-safety</a>
</h6>
<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>
</div>
<p>
<br>
</p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member13"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member13" title="insert(Range const &amp;)">insert(Range
const &amp;)</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.member13.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member13.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member13.synopsis">Synopsis</a>
</h6>
<p>
</p>
<pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">Range</span><span class="special">&gt;</span>
<span class="keyword">void</span> <span class="identifier">insert</span><span class="special">(</span><span class="identifier">Range</span> <span class="keyword">const</span> <span class="special">&amp;</span> <span class="identifier">rng</span><span class="special">)</span></pre>
<p>
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member13.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member13.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member13.parameters">Parameters</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">&amp;</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.member13.h2"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member13.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member13.throws">Throws</a>
</h6>
<p>
If Value copy constructor or copy assignment throws. When nodes allocation
fails.
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member13.h3"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member13.exception_safety"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member13.exception_safety">Exception-safety</a>
</h6>
<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>
</div>
<p>
<br>
</p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member14"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member14" title="remove(value_type const &amp;)">remove(value_type
const &amp;)</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.member14.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member14.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member14.description">Description</a>
</h6>
<p>
In contrast to the STL set/map erase() method this method removes only
one value from the container.
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member14.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member14.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member14.synopsis">Synopsis</a>
</h6>
<p>
</p>
<pre class="programlisting"><span class="identifier">size_type</span> <span class="identifier">remove</span><span class="special">(</span><span class="identifier">value_type</span> <span class="keyword">const</span> <span class="special">&amp;</span> <span class="identifier">value</span><span class="special">)</span></pre>
<p>
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member14.h2"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member14.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member14.parameters">Parameters</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">value_type</span> <span class="keyword">const</span> <span class="special">&amp;</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.member14.h3"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member14.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member14.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.member14.h4"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member14.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member14.throws">Throws</a>
</h6>
<p>
If Value copy constructor or copy assignment throws. When nodes allocation
fails.
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member14.h5"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member14.exception_safety"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member14.exception_safety">Exception-safety</a>
</h6>
<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>
</div>
<p>
<br>
</p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member15"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member15" 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.member15.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member15.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member15.description">Description</a>
</h6>
<p>
In contrast to the STL set/map erase() 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.member15.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member15.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member15.synopsis">Synopsis</a>
</h6>
<p>
</p>
<pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">Iterator</span><span class="special">&gt;</span>
<span class="identifier">size_type</span> <span class="identifier">remove</span><span class="special">(</span><span class="identifier">Iterator</span> <span class="identifier">first</span><span class="special">,</span> <span class="identifier">Iterator</span> <span class="identifier">last</span><span class="special">)</span></pre>
<p>
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member15.h2"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member15.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member15.parameters">Parameters</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.member15.h3"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member15.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member15.returns">Returns</a>
</h6>
<p>
The number of removed values.
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member15.h4"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member15.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member15.throws">Throws</a>
</h6>
<p>
If Value copy constructor or copy assignment throws. When nodes allocation
fails.
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member15.h5"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member15.exception_safety"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member15.exception_safety">Exception-safety</a>
</h6>
<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>
</div>
<p>
<br>
</p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member16"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member16" title="remove(Range const &amp;)">remove(Range
const &amp;)</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.member16.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member16.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member16.description">Description</a>
</h6>
<p>
In contrast to the STL set/map erase() 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.member16.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member16.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member16.synopsis">Synopsis</a>
</h6>
<p>
</p>
<pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">Range</span><span class="special">&gt;</span>
<span class="identifier">size_type</span> <span class="identifier">remove</span><span class="special">(</span><span class="identifier">Range</span> <span class="keyword">const</span> <span class="special">&amp;</span> <span class="identifier">rng</span><span class="special">)</span></pre>
<p>
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member16.h2"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member16.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member16.parameters">Parameters</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">&amp;</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.member16.h3"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member16.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member16.returns">Returns</a>
</h6>
<p>
The number of removed values.
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member16.h4"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member16.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member16.throws">Throws</a>
</h6>
<p>
If Value copy constructor or copy assignment throws. When nodes allocation
fails.
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member16.h5"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member16.exception_safety"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member16.exception_safety">Exception-safety</a>
</h6>
<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>
</div>
<p>
<br>
</p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member17"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member17" title="spatial_query(Predicates const &amp;, OutIter)">spatial_query(Predicates
const &amp;, 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.member17.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member17.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member17.description">Description</a>
</h6>
<p>
Spatial predicates may be a Geometry (in this case default predicate
- intersects is used) or generated by bgi::covered_by(geometry), bgi::disjoint(geometry),
bgi::intersects(geometry), bgi::overlaps(geometry), bgi::within(geometry),
!bgi::covered_by(geometry), !bgi::disjoint(geometry), !bgi::intersects(geometry),
!bgi::overlaps(geometry), !bgi::within(geometry) or bgi::value(func).
Those predicates may be passed together in std::pair or boost::tuple.
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member17.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member17.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member17.synopsis">Synopsis</a>
</h6>
<p>
</p>
<pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">Predicates</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">OutIter</span><span class="special">&gt;</span>
<span class="identifier">size_type</span> <span class="identifier">spatial_query</span><span class="special">(</span><span class="identifier">Predicates</span> <span class="keyword">const</span> <span class="special">&amp;</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></pre>
<p>
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member17.h2"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member17.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member17.parameters">Parameters</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Type
</p>
</th>
<th>
<p>
Name
</p>
</th>
<th>
<p>
Description
</p>
</th>
</tr></thead>
<tbody>
<tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">Predicates</span> <span class="keyword">const</span> <span class="special">&amp;</span></code>
</p>
</td>
<td>
<p>
<code class="computeroutput"><span class="identifier">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.member17.h3"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member17.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member17.returns">Returns</a>
</h6>
<p>
The number of values found.
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member17.h4"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member17.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member17.throws">Throws</a>
</h6>
<p>
If Value copy constructor or copy assignment throws. If OutIter dereference
or increment throws.
</p>
</div>
<p>
<br>
</p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member18"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member18" title="nearest_query(DistancesPredicates const &amp;, value_type &amp;)">nearest_query(DistancesPredicates
const &amp;, value_type &amp;)</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.member18.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member18.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member18.description">Description</a>
</h6>
<p>
The distances predicates may be a Point. This is default case where Value
which nearest point is closest to Point is returned. May be a PointRelation
which define how distance to Value is calculated. This may be generated
by bgi::to_nearest(Point), bgi::to_centroid(Point) or bgi::to_furthest(Point).
DistancesPredicates may also define distances bounds. E.g. that some
distance must be between min_distance and max_distance. This may be generated
by bgi::unbounded(PointRelation) - default case, bgi::min_bounded(PointRelation,
MinRelation), bgi::max_bounded(PointRelation, MaxRelation), bgi::bounded(PointRelation,
MinRelation, MaxRelation). MinRelation and MaxRelation describes bounds
and may be generated by bgi::to_nearest(dist_bound), bgi::to_centroid(dist_bound)
or bgi::to_furthest(dist_bound).
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member18.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member18.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member18.synopsis">Synopsis</a>
</h6>
<p>
</p>
<pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">DistancesPredicates</span><span class="special">&gt;</span>
<span class="identifier">size_type</span> <span class="identifier">nearest_query</span><span class="special">(</span><span class="identifier">DistancesPredicates</span> <span class="keyword">const</span> <span class="special">&amp;</span> <span class="identifier">dpred</span><span class="special">,</span> <span class="identifier">value_type</span> <span class="special">&amp;</span> <span class="identifier">v</span><span class="special">)</span></pre>
<p>
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member18.h2"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member18.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member18.parameters">Parameters</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">&amp;</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">value_type</span> <span class="special">&amp;</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.member18.h3"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member18.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member18.returns">Returns</a>
</h6>
<p>
The number of values found.
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member18.h4"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member18.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member18.throws">Throws</a>
</h6>
<p>
If Value copy constructor or copy assignment throws.
</p>
</div>
<p>
<br>
</p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member19"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member19" title="nearest_query(DistancesPredicates const &amp;, Predicates const &amp;, value_type &amp;)">nearest_query(DistancesPredicates
const &amp;, Predicates const &amp;, value_type &amp;)</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.member19.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member19.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member19.description">Description</a>
</h6>
<p>
The distances predicates may be a Point. This is default case where Value
which nearest point is closest to Point is returned. May be a PointRelation
which define how distance to Value is calculated. This may be generated
by bgi::to_nearest(Point), bgi::to_centroid(Point) or bgi::to_furthest(Point).
DistancesPredicates may also define distances bounds. E.g. that some
distance must be between min_distance and max_distance. This may be generated
by bgi::unbounded(PointRelation) - default case, bgi::min_bounded(PointRelation,
MinRelation), bgi::max_bounded(PointRelation, MaxRelation), bgi::bounded(PointRelation,
MinRelation, MaxRelation). MinRelation and MaxRelation describes bounds
and may be generated by bgi::to_nearest(dist_bound), bgi::to_centroid(dist_bound)
or bgi::to_furthest(dist_bound).
</p>
<p>
The spatial predicates. May be a Geometry (in this case default predicate
- intersects is used) or generated by bgi::covered_by(geometry), bgi::disjoint(geometry),
bgi::intersects(geometry), bgi::overlaps(geometry), bgi::within(geometry),
!bgi::covered_by(geometry), !bgi::disjoint(geometry), !bgi::intersects(geometry),
!bgi::overlaps(geometry), !bgi::within(geometry) or bgi::value(func).
Those predicates may be passed together in std::pair or boost::tuple.
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member19.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member19.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member19.synopsis">Synopsis</a>
</h6>
<p>
</p>
<pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">DistancesPredicates</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">Predicates</span><span class="special">&gt;</span>
<span class="identifier">size_type</span> <span class="identifier">nearest_query</span><span class="special">(</span><span class="identifier">DistancesPredicates</span> <span class="keyword">const</span> <span class="special">&amp;</span> <span class="identifier">dpred</span><span class="special">,</span>
<span class="identifier">Predicates</span> <span class="keyword">const</span> <span class="special">&amp;</span> <span class="identifier">pred</span><span class="special">,</span>
<span class="identifier">value_type</span> <span class="special">&amp;</span> <span class="identifier">v</span><span class="special">)</span></pre>
<p>
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member19.h2"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member19.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member19.parameters">Parameters</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">&amp;</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">&amp;</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">value_type</span> <span class="special">&amp;</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.member19.h3"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member19.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member19.returns">Returns</a>
</h6>
<p>
The number of values found.
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member19.h4"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member19.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member19.throws">Throws</a>
</h6>
<p>
If Value copy constructor or copy assignment throws.
</p>
</div>
<p>
<br>
</p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member20"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member20" title="nearest_query(DistancesPredicates const &amp;, size_t, OutIter)">nearest_query(DistancesPredicates
const &amp;, size_t, 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.member20.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member20.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member20.description">Description</a>
</h6>
<p>
The distances predicates. May be a Point. This is default case where
Value which nearest point is closest to Point is returned. May be a PointRelation
which define how distance to Value is calculated. This may be generated
by bgi::to_nearest(Point), bgi::to_centroid(Point) or bgi::to_furthest(Point).
DistancesPredicates may also define distances bounds. E.g. that some
distance must be between min_distance and max_distance. This may be generated
by bgi::unbounded(PointRelation) - default case, bgi::min_bounded(PointRelation,
MinRelation), bgi::max_bounded(PointRelation, MaxRelation), bgi::bounded(PointRelation,
MinRelation, MaxRelation). MinRelation and MaxRelation describes bounds
and may be generated by bgi::to_nearest(dist_bound), bgi::to_centroid(dist_bound)
or bgi::to_furthest(dist_bound).
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member20.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member20.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member20.synopsis">Synopsis</a>
</h6>
<p>
</p>
<pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">DistancesPredicates</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">OutIter</span><span class="special">&gt;</span>
<span class="identifier">size_type</span> <span class="identifier">nearest_query</span><span class="special">(</span><span class="identifier">DistancesPredicates</span> <span class="keyword">const</span> <span class="special">&amp;</span> <span class="identifier">dpred</span><span class="special">,</span>
<span class="identifier">size_t</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></pre>
<p>
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member20.h2"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member20.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member20.parameters">Parameters</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">&amp;</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">size_t</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. E.g. a back_insert_iterator.
</p>
</td>
</tr>
</tbody>
</table></div>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member20.h3"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member20.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member20.returns">Returns</a>
</h6>
<p>
The number of values found.
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member20.h4"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member20.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member20.throws">Throws</a>
</h6>
<p>
If Value copy constructor or copy assignment throws. If OutIter dereference
or increment throws.
</p>
</div>
<p>
<br>
</p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member21"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member21" title="nearest_query(DistancesPredicates const &amp;, size_t, Predicates const &amp;, OutIter)">nearest_query(DistancesPredicates
const &amp;, size_t, Predicates const &amp;, 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.member21.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member21.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member21.description">Description</a>
</h6>
<p>
The distances predicates may be a Point. This is default case where Value
which nearest point is closest to Point is returned. May be a PointRelation
which define how distance to Value is calculated. This may be generated
by bgi::to_nearest(Point), bgi::to_centroid(Point) or bgi::to_furthest(Point).
DistancesPredicates may also define distances bounds. E.g. that some
distance must be between min_distance and max_distance. This may be generated
by bgi::unbounded(PointRelation) - default case, bgi::min_bounded(PointRelation,
MinRelation), bgi::max_bounded(PointRelation, MaxRelation), bgi::bounded(PointRelation,
MinRelation, MaxRelation). MinRelation and MaxRelation describes bounds
and may be generated by bgi::to_nearest(dist_bound), bgi::to_centroid(dist_bound)
or bgi::to_furthest(dist_bound).
</p>
<p>
The spatial predicates. May be a Geometry (in this case default predicate
- intersects is used) or generated by bgi::covered_by(geometry), bgi::disjoint(geometry),
bgi::intersects(geometry), bgi::overlaps(geometry), bgi::within(geometry),
!bgi::covered_by(geometry), !bgi::disjoint(geometry), !bgi::intersects(geometry),
!bgi::overlaps(geometry), !bgi::within(geometry) or bgi::value(func).
Those predicates may be passed together in std::pair or boost::tuple.
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member21.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member21.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member21.synopsis">Synopsis</a>
</h6>
<p>
</p>
<pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">DistancesPredicates</span><span class="special">,</span>
<span class="keyword">typename</span> <span class="identifier">Predicates</span><span class="special">,</span>
<span class="keyword">typename</span> <span class="identifier">OutIter</span><span class="special">&gt;</span>
<span class="identifier">size_type</span> <span class="identifier">nearest_query</span><span class="special">(</span><span class="identifier">DistancesPredicates</span> <span class="keyword">const</span> <span class="special">&amp;</span> <span class="identifier">dpred</span><span class="special">,</span>
<span class="identifier">size_t</span> <span class="identifier">k</span><span class="special">,</span>
<span class="identifier">Predicates</span> <span class="keyword">const</span> <span class="special">&amp;</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></pre>
<p>
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member21.h2"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member21.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member21.parameters">Parameters</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">&amp;</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">size_t</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">&amp;</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.member21.h3"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member21.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member21.returns">Returns</a>
</h6>
<p>
The number of values found.
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member21.h4"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member21.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member21.throws">Throws</a>
</h6>
<p>
If Value copy constructor or copy assignment throws. If OutIter dereference
or increment throws.
</p>
</div>
<p>
<br>
</p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member22"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member22" 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.member22.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member22.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member22.synopsis">Synopsis</a>
</h6>
<p>
</p>
<pre class="programlisting"><span class="identifier">size_type</span> <span class="identifier">size</span><span class="special">()</span></pre>
<p>
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member22.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member22.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member22.returns">Returns</a>
</h6>
<p>
The number of stored values.
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member22.h2"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member22.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member22.throws">Throws</a>
</h6>
<p>
Nothing.
</p>
</div>
<p>
<br>
</p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member23"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member23" 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.member23.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member23.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member23.synopsis">Synopsis</a>
</h6>
<p>
</p>
<pre class="programlisting"><span class="keyword">bool</span> <span class="identifier">empty</span><span class="special">()</span></pre>
<p>
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member23.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member23.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member23.returns">Returns</a>
</h6>
<p>
true if the container is empty.
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member23.h2"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member23.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member23.throws">Throws</a>
</h6>
<p>
Nothing.
</p>
</div>
<p>
<br>
</p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member24"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member24" 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.member24.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member24.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member24.synopsis">Synopsis</a>
</h6>
<p>
</p>
<pre class="programlisting"><span class="keyword">void</span> <span class="identifier">clear</span><span class="special">()</span></pre>
<p>
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member24.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member24.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member24.throws">Throws</a>
</h6>
<p>
Nothing.
</p>
</div>
<p>
<br>
</p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member25"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member25" 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.member25.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member25.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member25.description">Description</a>
</h6>
<p>
Returns the box containing all values stored in the container. If the
container is empty the result of geometry::assign_inverse() is returned.
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member25.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member25.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member25.synopsis">Synopsis</a>
</h6>
<p>
</p>
<pre class="programlisting"><span class="identifier">box_type</span> <span class="identifier">box</span><span class="special">()</span></pre>
<p>
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member25.h2"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member25.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member25.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.member25.h3"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member25.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member25.throws">Throws</a>
</h6>
<p>
Nothing.
</p>
</div>
<p>
<br>
</p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member26"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member26" title="count(ValueOrIndexable const &amp;)">count(ValueOrIndexable
const &amp;)</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.member26.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member26.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member26.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.member26.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member26.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member26.synopsis">Synopsis</a>
</h6>
<p>
</p>
<pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">ValueOrIndexable</span><span class="special">&gt;</span>
<span class="identifier">size_type</span> <span class="identifier">count</span><span class="special">(</span><span class="identifier">ValueOrIndexable</span> <span class="keyword">const</span> <span class="special">&amp;</span> <span class="identifier">vori</span><span class="special">)</span></pre>
<p>
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member26.h2"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member26.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member26.parameters">Parameters</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">&amp;</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.member26.h3"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member26.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member26.returns">Returns</a>
</h6>
<p>
The number of values found.
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member26.h4"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member26.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member26.throws">Throws</a>
</h6>
<p>
Nothing.
</p>
</div>
<p>
<br>
</p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member27"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member27" title="parameters()">parameters()</a>
</h5></div></div></div>
<p>
Returns parameters.
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member27.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member27.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member27.synopsis">Synopsis</a>
</h6>
<p>
</p>
<pre class="programlisting"><span class="identifier">parameters_type</span> <span class="keyword">const</span> <span class="special">&amp;</span> <span class="identifier">parameters</span><span class="special">()</span></pre>
<p>
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member27.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member27.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member27.returns">Returns</a>
</h6>
<p>
The parameters object.
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member27.h2"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member27.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member27.throws">Throws</a>
</h6>
<p>
Nothing.
</p>
</div>
<p>
<br>
</p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member28"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member28" 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.member28.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member28.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member28.synopsis">Synopsis</a>
</h6>
<p>
</p>
<pre class="programlisting"><span class="identifier">translator_type</span> <span class="keyword">const</span> <span class="special">&amp;</span> <span class="identifier">translator</span><span class="special">()</span></pre>
<p>
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member28.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member28.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member28.returns">Returns</a>
</h6>
<p>
The translator object.
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member28.h2"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member28.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member28.throws">Throws</a>
</h6>
<p>
Nothing.
</p>
</div>
<p>
<br>
</p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member29"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member29" 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.member29.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member29.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member29.synopsis">Synopsis</a>
</h6>
<p>
</p>
<pre class="programlisting"><span class="identifier">allocator_type</span> <span class="identifier">get_allocator</span><span class="special">()</span></pre>
<p>
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member29.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member29.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member29.returns">Returns</a>
</h6>
<p>
The allocator.
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member29.h2"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member29.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member29.throws">Throws</a>
</h6>
<p>
If allocator copy constructor throws.
</p>
</div>
<p>
<br>
</p>
</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 (boost::geometry::index::)">Functions
related to the rtree (boost::geometry::index::)</a>
</h4></div></div></div>
<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#geometry_index.r_tree.reference.group__rtree__functions.function0" title="insert(rtree&lt;...&gt; &amp;, Value const &amp;)"><code class="computeroutput"><span class="identifier">insert</span><span class="special">(</span><span class="identifier">rtree</span><span class="special">&lt;...&gt;</span>
<span class="special">&amp;,</span> <span class="identifier">Value</span>
<span class="keyword">const</span> <span class="special">&amp;)</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#geometry_index.r_tree.reference.group__rtree__functions.function1" title="insert(rtree&lt;...&gt; &amp;, Iterator, Iterator)"><code class="computeroutput"><span class="identifier">insert</span><span class="special">(</span><span class="identifier">rtree</span><span class="special">&lt;...&gt;</span>
<span class="special">&amp;,</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#geometry_index.r_tree.reference.group__rtree__functions.function2" title="insert(rtree&lt;...&gt; &amp;, Range const &amp;)"><code class="computeroutput"><span class="identifier">insert</span><span class="special">(</span><span class="identifier">rtree</span><span class="special">&lt;...&gt;</span>
<span class="special">&amp;,</span> <span class="identifier">Range</span>
<span class="keyword">const</span> <span class="special">&amp;)</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#geometry_index.r_tree.reference.group__rtree__functions.function3" title="remove(rtree&lt;...&gt; &amp;, Value const &amp;)"><code class="computeroutput"><span class="identifier">remove</span><span class="special">(</span><span class="identifier">rtree</span><span class="special">&lt;...&gt;</span>
<span class="special">&amp;,</span> <span class="identifier">Value</span>
<span class="keyword">const</span> <span class="special">&amp;)</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#geometry_index.r_tree.reference.group__rtree__functions.function4" title="remove(rtree&lt;...&gt; &amp;, Iterator, Iterator)"><code class="computeroutput"><span class="identifier">remove</span><span class="special">(</span><span class="identifier">rtree</span><span class="special">&lt;...&gt;</span>
<span class="special">&amp;,</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#geometry_index.r_tree.reference.group__rtree__functions.function5" title="remove(rtree&lt;...&gt; &amp;, Range const &amp;)"><code class="computeroutput"><span class="identifier">remove</span><span class="special">(</span><span class="identifier">rtree</span><span class="special">&lt;...&gt;</span>
<span class="special">&amp;,</span> <span class="identifier">Range</span>
<span class="keyword">const</span> <span class="special">&amp;)</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#geometry_index.r_tree.reference.group__rtree__functions.function6" title="spatial_query(rtree&lt;...&gt; const &amp;, Predicates const &amp;, OutIter)"><code class="computeroutput"><span class="identifier">spatial_query</span><span class="special">(</span><span class="identifier">rtree</span><span class="special">&lt;...&gt;</span>
<span class="keyword">const</span> <span class="special">&amp;,</span>
<span class="identifier">Predicates</span> <span class="keyword">const</span>
<span class="special">&amp;,</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#geometry_index.r_tree.reference.group__rtree__functions.function7" title="nearest_query(rtree&lt;...&gt; const &amp;, DistancesPredicates const &amp;, Value &amp;)"><code class="computeroutput"><span class="identifier">nearest_query</span><span class="special">(</span><span class="identifier">rtree</span><span class="special">&lt;...&gt;</span>
<span class="keyword">const</span> <span class="special">&amp;,</span>
<span class="identifier">DistancesPredicates</span> <span class="keyword">const</span> <span class="special">&amp;,</span>
<span class="identifier">Value</span> <span class="special">&amp;)</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#geometry_index.r_tree.reference.group__rtree__functions.function8" title="nearest_query(rtree&lt;...&gt; const &amp;, DistancesPredicates const &amp;, Predicates const &amp;, Value &amp;)"><code class="computeroutput"><span class="identifier">nearest_query</span><span class="special">(</span><span class="identifier">rtree</span><span class="special">&lt;...&gt;</span>
<span class="keyword">const</span> <span class="special">&amp;,</span>
<span class="identifier">DistancesPredicates</span> <span class="keyword">const</span> <span class="special">&amp;,</span>
<span class="identifier">Predicates</span> <span class="keyword">const</span>
<span class="special">&amp;,</span> <span class="identifier">Value</span>
<span class="special">&amp;)</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#geometry_index.r_tree.reference.group__rtree__functions.function9" title="nearest_query(rtree&lt;...&gt; const &amp;, DistancesPredicates const &amp;, size_t, OutIter)"><code class="computeroutput"><span class="identifier">nearest_query</span><span class="special">(</span><span class="identifier">rtree</span><span class="special">&lt;...&gt;</span>
<span class="keyword">const</span> <span class="special">&amp;,</span>
<span class="identifier">DistancesPredicates</span> <span class="keyword">const</span> <span class="special">&amp;,</span>
<span class="identifier">size_t</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#geometry_index.r_tree.reference.group__rtree__functions.function10" title="nearest_query(rtree&lt;...&gt; const &amp;, DistancesPredicates const &amp;, size_t, Predicates const &amp;, OutIter)"><code class="computeroutput"><span class="identifier">nearest_query</span><span class="special">(</span><span class="identifier">rtree</span><span class="special">&lt;...&gt;</span>
<span class="keyword">const</span> <span class="special">&amp;,</span>
<span class="identifier">DistancesPredicates</span> <span class="keyword">const</span> <span class="special">&amp;,</span>
<span class="identifier">size_t</span><span class="special">,</span>
<span class="identifier">Predicates</span> <span class="keyword">const</span>
<span class="special">&amp;,</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#geometry_index.r_tree.reference.group__rtree__functions.function11" title="clear(rtree&lt;...&gt; &amp;)"><code class="computeroutput"><span class="identifier">clear</span><span class="special">(</span><span class="identifier">rtree</span><span class="special">&lt;...&gt;</span>
<span class="special">&amp;)</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#geometry_index.r_tree.reference.group__rtree__functions.function12" title="size(rtree&lt;...&gt; const &amp;)"><code class="computeroutput"><span class="identifier">size</span><span class="special">(</span><span class="identifier">rtree</span><span class="special">&lt;...&gt;</span>
<span class="keyword">const</span> <span class="special">&amp;)</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#geometry_index.r_tree.reference.group__rtree__functions.function13" title="empty(rtree&lt;...&gt; const &amp;)"><code class="computeroutput"><span class="identifier">empty</span><span class="special">(</span><span class="identifier">rtree</span><span class="special">&lt;...&gt;</span>
<span class="keyword">const</span> <span class="special">&amp;)</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#geometry_index.r_tree.reference.group__rtree__functions.function14" title="box(rtree&lt;...&gt; const &amp;)"><code class="computeroutput"><span class="identifier">box</span><span class="special">(</span><span class="identifier">rtree</span><span class="special">&lt;...&gt;</span>
<span class="keyword">const</span> <span class="special">&amp;)</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.function0"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function0" title="insert(rtree&lt;...&gt; &amp;, Value const &amp;)">insert(rtree&lt;...&gt;
&amp;, Value const &amp;)</a>
</h5></div></div></div>
<p>
Insert a value to the index.
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__rtree__functions.function0.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.function0.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function0.synopsis">Synopsis</a>
</h6>
<p>
</p>
<pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">Value</span><span class="special">,</span>
<span class="keyword">typename</span> <span class="identifier">Options</span><span class="special">,</span>
<span class="keyword">typename</span> <span class="identifier">Translator</span><span class="special">,</span>
<span class="keyword">typename</span> <span class="identifier">Allocator</span><span class="special">&gt;</span>
<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><span class="special">(</span><span class="identifier">rtree</span><span class="special">&lt;</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">&gt;</span> <span class="special">&amp;</span> <span class="identifier">tree</span><span class="special">,</span> <span class="identifier">Value</span> <span class="keyword">const</span> <span class="special">&amp;</span> <span class="identifier">v</span><span class="special">)</span></pre>
<p>
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__rtree__functions.function0.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.function0.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function0.parameters">Parameters</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">&lt;</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">&gt;</span>
<span class="special">&amp;</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">&amp;</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>
<p>
<br>
</p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.group__rtree__functions.function1"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function1" title="insert(rtree&lt;...&gt; &amp;, Iterator, Iterator)">insert(rtree&lt;...&gt;
&amp;, 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.function1.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.function1.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function1.synopsis">Synopsis</a>
</h6>
<p>
</p>
<pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">Value</span><span class="special">,</span>
<span class="keyword">typename</span> <span class="identifier">Options</span><span class="special">,</span>
<span class="keyword">typename</span> <span class="identifier">Translator</span><span class="special">,</span>
<span class="keyword">typename</span> <span class="identifier">Allocator</span><span class="special">,</span>
<span class="keyword">typename</span> <span class="identifier">Iterator</span><span class="special">&gt;</span>
<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><span class="special">(</span><span class="identifier">rtree</span><span class="special">&lt;</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">&gt;</span> <span class="special">&amp;</span> <span class="identifier">tree</span><span class="special">,</span>
<span class="identifier">Iterator</span> <span class="identifier">first</span><span class="special">,</span>
<span class="identifier">Iterator</span> <span class="identifier">last</span><span class="special">)</span></pre>
<p>
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__rtree__functions.function1.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.function1.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function1.parameters">Parameters</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">&lt;</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">&gt;</span>
<span class="special">&amp;</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>
<p>
<br>
</p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.group__rtree__functions.function2"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function2" title="insert(rtree&lt;...&gt; &amp;, Range const &amp;)">insert(rtree&lt;...&gt;
&amp;, Range const &amp;)</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.function2.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.function2.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function2.synopsis">Synopsis</a>
</h6>
<p>
</p>
<pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">Value</span><span class="special">,</span>
<span class="keyword">typename</span> <span class="identifier">Options</span><span class="special">,</span>
<span class="keyword">typename</span> <span class="identifier">Translator</span><span class="special">,</span>
<span class="keyword">typename</span> <span class="identifier">Allocator</span><span class="special">,</span>
<span class="keyword">typename</span> <span class="identifier">Range</span><span class="special">&gt;</span>
<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><span class="special">(</span><span class="identifier">rtree</span><span class="special">&lt;</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">&gt;</span> <span class="special">&amp;</span> <span class="identifier">tree</span><span class="special">,</span> <span class="identifier">Range</span> <span class="keyword">const</span> <span class="special">&amp;</span> <span class="identifier">rng</span><span class="special">)</span></pre>
<p>
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__rtree__functions.function2.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.function2.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function2.parameters">Parameters</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">&lt;</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">&gt;</span>
<span class="special">&amp;</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">&amp;</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>
<p>
<br>
</p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.group__rtree__functions.function3"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function3" title="remove(rtree&lt;...&gt; &amp;, Value const &amp;)">remove(rtree&lt;...&gt;
&amp;, Value const &amp;)</a>
</h5></div></div></div>
<p>
Remove a value from the container.
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__rtree__functions.function3.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.function3.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function3.description">Description</a>
</h6>
<p>
Remove a value from the container. In contrast to the STL set/map erase()
method this function removes only one value from the container.
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__rtree__functions.function3.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.function3.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function3.synopsis">Synopsis</a>
</h6>
<p>
</p>
<pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">Value</span><span class="special">,</span>
<span class="keyword">typename</span> <span class="identifier">Options</span><span class="special">,</span>
<span class="keyword">typename</span> <span class="identifier">Translator</span><span class="special">,</span>
<span class="keyword">typename</span> <span class="identifier">Allocator</span><span class="special">&gt;</span>
<span class="identifier">rtree</span><span class="special">&lt;</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">&gt;::</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><span class="special">(</span><span class="identifier">rtree</span><span class="special">&lt;</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">&gt;</span> <span class="special">&amp;</span> <span class="identifier">tree</span><span class="special">,</span> <span class="identifier">Value</span> <span class="keyword">const</span> <span class="special">&amp;</span> <span class="identifier">v</span><span class="special">)</span></pre>
<p>
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__rtree__functions.function3.h2"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.function3.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function3.parameters">Parameters</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">&lt;</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">&gt;</span>
<span class="special">&amp;</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">&amp;</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.function3.h3"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.function3.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function3.returns">Returns</a>
</h6>
<p>
1 if value was removed, 0 otherwise.
</p>
</div>
<p>
<br>
</p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.group__rtree__functions.function4"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function4" title="remove(rtree&lt;...&gt; &amp;, Iterator, Iterator)">remove(rtree&lt;...&gt;
&amp;, 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.function4.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.function4.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function4.description">Description</a>
</h6>
<p>
Remove a range of values from the container. In contrast to the STL set/map
erase() 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>
<h6>
<a name="geometry_index.r_tree.reference.group__rtree__functions.function4.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.function4.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function4.synopsis">Synopsis</a>
</h6>
<p>
</p>
<pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">Value</span><span class="special">,</span>
<span class="keyword">typename</span> <span class="identifier">Options</span><span class="special">,</span>
<span class="keyword">typename</span> <span class="identifier">Translator</span><span class="special">,</span>
<span class="keyword">typename</span> <span class="identifier">Allocator</span><span class="special">,</span>
<span class="keyword">typename</span> <span class="identifier">Iterator</span><span class="special">&gt;</span>
<span class="identifier">rtree</span><span class="special">&lt;</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">&gt;::</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><span class="special">(</span><span class="identifier">rtree</span><span class="special">&lt;</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">&gt;</span> <span class="special">&amp;</span> <span class="identifier">tree</span><span class="special">,</span>
<span class="identifier">Iterator</span> <span class="identifier">first</span><span class="special">,</span>
<span class="identifier">Iterator</span> <span class="identifier">last</span><span class="special">)</span></pre>
<p>
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__rtree__functions.function4.h2"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.function4.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function4.parameters">Parameters</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">&lt;</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">&gt;</span>
<span class="special">&amp;</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.function4.h3"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.function4.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function4.returns">Returns</a>
</h6>
<p>
The number of removed values.
</p>
</div>
<p>
<br>
</p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.group__rtree__functions.function5"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function5" title="remove(rtree&lt;...&gt; &amp;, Range const &amp;)">remove(rtree&lt;...&gt;
&amp;, Range const &amp;)</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.function5.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.function5.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function5.description">Description</a>
</h6>
<p>
Remove a range of values from the container. In contrast to the STL set/map
erase() 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.group__rtree__functions.function5.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.function5.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function5.synopsis">Synopsis</a>
</h6>
<p>
</p>
<pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">Value</span><span class="special">,</span>
<span class="keyword">typename</span> <span class="identifier">Options</span><span class="special">,</span>
<span class="keyword">typename</span> <span class="identifier">Translator</span><span class="special">,</span>
<span class="keyword">typename</span> <span class="identifier">Allocator</span><span class="special">,</span>
<span class="keyword">typename</span> <span class="identifier">Range</span><span class="special">&gt;</span>
<span class="identifier">rtree</span><span class="special">&lt;</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">&gt;::</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><span class="special">(</span><span class="identifier">rtree</span><span class="special">&lt;</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">&gt;</span> <span class="special">&amp;</span> <span class="identifier">tree</span><span class="special">,</span> <span class="identifier">Range</span> <span class="keyword">const</span> <span class="special">&amp;</span> <span class="identifier">rng</span><span class="special">)</span></pre>
<p>
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__rtree__functions.function5.h2"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.function5.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function5.parameters">Parameters</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">&lt;</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">&gt;</span>
<span class="special">&amp;</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">&amp;</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.function5.h3"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.function5.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function5.returns">Returns</a>
</h6>
<p>
The number of removed values.
</p>
</div>
<p>
<br>
</p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.group__rtree__functions.function6"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function6" title="spatial_query(rtree&lt;...&gt; const &amp;, Predicates const &amp;, OutIter)">spatial_query(rtree&lt;...&gt;
const &amp;, Predicates const &amp;, OutIter)</a>
</h5></div></div></div>
<p>
Find values meeting spatial predicates.
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__rtree__functions.function6.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.function6.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function6.synopsis">Synopsis</a>
</h6>
<p>
</p>
<pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">Value</span><span class="special">,</span>
<span class="keyword">typename</span> <span class="identifier">Options</span><span class="special">,</span>
<span class="keyword">typename</span> <span class="identifier">Translator</span><span class="special">,</span>
<span class="keyword">typename</span> <span class="identifier">Allocator</span><span class="special">,</span>
<span class="keyword">typename</span> <span class="identifier">Predicates</span><span class="special">,</span>
<span class="keyword">typename</span> <span class="identifier">OutIter</span><span class="special">&gt;</span>
<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><span class="special">(</span><span class="identifier">rtree</span><span class="special">&lt;</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">&gt;</span> <span class="keyword">const</span> <span class="special">&amp;</span> <span class="identifier">tree</span><span class="special">,</span>
<span class="identifier">Predicates</span> <span class="keyword">const</span> <span class="special">&amp;</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></pre>
<p>
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__rtree__functions.function6.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.function6.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function6.parameters">Parameters</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">&lt;</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">&gt;</span>
<span class="keyword">const</span> <span class="special">&amp;</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">&amp;</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.function6.h2"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.function6.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function6.returns">Returns</a>
</h6>
<p>
The number of found values.
</p>
</div>
<p>
<br>
</p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.group__rtree__functions.function7"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function7" title="nearest_query(rtree&lt;...&gt; const &amp;, DistancesPredicates const &amp;, Value &amp;)">nearest_query(rtree&lt;...&gt;
const &amp;, DistancesPredicates const &amp;, Value &amp;)</a>
</h5></div></div></div>
<p>
Find the value meeting distances predicates.
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__rtree__functions.function7.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.function7.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function7.synopsis">Synopsis</a>
</h6>
<p>
</p>
<pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">Value</span><span class="special">,</span>
<span class="keyword">typename</span> <span class="identifier">Options</span><span class="special">,</span>
<span class="keyword">typename</span> <span class="identifier">Translator</span><span class="special">,</span>
<span class="keyword">typename</span> <span class="identifier">Allocator</span><span class="special">,</span>
<span class="keyword">typename</span> <span class="identifier">DistancesPredicates</span><span class="special">&gt;</span>
<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><span class="special">(</span><span class="identifier">rtree</span><span class="special">&lt;</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">&gt;</span> <span class="keyword">const</span> <span class="special">&amp;</span> <span class="identifier">tree</span><span class="special">,</span>
<span class="identifier">DistancesPredicates</span> <span class="keyword">const</span> <span class="special">&amp;</span> <span class="identifier">dpred</span><span class="special">,</span>
<span class="identifier">Value</span> <span class="special">&amp;</span> <span class="identifier">v</span><span class="special">)</span></pre>
<p>
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__rtree__functions.function7.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.function7.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function7.parameters">Parameters</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">&lt;</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">&gt;</span>
<span class="keyword">const</span> <span class="special">&amp;</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">&amp;</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">&amp;</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.function7.h2"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.function7.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function7.returns">Returns</a>
</h6>
<p>
The number of found values.
</p>
</div>
<p>
<br>
</p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.group__rtree__functions.function8"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function8" title="nearest_query(rtree&lt;...&gt; const &amp;, DistancesPredicates const &amp;, Predicates const &amp;, Value &amp;)">nearest_query(rtree&lt;...&gt;
const &amp;, DistancesPredicates const &amp;, Predicates const &amp;, Value
&amp;)</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.function8.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.function8.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function8.synopsis">Synopsis</a>
</h6>
<p>
</p>
<pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">Value</span><span class="special">,</span>
<span class="keyword">typename</span> <span class="identifier">Options</span><span class="special">,</span>
<span class="keyword">typename</span> <span class="identifier">Translator</span><span class="special">,</span>
<span class="keyword">typename</span> <span class="identifier">Allocator</span><span class="special">,</span>
<span class="keyword">typename</span> <span class="identifier">DistancesPredicates</span><span class="special">,</span>
<span class="keyword">typename</span> <span class="identifier">Predicates</span><span class="special">&gt;</span>
<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><span class="special">(</span><span class="identifier">rtree</span><span class="special">&lt;</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">&gt;</span> <span class="keyword">const</span> <span class="special">&amp;</span> <span class="identifier">tree</span><span class="special">,</span>
<span class="identifier">DistancesPredicates</span> <span class="keyword">const</span> <span class="special">&amp;</span> <span class="identifier">dpred</span><span class="special">,</span>
<span class="identifier">Predicates</span> <span class="keyword">const</span> <span class="special">&amp;</span> <span class="identifier">pred</span><span class="special">,</span>
<span class="identifier">Value</span> <span class="special">&amp;</span> <span class="identifier">v</span><span class="special">)</span></pre>
<p>
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__rtree__functions.function8.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.function8.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function8.parameters">Parameters</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">&lt;</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">&gt;</span>
<span class="keyword">const</span> <span class="special">&amp;</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">&amp;</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">&amp;</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">&amp;</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.function8.h2"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.function8.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function8.returns">Returns</a>
</h6>
<p>
The number of found values.
</p>
</div>
<p>
<br>
</p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.group__rtree__functions.function9"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function9" title="nearest_query(rtree&lt;...&gt; const &amp;, DistancesPredicates const &amp;, size_t, OutIter)">nearest_query(rtree&lt;...&gt;
const &amp;, DistancesPredicates const &amp;, size_t, 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.function9.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.function9.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function9.synopsis">Synopsis</a>
</h6>
<p>
</p>
<pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">Value</span><span class="special">,</span>
<span class="keyword">typename</span> <span class="identifier">Options</span><span class="special">,</span>
<span class="keyword">typename</span> <span class="identifier">Translator</span><span class="special">,</span>
<span class="keyword">typename</span> <span class="identifier">Allocator</span><span class="special">,</span>
<span class="keyword">typename</span> <span class="identifier">DistancesPredicates</span><span class="special">,</span>
<span class="keyword">typename</span> <span class="identifier">OutIter</span><span class="special">&gt;</span>
<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><span class="special">(</span><span class="identifier">rtree</span><span class="special">&lt;</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">&gt;</span> <span class="keyword">const</span> <span class="special">&amp;</span> <span class="identifier">tree</span><span class="special">,</span>
<span class="identifier">DistancesPredicates</span> <span class="keyword">const</span> <span class="special">&amp;</span> <span class="identifier">dpred</span><span class="special">,</span>
<span class="identifier">size_t</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></pre>
<p>
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__rtree__functions.function9.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.function9.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function9.parameters">Parameters</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">&lt;</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">&gt;</span>
<span class="keyword">const</span> <span class="special">&amp;</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">&amp;</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">size_t</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.function9.h2"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.function9.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function9.returns">Returns</a>
</h6>
<p>
The number of found values.
</p>
</div>
<p>
<br>
</p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.group__rtree__functions.function10"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function10" title="nearest_query(rtree&lt;...&gt; const &amp;, DistancesPredicates const &amp;, size_t, Predicates const &amp;, OutIter)">nearest_query(rtree&lt;...&gt;
const &amp;, DistancesPredicates const &amp;, size_t, Predicates const
&amp;, 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.function10.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.function10.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function10.synopsis">Synopsis</a>
</h6>
<p>
</p>
<pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">Value</span><span class="special">,</span>
<span class="keyword">typename</span> <span class="identifier">Options</span><span class="special">,</span>
<span class="keyword">typename</span> <span class="identifier">Translator</span><span class="special">,</span>
<span class="keyword">typename</span> <span class="identifier">Allocator</span><span class="special">,</span>
<span class="keyword">typename</span> <span class="identifier">DistancesPredicates</span><span class="special">,</span>
<span class="keyword">typename</span> <span class="identifier">Predicates</span><span class="special">,</span>
<span class="keyword">typename</span> <span class="identifier">OutIter</span><span class="special">&gt;</span>
<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><span class="special">(</span><span class="identifier">rtree</span><span class="special">&lt;</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">&gt;</span> <span class="keyword">const</span> <span class="special">&amp;</span> <span class="identifier">tree</span><span class="special">,</span>
<span class="identifier">DistancesPredicates</span> <span class="keyword">const</span> <span class="special">&amp;</span> <span class="identifier">dpred</span><span class="special">,</span>
<span class="identifier">size_t</span> <span class="identifier">k</span><span class="special">,</span>
<span class="identifier">Predicates</span> <span class="keyword">const</span> <span class="special">&amp;</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></pre>
<p>
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__rtree__functions.function10.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.function10.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function10.parameters">Parameters</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">&lt;</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">&gt;</span>
<span class="keyword">const</span> <span class="special">&amp;</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">&amp;</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">size_t</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">&amp;</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.function10.h2"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.function10.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function10.returns">Returns</a>
</h6>
<p>
The number of found values.
</p>
</div>
<p>
<br>
</p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.group__rtree__functions.function11"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function11" title="clear(rtree&lt;...&gt; &amp;)">clear(rtree&lt;...&gt;
&amp;)</a>
</h5></div></div></div>
<p>
Remove all values from the index.
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__rtree__functions.function11.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.function11.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function11.synopsis">Synopsis</a>
</h6>
<p>
</p>
<pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">Value</span><span class="special">,</span>
<span class="keyword">typename</span> <span class="identifier">Options</span><span class="special">,</span>
<span class="keyword">typename</span> <span class="identifier">Translator</span><span class="special">,</span>
<span class="keyword">typename</span> <span class="identifier">Allocator</span><span class="special">&gt;</span>
<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><span class="special">(</span><span class="identifier">rtree</span><span class="special">&lt;</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">&gt;</span> <span class="special">&amp;</span> <span class="identifier">tree</span><span class="special">)</span></pre>
<p>
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__rtree__functions.function11.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.function11.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function11.parameters">Parameters</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">&lt;</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">&gt;</span>
<span class="special">&amp;</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>
<p>
<br>
</p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.group__rtree__functions.function12"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function12" title="size(rtree&lt;...&gt; const &amp;)">size(rtree&lt;...&gt;
const &amp;)</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.function12.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.function12.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function12.synopsis">Synopsis</a>
</h6>
<p>
</p>
<pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">Value</span><span class="special">,</span>
<span class="keyword">typename</span> <span class="identifier">Options</span><span class="special">,</span>
<span class="keyword">typename</span> <span class="identifier">Translator</span><span class="special">,</span>
<span class="keyword">typename</span> <span class="identifier">Allocator</span><span class="special">&gt;</span>
<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><span class="special">(</span><span class="identifier">rtree</span><span class="special">&lt;</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">&gt;</span> <span class="keyword">const</span> <span class="special">&amp;</span> <span class="identifier">tree</span><span class="special">)</span></pre>
<p>
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__rtree__functions.function12.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.function12.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function12.parameters">Parameters</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">&lt;</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">&gt;</span>
<span class="keyword">const</span> <span class="special">&amp;</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.function12.h2"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.function12.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function12.returns">Returns</a>
</h6>
<p>
The number of values stored in the index.
</p>
</div>
<p>
<br>
</p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.group__rtree__functions.function13"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function13" title="empty(rtree&lt;...&gt; const &amp;)">empty(rtree&lt;...&gt;
const &amp;)</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.function13.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.function13.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function13.synopsis">Synopsis</a>
</h6>
<p>
</p>
<pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">Value</span><span class="special">,</span>
<span class="keyword">typename</span> <span class="identifier">Options</span><span class="special">,</span>
<span class="keyword">typename</span> <span class="identifier">Translator</span><span class="special">,</span>
<span class="keyword">typename</span> <span class="identifier">Allocator</span><span class="special">&gt;</span>
<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><span class="special">(</span><span class="identifier">rtree</span><span class="special">&lt;</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">&gt;</span> <span class="keyword">const</span> <span class="special">&amp;</span> <span class="identifier">tree</span><span class="special">)</span></pre>
<p>
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__rtree__functions.function13.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.function13.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function13.parameters">Parameters</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">&lt;</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">&gt;</span>
<span class="keyword">const</span> <span class="special">&amp;</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.function13.h2"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.function13.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function13.returns">Returns</a>
</h6>
<p>
true if there are no values in the index.
</p>
</div>
<p>
<br>
</p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.group__rtree__functions.function14"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function14" title="box(rtree&lt;...&gt; const &amp;)">box(rtree&lt;...&gt;
const &amp;)</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.function14.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.function14.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function14.synopsis">Synopsis</a>
</h6>
<p>
</p>
<pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">Value</span><span class="special">,</span>
<span class="keyword">typename</span> <span class="identifier">Options</span><span class="special">,</span>
<span class="keyword">typename</span> <span class="identifier">Translator</span><span class="special">,</span>
<span class="keyword">typename</span> <span class="identifier">Allocator</span><span class="special">&gt;</span>
<span class="identifier">rtree</span><span class="special">&lt;</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">&gt;::</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><span class="special">(</span><span class="identifier">rtree</span><span class="special">&lt;</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">&gt;</span> <span class="keyword">const</span> <span class="special">&amp;</span> <span class="identifier">tree</span><span class="special">)</span></pre>
<p>
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__rtree__functions.function14.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.function14.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function14.parameters">Parameters</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">&lt;</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">&gt;</span>
<span class="keyword">const</span> <span class="special">&amp;</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.function14.h2"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.function14.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function14.returns">Returns</a>
</h6>
<p>
The box containing all stored values or an invalid box.
</p>
</div>
<p>
<br>
</p>
</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>
<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#geometry_index.r_tree.reference.group__predicates.function0" title="empty()"><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#geometry_index.r_tree.reference.group__predicates.function1" title="value(ValuePredicate const &amp;)"><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">&amp;)</span></code></a>
</p>
</td>
<td>
<p>
Generate value predicate.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.function2" title="covered_by(Geometry const &amp;)"><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">&amp;)</span></code></a>
</p>
</td>
<td>
<p>
Generate covered_by() predicate.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.function3" title="disjoint(Geometry const &amp;)"><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">&amp;)</span></code></a>
</p>
</td>
<td>
<p>
Generate disjoint() predicate.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.function4" title="intersects(Geometry const &amp;)"><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">&amp;)</span></code></a>
</p>
</td>
<td>
<p>
Generate intersects() predicate.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.function5" title="overlaps(Geometry const &amp;)"><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">&amp;)</span></code></a>
</p>
</td>
<td>
<p>
Generate overlaps() predicate.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.function6" title="within(Geometry const &amp;)"><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">&amp;)</span></code></a>
</p>
</td>
<td>
<p>
Generate within() 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.function0"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.function0" title="empty()">empty()</a>
</h5></div></div></div>
<p>
Generate empty predicate.
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__predicates.function0.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__predicates.function0.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.function0.synopsis">Synopsis</a>
</h6>
<p>
</p>
<pre class="programlisting"><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><span class="special">()</span></pre>
<p>
</p>
</div>
<p>
<br>
</p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.group__predicates.function1"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.function1" title="value(ValuePredicate const &amp;)">value(ValuePredicate
const &amp;)</a>
</h5></div></div></div>
<p>
Generate value predicate.
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__predicates.function1.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__predicates.function1.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.function1.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.function1.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__predicates.function1.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.function1.synopsis">Synopsis</a>
</h6>
<p>
</p>
<pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">ValuePredicate</span><span class="special">&gt;</span>
<span class="identifier">detail</span><span class="special">::</span><span class="identifier">value</span><span class="special">&lt;</span><span class="identifier">ValuePredicate</span><span class="special">&gt;</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><span class="special">(</span><span class="identifier">ValuePredicate</span> <span class="keyword">const</span> <span class="special">&amp;</span> <span class="identifier">vpred</span><span class="special">)</span></pre>
<p>
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__predicates.function1.h2"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__predicates.function1.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.function1.parameters">Parameters</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">&amp;</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>
<p>
<br>
</p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.group__predicates.function2"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.function2" title="covered_by(Geometry const &amp;)">covered_by(Geometry
const &amp;)</a>
</h5></div></div></div>
<p>
Generate covered_by() predicate.
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__predicates.function2.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__predicates.function2.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.function2.description">Description</a>
</h6>
<p>
Generate a predicate defining Value and Geometry relationship. Value
will be returned by the query if bg::covered_by(Indexable, Geometry)
returns true.
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__predicates.function2.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__predicates.function2.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.function2.synopsis">Synopsis</a>
</h6>
<p>
</p>
<pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">Geometry</span><span class="special">&gt;</span>
<span class="identifier">detail</span><span class="special">::</span><span class="identifier">covered_by</span><span class="special">&lt;</span><span class="identifier">Geometry</span><span class="special">&gt;</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><span class="special">(</span><span class="identifier">Geometry</span> <span class="keyword">const</span> <span class="special">&amp;</span> <span class="identifier">g</span><span class="special">)</span></pre>
<p>
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__predicates.function2.h2"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__predicates.function2.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.function2.parameters">Parameters</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">&amp;</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>
<p>
<br>
</p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.group__predicates.function3"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.function3" title="disjoint(Geometry const &amp;)">disjoint(Geometry
const &amp;)</a>
</h5></div></div></div>
<p>
Generate disjoint() predicate.
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__predicates.function3.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__predicates.function3.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.function3.description">Description</a>
</h6>
<p>
Generate a predicate defining Value and Geometry relationship. Value
will be returned by the query if bg::disjoint(Indexable, Geometry) returns
true.
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__predicates.function3.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__predicates.function3.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.function3.synopsis">Synopsis</a>
</h6>
<p>
</p>
<pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">Geometry</span><span class="special">&gt;</span>
<span class="identifier">detail</span><span class="special">::</span><span class="identifier">disjoint</span><span class="special">&lt;</span><span class="identifier">Geometry</span><span class="special">&gt;</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><span class="special">(</span><span class="identifier">Geometry</span> <span class="keyword">const</span> <span class="special">&amp;</span> <span class="identifier">g</span><span class="special">)</span></pre>
<p>
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__predicates.function3.h2"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__predicates.function3.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.function3.parameters">Parameters</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">&amp;</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>
<p>
<br>
</p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.group__predicates.function4"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.function4" title="intersects(Geometry const &amp;)">intersects(Geometry
const &amp;)</a>
</h5></div></div></div>
<p>
Generate intersects() predicate.
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__predicates.function4.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__predicates.function4.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.function4.description">Description</a>
</h6>
<p>
Generate a predicate defining Value and Geometry relationship. Value
will be returned by the query if bg::intersects(Indexable, Geometry)
returns true.
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__predicates.function4.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__predicates.function4.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.function4.synopsis">Synopsis</a>
</h6>
<p>
</p>
<pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">Geometry</span><span class="special">&gt;</span>
<span class="identifier">detail</span><span class="special">::</span><span class="identifier">intersects</span><span class="special">&lt;</span><span class="identifier">Geometry</span><span class="special">&gt;</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><span class="special">(</span><span class="identifier">Geometry</span> <span class="keyword">const</span> <span class="special">&amp;</span> <span class="identifier">g</span><span class="special">)</span></pre>
<p>
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__predicates.function4.h2"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__predicates.function4.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.function4.parameters">Parameters</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">&amp;</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>
<p>
<br>
</p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.group__predicates.function5"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.function5" title="overlaps(Geometry const &amp;)">overlaps(Geometry
const &amp;)</a>
</h5></div></div></div>
<p>
Generate overlaps() predicate.
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__predicates.function5.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__predicates.function5.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.function5.description">Description</a>
</h6>
<p>
Generate a predicate defining Value and Geometry relationship. Value
will be returned by the query if bg::overlaps(Indexable, Geometry) returns
true.
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__predicates.function5.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__predicates.function5.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.function5.synopsis">Synopsis</a>
</h6>
<p>
</p>
<pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">Geometry</span><span class="special">&gt;</span>
<span class="identifier">detail</span><span class="special">::</span><span class="identifier">overlaps</span><span class="special">&lt;</span><span class="identifier">Geometry</span><span class="special">&gt;</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><span class="special">(</span><span class="identifier">Geometry</span> <span class="keyword">const</span> <span class="special">&amp;</span> <span class="identifier">g</span><span class="special">)</span></pre>
<p>
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__predicates.function5.h2"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__predicates.function5.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.function5.parameters">Parameters</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">&amp;</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>
<p>
<br>
</p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.group__predicates.function6"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.function6" title="within(Geometry const &amp;)">within(Geometry
const &amp;)</a>
</h5></div></div></div>
<p>
Generate within() predicate.
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__predicates.function6.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__predicates.function6.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.function6.description">Description</a>
</h6>
<p>
Generate a predicate defining Value and Geometry relationship. Value
will be returned by the query if bg::within(Indexable, Geometry) returns
true.
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__predicates.function6.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__predicates.function6.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.function6.synopsis">Synopsis</a>
</h6>
<p>
</p>
<pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">Geometry</span><span class="special">&gt;</span>
<span class="identifier">detail</span><span class="special">::</span><span class="identifier">within</span><span class="special">&lt;</span><span class="identifier">Geometry</span><span class="special">&gt;</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><span class="special">(</span><span class="identifier">Geometry</span> <span class="keyword">const</span> <span class="special">&amp;</span> <span class="identifier">g</span><span class="special">)</span></pre>
<p>
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__predicates.function6.h2"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__predicates.function6.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.function6.parameters">Parameters</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">&amp;</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>
<p>
<br>
</p>
</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>
<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#geometry_index.r_tree.reference.group__distance__predicates.function0" title="to_nearest(T const &amp;)"><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">&amp;)</span></code></a>
</p>
</td>
<td>
<p>
Generate to_nearest() Point-Indexable relationship.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.function1" title="to_centroid(T const &amp;)"><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">&amp;)</span></code></a>
</p>
</td>
<td>
<p>
Generate to_centroid() Point-Indexable relationship.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.function2" title="to_furthest(T const &amp;)"><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">&amp;)</span></code></a>
</p>
</td>
<td>
<p>
Generate to_furthest() Point-Indexable relationship.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.function3" title="unbounded(PointRelation const &amp;)"><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">&amp;)</span></code></a>
</p>
</td>
<td>
<p>
Generate unbounded() distance predicate.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.function4" title="min_bounded(PointRelation const &amp;, MinRelation const &amp;)"><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">&amp;,</span> <span class="identifier">MinRelation</span>
<span class="keyword">const</span> <span class="special">&amp;)</span></code></a>
</p>
</td>
<td>
<p>
Generate min_bounded() distance predicate.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.function5" title="max_bounded(PointRelation const &amp;, MaxRelation const &amp;)"><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">&amp;,</span> <span class="identifier">MaxRelation</span>
<span class="keyword">const</span> <span class="special">&amp;)</span></code></a>
</p>
</td>
<td>
<p>
Generate max_bounded() distance predicate.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.function6" title="bounded(PointRelation const &amp;, MinRelation const &amp;, MaxRelation const &amp;)"><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">&amp;,</span> <span class="identifier">MinRelation</span>
<span class="keyword">const</span> <span class="special">&amp;,</span>
<span class="identifier">MaxRelation</span> <span class="keyword">const</span>
<span class="special">&amp;)</span></code></a>
</p>
</td>
<td>
<p>
Generate bounded() 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.function0"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.function0" title="to_nearest(T const &amp;)">to_nearest(T
const &amp;)</a>
</h5></div></div></div>
<p>
Generate to_nearest() Point-Indexable relationship.
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__distance__predicates.function0.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__distance__predicates.function0.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.function0.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.function0.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__distance__predicates.function0.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.function0.synopsis">Synopsis</a>
</h6>
<p>
</p>
<pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">T</span><span class="special">&gt;</span>
<span class="identifier">detail</span><span class="special">::</span><span class="identifier">to_nearest</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;</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><span class="special">(</span><span class="identifier">T</span> <span class="keyword">const</span> <span class="special">&amp;</span> <span class="identifier">v</span><span class="special">)</span></pre>
<p>
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__distance__predicates.function0.h2"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__distance__predicates.function0.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.function0.parameters">Parameters</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">&amp;</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>
<p>
<br>
</p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.group__distance__predicates.function1"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.function1" title="to_centroid(T const &amp;)">to_centroid(T
const &amp;)</a>
</h5></div></div></div>
<p>
Generate to_centroid() Point-Indexable relationship.
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__distance__predicates.function1.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__distance__predicates.function1.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.function1.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.function1.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__distance__predicates.function1.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.function1.synopsis">Synopsis</a>
</h6>
<p>
</p>
<pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">T</span><span class="special">&gt;</span>
<span class="identifier">detail</span><span class="special">::</span><span class="identifier">to_centroid</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;</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><span class="special">(</span><span class="identifier">T</span> <span class="keyword">const</span> <span class="special">&amp;</span> <span class="identifier">v</span><span class="special">)</span></pre>
<p>
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__distance__predicates.function1.h2"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__distance__predicates.function1.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.function1.parameters">Parameters</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">&amp;</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>
<p>
<br>
</p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.group__distance__predicates.function2"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.function2" title="to_furthest(T const &amp;)">to_furthest(T
const &amp;)</a>
</h5></div></div></div>
<p>
Generate to_furthest() Point-Indexable relationship.
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__distance__predicates.function2.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__distance__predicates.function2.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.function2.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.function2.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__distance__predicates.function2.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.function2.synopsis">Synopsis</a>
</h6>
<p>
</p>
<pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">T</span><span class="special">&gt;</span>
<span class="identifier">detail</span><span class="special">::</span><span class="identifier">to_furthest</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;</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><span class="special">(</span><span class="identifier">T</span> <span class="keyword">const</span> <span class="special">&amp;</span> <span class="identifier">v</span><span class="special">)</span></pre>
<p>
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__distance__predicates.function2.h2"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__distance__predicates.function2.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.function2.parameters">Parameters</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">&amp;</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>
<p>
<br>
</p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.group__distance__predicates.function3"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.function3" title="unbounded(PointRelation const &amp;)">unbounded(PointRelation
const &amp;)</a>
</h5></div></div></div>
<p>
Generate unbounded() distance predicate.
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__distance__predicates.function3.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__distance__predicates.function3.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.function3.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.function3.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__distance__predicates.function3.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.function3.synopsis">Synopsis</a>
</h6>
<p>
</p>
<pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">PointRelation</span><span class="special">&gt;</span>
<span class="identifier">detail</span><span class="special">::</span><span class="identifier">unbounded</span><span class="special">&lt;</span><span class="identifier">PointRelation</span><span class="special">&gt;</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><span class="special">(</span><span class="identifier">PointRelation</span> <span class="keyword">const</span> <span class="special">&amp;</span> <span class="identifier">pr</span><span class="special">)</span></pre>
<p>
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__distance__predicates.function3.h2"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__distance__predicates.function3.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.function3.parameters">Parameters</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">&amp;</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 bgi::to_nearest(Point),
bgi::to_centroid(Point) or bgi::to_furthest(Point).
</p>
</td>
</tr></tbody>
</table></div>
</div>
<p>
<br>
</p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.group__distance__predicates.function4"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.function4" title="min_bounded(PointRelation const &amp;, MinRelation const &amp;)">min_bounded(PointRelation
const &amp;, MinRelation const &amp;)</a>
</h5></div></div></div>
<p>
Generate min_bounded() distance predicate.
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__distance__predicates.function4.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__distance__predicates.function4.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.function4.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.function4.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__distance__predicates.function4.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.function4.synopsis">Synopsis</a>
</h6>
<p>
</p>
<pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">PointRelation</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">MinRelation</span><span class="special">&gt;</span>
<span class="identifier">detail</span><span class="special">::</span><span class="identifier">min_bounded</span><span class="special">&lt;</span><span class="identifier">PointRelation</span><span class="special">,</span> <span class="identifier">MinRelation</span><span class="special">&gt;</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><span class="special">(</span><span class="identifier">PointRelation</span> <span class="keyword">const</span> <span class="special">&amp;</span> <span class="identifier">pr</span><span class="special">,</span> <span class="identifier">MinRelation</span> <span class="keyword">const</span> <span class="special">&amp;</span> <span class="identifier">minr</span><span class="special">)</span></pre>
<p>
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__distance__predicates.function4.h2"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__distance__predicates.function4.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.function4.parameters">Parameters</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">&amp;</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 bgi::to_nearest(Point),
bgi::to_centroid(Point) or bgi::to_furthest(Point).
</p>
</td>
</tr>
<tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">MinRelation</span> <span class="keyword">const</span> <span class="special">&amp;</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 bgi::to_nearest(min_distance),
bgi::to_centroid(min_distance) or bgi::to_furthest(min_distance).
</p>
</td>
</tr>
</tbody>
</table></div>
</div>
<p>
<br>
</p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.group__distance__predicates.function5"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.function5" title="max_bounded(PointRelation const &amp;, MaxRelation const &amp;)">max_bounded(PointRelation
const &amp;, MaxRelation const &amp;)</a>
</h5></div></div></div>
<p>
Generate max_bounded() distance predicate.
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__distance__predicates.function5.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__distance__predicates.function5.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.function5.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.function5.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__distance__predicates.function5.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.function5.synopsis">Synopsis</a>
</h6>
<p>
</p>
<pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">PointRelation</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">MaxRelation</span><span class="special">&gt;</span>
<span class="identifier">detail</span><span class="special">::</span><span class="identifier">max_bounded</span><span class="special">&lt;</span><span class="identifier">PointRelation</span><span class="special">,</span> <span class="identifier">MaxRelation</span><span class="special">&gt;</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><span class="special">(</span><span class="identifier">PointRelation</span> <span class="keyword">const</span> <span class="special">&amp;</span> <span class="identifier">pr</span><span class="special">,</span> <span class="identifier">MaxRelation</span> <span class="keyword">const</span> <span class="special">&amp;</span> <span class="identifier">maxr</span><span class="special">)</span></pre>
<p>
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__distance__predicates.function5.h2"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__distance__predicates.function5.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.function5.parameters">Parameters</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">&amp;</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 bgi::to_nearest(Point),
bgi::to_centroid(Point) or bgi::to_furthest(Point).
</p>
</td>
</tr>
<tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">MaxRelation</span> <span class="keyword">const</span> <span class="special">&amp;</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 bgi::to_nearest(max_distance),
bgi::to_centroid(max_distance) or bgi::to_furthest(max_distance).
</p>
</td>
</tr>
</tbody>
</table></div>
</div>
<p>
<br>
</p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.group__distance__predicates.function6"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.function6" title="bounded(PointRelation const &amp;, MinRelation const &amp;, MaxRelation const &amp;)">bounded(PointRelation
const &amp;, MinRelation const &amp;, MaxRelation const &amp;)</a>
</h5></div></div></div>
<p>
Generate bounded() distance predicate.
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__distance__predicates.function6.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__distance__predicates.function6.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.function6.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.function6.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__distance__predicates.function6.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.function6.synopsis">Synopsis</a>
</h6>
<p>
</p>
<pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">PointRelation</span><span class="special">,</span>
<span class="keyword">typename</span> <span class="identifier">MinRelation</span><span class="special">,</span>
<span class="keyword">typename</span> <span class="identifier">MaxRelation</span><span class="special">&gt;</span>
<span class="identifier">detail</span><span class="special">::</span><span class="identifier">bounded</span><span class="special">&lt;</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">&gt;</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><span class="special">(</span><span class="identifier">PointRelation</span> <span class="keyword">const</span> <span class="special">&amp;</span> <span class="identifier">pr</span><span class="special">,</span>
<span class="identifier">MinRelation</span> <span class="keyword">const</span> <span class="special">&amp;</span> <span class="identifier">minr</span><span class="special">,</span>
<span class="identifier">MaxRelation</span> <span class="keyword">const</span> <span class="special">&amp;</span> <span class="identifier">maxr</span><span class="special">)</span></pre>
<p>
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__distance__predicates.function6.h2"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__distance__predicates.function6.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.function6.parameters">Parameters</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">&amp;</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 bgi::to_nearest(Point),
bgi::to_centroid(Point) or bgi::to_furthest(Point).
</p>
</td>
</tr>
<tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">MinRelation</span> <span class="keyword">const</span> <span class="special">&amp;</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 bgi::to_nearest(min_distance),
bgi::to_centroid(min_distance) or bgi::to_furthest(min_distance).
</p>
</td>
</tr>
<tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">MaxRelation</span> <span class="keyword">const</span> <span class="special">&amp;</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 bgi::to_nearest(max_distance),
bgi::to_centroid(max_distance) or bgi::to_furthest(max_distance).
</p>
</td>
</tr>
</tbody>
</table></div>
</div>
<p>
<br>
</p>
</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>
<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#geometry_index.r_tree.reference.group__adaptors.function0" title="nearest_queried(DistancesPredicates const &amp;, size_t, Predicates const &amp;)"><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">&amp;,</span> <span class="identifier">size_t</span><span class="special">,</span> <span class="identifier">Predicates</span>
<span class="keyword">const</span> <span class="special">&amp;)</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#geometry_index.r_tree.reference.group__adaptors.function1" title="nearest_queried(DistancesPredicates const &amp;, size_t)"><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">&amp;,</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#geometry_index.r_tree.reference.group__adaptors.function2" title="spatial_queried(Predicates const &amp;)"><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">&amp;)</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.function0"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__adaptors.function0" title="nearest_queried(DistancesPredicates const &amp;, size_t, Predicates const &amp;)">nearest_queried(DistancesPredicates
const &amp;, size_t, Predicates const &amp;)</a>
</h5></div></div></div>
<p>
The nearest query index adaptor generator.
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__adaptors.function0.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__adaptors.function0.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__adaptors.function0.synopsis">Synopsis</a>
</h6>
<p>
</p>
<pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">DistancesPredicates</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">Predicates</span><span class="special">&gt;</span>
<span class="identifier">detail</span><span class="special">::</span><span class="identifier">nearest_query</span><span class="special">&lt;</span><span class="identifier">DistancesPredicates</span><span class="special">,</span> <span class="identifier">Predicates</span><span class="special">&gt;</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><span class="special">(</span><span class="identifier">DistancesPredicates</span> <span class="keyword">const</span> <span class="special">&amp;</span> <span class="identifier">dpred</span><span class="special">,</span>
<span class="identifier">size_t</span> <span class="identifier">k</span><span class="special">,</span>
<span class="identifier">Predicates</span> <span class="keyword">const</span> <span class="special">&amp;</span> <span class="identifier">pred</span><span class="special">)</span></pre>
<p>
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__adaptors.function0.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__adaptors.function0.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__adaptors.function0.parameters">Parameters</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">&amp;</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">&amp;</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>
<p>
<br>
</p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.group__adaptors.function1"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__adaptors.function1" title="nearest_queried(DistancesPredicates const &amp;, size_t)">nearest_queried(DistancesPredicates
const &amp;, 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.function1.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__adaptors.function1.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__adaptors.function1.synopsis">Synopsis</a>
</h6>
<p>
</p>
<pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">DistancesPredicates</span><span class="special">&gt;</span>
<span class="identifier">detail</span><span class="special">::</span><span class="identifier">nearest_query</span><span class="special">&lt;</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">&gt;</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><span class="special">(</span><span class="identifier">DistancesPredicates</span> <span class="keyword">const</span> <span class="special">&amp;</span> <span class="identifier">dpred</span><span class="special">,</span> <span class="identifier">size_t</span> <span class="identifier">k</span><span class="special">)</span></pre>
<p>
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__adaptors.function1.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__adaptors.function1.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__adaptors.function1.parameters">Parameters</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">&amp;</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>
<p>
<br>
</p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.group__adaptors.function2"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__adaptors.function2" title="spatial_queried(Predicates const &amp;)">spatial_queried(Predicates
const &amp;)</a>
</h5></div></div></div>
<p>
The spatial query index adaptor generator.
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__adaptors.function2.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__adaptors.function2.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__adaptors.function2.synopsis">Synopsis</a>
</h6>
<p>
</p>
<pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">Predicates</span><span class="special">&gt;</span>
<span class="identifier">detail</span><span class="special">::</span><span class="identifier">spatial_query</span><span class="special">&lt;</span><span class="identifier">Predicates</span><span class="special">&gt;</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><span class="special">(</span><span class="identifier">Predicates</span> <span class="keyword">const</span> <span class="special">&amp;</span> <span class="identifier">pred</span><span class="special">)</span></pre>
<p>
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__adaptors.function2.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__adaptors.function2.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__adaptors.function2.parameters">Parameters</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Type
</p>
</th>
<th>
<p>
Name
</p>
</th>
<th>
<p>
Description
</p>
</th>
</tr></thead>
<tbody><tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">Predicates</span> <span class="keyword">const</span> <span class="special">&amp;</span></code>
</p>
</td>
<td>
<p>
<code class="computeroutput"><span class="identifier">pred</span></code>
</p>
</td>
<td>
<p>
Spatial predicates.
</p>
</td>
</tr></tbody>
</table></div>
</div>
<p>
<br>
</p>
</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 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="id939489"></a><a class="indexterm" name="id939494"></a><a class="indexterm" name="id939499"></a><a class="indexterm" name="id939504"></a><a class="indexterm" name="id939509"></a>
The default translator.
</p>
<h6>
<a name="geometry_index.r_tree.reference.translators.boost_geometry_index_translator_def.h0"></a>
<span class="phrase"><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&lt;Indexable, Second&gt; and boost::tuple&lt;Indexable, ...&gt;.
</p>
<h6>
<a name="geometry_index.r_tree.reference.translators.boost_geometry_index_translator_def.h1"></a>
<span class="phrase"><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">&lt;.</span><span class="identifier">hpp</span><span class="special">&gt;</span></code>
</p>
<h6>
<a name="geometry_index.r_tree.reference.translators.boost_geometry_index_translator_def.h2"></a>
<span class="phrase"><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>
<p>
</p>
<pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">Value</span><span class="special">&gt;</span>
<span class="keyword">struct</span> <span class="identifier">def</span>
<span class="special">{</span>
<span class="comment">// ...</span>
<span class="special">};</span>
</pre>
<p>
</p>
<h6>
<a name="geometry_index.r_tree.reference.translators.boost_geometry_index_translator_def.h3"></a>
<span class="phrase"><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 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="id939720"></a><a class="indexterm" name="id939725"></a><a class="indexterm" name="id939729"></a><a class="indexterm" name="id939734"></a><a class="indexterm" name="id939739"></a>
The index translator.
</p>
<h6>
<a name="geometry_index.r_tree.reference.translators.boost_geometry_index_translator_index.h0"></a>
<span class="phrase"><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 translator::def&lt;...&gt; 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 class="phrase"><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">&lt;.</span><span class="identifier">hpp</span><span class="special">&gt;</span></code>
</p>
<h6>
<a name="geometry_index.r_tree.reference.translators.boost_geometry_index_translator_index.h2"></a>
<span class="phrase"><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>
<p>
</p>
<pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">Container</span><span class="special">&gt;</span>
<span class="keyword">class</span> <span class="identifier">index</span>
<span class="special">{</span>
<span class="comment">// ...</span>
<span class="special">};</span>
</pre>
<p>
</p>
<h6>
<a name="geometry_index.r_tree.reference.translators.boost_geometry_index_translator_index.h3"></a>
<span class="phrase"><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 class="phrase"><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#geometry_index.r_tree.reference.translators.boost_geometry_index_translator_index.member0" title="index(Container const &amp;)"><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">&amp;)</span></code></a>
</p>
</td>
<td>
<p>
The constructor.
</p>
</td>
</tr></tbody>
</table></div>
<p>
<br>
</p>
<div class="section">
<div class="titlepage"><div><div><h6 class="title">
<a name="geometry_index.r_tree.reference.translators.boost_geometry_index_translator_index.member0"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.translators.boost_geometry_index_translator_index.member0" title="index(Container const &amp;)">index(Container
const &amp;)</a>
</h6></div></div></div>
<p>
The constructor.
</p>
<h7><a name="geometry_index.r_tree.reference.translators.boost_geometry_index_translator_index.member0.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.translators.boost_geometry_index_translator_index.member0.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.translators.boost_geometry_index_translator_index.member0.synopsis">Synopsis</a>
</h7><p>
</p>
<pre class="programlisting"><span class="identifier">index</span><span class="special">(</span><span class="identifier">Container</span> <span class="keyword">const</span> <span class="special">&amp;</span> <span class="identifier">c</span><span class="special">)</span></pre>
<p>
</p>
<h7><a name="geometry_index.r_tree.reference.translators.boost_geometry_index_translator_index.member0.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.translators.boost_geometry_index_translator_index.member0.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.translators.boost_geometry_index_translator_index.member0.parameters">Parameters</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">&amp;</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>
<p>
<br>
</p>
</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>
<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#geometry_index.r_tree.reference.group__inserters.function0" title="inserter(Container &amp;)"><code class="computeroutput"><span class="identifier">inserter</span><span class="special">(</span><span class="identifier">Container</span> <span class="special">&amp;)</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.function0"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__inserters.function0" title="inserter(Container &amp;)">inserter(Container
&amp;)</a>
</h5></div></div></div>
<p>
Insert iterator generator.
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__inserters.function0.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__inserters.function0.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__inserters.function0.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&amp;) defined.
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__inserters.function0.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__inserters.function0.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__inserters.function0.synopsis">Synopsis</a>
</h6>
<p>
</p>
<pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">Container</span><span class="special">&gt;</span>
<span class="identifier">insert_iterator</span><span class="special">&lt;</span><span class="identifier">Container</span><span class="special">&gt;</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><span class="special">(</span><span class="identifier">Container</span> <span class="special">&amp;</span> <span class="identifier">c</span><span class="special">)</span></pre>
<p>
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__inserters.function0.h2"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__inserters.function0.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__inserters.function0.parameters">Parameters</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">&amp;</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.function0.h3"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__inserters.function0.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__inserters.function0.returns">Returns</a>
</h6>
<p>
The insert iterator inserting values to the container.
</p>
</div>
<p>
<br>
</p>
</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 &#169; 2011, 2012 Adam Wulkiewicz<br>Copyright &#169; 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>
Reference in New Issue View Git Blame Copy Permalink