Adam Wulkiewicz 0bc541d1e9 rtree query default spatial predicate removed. Explicit call of intersects() is expected.
Predicates and DistancePredicates are stored by value in visitors.
Each predicate is stored by value in expression tuple.
Examples and docs updated.

[SVN r83232]
2013-03-01 18:14:46 +00:00

6987 lines
405 KiB
HTML

<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Reference</title>
<link rel="stylesheet" href="http://www.boost.org/doc/libs/release/doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.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="rtree_examples.html" title="Examples">
</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="rtree_examples.html"><img src="http://www.boost.org/doc/libs/release/doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../r_tree.html"><img src="http://www.boost.org/doc/libs/release/doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="http://www.boost.org/doc/libs/release/doc/src/images/home.png" alt="Home"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h3 class="title">
<a name="geometry_index.r_tree.reference"></a><a class="link" href="reference.html" title="Reference">Reference</a>
</h3></div></div></div>
<div class="toc"><dl>
<dt><span class="section"><a href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree">boost::geometry::index::rtree</a></span></dt>
<dt><span class="section"><a href="reference.html#geometry_index.r_tree.reference.group__rtree__functions">Functions
related to the rtree</a></span></dt>
<dt><span class="section"><a href="reference.html#geometry_index.r_tree.reference.parameters">R-tree
parameters (boost::geometry::index::)</a></span></dt>
<dt><span class="section"><a href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__translator">boost::geometry::index::translator</a></span></dt>
<dt><span class="section"><a href="reference.html#geometry_index.r_tree.reference.group__predicates">Predicates
(boost::geometry::index::)</a></span></dt>
<dt><span class="section"><a href="reference.html#geometry_index.r_tree.reference.group__nearest__relations">Nearest
relations (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.group__inserters">Inserters
(boost::geometry::index::)</a></span></dt>
</dl></div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree"></a><a name="classboost_1_1geometry_1_1index_1_1rtree"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree" title="boost::geometry::index::rtree">boost::geometry::index::rtree</a>
</h4></div></div></div>
<p>
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>
This is self-balancing spatial index capable to store various types of
Values and balancing algorithms.
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.parameters">Parameters</a>
</h6>
<p>
The user must pass a type defining the Parameters which will be used in
rtree creation process. This type is used e.g. to specify balancing algorithm
with specific parameters like min and max number of elements in node.
</p>
<p>
Predefined algorithms with compile-time parameters are:
</p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem">
<code class="literal"><a class="link" href="reference.html#structboost_1_1geometry_1_1index_1_1linear">boost::geometry::index::linear</a></code>,
</li>
<li class="listitem">
<code class="literal"><a class="link" href="reference.html#structboost_1_1geometry_1_1index_1_1quadratic">boost::geometry::index::quadratic</a></code>,
</li>
<li class="listitem">
<code class="literal"><a class="link" href="reference.html#structboost_1_1geometry_1_1index_1_1rstar">boost::geometry::index::rstar</a></code>.
</li>
</ul></div>
<p>
Predefined algorithms with run-time parameters are:
</p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem">
<code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1dynamic__linear">boost::geometry::index::dynamic_linear</a></code>,
</li>
<li class="listitem">
<code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1dynamic__quadratic">boost::geometry::index::dynamic_quadratic</a></code>,
</li>
<li class="listitem">
<code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1dynamic__rstar">boost::geometry::index::dynamic_rstar</a></code>.
</li>
</ul></div>
<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.translator"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.translator">Translator</a>
</h6>
<p>
The Translator translates from Value to Indexable each time r-tree requires
it. Which means that this operation is done for each Value access. Therefore
the Translator should return the Indexable by const reference instead of
a value. Default translator can translate all types adapted to Point or
Box concepts (called Indexables). It also handles <code class="literal"><code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special">&lt;</span><span class="identifier">Indexable</span><span class="special">,</span>
<span class="identifier">T</span><span class="special">&gt;</span></code></code>
and <code class="literal"><code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">tuple</span><span class="special">&lt;</span><span class="identifier">Indexable</span><span class="special">,</span>
<span class="special">...&gt;</span></code></code>. For example,
if <code class="literal"><code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special">&lt;</span><span class="identifier">Box</span><span class="special">,</span> <span class="keyword">int</span><span class="special">&gt;</span></code></code>
is stored in the container, the default translator translates from <code class="literal"><code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special">&lt;</span><span class="identifier">Box</span><span class="special">,</span> <span class="keyword">int</span><span class="special">&gt;</span> <span class="keyword">const</span><span class="special">&amp;</span></code></code>
to <code class="literal"><code class="computeroutput"><span class="identifier">Box</span> <span class="keyword">const</span><span class="special">&amp;</span></code></code>.
</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.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">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">rtree</span><span class="special">.</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.h4"></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>
<pre class="programlisting"><code class="computeroutput"><span class="keyword">template</span><span class="special">&lt;</span></code><code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Value</span></code><code class="computeroutput"><span class="special">,</span></code>
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Parameters</span></code><code class="computeroutput"><span class="special">,</span></code>
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Translator</span></code> = <code class="literal"><a class="link" href="reference.html#structboost_1_1geometry_1_1index_1_1translator">index::translator</a></code><code class="computeroutput"><span class="special">&lt;</span><span class="identifier">Value</span><span class="special">&gt;</span></code><code class="computeroutput"><span class="special">,</span></code>
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Allocator</span></code> = <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">allocator</span><span class="special">&lt;</span><span class="identifier">Value</span><span class="special">&gt;</span></code><code class="computeroutput"><span class="special">&gt;</span></code>
<code class="computeroutput"><span class="keyword">class</span> <span class="identifier">rtree</span></code>
<code class="computeroutput"><span class="special">{</span></code>
<code class="computeroutput"> <span class="comment">// ...</span></code>
<code class="computeroutput"><span class="special">};</span></code>
</pre>
<h6>
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.h5"></a>
<span 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.h6"></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>
<a name="classboost_1_1geometry_1_1index_1_1rtree_1a9979db9ef37591985256cb8ad31862bb"></a><code class="computeroutput"><span class="identifier">value_type</span></code>
</p>
</td>
<td>
<p>
The type of Value stored in the container.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a name="classboost_1_1geometry_1_1index_1_1rtree_1af85d4e399a807b3e4e46d38a0b4ffc5a"></a><code class="computeroutput"><span class="identifier">parameters_type</span></code>
</p>
</td>
<td>
<p>
R-tree parameters type.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a name="classboost_1_1geometry_1_1index_1_1rtree_1adbc30a1fa986e2e856e0662111ac2d91"></a><code class="computeroutput"><span class="identifier">translator_type</span></code>
</p>
</td>
<td>
<p>
Value to Indexable Translator type.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a name="classboost_1_1geometry_1_1index_1_1rtree_1a9d35bc38fa697c6f600548fb5b38807d"></a><code class="computeroutput"><span class="identifier">allocator_type</span></code>
</p>
</td>
<td>
<p>
The type of allocator used by the container.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a name="classboost_1_1geometry_1_1index_1_1rtree_1a5c1a657074c527ed65f858c1ab6b36e6"></a><code class="computeroutput"><span class="identifier">size_type</span></code>
</p>
</td>
<td>
<p>
Unsigned integral type used by the container.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a name="classboost_1_1geometry_1_1index_1_1rtree_1a6533b05d4a2eea9d4a0033e192add466"></a><code class="computeroutput"><span class="identifier">indexable_type</span></code>
</p>
</td>
<td>
<p>
The Indexable type to which Value is translated.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a name="classboost_1_1geometry_1_1index_1_1rtree_1a653555282525601512c3b1bed1e9590f"></a><code class="computeroutput"><span class="identifier">bounds_type</span></code>
</p>
</td>
<td>
<p>
The Box type used by the R-tree.
</p>
</td>
</tr>
</tbody>
</table></div>
<h6>
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.h7"></a>
<span 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#classboost_1_1geometry_1_1index_1_1rtree_1a393bb202f84b6fe5613df02d1ba2a092"><code class="computeroutput"><span class="identifier">rtree</span><span class="special">()</span></code></a>
</p>
</td>
<td>
<p>
The constructor.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a434839ea5dd2e57f9491d18520621c4b"><code class="computeroutput"><span class="identifier">rtree</span><span class="special">(</span><span class="identifier">parameters_type</span> <span class="keyword">const</span>
<span class="special">&amp;,</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#classboost_1_1geometry_1_1index_1_1rtree_1ace0b58f496b7eb00c518b4fc2794f4bc"><code class="computeroutput"><span class="identifier">rtree</span><span class="special">(</span><span class="identifier">Iterator</span><span class="special">,</span>
<span class="identifier">Iterator</span><span class="special">)</span></code></a>
</p>
</td>
<td>
<p>
The constructor.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a513f271626372c6dad5488f64db6d1d4"><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#classboost_1_1geometry_1_1index_1_1rtree_1ae8b10914ec434d1ee6877f5e1000b674"><code class="computeroutput"><span class="special">~</span><span class="identifier">rtree</span><span class="special">()</span></code></a>
</p>
</td>
<td>
<p>
The destructor.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a006904b4e7dcef1fd1efcb70a010964f"><code class="computeroutput"><span class="identifier">rtree</span><span class="special">(</span><span class="identifier">rtree</span> <span class="keyword">const</span>
<span class="special">&amp;)</span></code></a>
</p>
</td>
<td>
<p>
The copy constructor.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1ac59521aa9a9b69104fa25c0f7b705354"><code class="computeroutput"><span class="identifier">rtree</span><span class="special">(</span><span class="identifier">rtree</span> <span class="keyword">const</span>
<span class="special">&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#classboost_1_1geometry_1_1index_1_1rtree_1a050fca8af38fe25548d4c22830b55bf2"><code class="computeroutput"><span class="identifier">rtree</span><span class="special">(</span><span class="identifier">rtree</span> <span class="special">&amp;&amp;)</span></code></a>
</p>
</td>
<td>
<p>
The moving constructor.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1ae0b4e031554daa6e6e8d3a0f95630260"><code class="computeroutput"><span class="identifier">rtree</span><span class="special">(</span><span class="identifier">rtree</span> <span class="special">&amp;&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 moving constructor.
</p>
</td>
</tr>
</tbody>
</table></div>
<h6>
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.h8"></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>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Modifier
</p>
</th>
<th>
<p>
Function
</p>
</th>
<th>
<p>
Description
</p>
</th>
</tr></thead>
<tbody>
<tr>
<td>
</td>
<td>
<p>
<a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1ab823a214501cb0f9fd00ba12a1ade179"><code class="computeroutput"><span class="keyword">operator</span><span class="special">=(</span><span class="keyword">const</span> <span class="identifier">rtree</span>
<span class="special">&amp;)</span></code></a>
</p>
</td>
<td>
<p>
The assignment operator.
</p>
</td>
</tr>
<tr>
<td>
</td>
<td>
<p>
<a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a44bd4edee49db92c18b6bbbba77b42be"><code class="computeroutput"><span class="keyword">operator</span><span class="special">=(</span><span class="identifier">rtree</span> <span class="special">&amp;&amp;)</span></code></a>
</p>
</td>
<td>
<p>
The moving assignment.
</p>
</td>
</tr>
<tr>
<td>
</td>
<td>
<p>
<a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1aad0285d25f96341a8dd6cc22feb3bd73"><code class="computeroutput"><span class="identifier">swap</span><span class="special">(</span><span class="identifier">rtree</span> <span class="special">&amp;)</span></code></a>
</p>
</td>
<td>
<p>
Swaps contents of two rtrees.
</p>
</td>
</tr>
<tr>
<td>
</td>
<td>
<p>
<a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1af6d5bd81e46cb4ff89277c753133664c"><code class="computeroutput"><span class="identifier">insert</span><span class="special">(</span><span class="identifier">value_type</span> <span class="keyword">const</span>
<span class="special">&amp;)</span></code></a>
</p>
</td>
<td>
<p>
Insert a value to the index.
</p>
</td>
</tr>
<tr>
<td>
</td>
<td>
<p>
<a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a5263a3faac7b4f0090d4ad1d44cc540d"><code class="computeroutput"><span class="identifier">insert</span><span class="special">(</span><span class="identifier">Iterator</span><span class="special">,</span>
<span class="identifier">Iterator</span><span class="special">)</span></code></a>
</p>
</td>
<td>
<p>
Insert a range of values to the index.
</p>
</td>
</tr>
<tr>
<td>
</td>
<td>
<p>
<a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1abb624abd9268b41e815d40342b2634c2"><code class="computeroutput"><span class="identifier">insert</span><span class="special">(</span><span class="identifier">Range</span> <span class="keyword">const</span>
<span class="special">&amp;)</span></code></a>
</p>
</td>
<td>
<p>
Insert a range of values to the index.
</p>
</td>
</tr>
<tr>
<td>
</td>
<td>
<p>
<a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1af6ca6909354a997f89411ef40ea5688a"><code class="computeroutput"><span class="identifier">remove</span><span class="special">(</span><span class="identifier">value_type</span> <span class="keyword">const</span>
<span class="special">&amp;)</span></code></a>
</p>
</td>
<td>
<p>
Remove a value from the container.
</p>
</td>
</tr>
<tr>
<td>
</td>
<td>
<p>
<a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a6e9123114697d65b16ebc49cd5371fbd"><code class="computeroutput"><span class="identifier">remove</span><span class="special">(</span><span class="identifier">Iterator</span><span class="special">,</span>
<span class="identifier">Iterator</span><span class="special">)</span></code></a>
</p>
</td>
<td>
<p>
Remove a range of values from the container.
</p>
</td>
</tr>
<tr>
<td>
</td>
<td>
<p>
<a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a5a57bb93b0b2d7ea1c659e925f918e9c"><code class="computeroutput"><span class="identifier">remove</span><span class="special">(</span><span class="identifier">Range</span> <span class="keyword">const</span>
<span class="special">&amp;)</span></code></a>
</p>
</td>
<td>
<p>
Remove a range of values from the container.
</p>
</td>
</tr>
<tr>
<td>
<p>
<code class="computeroutput"><span class="keyword">const</span></code>
</p>
</td>
<td>
<p>
<a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a25ce2ead0e8a2d270105f4958237e949"><code class="computeroutput"><span class="identifier">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 passed predicates e.g. nearest to some Point
and/or intersecting some Box.
</p>
</td>
</tr>
<tr>
<td>
<p>
<code class="computeroutput"><span class="keyword">const</span></code>
</p>
</td>
<td>
<p>
<a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a89561a834563f2ed6fc782bad16143fd"><code class="computeroutput"><span class="identifier">size</span><span class="special">()</span></code></a>
</p>
</td>
<td>
<p>
Returns the number of stored values.
</p>
</td>
</tr>
<tr>
<td>
<p>
<code class="computeroutput"><span class="keyword">const</span></code>
</p>
</td>
<td>
<p>
<a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1ae889567443b0ba0dbdb975564c55804c"><code class="computeroutput"><span class="identifier">empty</span><span class="special">()</span></code></a>
</p>
</td>
<td>
<p>
Query if the container is empty.
</p>
</td>
</tr>
<tr>
<td>
</td>
<td>
<p>
<a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1ae6027e42d28a4bf93e74b055c79e6b09"><code class="computeroutput"><span class="identifier">clear</span><span class="special">()</span></code></a>
</p>
</td>
<td>
<p>
Removes all values stored in the container.
</p>
</td>
</tr>
<tr>
<td>
<p>
<code class="computeroutput"><span class="keyword">const</span></code>
</p>
</td>
<td>
<p>
<a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1aeba4f1afee40262204dd074a93536ebf"><code class="computeroutput"><span class="identifier">bounds</span><span class="special">()</span></code></a>
</p>
</td>
<td>
<p>
Returns the box able to contain all values stored in the container.
</p>
</td>
</tr>
<tr>
<td>
<p>
<code class="computeroutput"><span class="keyword">const</span></code>
</p>
</td>
<td>
<p>
<a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a17fce1fac81f6460d2c3a5744f4963ee"><code class="computeroutput"><span class="identifier">count</span><span class="special">(</span><span class="identifier">ValueOrIndexable</span> <span class="keyword">const</span>
<span class="special">&amp;)</span></code></a>
</p>
</td>
<td>
<p>
Count Values or Indexables stored in the container.
</p>
</td>
</tr>
<tr>
<td>
<p>
<code class="computeroutput"><span class="keyword">const</span></code>
</p>
</td>
<td>
<p>
<a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a18910715f67608ff010556ac41f51606"><code class="computeroutput"><span class="identifier">parameters</span><span class="special">()</span></code></a>
</p>
</td>
<td>
<p>
Returns parameters.
</p>
</td>
</tr>
<tr>
<td>
<p>
<code class="computeroutput"><span class="keyword">const</span></code>
</p>
</td>
<td>
<p>
<a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1afc7e9a4bd53a58552c17c1e7cb997258"><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>
<code class="computeroutput"><span class="keyword">const</span></code>
</p>
</td>
<td>
<p>
<a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a1eeb303253f4cabe3a89a82ed41247ff"><code class="computeroutput"><span class="identifier">get_allocator</span><span class="special">()</span></code></a>
</p>
</td>
<td>
<p>
Returns allocator used by the rtree.
</p>
</td>
</tr>
</tbody>
</table></div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree__"></a><a name="classboost_1_1geometry_1_1index_1_1rtree_1a393bb202f84b6fe5613df02d1ba2a092"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree__" title="rtree()">rtree()</a>
</h5></div></div></div>
<p>
The constructor.
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree__.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree__.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree__.synopsis">Synopsis</a>
</h6>
<pre class="programlisting"><code class="computeroutput"><span class="identifier">rtree</span></code><code class="computeroutput"><span class="special">(</span></code><code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1af85d4e399a807b3e4e46d38a0b4ffc5a">parameters_type</a></code><code class="computeroutput"> <span class="keyword">const</span> <span class="special">&amp;</span></code> <code class="computeroutput"><span class="identifier">parameters</span></code> = <code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1af85d4e399a807b3e4e46d38a0b4ffc5a">parameters_type</a></code><code class="computeroutput"><span class="special">()</span></code><code class="computeroutput"><span class="special">,</span></code> <code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1adbc30a1fa986e2e856e0662111ac2d91">translator_type</a></code><code class="computeroutput"> <span class="keyword">const</span> <span class="special">&amp;</span></code> <code class="computeroutput"><span class="identifier">translator</span></code> = <code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1adbc30a1fa986e2e856e0662111ac2d91">translator_type</a></code><code class="computeroutput"><span class="special">()</span></code><code class="computeroutput"><span class="special">)</span></code>
</pre>
<h6>
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree__.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree__.modifier_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree__.modifier_s_">Modifier(s)</a>
</h6>
<p>
</p>
<pre class="programlisting"><span class="keyword">explicit</span></pre>
<p>
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree__.h2"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree__.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree__.parameter_s_">Parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Type
</p>
</th>
<th>
<p>
Name
</p>
</th>
<th>
<p>
Description
</p>
</th>
</tr></thead>
<tbody>
<tr>
<td>
<p>
<code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1af85d4e399a807b3e4e46d38a0b4ffc5a">parameters_type</a></code><code class="computeroutput">
<span class="keyword">const</span> <span class="special">&amp;</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="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1adbc30a1fa986e2e856e0662111ac2d91">translator_type</a></code><code class="computeroutput">
<span class="keyword">const</span> <span class="special">&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.rtree__.h3"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree__.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree__.throws">Throws</a>
</h6>
<p>
If allocator default constructor throws.
</p>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_parameters_type_const____translator_type_const____allocator_type_"></a><a name="classboost_1_1geometry_1_1index_1_1rtree_1a434839ea5dd2e57f9491d18520621c4b"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_parameters_type_const____translator_type_const____allocator_type_" title="rtree(parameters_type const &amp;, translator_type const &amp;, allocator_type)">rtree(parameters_type
const &amp;, 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.rtree_parameters_type_const____translator_type_const____allocator_type_.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_parameters_type_const____translator_type_const____allocator_type_.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_parameters_type_const____translator_type_const____allocator_type_.synopsis">Synopsis</a>
</h6>
<pre class="programlisting"><code class="computeroutput"><span class="identifier">rtree</span></code><code class="computeroutput"><span class="special">(</span></code><code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1af85d4e399a807b3e4e46d38a0b4ffc5a">parameters_type</a></code><code class="computeroutput"> <span class="keyword">const</span> <span class="special">&amp;</span></code> <code class="computeroutput"><span class="identifier">parameters</span></code><code class="computeroutput"><span class="special">,</span></code>
<code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1adbc30a1fa986e2e856e0662111ac2d91">translator_type</a></code><code class="computeroutput"> <span class="keyword">const</span> <span class="special">&amp;</span></code> <code class="computeroutput"><span class="identifier">translator</span></code><code class="computeroutput"><span class="special">,</span></code>
<code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a9d35bc38fa697c6f600548fb5b38807d">allocator_type</a></code> <code class="computeroutput"><span class="identifier">allocator</span></code><code class="computeroutput"><span class="special">)</span></code>
</pre>
<h6>
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_parameters_type_const____translator_type_const____allocator_type_.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_parameters_type_const____translator_type_const____allocator_type_.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_parameters_type_const____translator_type_const____allocator_type_.parameter_s_">Parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Type
</p>
</th>
<th>
<p>
Name
</p>
</th>
<th>
<p>
Description
</p>
</th>
</tr></thead>
<tbody>
<tr>
<td>
<p>
<code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1af85d4e399a807b3e4e46d38a0b4ffc5a">parameters_type</a></code><code class="computeroutput">
<span class="keyword">const</span> <span class="special">&amp;</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="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1adbc30a1fa986e2e856e0662111ac2d91">translator_type</a></code><code class="computeroutput">
<span class="keyword">const</span> <span class="special">&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="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a9d35bc38fa697c6f600548fb5b38807d">allocator_type</a></code>
</p>
</td>
<td>
<p>
<code class="computeroutput"><span class="identifier">allocator</span></code>
</p>
</td>
<td>
<p>
The allocator object.
</p>
</td>
</tr>
</tbody>
</table></div>
<h6>
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_parameters_type_const____translator_type_const____allocator_type_.h2"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_parameters_type_const____translator_type_const____allocator_type_.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_parameters_type_const____translator_type_const____allocator_type_.throws">Throws</a>
</h6>
<p>
If allocator copy constructor throws.
</p>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_iterator__iterator_"></a><a name="classboost_1_1geometry_1_1index_1_1rtree_1ace0b58f496b7eb00c518b4fc2794f4bc"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_iterator__iterator_" title="rtree(Iterator, Iterator)">rtree(Iterator,
Iterator)</a>
</h5></div></div></div>
<p>
The constructor.
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_iterator__iterator_.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_iterator__iterator_.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_iterator__iterator_.synopsis">Synopsis</a>
</h6>
<pre class="programlisting"><code class="computeroutput"><span class="keyword">template</span><span class="special">&lt;</span></code><code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Iterator</span></code><code class="computeroutput"><span class="special">&gt;</span></code>
<code class="computeroutput"><span class="identifier">rtree</span></code><code class="computeroutput"><span class="special">(</span></code><code class="computeroutput"><span class="identifier">Iterator</span></code> <code class="computeroutput"><span class="identifier">first</span></code><code class="computeroutput"><span class="special">,</span></code>
<code class="computeroutput"><span class="identifier">Iterator</span></code> <code class="computeroutput"><span class="identifier">last</span></code><code class="computeroutput"><span class="special">,</span></code>
<code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1af85d4e399a807b3e4e46d38a0b4ffc5a">parameters_type</a></code><code class="computeroutput"> <span class="keyword">const</span> <span class="special">&amp;</span></code> <code class="computeroutput"><span class="identifier">parameters</span></code> = <code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1af85d4e399a807b3e4e46d38a0b4ffc5a">parameters_type</a></code><code class="computeroutput"><span class="special">()</span></code><code class="computeroutput"><span class="special">,</span></code>
<code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1adbc30a1fa986e2e856e0662111ac2d91">translator_type</a></code><code class="computeroutput"> <span class="keyword">const</span> <span class="special">&amp;</span></code> <code class="computeroutput"><span class="identifier">translator</span></code> = <code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1adbc30a1fa986e2e856e0662111ac2d91">translator_type</a></code><code class="computeroutput"><span class="special">()</span></code><code class="computeroutput"><span class="special">,</span></code>
<code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a9d35bc38fa697c6f600548fb5b38807d">allocator_type</a></code> <code class="computeroutput"><span class="identifier">allocator</span></code> = <code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a9d35bc38fa697c6f600548fb5b38807d">allocator_type</a></code><code class="computeroutput"><span class="special">()</span></code><code class="computeroutput"><span class="special">)</span></code>
</pre>
<h6>
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_iterator__iterator_.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_iterator__iterator_.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_iterator__iterator_.parameter_s_">Parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Type
</p>
</th>
<th>
<p>
Name
</p>
</th>
<th>
<p>
Description
</p>
</th>
</tr></thead>
<tbody>
<tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">Iterator</span></code>
</p>
</td>
<td>
<p>
<code class="computeroutput"><span class="identifier">first</span></code>
</p>
</td>
<td>
<p>
The beginning of the range of Values.
</p>
</td>
</tr>
<tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">Iterator</span></code>
</p>
</td>
<td>
<p>
<code class="computeroutput"><span class="identifier">last</span></code>
</p>
</td>
<td>
<p>
The end of the range of Values.
</p>
</td>
</tr>
<tr>
<td>
<p>
<code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1af85d4e399a807b3e4e46d38a0b4ffc5a">parameters_type</a></code><code class="computeroutput">
<span class="keyword">const</span> <span class="special">&amp;</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="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1adbc30a1fa986e2e856e0662111ac2d91">translator_type</a></code><code class="computeroutput">
<span class="keyword">const</span> <span class="special">&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="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a9d35bc38fa697c6f600548fb5b38807d">allocator_type</a></code>
</p>
</td>
<td>
<p>
<code class="computeroutput"><span class="identifier">allocator</span></code>
</p>
</td>
<td>
<p>
The allocator object.
</p>
</td>
</tr>
</tbody>
</table></div>
<h6>
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_iterator__iterator_.h2"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_iterator__iterator_.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_iterator__iterator_.throws">Throws</a>
</h6>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem">
If allocator copy constructor throws.
</li>
<li class="listitem">
If Value copy constructor or copy assignment throws.
</li>
<li class="listitem">
If allocation throws.
</li>
<li class="listitem">
When memory allocation for Node fails.
</li>
</ul></div>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_range_const___"></a><a name="classboost_1_1geometry_1_1index_1_1rtree_1a513f271626372c6dad5488f64db6d1d4"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_range_const___" 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.rtree_range_const___.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_range_const___.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_range_const___.synopsis">Synopsis</a>
</h6>
<pre class="programlisting"><code class="computeroutput"><span class="keyword">template</span><span class="special">&lt;</span></code><code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Range</span></code><code class="computeroutput"><span class="special">&gt;</span></code>
<code class="computeroutput"><span class="identifier">rtree</span></code><code class="computeroutput"><span class="special">(</span></code><code class="computeroutput"><span class="identifier">Range</span> <span class="keyword">const</span> <span class="special">&amp;</span></code> <code class="computeroutput"><span class="identifier">rng</span></code><code class="computeroutput"><span class="special">,</span></code>
<code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1af85d4e399a807b3e4e46d38a0b4ffc5a">parameters_type</a></code><code class="computeroutput"> <span class="keyword">const</span> <span class="special">&amp;</span></code> <code class="computeroutput"><span class="identifier">parameters</span></code> = <code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1af85d4e399a807b3e4e46d38a0b4ffc5a">parameters_type</a></code><code class="computeroutput"><span class="special">()</span></code><code class="computeroutput"><span class="special">,</span></code>
<code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1adbc30a1fa986e2e856e0662111ac2d91">translator_type</a></code><code class="computeroutput"> <span class="keyword">const</span> <span class="special">&amp;</span></code> <code class="computeroutput"><span class="identifier">translator</span></code> = <code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1adbc30a1fa986e2e856e0662111ac2d91">translator_type</a></code><code class="computeroutput"><span class="special">()</span></code><code class="computeroutput"><span class="special">,</span></code>
<code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a9d35bc38fa697c6f600548fb5b38807d">allocator_type</a></code> <code class="computeroutput"><span class="identifier">allocator</span></code> = <code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a9d35bc38fa697c6f600548fb5b38807d">allocator_type</a></code><code class="computeroutput"><span class="special">()</span></code><code class="computeroutput"><span class="special">)</span></code>
</pre>
<h6>
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_range_const___.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_range_const___.modifier_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_range_const___.modifier_s_">Modifier(s)</a>
</h6>
<p>
</p>
<pre class="programlisting"><span class="keyword">explicit</span></pre>
<p>
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_range_const___.h2"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_range_const___.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_range_const___.parameter_s_">Parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Type
</p>
</th>
<th>
<p>
Name
</p>
</th>
<th>
<p>
Description
</p>
</th>
</tr></thead>
<tbody>
<tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">Range</span> <span class="keyword">const</span>
<span class="special">&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="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1af85d4e399a807b3e4e46d38a0b4ffc5a">parameters_type</a></code><code class="computeroutput">
<span class="keyword">const</span> <span class="special">&amp;</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="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1adbc30a1fa986e2e856e0662111ac2d91">translator_type</a></code><code class="computeroutput">
<span class="keyword">const</span> <span class="special">&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="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a9d35bc38fa697c6f600548fb5b38807d">allocator_type</a></code>
</p>
</td>
<td>
<p>
<code class="computeroutput"><span class="identifier">allocator</span></code>
</p>
</td>
<td>
<p>
The allocator object.
</p>
</td>
</tr>
</tbody>
</table></div>
<h6>
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_range_const___.h3"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_range_const___.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_range_const___.throws">Throws</a>
</h6>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem">
If allocator copy constructor throws.
</li>
<li class="listitem">
If Value copy constructor or copy assignment throws.
</li>
<li class="listitem">
If allocation throws.
</li>
<li class="listitem">
When memory allocation for Node fails.
</li>
</ul></div>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree._rtree__"></a><a name="classboost_1_1geometry_1_1index_1_1rtree_1ae8b10914ec434d1ee6877f5e1000b674"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree._rtree__" title="~rtree()">~rtree()</a>
</h5></div></div></div>
<p>
The destructor.
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree._rtree__.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost__geometry__index__rtree._rtree__.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree._rtree__.synopsis">Synopsis</a>
</h6>
<pre class="programlisting"><code class="computeroutput"><span class="special">~</span><span class="identifier">rtree</span></code><code class="computeroutput"><span class="special">()</span></code>
</pre>
<h6>
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree._rtree__.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost__geometry__index__rtree._rtree__.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree._rtree__.throws">Throws</a>
</h6>
<p>
Nothing.
</p>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_rtree_const___"></a><a name="classboost_1_1geometry_1_1index_1_1rtree_1a006904b4e7dcef1fd1efcb70a010964f"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_rtree_const___" title="rtree(rtree const &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.rtree_rtree_const___.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_rtree_const___.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_rtree_const___.description">Description</a>
</h6>
<p>
It uses parameters, translator and allocator from the source tree.
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_rtree_const___.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_rtree_const___.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_rtree_const___.synopsis">Synopsis</a>
</h6>
<pre class="programlisting"><code class="computeroutput"><span class="identifier">rtree</span></code><code class="computeroutput"><span class="special">(</span></code><code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree">rtree</a></code><code class="computeroutput"> <span class="keyword">const</span> <span class="special">&amp;</span></code> <code class="computeroutput"><span class="identifier">src</span></code><code class="computeroutput"><span class="special">)</span></code>
</pre>
<h6>
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_rtree_const___.h2"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_rtree_const___.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_rtree_const___.parameter_s_">Parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Type
</p>
</th>
<th>
<p>
Name
</p>
</th>
<th>
<p>
Description
</p>
</th>
</tr></thead>
<tbody><tr>
<td>
<p>
<code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree">rtree</a></code><code class="computeroutput">
<span class="keyword">const</span> <span class="special">&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.rtree_rtree_const___.h3"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_rtree_const___.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_rtree_const___.throws">Throws</a>
</h6>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem">
If allocator copy constructor throws.
</li>
<li class="listitem">
If Value copy constructor throws.
</li>
<li class="listitem">
If allocation throws.
</li>
<li class="listitem">
When memory allocation for Node fails.
</li>
</ul></div>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_rtree_const____allocator_type_const___"></a><a name="classboost_1_1geometry_1_1index_1_1rtree_1ac59521aa9a9b69104fa25c0f7b705354"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_rtree_const____allocator_type_const___" title="rtree(rtree const &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.rtree_rtree_const____allocator_type_const___.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_rtree_const____allocator_type_const___.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_rtree_const____allocator_type_const___.description">Description</a>
</h6>
<p>
It uses Parameters and translator from the source tree.
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_rtree_const____allocator_type_const___.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_rtree_const____allocator_type_const___.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_rtree_const____allocator_type_const___.synopsis">Synopsis</a>
</h6>
<pre class="programlisting"><code class="computeroutput"><span class="identifier">rtree</span></code><code class="computeroutput"><span class="special">(</span></code><code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree">rtree</a></code><code class="computeroutput"> <span class="keyword">const</span> <span class="special">&amp;</span></code> <code class="computeroutput"><span class="identifier">src</span></code><code class="computeroutput"><span class="special">,</span></code> <code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a9d35bc38fa697c6f600548fb5b38807d">allocator_type</a></code><code class="computeroutput"> <span class="keyword">const</span> <span class="special">&amp;</span></code> <code class="computeroutput"><span class="identifier">allocator</span></code><code class="computeroutput"><span class="special">)</span></code>
</pre>
<h6>
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_rtree_const____allocator_type_const___.h2"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_rtree_const____allocator_type_const___.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_rtree_const____allocator_type_const___.parameter_s_">Parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Type
</p>
</th>
<th>
<p>
Name
</p>
</th>
<th>
<p>
Description
</p>
</th>
</tr></thead>
<tbody>
<tr>
<td>
<p>
<code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree">rtree</a></code><code class="computeroutput">
<span class="keyword">const</span> <span class="special">&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="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a9d35bc38fa697c6f600548fb5b38807d">allocator_type</a></code><code class="computeroutput">
<span class="keyword">const</span> <span class="special">&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.rtree_rtree_const____allocator_type_const___.h3"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_rtree_const____allocator_type_const___.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_rtree_const____allocator_type_const___.throws">Throws</a>
</h6>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem">
If allocator copy constructor throws.
</li>
<li class="listitem">
If Value copy constructor throws.
</li>
<li class="listitem">
If allocation throws.
</li>
<li class="listitem">
When memory allocation for Node fails.
</li>
</ul></div>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_rtree____"></a><a name="classboost_1_1geometry_1_1index_1_1rtree_1a050fca8af38fe25548d4c22830b55bf2"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_rtree____" title="rtree(rtree &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.rtree_rtree____.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_rtree____.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_rtree____.description">Description</a>
</h6>
<p>
It uses parameters, translator and allocator from the source tree.
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_rtree____.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_rtree____.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_rtree____.synopsis">Synopsis</a>
</h6>
<pre class="programlisting"><code class="computeroutput"><span class="identifier">rtree</span></code><code class="computeroutput"><span class="special">(</span></code><code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree">rtree</a></code><code class="computeroutput"> <span class="special">&amp;&amp;</span></code> <code class="computeroutput"><span class="identifier">src</span></code><code class="computeroutput"><span class="special">)</span></code>
</pre>
<h6>
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_rtree____.h2"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_rtree____.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_rtree____.parameter_s_">Parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Type
</p>
</th>
<th>
<p>
Name
</p>
</th>
<th>
<p>
Description
</p>
</th>
</tr></thead>
<tbody><tr>
<td>
<p>
<code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree">rtree</a></code><code class="computeroutput">
<span class="special">&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.rtree_rtree____.h3"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_rtree____.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_rtree____.throws">Throws</a>
</h6>
<p>
Nothing.
</p>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_rtree_____allocator_type_const___"></a><a name="classboost_1_1geometry_1_1index_1_1rtree_1ae0b4e031554daa6e6e8d3a0f95630260"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_rtree_____allocator_type_const___" title="rtree(rtree &amp;&amp;, allocator_type const &amp;)">rtree(rtree
&amp;&amp;, allocator_type const &amp;)</a>
</h5></div></div></div>
<p>
The moving constructor.
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_rtree_____allocator_type_const___.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_rtree_____allocator_type_const___.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_rtree_____allocator_type_const___.description">Description</a>
</h6>
<p>
It uses parameters and translator from the source tree.
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_rtree_____allocator_type_const___.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_rtree_____allocator_type_const___.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_rtree_____allocator_type_const___.synopsis">Synopsis</a>
</h6>
<pre class="programlisting"><code class="computeroutput"><span class="identifier">rtree</span></code><code class="computeroutput"><span class="special">(</span></code><code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree">rtree</a></code><code class="computeroutput"> <span class="special">&amp;&amp;</span></code> <code class="computeroutput"><span class="identifier">src</span></code><code class="computeroutput"><span class="special">,</span></code> <code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a9d35bc38fa697c6f600548fb5b38807d">allocator_type</a></code><code class="computeroutput"> <span class="keyword">const</span> <span class="special">&amp;</span></code> <code class="computeroutput"><span class="identifier">allocator</span></code><code class="computeroutput"><span class="special">)</span></code>
</pre>
<h6>
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_rtree_____allocator_type_const___.h2"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_rtree_____allocator_type_const___.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_rtree_____allocator_type_const___.parameter_s_">Parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Type
</p>
</th>
<th>
<p>
Name
</p>
</th>
<th>
<p>
Description
</p>
</th>
</tr></thead>
<tbody>
<tr>
<td>
<p>
<code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree">rtree</a></code><code class="computeroutput">
<span class="special">&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>
<tr>
<td>
<p>
<code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a9d35bc38fa697c6f600548fb5b38807d">allocator_type</a></code><code class="computeroutput">
<span class="keyword">const</span> <span class="special">&amp;</span></code>
</p>
</td>
<td>
<p>
<code class="computeroutput"><span class="identifier">allocator</span></code>
</p>
</td>
<td>
<p>
The allocator.
</p>
</td>
</tr>
</tbody>
</table></div>
<h6>
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_rtree_____allocator_type_const___.h3"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_rtree_____allocator_type_const___.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.rtree_rtree_____allocator_type_const___.throws">Throws</a>
</h6>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem">
If allocator copy constructor throws.
</li>
<li class="listitem">
If Value copy constructor throws (only if allocators aren't equal).
</li>
<li class="listitem">
If allocation throws (only if allocators aren't equal).
</li>
<li class="listitem">
When memory allocation for Node fails (only if allocators aren't
equal).
</li>
</ul></div>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.operator__const_rtree___"></a><a name="classboost_1_1geometry_1_1index_1_1rtree_1ab823a214501cb0f9fd00ba12a1ade179"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.operator__const_rtree___" title="operator=(const rtree &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.operator__const_rtree___.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.operator__const_rtree___.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.operator__const_rtree___.description">Description</a>
</h6>
<p>
It uses parameters and translator from the source tree.
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.operator__const_rtree___.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.operator__const_rtree___.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.operator__const_rtree___.synopsis">Synopsis</a>
</h6>
<pre class="programlisting"><code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree">rtree</a></code><code class="computeroutput"> <span class="special">&amp;</span></code> <code class="computeroutput"><span class="keyword">operator</span><span class="special">=</span></code><code class="computeroutput"><span class="special">(</span></code><code class="computeroutput"><span class="keyword">const</span> </code><code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree">rtree</a></code><code class="computeroutput"> <span class="special">&amp;</span></code> <code class="computeroutput"><span class="identifier">src</span></code><code class="computeroutput"><span class="special">)</span></code>
</pre>
<h6>
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.operator__const_rtree___.h2"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.operator__const_rtree___.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.operator__const_rtree___.parameter_s_">Parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Type
</p>
</th>
<th>
<p>
Name
</p>
</th>
<th>
<p>
Description
</p>
</th>
</tr></thead>
<tbody><tr>
<td>
<p>
<code class="computeroutput"><span class="keyword">const</span> </code><code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree">rtree</a></code><code class="computeroutput">
<span class="special">&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.operator__const_rtree___.h3"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.operator__const_rtree___.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.operator__const_rtree___.throws">Throws</a>
</h6>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem">
If Value copy constructor throws.
</li>
<li class="listitem">
If allocation throws.
</li>
<li class="listitem">
When nodes allocation fails.
</li>
</ul></div>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.operator__rtree____"></a><a name="classboost_1_1geometry_1_1index_1_1rtree_1a44bd4edee49db92c18b6bbbba77b42be"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.operator__rtree____" title="operator=(rtree &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.operator__rtree____.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.operator__rtree____.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.operator__rtree____.description">Description</a>
</h6>
<p>
It uses parameters and translator from the source tree.
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.operator__rtree____.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.operator__rtree____.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.operator__rtree____.synopsis">Synopsis</a>
</h6>
<pre class="programlisting"><code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree">rtree</a></code><code class="computeroutput"> <span class="special">&amp;</span></code> <code class="computeroutput"><span class="keyword">operator</span><span class="special">=</span></code><code class="computeroutput"><span class="special">(</span></code><code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree">rtree</a></code><code class="computeroutput"> <span class="special">&amp;&amp;</span></code> <code class="computeroutput"><span class="identifier">src</span></code><code class="computeroutput"><span class="special">)</span></code>
</pre>
<h6>
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.operator__rtree____.h2"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.operator__rtree____.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.operator__rtree____.parameter_s_">Parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Type
</p>
</th>
<th>
<p>
Name
</p>
</th>
<th>
<p>
Description
</p>
</th>
</tr></thead>
<tbody><tr>
<td>
<p>
<code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree">rtree</a></code><code class="computeroutput">
<span class="special">&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.operator__rtree____.h3"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.operator__rtree____.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.operator__rtree____.throws">Throws</a>
</h6>
<p>
Only if allocators aren't equal.
</p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem">
If Value copy constructor throws.
</li>
<li class="listitem">
If allocation throws.
</li>
<li class="listitem">
When nodes allocation fails.
</li>
</ul></div>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.swap_rtree___"></a><a name="classboost_1_1geometry_1_1index_1_1rtree_1aad0285d25f96341a8dd6cc22feb3bd73"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.swap_rtree___" title="swap(rtree &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.swap_rtree___.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.swap_rtree___.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.swap_rtree___.description">Description</a>
</h6>
<p>
Parameters, translator and allocators are swapped as well.
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.swap_rtree___.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.swap_rtree___.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.swap_rtree___.synopsis">Synopsis</a>
</h6>
<pre class="programlisting"><code class="computeroutput"><span class="keyword">void</span></code> <code class="computeroutput"><span class="identifier">swap</span></code><code class="computeroutput"><span class="special">(</span></code><code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree">rtree</a></code><code class="computeroutput"> <span class="special">&amp;</span></code> <code class="computeroutput"><span class="identifier">other</span></code><code class="computeroutput"><span class="special">)</span></code>
</pre>
<h6>
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.swap_rtree___.h2"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.swap_rtree___.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.swap_rtree___.parameter_s_">Parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Type
</p>
</th>
<th>
<p>
Name
</p>
</th>
<th>
<p>
Description
</p>
</th>
</tr></thead>
<tbody><tr>
<td>
<p>
<code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree">rtree</a></code><code class="computeroutput">
<span class="special">&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.swap_rtree___.h3"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.swap_rtree___.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.swap_rtree___.throws">Throws</a>
</h6>
<p>
If allocators swap throws.
</p>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.insert_value_type_const___"></a><a name="classboost_1_1geometry_1_1index_1_1rtree_1af6d5bd81e46cb4ff89277c753133664c"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.insert_value_type_const___" title="insert(value_type const &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.insert_value_type_const___.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.insert_value_type_const___.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.insert_value_type_const___.synopsis">Synopsis</a>
</h6>
<pre class="programlisting"><code class="computeroutput"><span class="keyword">void</span></code> <code class="computeroutput"><span class="identifier">insert</span></code><code class="computeroutput"><span class="special">(</span></code><code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a9979db9ef37591985256cb8ad31862bb">value_type</a></code><code class="computeroutput"> <span class="keyword">const</span> <span class="special">&amp;</span></code> <code class="computeroutput"><span class="identifier">value</span></code><code class="computeroutput"><span class="special">)</span></code>
</pre>
<h6>
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.insert_value_type_const___.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.insert_value_type_const___.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.insert_value_type_const___.parameter_s_">Parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Type
</p>
</th>
<th>
<p>
Name
</p>
</th>
<th>
<p>
Description
</p>
</th>
</tr></thead>
<tbody><tr>
<td>
<p>
<code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a9979db9ef37591985256cb8ad31862bb">value_type</a></code><code class="computeroutput">
<span class="keyword">const</span> <span class="special">&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.insert_value_type_const___.h2"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.insert_value_type_const___.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.insert_value_type_const___.throws">Throws</a>
</h6>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem">
If Value copy constructor or copy assignment throws.
</li>
<li class="listitem">
If allocation throws.
</li>
<li class="listitem">
When nodes allocation fails.
</li>
</ul></div>
<div class="warning"><table border="0" summary="Warning">
<tr>
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Warning]" src="http://www.boost.org/doc/libs/release/doc/src/images/warning.png"></td>
<th align="left">Warning</th>
</tr>
<tr><td align="left" valign="top"><p>
This operation is not thread safe. If it throws, the R-tree may be
left in an inconsistent state, elements must not be inserted or removed,
methods may return invalid data.
</p></td></tr>
</table></div>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.insert_iterator__iterator_"></a><a name="classboost_1_1geometry_1_1index_1_1rtree_1a5263a3faac7b4f0090d4ad1d44cc540d"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.insert_iterator__iterator_" title="insert(Iterator, Iterator)">insert(Iterator,
Iterator)</a>
</h5></div></div></div>
<p>
Insert a range of values to the index.
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.insert_iterator__iterator_.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.insert_iterator__iterator_.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.insert_iterator__iterator_.synopsis">Synopsis</a>
</h6>
<pre class="programlisting"><code class="computeroutput"><span class="keyword">template</span><span class="special">&lt;</span></code><code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Iterator</span></code><code class="computeroutput"><span class="special">&gt;</span></code>
<code class="computeroutput"><span class="keyword">void</span></code> <code class="computeroutput"><span class="identifier">insert</span></code><code class="computeroutput"><span class="special">(</span></code><code class="computeroutput"><span class="identifier">Iterator</span></code> <code class="computeroutput"><span class="identifier">first</span></code><code class="computeroutput"><span class="special">,</span></code> <code class="computeroutput"><span class="identifier">Iterator</span></code> <code class="computeroutput"><span class="identifier">last</span></code><code class="computeroutput"><span class="special">)</span></code>
</pre>
<h6>
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.insert_iterator__iterator_.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.insert_iterator__iterator_.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.insert_iterator__iterator_.parameter_s_">Parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Type
</p>
</th>
<th>
<p>
Name
</p>
</th>
<th>
<p>
Description
</p>
</th>
</tr></thead>
<tbody>
<tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">Iterator</span></code>
</p>
</td>
<td>
<p>
<code class="computeroutput"><span class="identifier">first</span></code>
</p>
</td>
<td>
<p>
The beginning of the range of values.
</p>
</td>
</tr>
<tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">Iterator</span></code>
</p>
</td>
<td>
<p>
<code class="computeroutput"><span class="identifier">last</span></code>
</p>
</td>
<td>
<p>
The end of the range of values.
</p>
</td>
</tr>
</tbody>
</table></div>
<h6>
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.insert_iterator__iterator_.h2"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.insert_iterator__iterator_.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.insert_iterator__iterator_.throws">Throws</a>
</h6>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem">
If Value copy constructor or copy assignment throws.
</li>
<li class="listitem">
If allocation throws.
</li>
<li class="listitem">
When nodes allocation fails.
</li>
</ul></div>
<div class="warning"><table border="0" summary="Warning">
<tr>
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Warning]" src="http://www.boost.org/doc/libs/release/doc/src/images/warning.png"></td>
<th align="left">Warning</th>
</tr>
<tr><td align="left" valign="top"><p>
This operation is not thread safe. If it throws, the R-tree may be
left in an inconsistent state, elements must not be inserted or removed,
methods may return invalid data.
</p></td></tr>
</table></div>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.insert_range_const___"></a><a name="classboost_1_1geometry_1_1index_1_1rtree_1abb624abd9268b41e815d40342b2634c2"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.insert_range_const___" title="insert(Range const &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.insert_range_const___.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.insert_range_const___.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.insert_range_const___.synopsis">Synopsis</a>
</h6>
<pre class="programlisting"><code class="computeroutput"><span class="keyword">template</span><span class="special">&lt;</span></code><code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Range</span></code><code class="computeroutput"><span class="special">&gt;</span></code>
<code class="computeroutput"><span class="keyword">void</span></code> <code class="computeroutput"><span class="identifier">insert</span></code><code class="computeroutput"><span class="special">(</span></code><code class="computeroutput"><span class="identifier">Range</span> <span class="keyword">const</span> <span class="special">&amp;</span></code> <code class="computeroutput"><span class="identifier">rng</span></code><code class="computeroutput"><span class="special">)</span></code>
</pre>
<h6>
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.insert_range_const___.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.insert_range_const___.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.insert_range_const___.parameter_s_">Parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Type
</p>
</th>
<th>
<p>
Name
</p>
</th>
<th>
<p>
Description
</p>
</th>
</tr></thead>
<tbody><tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">Range</span> <span class="keyword">const</span>
<span class="special">&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.insert_range_const___.h2"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.insert_range_const___.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.insert_range_const___.throws">Throws</a>
</h6>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem">
If Value copy constructor or copy assignment throws.
</li>
<li class="listitem">
If allocation throws.
</li>
<li class="listitem">
When nodes allocation fails.
</li>
</ul></div>
<div class="warning"><table border="0" summary="Warning">
<tr>
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Warning]" src="http://www.boost.org/doc/libs/release/doc/src/images/warning.png"></td>
<th align="left">Warning</th>
</tr>
<tr><td align="left" valign="top"><p>
This operation is not thread safe. If it throws, the R-tree may be
left in an inconsistent state, elements must not be inserted or removed,
methods may return invalid data.
</p></td></tr>
</table></div>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.remove_value_type_const___"></a><a name="classboost_1_1geometry_1_1index_1_1rtree_1af6ca6909354a997f89411ef40ea5688a"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.remove_value_type_const___" title="remove(value_type const &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.remove_value_type_const___.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.remove_value_type_const___.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.remove_value_type_const___.description">Description</a>
</h6>
<p>
In contrast to the <code class="literal"><code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">set</span></code></code>
or <code class="literal"><code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">map</span> <span class="identifier">erase</span><span class="special">()</span></code></code> method this method removes
only one value from the container.
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.remove_value_type_const___.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.remove_value_type_const___.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.remove_value_type_const___.synopsis">Synopsis</a>
</h6>
<pre class="programlisting"><code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a5c1a657074c527ed65f858c1ab6b36e6">size_type</a></code> <code class="computeroutput"><span class="identifier">remove</span></code><code class="computeroutput"><span class="special">(</span></code><code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a9979db9ef37591985256cb8ad31862bb">value_type</a></code><code class="computeroutput"> <span class="keyword">const</span> <span class="special">&amp;</span></code> <code class="computeroutput"><span class="identifier">value</span></code><code class="computeroutput"><span class="special">)</span></code>
</pre>
<h6>
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.remove_value_type_const___.h2"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.remove_value_type_const___.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.remove_value_type_const___.parameter_s_">Parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Type
</p>
</th>
<th>
<p>
Name
</p>
</th>
<th>
<p>
Description
</p>
</th>
</tr></thead>
<tbody><tr>
<td>
<p>
<code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a9979db9ef37591985256cb8ad31862bb">value_type</a></code><code class="computeroutput">
<span class="keyword">const</span> <span class="special">&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.remove_value_type_const___.h3"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.remove_value_type_const___.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.remove_value_type_const___.returns">Returns</a>
</h6>
<p>
1 if the value was removed, 0 otherwise.
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.remove_value_type_const___.h4"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.remove_value_type_const___.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.remove_value_type_const___.throws">Throws</a>
</h6>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem">
If Value copy constructor or copy assignment throws.
</li>
<li class="listitem">
If allocation throws.
</li>
<li class="listitem">
When nodes allocation fails.
</li>
</ul></div>
<div class="warning"><table border="0" summary="Warning">
<tr>
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Warning]" src="http://www.boost.org/doc/libs/release/doc/src/images/warning.png"></td>
<th align="left">Warning</th>
</tr>
<tr><td align="left" valign="top"><p>
This operation is not thread safe. If it throws, the R-tree may be
left in an inconsistent state, elements must not be inserted or removed,
methods may return invalid data.
</p></td></tr>
</table></div>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.remove_iterator__iterator_"></a><a name="classboost_1_1geometry_1_1index_1_1rtree_1a6e9123114697d65b16ebc49cd5371fbd"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.remove_iterator__iterator_" title="remove(Iterator, Iterator)">remove(Iterator,
Iterator)</a>
</h5></div></div></div>
<p>
Remove a range of values from the container.
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.remove_iterator__iterator_.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.remove_iterator__iterator_.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.remove_iterator__iterator_.description">Description</a>
</h6>
<p>
In contrast to the <code class="literal"><code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">set</span></code></code>
or <code class="literal"><code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">map</span> <span class="identifier">erase</span><span class="special">()</span></code></code> method it doesn't take iterators
pointing to values stored in this container. It removes values equal
to these passed as a range. Furthermore this method removes only one
value for each one passed in the range, not all equal values.
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.remove_iterator__iterator_.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.remove_iterator__iterator_.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.remove_iterator__iterator_.synopsis">Synopsis</a>
</h6>
<pre class="programlisting"><code class="computeroutput"><span class="keyword">template</span><span class="special">&lt;</span></code><code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Iterator</span></code><code class="computeroutput"><span class="special">&gt;</span></code>
<code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a5c1a657074c527ed65f858c1ab6b36e6">size_type</a></code> <code class="computeroutput"><span class="identifier">remove</span></code><code class="computeroutput"><span class="special">(</span></code><code class="computeroutput"><span class="identifier">Iterator</span></code> <code class="computeroutput"><span class="identifier">first</span></code><code class="computeroutput"><span class="special">,</span></code> <code class="computeroutput"><span class="identifier">Iterator</span></code> <code class="computeroutput"><span class="identifier">last</span></code><code class="computeroutput"><span class="special">)</span></code>
</pre>
<h6>
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.remove_iterator__iterator_.h2"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.remove_iterator__iterator_.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.remove_iterator__iterator_.parameter_s_">Parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Type
</p>
</th>
<th>
<p>
Name
</p>
</th>
<th>
<p>
Description
</p>
</th>
</tr></thead>
<tbody>
<tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">Iterator</span></code>
</p>
</td>
<td>
<p>
<code class="computeroutput"><span class="identifier">first</span></code>
</p>
</td>
<td>
<p>
The beginning of the range of values.
</p>
</td>
</tr>
<tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">Iterator</span></code>
</p>
</td>
<td>
<p>
<code class="computeroutput"><span class="identifier">last</span></code>
</p>
</td>
<td>
<p>
The end of the range of values.
</p>
</td>
</tr>
</tbody>
</table></div>
<h6>
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.remove_iterator__iterator_.h3"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.remove_iterator__iterator_.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.remove_iterator__iterator_.returns">Returns</a>
</h6>
<p>
The number of removed values.
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.remove_iterator__iterator_.h4"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.remove_iterator__iterator_.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.remove_iterator__iterator_.throws">Throws</a>
</h6>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem">
If Value copy constructor or copy assignment throws.
</li>
<li class="listitem">
If allocation throws.
</li>
<li class="listitem">
When nodes allocation fails.
</li>
</ul></div>
<div class="warning"><table border="0" summary="Warning">
<tr>
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Warning]" src="http://www.boost.org/doc/libs/release/doc/src/images/warning.png"></td>
<th align="left">Warning</th>
</tr>
<tr><td align="left" valign="top"><p>
This operation is not thread safe. If it throws, the R-tree may be
left in an inconsistent state, elements must not be inserted or removed,
methods may return invalid data.
</p></td></tr>
</table></div>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.remove_range_const___"></a><a name="classboost_1_1geometry_1_1index_1_1rtree_1a5a57bb93b0b2d7ea1c659e925f918e9c"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.remove_range_const___" title="remove(Range const &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.remove_range_const___.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.remove_range_const___.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.remove_range_const___.description">Description</a>
</h6>
<p>
In contrast to the <code class="literal"><code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">set</span></code></code>
or <code class="literal"><code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">map</span> <span class="identifier">erase</span><span class="special">()</span></code></code> method it removes values
equal to these passed as a range. Furthermore, this method removes only
one value for each one passed in the range, not all equal values.
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.remove_range_const___.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.remove_range_const___.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.remove_range_const___.synopsis">Synopsis</a>
</h6>
<pre class="programlisting"><code class="computeroutput"><span class="keyword">template</span><span class="special">&lt;</span></code><code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Range</span></code><code class="computeroutput"><span class="special">&gt;</span></code>
<code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a5c1a657074c527ed65f858c1ab6b36e6">size_type</a></code> <code class="computeroutput"><span class="identifier">remove</span></code><code class="computeroutput"><span class="special">(</span></code><code class="computeroutput"><span class="identifier">Range</span> <span class="keyword">const</span> <span class="special">&amp;</span></code> <code class="computeroutput"><span class="identifier">rng</span></code><code class="computeroutput"><span class="special">)</span></code>
</pre>
<h6>
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.remove_range_const___.h2"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.remove_range_const___.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.remove_range_const___.parameter_s_">Parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Type
</p>
</th>
<th>
<p>
Name
</p>
</th>
<th>
<p>
Description
</p>
</th>
</tr></thead>
<tbody><tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">Range</span> <span class="keyword">const</span>
<span class="special">&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.remove_range_const___.h3"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.remove_range_const___.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.remove_range_const___.returns">Returns</a>
</h6>
<p>
The number of removed values.
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.remove_range_const___.h4"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.remove_range_const___.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.remove_range_const___.throws">Throws</a>
</h6>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem">
If Value copy constructor or copy assignment throws.
</li>
<li class="listitem">
If allocation throws.
</li>
<li class="listitem">
When nodes allocation fails.
</li>
</ul></div>
<div class="warning"><table border="0" summary="Warning">
<tr>
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Warning]" src="http://www.boost.org/doc/libs/release/doc/src/images/warning.png"></td>
<th align="left">Warning</th>
</tr>
<tr><td align="left" valign="top"><p>
This operation is not thread safe. If it throws, the R-tree may be
left in an inconsistent state, elements must not be inserted or removed,
methods may return invalid data.
</p></td></tr>
</table></div>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.query_predicates_const____outiter_"></a><a name="classboost_1_1geometry_1_1index_1_1rtree_1a25ce2ead0e8a2d270105f4958237e949"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.query_predicates_const____outiter_" title="query(Predicates const &amp;, OutIter)">query(Predicates
const &amp;, OutIter)</a>
</h5></div></div></div>
<p>
Finds values meeting passed predicates e.g. nearest to some Point and/or
intersecting some Box.
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.query_predicates_const____outiter_.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.query_predicates_const____outiter_.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.query_predicates_const____outiter_.description">Description</a>
</h6>
<p>
This query function performs spatial and k-nearest neighbor searches.
It allows to pass a set of predicates. Values will be returned only if
all predicates are met.
</p>
<p>
<span class="bold"><strong>Spatial predicates</strong></span>
</p>
<p>
Spatial predicates may be generated by one of the functions listed below:
</p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem">
<code class="literal"><a class="link" href="reference.html#group__predicates_1ga0a613a7f1d18ac33955bfdc2c5777c61">boost::geometry::index::covered_by()</a></code>,
</li>
<li class="listitem">
<code class="literal"><a class="link" href="reference.html#group__predicates_1ga351bb3b82e019ff45adf789385b8007d">boost::geometry::index::disjoint()</a></code>,
</li>
<li class="listitem">
<code class="literal"><a class="link" href="reference.html#group__predicates_1ga7301c50e0272976b9f1434536383e6d0">boost::geometry::index::intersects()</a></code>,
</li>
<li class="listitem">
<code class="literal"><a class="link" href="reference.html#group__predicates_1ga5511236f56be1defcccbf11e742ccd88">boost::geometry::index::overlaps()</a></code>,
</li>
<li class="listitem">
<code class="literal"><a class="link" href="reference.html#group__predicates_1gabf9c4e76dd8a09a4c476f2f8fa8a0e4d">boost::geometry::index::within()</a></code>,
</li>
</ul></div>
<p>
It is possible to negate spatial predicates:
</p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem">
<code class="literal"><code class="computeroutput"><span class="special">!</span> </code><a class="link" href="reference.html#group__predicates_1ga0a613a7f1d18ac33955bfdc2c5777c61">boost::geometry::index::covered_by()</a></code>,
</li>
<li class="listitem">
<code class="literal"><code class="computeroutput"><span class="special">!</span> </code><a class="link" href="reference.html#group__predicates_1ga351bb3b82e019ff45adf789385b8007d">boost::geometry::index::disjoint()</a></code>,
</li>
<li class="listitem">
<code class="literal"><code class="computeroutput"><span class="special">!</span> </code><a class="link" href="reference.html#group__predicates_1ga7301c50e0272976b9f1434536383e6d0">boost::geometry::index::intersects()</a></code>,
</li>
<li class="listitem">
<code class="literal"><code class="computeroutput"><span class="special">!</span> </code><a class="link" href="reference.html#group__predicates_1ga5511236f56be1defcccbf11e742ccd88">boost::geometry::index::overlaps()</a></code>,
</li>
<li class="listitem">
<code class="literal"><code class="computeroutput"><span class="special">!</span> </code><a class="link" href="reference.html#group__predicates_1gabf9c4e76dd8a09a4c476f2f8fa8a0e4d">boost::geometry::index::within()</a></code>
</li>
</ul></div>
<p>
<span class="bold"><strong>Satisfies predicate</strong></span>
</p>
<p>
This is a special kind of predicate which allows to pass a user-defined
function or function object which checks if Value should be returned
by the query. It's generated by:
</p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
<code class="literal"><a class="link" href="reference.html#group__predicates_1gae7e9291c5b99041fb155d29de0860bab">boost::geometry::index::satisfies()</a></code>.
</li></ul></div>
<p>
<span class="bold"><strong>Nearest predicate</strong></span>
</p>
<p>
If the nearest predicate is passed a k-nearest neighbor search will be
performed. This query will result in returning k values to the output
iterator. Only one nearest predicate may be passed to the query. It may
be generated by:
</p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
<code class="literal"><a class="link" href="reference.html#group__predicates_1gae80a2c204673a8b11c4fc137cfff6556">boost::geometry::index::nearest()</a></code>.
</li></ul></div>
<p>
<span class="bold"><strong>Connecting predicates</strong></span>
</p>
<p>
Predicates may be passed together connected with <code class="literal"><code class="computeroutput"><span class="keyword">operator</span><span class="special">&amp;&amp;()</span></code></code>.
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.query_predicates_const____outiter_.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.query_predicates_const____outiter_.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.query_predicates_const____outiter_.synopsis">Synopsis</a>
</h6>
<pre class="programlisting"><code class="computeroutput"><span class="keyword">template</span><span class="special">&lt;</span></code><code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Predicates</span></code><code class="computeroutput"><span class="special">,</span></code> <code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">OutIter</span></code><code class="computeroutput"><span class="special">&gt;</span></code>
<code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a5c1a657074c527ed65f858c1ab6b36e6">size_type</a></code> <code class="computeroutput"><span class="identifier">query</span></code><code class="computeroutput"><span class="special">(</span></code><code class="computeroutput"><span class="identifier">Predicates</span> <span class="keyword">const</span> <span class="special">&amp;</span></code> <code class="computeroutput"><span class="identifier">predicates</span></code><code class="computeroutput"><span class="special">,</span></code> <code class="computeroutput"><span class="identifier">OutIter</span></code> <code class="computeroutput"><span class="identifier">out_it</span></code><code class="computeroutput"><span class="special">)</span></code>
</pre>
<h6>
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.query_predicates_const____outiter_.h2"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.query_predicates_const____outiter_.modifier_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.query_predicates_const____outiter_.modifier_s_">Modifier(s)</a>
</h6>
<p>
</p>
<pre class="programlisting"><span class="keyword">const</span></pre>
<p>
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.query_predicates_const____outiter_.h3"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.query_predicates_const____outiter_.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.query_predicates_const____outiter_.parameter_s_">Parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Type
</p>
</th>
<th>
<p>
Name
</p>
</th>
<th>
<p>
Description
</p>
</th>
</tr></thead>
<tbody>
<tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">Predicates</span> <span class="keyword">const</span> <span class="special">&amp;</span></code>
</p>
</td>
<td>
<p>
<code class="computeroutput"><span class="identifier">predicates</span></code>
</p>
</td>
<td>
<p>
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, e.g. generated by std::back_inserter().
</p>
</td>
</tr>
</tbody>
</table></div>
<h6>
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.query_predicates_const____outiter_.h4"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.query_predicates_const____outiter_.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.query_predicates_const____outiter_.returns">Returns</a>
</h6>
<p>
The number of values found.
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.query_predicates_const____outiter_.h5"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.query_predicates_const____outiter_.example"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.query_predicates_const____outiter_.example">Example</a>
</h6>
<p>
</p>
<pre class="programlisting"><span class="comment">// return elements intersecting box</span>
<span class="identifier">tree</span><span class="special">.</span><span class="identifier">query</span><span class="special">(</span><span class="identifier">bgi</span><span class="special">::</span><span class="identifier">intersects</span><span class="special">(</span><span class="identifier">box</span><span class="special">),</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">back_inserter</span><span class="special">(</span><span class="identifier">result</span><span class="special">));</span>
<span class="comment">// return elements intersecting poly but not within box</span>
<span class="identifier">tree</span><span class="special">.</span><span class="identifier">query</span><span class="special">(</span><span class="identifier">bgi</span><span class="special">::</span><span class="identifier">intersects</span><span class="special">(</span><span class="identifier">poly</span><span class="special">)</span> <span class="special">&amp;&amp;</span> <span class="special">!</span><span class="identifier">bgi</span><span class="special">::</span><span class="identifier">within</span><span class="special">(</span><span class="identifier">box</span><span class="special">),</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">back_inserter</span><span class="special">(</span><span class="identifier">result</span><span class="special">));</span>
<span class="comment">// return elements overlapping box and meeting my_fun unary predicate</span>
<span class="identifier">tree</span><span class="special">.</span><span class="identifier">query</span><span class="special">(</span><span class="identifier">bgi</span><span class="special">::</span><span class="identifier">overlaps</span><span class="special">(</span><span class="identifier">box</span><span class="special">)</span> <span class="special">&amp;&amp;</span> <span class="identifier">bgi</span><span class="special">::</span><span class="identifier">satisfies</span><span class="special">(</span><span class="identifier">my_fun</span><span class="special">),</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">back_inserter</span><span class="special">(</span><span class="identifier">result</span><span class="special">));</span>
<span class="comment">// return 5 elements nearest to pt and elements are intersecting box</span>
<span class="identifier">tree</span><span class="special">.</span><span class="identifier">query</span><span class="special">(</span><span class="identifier">bgi</span><span class="special">::</span><span class="identifier">nearest</span><span class="special">(</span><span class="identifier">pt</span><span class="special">,</span> <span class="number">5</span><span class="special">)</span> <span class="special">&amp;&amp;</span> <span class="identifier">bgi</span><span class="special">::</span><span class="identifier">intersects</span><span class="special">(</span><span class="identifier">box</span><span class="special">),</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">back_inserter</span><span class="special">(</span><span class="identifier">result</span><span class="special">));</span>
<span class="comment">// return 5 elements which centroids are nearest to pt and elements aren't within box</span>
<span class="identifier">tree</span><span class="special">.</span><span class="identifier">query</span><span class="special">(</span><span class="identifier">bgi</span><span class="special">::</span><span class="identifier">nearest</span><span class="special">(</span><span class="identifier">bgi</span><span class="special">::</span><span class="identifier">to_centroid</span><span class="special">(</span><span class="identifier">pt</span><span class="special">),</span> <span class="number">5</span><span class="special">)</span> <span class="special">&amp;&amp;</span> <span class="special">!</span><span class="identifier">bgi</span><span class="special">::</span><span class="identifier">within</span><span class="special">(</span><span class="identifier">box</span><span class="special">),</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">back_inserter</span><span class="special">(</span><span class="identifier">result</span><span class="special">));</span>
</pre>
<p>
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.query_predicates_const____outiter_.h6"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.query_predicates_const____outiter_.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.query_predicates_const____outiter_.throws">Throws</a>
</h6>
<p>
If Value copy constructor or copy assignment throws.
</p>
<div class="warning"><table border="0" summary="Warning">
<tr>
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Warning]" src="http://www.boost.org/doc/libs/release/doc/src/images/warning.png"></td>
<th align="left">Warning</th>
</tr>
<tr><td align="left" valign="top"><p>
Only one <code class="literal"><a class="link" href="reference.html#group__predicates_1gae80a2c204673a8b11c4fc137cfff6556">nearest()</a></code>
perdicate may be passed to the query.
</p></td></tr>
</table></div>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.size__"></a><a name="classboost_1_1geometry_1_1index_1_1rtree_1a89561a834563f2ed6fc782bad16143fd"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.size__" title="size()">size()</a>
</h5></div></div></div>
<p>
Returns the number of stored values.
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.size__.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.size__.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.size__.synopsis">Synopsis</a>
</h6>
<pre class="programlisting"><code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a5c1a657074c527ed65f858c1ab6b36e6">size_type</a></code> <code class="computeroutput"><span class="identifier">size</span></code><code class="computeroutput"><span class="special">()</span></code>
</pre>
<h6>
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.size__.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.size__.modifier_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.size__.modifier_s_">Modifier(s)</a>
</h6>
<p>
</p>
<pre class="programlisting"><span class="keyword">const</span></pre>
<p>
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.size__.h2"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.size__.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.size__.returns">Returns</a>
</h6>
<p>
The number of stored values.
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.size__.h3"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.size__.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.size__.throws">Throws</a>
</h6>
<p>
Nothing.
</p>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.empty__"></a><a name="classboost_1_1geometry_1_1index_1_1rtree_1ae889567443b0ba0dbdb975564c55804c"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.empty__" title="empty()">empty()</a>
</h5></div></div></div>
<p>
Query if the container is empty.
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.empty__.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.empty__.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.empty__.synopsis">Synopsis</a>
</h6>
<pre class="programlisting"><code class="computeroutput"><span class="keyword">bool</span></code> <code class="computeroutput"><span class="identifier">empty</span></code><code class="computeroutput"><span class="special">()</span></code>
</pre>
<h6>
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.empty__.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.empty__.modifier_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.empty__.modifier_s_">Modifier(s)</a>
</h6>
<p>
</p>
<pre class="programlisting"><span class="keyword">const</span></pre>
<p>
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.empty__.h2"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.empty__.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.empty__.returns">Returns</a>
</h6>
<p>
true if the container is empty.
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.empty__.h3"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.empty__.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.empty__.throws">Throws</a>
</h6>
<p>
Nothing.
</p>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.clear__"></a><a name="classboost_1_1geometry_1_1index_1_1rtree_1ae6027e42d28a4bf93e74b055c79e6b09"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.clear__" title="clear()">clear()</a>
</h5></div></div></div>
<p>
Removes all values stored in the container.
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.clear__.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.clear__.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.clear__.synopsis">Synopsis</a>
</h6>
<pre class="programlisting"><code class="computeroutput"><span class="keyword">void</span></code> <code class="computeroutput"><span class="identifier">clear</span></code><code class="computeroutput"><span class="special">()</span></code>
</pre>
<h6>
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.clear__.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.clear__.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.clear__.throws">Throws</a>
</h6>
<p>
Nothing.
</p>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.bounds__"></a><a name="classboost_1_1geometry_1_1index_1_1rtree_1aeba4f1afee40262204dd074a93536ebf"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.bounds__" title="bounds()">bounds()</a>
</h5></div></div></div>
<p>
Returns the box able to contain all values stored in the container.
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.bounds__.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.bounds__.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.bounds__.description">Description</a>
</h6>
<p>
Returns the box able to contain all values stored in the container. If
the container is empty the result of <code class="literal"><code class="computeroutput"><span class="identifier">geometry</span><span class="special">::</span><span class="identifier">assign_inverse</span><span class="special">()</span></code></code> is returned.
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.bounds__.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.bounds__.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.bounds__.synopsis">Synopsis</a>
</h6>
<pre class="programlisting"><code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a653555282525601512c3b1bed1e9590f">bounds_type</a></code> <code class="computeroutput"><span class="identifier">bounds</span></code><code class="computeroutput"><span class="special">()</span></code>
</pre>
<h6>
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.bounds__.h2"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.bounds__.modifier_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.bounds__.modifier_s_">Modifier(s)</a>
</h6>
<p>
</p>
<pre class="programlisting"><span class="keyword">const</span></pre>
<p>
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.bounds__.h3"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.bounds__.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.bounds__.returns">Returns</a>
</h6>
<p>
The box able to contain 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.bounds__.h4"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.bounds__.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.bounds__.throws">Throws</a>
</h6>
<p>
Nothing.
</p>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.count_valueorindexable_const___"></a><a name="classboost_1_1geometry_1_1index_1_1rtree_1a17fce1fac81f6460d2c3a5744f4963ee"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.count_valueorindexable_const___" title="count(ValueOrIndexable const &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.count_valueorindexable_const___.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.count_valueorindexable_const___.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.count_valueorindexable_const___.description">Description</a>
</h6>
<p>
For indexable_type it returns the number of values which indexables equals
the parameter. For value_type it returns the number of values which equals
the parameter.
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.count_valueorindexable_const___.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.count_valueorindexable_const___.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.count_valueorindexable_const___.synopsis">Synopsis</a>
</h6>
<pre class="programlisting"><code class="computeroutput"><span class="keyword">template</span><span class="special">&lt;</span></code><code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">ValueOrIndexable</span></code><code class="computeroutput"><span class="special">&gt;</span></code>
<code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a5c1a657074c527ed65f858c1ab6b36e6">size_type</a></code> <code class="computeroutput"><span class="identifier">count</span></code><code class="computeroutput"><span class="special">(</span></code><code class="computeroutput"><span class="identifier">ValueOrIndexable</span> <span class="keyword">const</span> <span class="special">&amp;</span></code> <code class="computeroutput"><span class="identifier">vori</span></code><code class="computeroutput"><span class="special">)</span></code>
</pre>
<h6>
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.count_valueorindexable_const___.h2"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.count_valueorindexable_const___.modifier_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.count_valueorindexable_const___.modifier_s_">Modifier(s)</a>
</h6>
<p>
</p>
<pre class="programlisting"><span class="keyword">const</span></pre>
<p>
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.count_valueorindexable_const___.h3"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.count_valueorindexable_const___.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.count_valueorindexable_const___.parameter_s_">Parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Type
</p>
</th>
<th>
<p>
Name
</p>
</th>
<th>
<p>
Description
</p>
</th>
</tr></thead>
<tbody><tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">ValueOrIndexable</span>
<span class="keyword">const</span> <span class="special">&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.count_valueorindexable_const___.h4"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.count_valueorindexable_const___.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.count_valueorindexable_const___.returns">Returns</a>
</h6>
<p>
The number of values found.
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.count_valueorindexable_const___.h5"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.count_valueorindexable_const___.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.count_valueorindexable_const___.throws">Throws</a>
</h6>
<p>
Nothing.
</p>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.parameters__"></a><a name="classboost_1_1geometry_1_1index_1_1rtree_1a18910715f67608ff010556ac41f51606"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.parameters__" title="parameters()">parameters()</a>
</h5></div></div></div>
<p>
Returns parameters.
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.parameters__.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.parameters__.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.parameters__.synopsis">Synopsis</a>
</h6>
<pre class="programlisting"><code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1af85d4e399a807b3e4e46d38a0b4ffc5a">parameters_type</a></code><code class="computeroutput"> <span class="keyword">const</span> <span class="special">&amp;</span></code> <code class="computeroutput"><span class="identifier">parameters</span></code><code class="computeroutput"><span class="special">()</span></code>
</pre>
<h6>
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.parameters__.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.parameters__.modifier_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.parameters__.modifier_s_">Modifier(s)</a>
</h6>
<p>
</p>
<pre class="programlisting"><span class="keyword">const</span></pre>
<p>
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.parameters__.h2"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.parameters__.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.parameters__.returns">Returns</a>
</h6>
<p>
The parameters object.
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.parameters__.h3"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.parameters__.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.parameters__.throws">Throws</a>
</h6>
<p>
Nothing.
</p>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.translator__"></a><a name="classboost_1_1geometry_1_1index_1_1rtree_1afc7e9a4bd53a58552c17c1e7cb997258"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.translator__" title="translator()">translator()</a>
</h5></div></div></div>
<p>
Returns the translator object.
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.translator__.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.translator__.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.translator__.synopsis">Synopsis</a>
</h6>
<pre class="programlisting"><code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1adbc30a1fa986e2e856e0662111ac2d91">translator_type</a></code><code class="computeroutput"> <span class="keyword">const</span> <span class="special">&amp;</span></code> <code class="computeroutput"><span class="identifier">translator</span></code><code class="computeroutput"><span class="special">()</span></code>
</pre>
<h6>
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.translator__.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.translator__.modifier_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.translator__.modifier_s_">Modifier(s)</a>
</h6>
<p>
</p>
<pre class="programlisting"><span class="keyword">const</span></pre>
<p>
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.translator__.h2"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.translator__.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.translator__.returns">Returns</a>
</h6>
<p>
The translator object.
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.translator__.h3"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.translator__.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.translator__.throws">Throws</a>
</h6>
<p>
Nothing.
</p>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.get_allocator__"></a><a name="classboost_1_1geometry_1_1index_1_1rtree_1a1eeb303253f4cabe3a89a82ed41247ff"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.get_allocator__" title="get_allocator()">get_allocator()</a>
</h5></div></div></div>
<p>
Returns allocator used by the rtree.
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.get_allocator__.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.get_allocator__.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.get_allocator__.synopsis">Synopsis</a>
</h6>
<pre class="programlisting"><code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a9d35bc38fa697c6f600548fb5b38807d">allocator_type</a></code> <code class="computeroutput"><span class="identifier">get_allocator</span></code><code class="computeroutput"><span class="special">()</span></code>
</pre>
<h6>
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.get_allocator__.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.get_allocator__.modifier_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.get_allocator__.modifier_s_">Modifier(s)</a>
</h6>
<p>
</p>
<pre class="programlisting"><span class="keyword">const</span></pre>
<p>
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.get_allocator__.h2"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.get_allocator__.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.get_allocator__.returns">Returns</a>
</h6>
<p>
The allocator.
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.get_allocator__.h3"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost__geometry__index__rtree.get_allocator__.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__rtree.get_allocator__.throws">Throws</a>
</h6>
<p>
If allocator copy constructor throws.
</p>
</div>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="geometry_index.r_tree.reference.group__rtree__functions"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions" title="Functions related to the rtree">Functions
related to the rtree</a>
</h4></div></div></div>
<h6>
<a name="geometry_index.r_tree.reference.group__rtree__functions.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.functions"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.functions">Functions</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Function
</p>
</th>
<th>
<p>
Description
</p>
</th>
</tr></thead>
<tbody>
<tr>
<td>
<p>
<a class="link" href="reference.html#group__rtree__functions_1gac0ac9ed0e01f7494a5a3059e75d3c5cc"><code class="computeroutput"><span class="identifier">insert</span><span class="special">(</span><span class="identifier">rtree</span><span class="special">&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#group__rtree__functions_1gaf8f4fa09c12b96ace3bbb38823a9191b"><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#group__rtree__functions_1ga97ec330c1c021a1ac2d896a488c2eb9c"><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#group__rtree__functions_1gad40492a5b99c3eebbd51901574762527"><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#group__rtree__functions_1ga0219361de8b15c539af3f9bd027938ce"><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#group__rtree__functions_1ga5885d6c90a91f238f72ab9b5ef24daf9"><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#group__rtree__functions_1ga86e0808522ef6682b72b310a3891b276"><code class="computeroutput"><span class="identifier">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>
Finds values meeting passed predicates e.g. nearest to some Point
and/or intersecting some Box.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="reference.html#group__rtree__functions_1ga0c65d7b29b1edf72f1d236ccf211f63c"><code class="computeroutput"><span class="identifier">clear</span><span class="special">(</span><span class="identifier">rtree</span><span class="special">&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#group__rtree__functions_1gaec0b88a9d8b408753e3069134f1598c7"><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#group__rtree__functions_1ga459e3d404fec7cbd66794714cbdd129e"><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#group__rtree__functions_1gadb11fdb8e75ba7652286ec6750b49c4f"><code class="computeroutput"><span class="identifier">bounds</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>
<tr>
<td>
<p>
<a class="link" href="reference.html#group__rtree__functions_1ga043d21dc24c57fcabc5ee85093eb8b15"><code class="computeroutput"><span class="identifier">swap</span><span class="special">(</span><span class="identifier">rtree</span><span class="special">&lt;...&gt;</span>
<span class="special">&amp;,</span> <span class="identifier">rtree</span><span class="special">&lt;...&gt;</span> <span class="special">&amp;)</span></code></a>
</p>
</td>
<td>
<p>
Exchanges the contents of the container with those of other.
</p>
</td>
</tr>
</tbody>
</table></div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.group__rtree__functions.insert_rtree_________value_const___"></a><a name="group__rtree__functions_1gac0ac9ed0e01f7494a5a3059e75d3c5cc"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.insert_rtree_________value_const___" title="insert(rtree&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.insert_rtree_________value_const___.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.insert_rtree_________value_const___.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.insert_rtree_________value_const___.description">Description</a>
</h6>
<p>
It calls <code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1af6d5bd81e46cb4ff89277c753133664c">rtree::insert(value_type
const&amp;)</a></code>.
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__rtree__functions.insert_rtree_________value_const___.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.insert_rtree_________value_const___.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.insert_rtree_________value_const___.synopsis">Synopsis</a>
</h6>
<pre class="programlisting"><code class="computeroutput"><span class="keyword">template</span><span class="special">&lt;</span></code><code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Value</span></code><code class="computeroutput"><span class="special">,</span></code>
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Options</span></code><code class="computeroutput"><span class="special">,</span></code>
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Translator</span></code><code class="computeroutput"><span class="special">,</span></code>
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Allocator</span></code><code class="computeroutput"><span class="special">&gt;</span></code>
<code class="computeroutput"><span class="keyword">void</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">geometry</span><span class="special">::</span><span class="identifier">index</span><span class="special">::</span><span class="identifier">insert</span></code><code class="computeroutput"><span class="special">(</span></code><code class="computeroutput"><span class="identifier">rtree</span><span class="special">&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> <code class="computeroutput"><span class="identifier">tree</span></code><code class="computeroutput"><span class="special">,</span></code> <code class="computeroutput"><span class="identifier">Value</span> <span class="keyword">const</span> <span class="special">&amp;</span></code> <code class="computeroutput"><span class="identifier">v</span></code><code class="computeroutput"><span class="special">)</span></code>
</pre>
<h6>
<a name="geometry_index.r_tree.reference.group__rtree__functions.insert_rtree_________value_const___.h2"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.insert_rtree_________value_const___.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.insert_rtree_________value_const___.parameter_s_">Parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Type
</p>
</th>
<th>
<p>
Name
</p>
</th>
<th>
<p>
Description
</p>
</th>
</tr></thead>
<tbody>
<tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">rtree</span><span class="special">&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>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.group__rtree__functions.insert_rtree_________iterator__iterator_"></a><a name="group__rtree__functions_1gaf8f4fa09c12b96ace3bbb38823a9191b"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.insert_rtree_________iterator__iterator_" title="insert(rtree&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.insert_rtree_________iterator__iterator_.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.insert_rtree_________iterator__iterator_.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.insert_rtree_________iterator__iterator_.description">Description</a>
</h6>
<p>
It calls <code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a5263a3faac7b4f0090d4ad1d44cc540d">rtree::insert(Iterator,
Iterator)</a></code>.
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__rtree__functions.insert_rtree_________iterator__iterator_.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.insert_rtree_________iterator__iterator_.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.insert_rtree_________iterator__iterator_.synopsis">Synopsis</a>
</h6>
<pre class="programlisting"><code class="computeroutput"><span class="keyword">template</span><span class="special">&lt;</span></code><code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Value</span></code><code class="computeroutput"><span class="special">,</span></code>
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Options</span></code><code class="computeroutput"><span class="special">,</span></code>
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Translator</span></code><code class="computeroutput"><span class="special">,</span></code>
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Allocator</span></code><code class="computeroutput"><span class="special">,</span></code>
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Iterator</span></code><code class="computeroutput"><span class="special">&gt;</span></code>
<code class="computeroutput"><span class="keyword">void</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">geometry</span><span class="special">::</span><span class="identifier">index</span><span class="special">::</span><span class="identifier">insert</span></code><code class="computeroutput"><span class="special">(</span></code><code class="computeroutput"><span class="identifier">rtree</span><span class="special">&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> <code class="computeroutput"><span class="identifier">tree</span></code><code class="computeroutput"><span class="special">,</span></code>
<code class="computeroutput"><span class="identifier">Iterator</span></code> <code class="computeroutput"><span class="identifier">first</span></code><code class="computeroutput"><span class="special">,</span></code>
<code class="computeroutput"><span class="identifier">Iterator</span></code> <code class="computeroutput"><span class="identifier">last</span></code><code class="computeroutput"><span class="special">)</span></code>
</pre>
<h6>
<a name="geometry_index.r_tree.reference.group__rtree__functions.insert_rtree_________iterator__iterator_.h2"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.insert_rtree_________iterator__iterator_.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.insert_rtree_________iterator__iterator_.parameter_s_">Parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Type
</p>
</th>
<th>
<p>
Name
</p>
</th>
<th>
<p>
Description
</p>
</th>
</tr></thead>
<tbody>
<tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">rtree</span><span class="special">&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>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.group__rtree__functions.insert_rtree_________range_const___"></a><a name="group__rtree__functions_1ga97ec330c1c021a1ac2d896a488c2eb9c"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.insert_rtree_________range_const___" title="insert(rtree&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.insert_rtree_________range_const___.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.insert_rtree_________range_const___.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.insert_rtree_________range_const___.description">Description</a>
</h6>
<p>
It calls <code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1abb624abd9268b41e815d40342b2634c2">rtree::insert(Range
const&amp;)</a></code>.
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__rtree__functions.insert_rtree_________range_const___.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.insert_rtree_________range_const___.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.insert_rtree_________range_const___.synopsis">Synopsis</a>
</h6>
<pre class="programlisting"><code class="computeroutput"><span class="keyword">template</span><span class="special">&lt;</span></code><code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Value</span></code><code class="computeroutput"><span class="special">,</span></code>
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Options</span></code><code class="computeroutput"><span class="special">,</span></code>
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Translator</span></code><code class="computeroutput"><span class="special">,</span></code>
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Allocator</span></code><code class="computeroutput"><span class="special">,</span></code>
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Range</span></code><code class="computeroutput"><span class="special">&gt;</span></code>
<code class="computeroutput"><span class="keyword">void</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">geometry</span><span class="special">::</span><span class="identifier">index</span><span class="special">::</span><span class="identifier">insert</span></code><code class="computeroutput"><span class="special">(</span></code><code class="computeroutput"><span class="identifier">rtree</span><span class="special">&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> <code class="computeroutput"><span class="identifier">tree</span></code><code class="computeroutput"><span class="special">,</span></code> <code class="computeroutput"><span class="identifier">Range</span> <span class="keyword">const</span> <span class="special">&amp;</span></code> <code class="computeroutput"><span class="identifier">rng</span></code><code class="computeroutput"><span class="special">)</span></code>
</pre>
<h6>
<a name="geometry_index.r_tree.reference.group__rtree__functions.insert_rtree_________range_const___.h2"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.insert_rtree_________range_const___.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.insert_rtree_________range_const___.parameter_s_">Parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Type
</p>
</th>
<th>
<p>
Name
</p>
</th>
<th>
<p>
Description
</p>
</th>
</tr></thead>
<tbody>
<tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">rtree</span><span class="special">&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>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.group__rtree__functions.remove_rtree_________value_const___"></a><a name="group__rtree__functions_1gad40492a5b99c3eebbd51901574762527"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.remove_rtree_________value_const___" title="remove(rtree&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.remove_rtree_________value_const___.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.remove_rtree_________value_const___.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.remove_rtree_________value_const___.description">Description</a>
</h6>
<p>
Remove a value from the container. In contrast to the <code class="literal"><code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">set</span></code></code> or <code class="literal"><code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">map</span> <span class="identifier">erase</span><span class="special">()</span></code></code> method this function removes
only one value from the container.
</p>
<p>
It calls <code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1af6ca6909354a997f89411ef40ea5688a">rtree::remove(value_type
const&amp;)</a></code>.
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__rtree__functions.remove_rtree_________value_const___.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.remove_rtree_________value_const___.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.remove_rtree_________value_const___.synopsis">Synopsis</a>
</h6>
<pre class="programlisting"><code class="computeroutput"><span class="keyword">template</span><span class="special">&lt;</span></code><code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Value</span></code><code class="computeroutput"><span class="special">,</span></code>
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Options</span></code><code class="computeroutput"><span class="special">,</span></code>
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Translator</span></code><code class="computeroutput"><span class="special">,</span></code>
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Allocator</span></code><code class="computeroutput"><span class="special">&gt;</span></code>
<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="identifier">size_type</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">geometry</span><span class="special">::</span><span class="identifier">index</span><span class="special">::</span><span class="identifier">remove</span></code><code class="computeroutput"><span class="special">(</span></code><code class="computeroutput"><span class="identifier">rtree</span><span class="special">&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> <code class="computeroutput"><span class="identifier">tree</span></code><code class="computeroutput"><span class="special">,</span></code> <code class="computeroutput"><span class="identifier">Value</span> <span class="keyword">const</span> <span class="special">&amp;</span></code> <code class="computeroutput"><span class="identifier">v</span></code><code class="computeroutput"><span class="special">)</span></code>
</pre>
<h6>
<a name="geometry_index.r_tree.reference.group__rtree__functions.remove_rtree_________value_const___.h2"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.remove_rtree_________value_const___.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.remove_rtree_________value_const___.parameter_s_">Parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Type
</p>
</th>
<th>
<p>
Name
</p>
</th>
<th>
<p>
Description
</p>
</th>
</tr></thead>
<tbody>
<tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">rtree</span><span class="special">&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.remove_rtree_________value_const___.h3"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.remove_rtree_________value_const___.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.remove_rtree_________value_const___.returns">Returns</a>
</h6>
<p>
1 if value was removed, 0 otherwise.
</p>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.group__rtree__functions.remove_rtree_________iterator__iterator_"></a><a name="group__rtree__functions_1ga0219361de8b15c539af3f9bd027938ce"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.remove_rtree_________iterator__iterator_" title="remove(rtree&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.remove_rtree_________iterator__iterator_.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.remove_rtree_________iterator__iterator_.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.remove_rtree_________iterator__iterator_.description">Description</a>
</h6>
<p>
Remove a range of values from the container. In contrast to the <code class="literal"><code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">set</span></code></code> or <code class="literal"><code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">map</span> <span class="identifier">erase</span><span class="special">()</span></code></code> method it doesn't take iterators
pointing to values stored in this container. It removes values equal
to these passed as a range. Furthermore this function removes only one
value for each one passed in the range, not all equal values.
</p>
<p>
It calls <code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a6e9123114697d65b16ebc49cd5371fbd">rtree::remove(Iterator,
Iterator)</a></code>.
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__rtree__functions.remove_rtree_________iterator__iterator_.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.remove_rtree_________iterator__iterator_.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.remove_rtree_________iterator__iterator_.synopsis">Synopsis</a>
</h6>
<pre class="programlisting"><code class="computeroutput"><span class="keyword">template</span><span class="special">&lt;</span></code><code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Value</span></code><code class="computeroutput"><span class="special">,</span></code>
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Options</span></code><code class="computeroutput"><span class="special">,</span></code>
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Translator</span></code><code class="computeroutput"><span class="special">,</span></code>
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Allocator</span></code><code class="computeroutput"><span class="special">,</span></code>
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Iterator</span></code><code class="computeroutput"><span class="special">&gt;</span></code>
<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="identifier">size_type</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">geometry</span><span class="special">::</span><span class="identifier">index</span><span class="special">::</span><span class="identifier">remove</span></code><code class="computeroutput"><span class="special">(</span></code><code class="computeroutput"><span class="identifier">rtree</span><span class="special">&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> <code class="computeroutput"><span class="identifier">tree</span></code><code class="computeroutput"><span class="special">,</span></code>
<code class="computeroutput"><span class="identifier">Iterator</span></code> <code class="computeroutput"><span class="identifier">first</span></code><code class="computeroutput"><span class="special">,</span></code>
<code class="computeroutput"><span class="identifier">Iterator</span></code> <code class="computeroutput"><span class="identifier">last</span></code><code class="computeroutput"><span class="special">)</span></code>
</pre>
<h6>
<a name="geometry_index.r_tree.reference.group__rtree__functions.remove_rtree_________iterator__iterator_.h2"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.remove_rtree_________iterator__iterator_.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.remove_rtree_________iterator__iterator_.parameter_s_">Parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Type
</p>
</th>
<th>
<p>
Name
</p>
</th>
<th>
<p>
Description
</p>
</th>
</tr></thead>
<tbody>
<tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">rtree</span><span class="special">&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.remove_rtree_________iterator__iterator_.h3"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.remove_rtree_________iterator__iterator_.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.remove_rtree_________iterator__iterator_.returns">Returns</a>
</h6>
<p>
The number of removed values.
</p>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.group__rtree__functions.remove_rtree_________range_const___"></a><a name="group__rtree__functions_1ga5885d6c90a91f238f72ab9b5ef24daf9"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.remove_rtree_________range_const___" title="remove(rtree&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.remove_rtree_________range_const___.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.remove_rtree_________range_const___.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.remove_rtree_________range_const___.description">Description</a>
</h6>
<p>
Remove a range of values from the container. In contrast to the <code class="literal"><code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">set</span></code></code> or <code class="literal"><code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">map</span> <span class="identifier">erase</span><span class="special">()</span></code></code> method it removes values
equal to these passed as a range. Furthermore this method removes only
one value for each one passed in the range, not all equal values.
</p>
<p>
It calls <code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a5a57bb93b0b2d7ea1c659e925f918e9c">rtree::remove(Range
const&amp;)</a></code>.
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__rtree__functions.remove_rtree_________range_const___.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.remove_rtree_________range_const___.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.remove_rtree_________range_const___.synopsis">Synopsis</a>
</h6>
<pre class="programlisting"><code class="computeroutput"><span class="keyword">template</span><span class="special">&lt;</span></code><code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Value</span></code><code class="computeroutput"><span class="special">,</span></code>
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Options</span></code><code class="computeroutput"><span class="special">,</span></code>
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Translator</span></code><code class="computeroutput"><span class="special">,</span></code>
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Allocator</span></code><code class="computeroutput"><span class="special">,</span></code>
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Range</span></code><code class="computeroutput"><span class="special">&gt;</span></code>
<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="identifier">size_type</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">geometry</span><span class="special">::</span><span class="identifier">index</span><span class="special">::</span><span class="identifier">remove</span></code><code class="computeroutput"><span class="special">(</span></code><code class="computeroutput"><span class="identifier">rtree</span><span class="special">&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> <code class="computeroutput"><span class="identifier">tree</span></code><code class="computeroutput"><span class="special">,</span></code> <code class="computeroutput"><span class="identifier">Range</span> <span class="keyword">const</span> <span class="special">&amp;</span></code> <code class="computeroutput"><span class="identifier">rng</span></code><code class="computeroutput"><span class="special">)</span></code>
</pre>
<h6>
<a name="geometry_index.r_tree.reference.group__rtree__functions.remove_rtree_________range_const___.h2"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.remove_rtree_________range_const___.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.remove_rtree_________range_const___.parameter_s_">Parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Type
</p>
</th>
<th>
<p>
Name
</p>
</th>
<th>
<p>
Description
</p>
</th>
</tr></thead>
<tbody>
<tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">rtree</span><span class="special">&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.remove_rtree_________range_const___.h3"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.remove_rtree_________range_const___.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.remove_rtree_________range_const___.returns">Returns</a>
</h6>
<p>
The number of removed values.
</p>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.group__rtree__functions.query_rtree______const____predicates_const____outiter_"></a><a name="group__rtree__functions_1ga86e0808522ef6682b72b310a3891b276"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.query_rtree______const____predicates_const____outiter_" title="query(rtree&lt;...&gt; const &amp;, Predicates const &amp;, OutIter)">query(rtree&lt;...&gt;
const &amp;, Predicates const &amp;, OutIter)</a>
</h5></div></div></div>
<p>
Finds values meeting passed predicates e.g. nearest to some Point and/or
intersecting some Box.
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__rtree__functions.query_rtree______const____predicates_const____outiter_.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.query_rtree______const____predicates_const____outiter_.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.query_rtree______const____predicates_const____outiter_.description">Description</a>
</h6>
<p>
This query function performs spatial and k-nearest neighbor searches.
It allows to pass a set of predicates. Values will be returned only if
all predicates are met.
</p>
<p>
<span class="bold"><strong>Spatial predicates</strong></span>
</p>
<p>
Spatial predicates may be generated by one of the functions listed below:
</p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem">
<code class="literal"><a class="link" href="reference.html#group__predicates_1ga0a613a7f1d18ac33955bfdc2c5777c61">boost::geometry::index::covered_by()</a></code>,
</li>
<li class="listitem">
<code class="literal"><a class="link" href="reference.html#group__predicates_1ga351bb3b82e019ff45adf789385b8007d">boost::geometry::index::disjoint()</a></code>,
</li>
<li class="listitem">
<code class="literal"><a class="link" href="reference.html#group__predicates_1ga7301c50e0272976b9f1434536383e6d0">boost::geometry::index::intersects()</a></code>,
</li>
<li class="listitem">
<code class="literal"><a class="link" href="reference.html#group__predicates_1ga5511236f56be1defcccbf11e742ccd88">boost::geometry::index::overlaps()</a></code>,
</li>
<li class="listitem">
<code class="literal"><a class="link" href="reference.html#group__predicates_1gabf9c4e76dd8a09a4c476f2f8fa8a0e4d">boost::geometry::index::within()</a></code>,
</li>
</ul></div>
<p>
It is possible to negate spatial predicates:
</p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem">
<code class="literal"><code class="computeroutput"><span class="special">!</span> </code><a class="link" href="reference.html#group__predicates_1ga0a613a7f1d18ac33955bfdc2c5777c61">boost::geometry::index::covered_by()</a></code>,
</li>
<li class="listitem">
<code class="literal"><code class="computeroutput"><span class="special">!</span> </code><a class="link" href="reference.html#group__predicates_1ga351bb3b82e019ff45adf789385b8007d">boost::geometry::index::disjoint()</a></code>,
</li>
<li class="listitem">
<code class="literal"><code class="computeroutput"><span class="special">!</span> </code><a class="link" href="reference.html#group__predicates_1ga7301c50e0272976b9f1434536383e6d0">boost::geometry::index::intersects()</a></code>,
</li>
<li class="listitem">
<code class="literal"><code class="computeroutput"><span class="special">!</span> </code><a class="link" href="reference.html#group__predicates_1ga5511236f56be1defcccbf11e742ccd88">boost::geometry::index::overlaps()</a></code>,
</li>
<li class="listitem">
<code class="literal"><code class="computeroutput"><span class="special">!</span> </code><a class="link" href="reference.html#group__predicates_1gabf9c4e76dd8a09a4c476f2f8fa8a0e4d">boost::geometry::index::within()</a></code>
</li>
</ul></div>
<p>
<span class="bold"><strong>Satisfies predicate</strong></span>
</p>
<p>
This is a special kind of predicate which allows to pass a user-defined
function or function object which checks if Value should be returned
by the query. It's generated by:
</p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
<code class="literal"><a class="link" href="reference.html#group__predicates_1gae7e9291c5b99041fb155d29de0860bab">boost::geometry::index::satisfies()</a></code>.
</li></ul></div>
<p>
<span class="bold"><strong>Nearest predicate</strong></span>
</p>
<p>
If the nearest predicate is passed a k-nearest neighbor search will be
performed. This query will result in returning k values to the output
iterator. Only one nearest predicate may be passed to the query. It may
be generated by:
</p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
<code class="literal"><a class="link" href="reference.html#group__predicates_1gae80a2c204673a8b11c4fc137cfff6556">boost::geometry::index::nearest()</a></code>.
</li></ul></div>
<p>
<span class="bold"><strong>Connecting predicates</strong></span>
</p>
<p>
Predicates may be passed together connected with <code class="literal"><code class="computeroutput"><span class="keyword">operator</span><span class="special">&amp;&amp;()</span></code></code>.
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__rtree__functions.query_rtree______const____predicates_const____outiter_.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.query_rtree______const____predicates_const____outiter_.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.query_rtree______const____predicates_const____outiter_.synopsis">Synopsis</a>
</h6>
<pre class="programlisting"><code class="computeroutput"><span class="keyword">template</span><span class="special">&lt;</span></code><code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Value</span></code><code class="computeroutput"><span class="special">,</span></code>
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Options</span></code><code class="computeroutput"><span class="special">,</span></code>
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Translator</span></code><code class="computeroutput"><span class="special">,</span></code>
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Allocator</span></code><code class="computeroutput"><span class="special">,</span></code>
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Predicates</span></code><code class="computeroutput"><span class="special">,</span></code>
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">OutIter</span></code><code class="computeroutput"><span class="special">&gt;</span></code>
<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="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">query</span></code><code class="computeroutput"><span class="special">(</span></code><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> <code class="computeroutput"><span class="identifier">tree</span></code><code class="computeroutput"><span class="special">,</span></code>
<code class="computeroutput"><span class="identifier">Predicates</span> <span class="keyword">const</span> <span class="special">&amp;</span></code> <code class="computeroutput"><span class="identifier">predicates</span></code><code class="computeroutput"><span class="special">,</span></code>
<code class="computeroutput"><span class="identifier">OutIter</span></code> <code class="computeroutput"><span class="identifier">out_it</span></code><code class="computeroutput"><span class="special">)</span></code>
</pre>
<h6>
<a name="geometry_index.r_tree.reference.group__rtree__functions.query_rtree______const____predicates_const____outiter_.h2"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.query_rtree______const____predicates_const____outiter_.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.query_rtree______const____predicates_const____outiter_.parameter_s_">Parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Type
</p>
</th>
<th>
<p>
Name
</p>
</th>
<th>
<p>
Description
</p>
</th>
</tr></thead>
<tbody>
<tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">rtree</span><span class="special">&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 rtree.
</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">predicates</span></code>
</p>
</td>
<td>
<p>
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, e.g. generated by std::back_inserter().
</p>
</td>
</tr>
</tbody>
</table></div>
<h6>
<a name="geometry_index.r_tree.reference.group__rtree__functions.query_rtree______const____predicates_const____outiter_.h3"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.query_rtree______const____predicates_const____outiter_.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.query_rtree______const____predicates_const____outiter_.returns">Returns</a>
</h6>
<p>
The number of values found.
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__rtree__functions.query_rtree______const____predicates_const____outiter_.h4"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.query_rtree______const____predicates_const____outiter_.example"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.query_rtree______const____predicates_const____outiter_.example">Example</a>
</h6>
<p>
</p>
<pre class="programlisting"><span class="comment">// return elements intersecting box</span>
<span class="identifier">bgi</span><span class="special">::</span><span class="identifier">query</span><span class="special">(</span><span class="identifier">tree</span><span class="special">,</span> <span class="identifier">bgi</span><span class="special">::</span><span class="identifier">intersects</span><span class="special">(</span><span class="identifier">box</span><span class="special">),</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">back_inserter</span><span class="special">(</span><span class="identifier">result</span><span class="special">));</span>
<span class="comment">// return elements intersecting poly but not within box</span>
<span class="identifier">bgi</span><span class="special">::</span><span class="identifier">query</span><span class="special">(</span><span class="identifier">tree</span><span class="special">,</span> <span class="identifier">bgi</span><span class="special">::</span><span class="identifier">intersects</span><span class="special">(</span><span class="identifier">poly</span><span class="special">)</span> <span class="special">&amp;&amp;</span> <span class="special">!</span><span class="identifier">bgi</span><span class="special">::</span><span class="identifier">within</span><span class="special">(</span><span class="identifier">box</span><span class="special">),</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">back_inserter</span><span class="special">(</span><span class="identifier">result</span><span class="special">));</span>
<span class="comment">// return elements overlapping box and meeting my_fun value predicate</span>
<span class="identifier">bgi</span><span class="special">::</span><span class="identifier">query</span><span class="special">(</span><span class="identifier">tree</span><span class="special">,</span> <span class="identifier">bgi</span><span class="special">::</span><span class="identifier">overlaps</span><span class="special">(</span><span class="identifier">box</span><span class="special">)</span> <span class="special">&amp;&amp;</span> <span class="identifier">bgi</span><span class="special">::</span><span class="identifier">satisfies</span><span class="special">(</span><span class="identifier">my_fun</span><span class="special">),</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">back_inserter</span><span class="special">(</span><span class="identifier">result</span><span class="special">));</span>
<span class="comment">// return 5 elements nearest to pt and elements are intersecting box</span>
<span class="identifier">bgi</span><span class="special">::</span><span class="identifier">query</span><span class="special">(</span><span class="identifier">tree</span><span class="special">,</span> <span class="identifier">bgi</span><span class="special">::</span><span class="identifier">nearest</span><span class="special">(</span><span class="identifier">pt</span><span class="special">,</span> <span class="number">5</span><span class="special">)</span> <span class="special">&amp;&amp;</span> <span class="identifier">bgi</span><span class="special">::</span><span class="identifier">intersects</span><span class="special">(</span><span class="identifier">box</span><span class="special">),</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">back_inserter</span><span class="special">(</span><span class="identifier">result</span><span class="special">));</span>
<span class="comment">// return 5 elements which centroids are nearest to pt and elements aren't within box</span>
<span class="identifier">bgi</span><span class="special">::</span><span class="identifier">query</span><span class="special">(</span><span class="identifier">tree</span><span class="special">,</span> <span class="identifier">bgi</span><span class="special">::</span><span class="identifier">nearest</span><span class="special">(</span><span class="identifier">bgi</span><span class="special">::</span><span class="identifier">to_centroid</span><span class="special">(</span><span class="identifier">pt</span><span class="special">),</span> <span class="number">5</span><span class="special">)</span> <span class="special">&amp;&amp;</span> <span class="special">!</span><span class="identifier">bgi</span><span class="special">::</span><span class="identifier">within</span><span class="special">(</span><span class="identifier">box</span><span class="special">),</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">back_inserter</span><span class="special">(</span><span class="identifier">result</span><span class="special">));</span>
</pre>
<p>
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__rtree__functions.query_rtree______const____predicates_const____outiter_.h5"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.query_rtree______const____predicates_const____outiter_.throws"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.query_rtree______const____predicates_const____outiter_.throws">Throws</a>
</h6>
<p>
If Value copy constructor or copy assignment throws.
</p>
<div class="warning"><table border="0" summary="Warning">
<tr>
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Warning]" src="http://www.boost.org/doc/libs/release/doc/src/images/warning.png"></td>
<th align="left">Warning</th>
</tr>
<tr><td align="left" valign="top"><p>
Only one <code class="literal"><a class="link" href="reference.html#group__predicates_1gae80a2c204673a8b11c4fc137cfff6556">nearest()</a></code>
perdicate may be passed to the query.
</p></td></tr>
</table></div>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.group__rtree__functions.clear_rtree________"></a><a name="group__rtree__functions_1ga0c65d7b29b1edf72f1d236ccf211f63c"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.clear_rtree________" title="clear(rtree&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.clear_rtree________.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.clear_rtree________.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.clear_rtree________.description">Description</a>
</h6>
<p>
It calls <code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1ae6027e42d28a4bf93e74b055c79e6b09">rtree::clear()</a></code>.
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__rtree__functions.clear_rtree________.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.clear_rtree________.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.clear_rtree________.synopsis">Synopsis</a>
</h6>
<pre class="programlisting"><code class="computeroutput"><span class="keyword">template</span><span class="special">&lt;</span></code><code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Value</span></code><code class="computeroutput"><span class="special">,</span></code>
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Options</span></code><code class="computeroutput"><span class="special">,</span></code>
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Translator</span></code><code class="computeroutput"><span class="special">,</span></code>
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Allocator</span></code><code class="computeroutput"><span class="special">&gt;</span></code>
<code class="computeroutput"><span class="keyword">void</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">geometry</span><span class="special">::</span><span class="identifier">index</span><span class="special">::</span><span class="identifier">clear</span></code><code class="computeroutput"><span class="special">(</span></code><code class="computeroutput"><span class="identifier">rtree</span><span class="special">&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> <code class="computeroutput"><span class="identifier">tree</span></code><code class="computeroutput"><span class="special">)</span></code>
</pre>
<h6>
<a name="geometry_index.r_tree.reference.group__rtree__functions.clear_rtree________.h2"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.clear_rtree________.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.clear_rtree________.parameter_s_">Parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Type
</p>
</th>
<th>
<p>
Name
</p>
</th>
<th>
<p>
Description
</p>
</th>
</tr></thead>
<tbody><tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">rtree</span><span class="special">&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>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.group__rtree__functions.size_rtree______const___"></a><a name="group__rtree__functions_1gaec0b88a9d8b408753e3069134f1598c7"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.size_rtree______const___" title="size(rtree&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.size_rtree______const___.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.size_rtree______const___.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.size_rtree______const___.description">Description</a>
</h6>
<p>
It calls <code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1a89561a834563f2ed6fc782bad16143fd">rtree::size()</a></code>.
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__rtree__functions.size_rtree______const___.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.size_rtree______const___.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.size_rtree______const___.synopsis">Synopsis</a>
</h6>
<pre class="programlisting"><code class="computeroutput"><span class="keyword">template</span><span class="special">&lt;</span></code><code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Value</span></code><code class="computeroutput"><span class="special">,</span></code>
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Options</span></code><code class="computeroutput"><span class="special">,</span></code>
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Translator</span></code><code class="computeroutput"><span class="special">,</span></code>
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Allocator</span></code><code class="computeroutput"><span class="special">&gt;</span></code>
<code class="computeroutput"><span class="identifier">size_t</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">geometry</span><span class="special">::</span><span class="identifier">index</span><span class="special">::</span><span class="identifier">size</span></code><code class="computeroutput"><span class="special">(</span></code><code class="computeroutput"><span class="identifier">rtree</span><span class="special">&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> <code class="computeroutput"><span class="identifier">tree</span></code><code class="computeroutput"><span class="special">)</span></code>
</pre>
<h6>
<a name="geometry_index.r_tree.reference.group__rtree__functions.size_rtree______const___.h2"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.size_rtree______const___.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.size_rtree______const___.parameter_s_">Parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Type
</p>
</th>
<th>
<p>
Name
</p>
</th>
<th>
<p>
Description
</p>
</th>
</tr></thead>
<tbody><tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">rtree</span><span class="special">&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.size_rtree______const___.h3"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.size_rtree______const___.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.size_rtree______const___.returns">Returns</a>
</h6>
<p>
The number of values stored in the index.
</p>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.group__rtree__functions.empty_rtree______const___"></a><a name="group__rtree__functions_1ga459e3d404fec7cbd66794714cbdd129e"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.empty_rtree______const___" title="empty(rtree&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.empty_rtree______const___.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.empty_rtree______const___.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.empty_rtree______const___.description">Description</a>
</h6>
<p>
It calls <code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1ae889567443b0ba0dbdb975564c55804c">rtree::empty()</a></code>.
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__rtree__functions.empty_rtree______const___.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.empty_rtree______const___.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.empty_rtree______const___.synopsis">Synopsis</a>
</h6>
<pre class="programlisting"><code class="computeroutput"><span class="keyword">template</span><span class="special">&lt;</span></code><code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Value</span></code><code class="computeroutput"><span class="special">,</span></code>
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Options</span></code><code class="computeroutput"><span class="special">,</span></code>
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Translator</span></code><code class="computeroutput"><span class="special">,</span></code>
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Allocator</span></code><code class="computeroutput"><span class="special">&gt;</span></code>
<code class="computeroutput"><span class="keyword">bool</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">geometry</span><span class="special">::</span><span class="identifier">index</span><span class="special">::</span><span class="identifier">empty</span></code><code class="computeroutput"><span class="special">(</span></code><code class="computeroutput"><span class="identifier">rtree</span><span class="special">&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> <code class="computeroutput"><span class="identifier">tree</span></code><code class="computeroutput"><span class="special">)</span></code>
</pre>
<h6>
<a name="geometry_index.r_tree.reference.group__rtree__functions.empty_rtree______const___.h2"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.empty_rtree______const___.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.empty_rtree______const___.parameter_s_">Parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Type
</p>
</th>
<th>
<p>
Name
</p>
</th>
<th>
<p>
Description
</p>
</th>
</tr></thead>
<tbody><tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">rtree</span><span class="special">&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.empty_rtree______const___.h3"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.empty_rtree______const___.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.empty_rtree______const___.returns">Returns</a>
</h6>
<p>
true if there are no values in the index.
</p>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.group__rtree__functions.bounds_rtree______const___"></a><a name="group__rtree__functions_1gadb11fdb8e75ba7652286ec6750b49c4f"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.bounds_rtree______const___" title="bounds(rtree&lt;...&gt; const &amp;)">bounds(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.bounds_rtree______const___.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.bounds_rtree______const___.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.bounds_rtree______const___.description">Description</a>
</h6>
<p>
It calls <code class="literal"><code class="computeroutput"><span class="identifier">rtree</span><span class="special">::</span><span class="identifier">envelope</span><span class="special">()</span></code></code>.
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__rtree__functions.bounds_rtree______const___.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.bounds_rtree______const___.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.bounds_rtree______const___.synopsis">Synopsis</a>
</h6>
<pre class="programlisting"><code class="computeroutput"><span class="keyword">template</span><span class="special">&lt;</span></code><code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Value</span></code><code class="computeroutput"><span class="special">,</span></code>
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Options</span></code><code class="computeroutput"><span class="special">,</span></code>
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Translator</span></code><code class="computeroutput"><span class="special">,</span></code>
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Allocator</span></code><code class="computeroutput"><span class="special">&gt;</span></code>
<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="identifier">bounds_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">bounds</span></code><code class="computeroutput"><span class="special">(</span></code><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> <code class="computeroutput"><span class="identifier">tree</span></code><code class="computeroutput"><span class="special">)</span></code>
</pre>
<h6>
<a name="geometry_index.r_tree.reference.group__rtree__functions.bounds_rtree______const___.h2"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.bounds_rtree______const___.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.bounds_rtree______const___.parameter_s_">Parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Type
</p>
</th>
<th>
<p>
Name
</p>
</th>
<th>
<p>
Description
</p>
</th>
</tr></thead>
<tbody><tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">rtree</span><span class="special">&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.bounds_rtree______const___.h3"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.bounds_rtree______const___.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.bounds_rtree______const___.returns">Returns</a>
</h6>
<p>
The box containing all stored values or an invalid box.
</p>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.group__rtree__functions.swap_rtree_________rtree________"></a><a name="group__rtree__functions_1ga043d21dc24c57fcabc5ee85093eb8b15"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.swap_rtree_________rtree________" title="swap(rtree&lt;...&gt; &amp;, rtree&lt;...&gt; &amp;)">swap(rtree&lt;...&gt;
&amp;, rtree&lt;...&gt; &amp;)</a>
</h5></div></div></div>
<p>
Exchanges the contents of the container with those of other.
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__rtree__functions.swap_rtree_________rtree________.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.swap_rtree_________rtree________.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.swap_rtree_________rtree________.description">Description</a>
</h6>
<p>
It calls <code class="literal"><a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1rtree_1aad0285d25f96341a8dd6cc22feb3bd73">rtree::swap()</a></code>.
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__rtree__functions.swap_rtree_________rtree________.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.swap_rtree_________rtree________.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.swap_rtree_________rtree________.synopsis">Synopsis</a>
</h6>
<pre class="programlisting"><code class="computeroutput"><span class="keyword">template</span><span class="special">&lt;</span></code><code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Value</span></code><code class="computeroutput"><span class="special">,</span></code>
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Options</span></code><code class="computeroutput"><span class="special">,</span></code>
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Translator</span></code><code class="computeroutput"><span class="special">,</span></code>
<code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Allocator</span></code><code class="computeroutput"><span class="special">&gt;</span></code>
<code class="computeroutput"><span class="keyword">void</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">geometry</span><span class="special">::</span><span class="identifier">index</span><span class="special">::</span><span class="identifier">swap</span></code><code class="computeroutput"><span class="special">(</span></code><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> <code class="computeroutput"><span class="identifier">l</span></code><code class="computeroutput"><span class="special">,</span></code> <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> <code class="computeroutput"><span class="identifier">r</span></code><code class="computeroutput"><span class="special">)</span></code>
</pre>
<h6>
<a name="geometry_index.r_tree.reference.group__rtree__functions.swap_rtree_________rtree________.h2"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__rtree__functions.swap_rtree_________rtree________.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.swap_rtree_________rtree________.parameter_s_">Parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Type
</p>
</th>
<th>
<p>
Name
</p>
</th>
<th>
<p>
Description
</p>
</th>
</tr></thead>
<tbody>
<tr>
<td>
<p>
<code class="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">l</span></code>
</p>
</td>
<td>
<p>
The first rtree.
</p>
</td>
</tr>
<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">r</span></code>
</p>
</td>
<td>
<p>
The second rtree.
</p>
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="geometry_index.r_tree.reference.parameters"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.parameters" title="R-tree parameters (boost::geometry::index::)">R-tree
parameters (boost::geometry::index::)</a>
</h4></div></div></div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.parameters.boost__geometry__index__linear"></a><a name="structboost_1_1geometry_1_1index_1_1linear"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.parameters.boost__geometry__index__linear" title="boost::geometry::index::linear">boost::geometry::index::linear</a>
</h5></div></div></div>
<p>
Linear r-tree creation algorithm parameters.
</p>
<h6>
<a name="geometry_index.r_tree.reference.parameters.boost__geometry__index__linear.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.parameters.boost__geometry__index__linear.header"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.parameters.boost__geometry__index__linear.header">Header</a>
</h6>
<p>
<code class="computeroutput"><span class="preprocessor">#include</span> <span class="special">&lt;</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">parameters</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span></code>
</p>
<h6>
<a name="geometry_index.r_tree.reference.parameters.boost__geometry__index__linear.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.parameters.boost__geometry__index__linear.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.parameters.boost__geometry__index__linear.synopsis">Synopsis</a>
</h6>
<pre class="programlisting"><code class="computeroutput"><span class="keyword">template</span><span class="special">&lt;</span></code><code class="computeroutput"><span class="identifier">size_t</span> <span class="identifier">MaxElements</span></code><code class="computeroutput"><span class="special">,</span></code> <code class="computeroutput"><span class="identifier">size_t</span> <span class="identifier">MinElements</span></code><code class="computeroutput"><span class="special">&gt;</span></code>
<code class="computeroutput"><span class="keyword">struct</span> <span class="identifier">linear</span></code>
<code class="computeroutput"><span class="special">{</span></code>
<code class="computeroutput"> <span class="comment">// ...</span></code>
<code class="computeroutput"><span class="special">};</span></code>
</pre>
<h6>
<a name="geometry_index.r_tree.reference.parameters.boost__geometry__index__linear.h2"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.parameters.boost__geometry__index__linear.template_parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.parameters.boost__geometry__index__linear.template_parameter_s_">Template
parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Parameter
</p>
</th>
<th>
<p>
Description
</p>
</th>
</tr></thead>
<tbody>
<tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">size_t</span> <span class="identifier">MaxElements</span></code>
</p>
</td>
<td>
<p>
Maximum number of elements in nodes.
</p>
</td>
</tr>
<tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">size_t</span> <span class="identifier">MinElements</span></code>
</p>
</td>
<td>
<p>
Minimum number of elements in nodes.
</p>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.parameters.boost__geometry__index__quadratic"></a><a name="structboost_1_1geometry_1_1index_1_1quadratic"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.parameters.boost__geometry__index__quadratic" title="boost::geometry::index::quadratic">boost::geometry::index::quadratic</a>
</h5></div></div></div>
<p>
Quadratic r-tree creation algorithm parameters.
</p>
<h6>
<a name="geometry_index.r_tree.reference.parameters.boost__geometry__index__quadratic.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.parameters.boost__geometry__index__quadratic.header"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.parameters.boost__geometry__index__quadratic.header">Header</a>
</h6>
<p>
<code class="computeroutput"><span class="preprocessor">#include</span> <span class="special">&lt;</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">parameters</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span></code>
</p>
<h6>
<a name="geometry_index.r_tree.reference.parameters.boost__geometry__index__quadratic.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.parameters.boost__geometry__index__quadratic.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.parameters.boost__geometry__index__quadratic.synopsis">Synopsis</a>
</h6>
<pre class="programlisting"><code class="computeroutput"><span class="keyword">template</span><span class="special">&lt;</span></code><code class="computeroutput"><span class="identifier">size_t</span> <span class="identifier">MaxElements</span></code><code class="computeroutput"><span class="special">,</span></code> <code class="computeroutput"><span class="identifier">size_t</span> <span class="identifier">MinElements</span></code><code class="computeroutput"><span class="special">&gt;</span></code>
<code class="computeroutput"><span class="keyword">struct</span> <span class="identifier">quadratic</span></code>
<code class="computeroutput"><span class="special">{</span></code>
<code class="computeroutput"> <span class="comment">// ...</span></code>
<code class="computeroutput"><span class="special">};</span></code>
</pre>
<h6>
<a name="geometry_index.r_tree.reference.parameters.boost__geometry__index__quadratic.h2"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.parameters.boost__geometry__index__quadratic.template_parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.parameters.boost__geometry__index__quadratic.template_parameter_s_">Template
parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Parameter
</p>
</th>
<th>
<p>
Description
</p>
</th>
</tr></thead>
<tbody>
<tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">size_t</span> <span class="identifier">MaxElements</span></code>
</p>
</td>
<td>
<p>
Maximum number of elements in nodes.
</p>
</td>
</tr>
<tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">size_t</span> <span class="identifier">MinElements</span></code>
</p>
</td>
<td>
<p>
Minimum number of elements in nodes.
</p>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.parameters.boost__geometry__index__rstar"></a><a name="structboost_1_1geometry_1_1index_1_1rstar"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.parameters.boost__geometry__index__rstar" title="boost::geometry::index::rstar">boost::geometry::index::rstar</a>
</h5></div></div></div>
<p>
R*-tree creation algorithm parameters.
</p>
<h6>
<a name="geometry_index.r_tree.reference.parameters.boost__geometry__index__rstar.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.parameters.boost__geometry__index__rstar.header"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.parameters.boost__geometry__index__rstar.header">Header</a>
</h6>
<p>
<code class="computeroutput"><span class="preprocessor">#include</span> <span class="special">&lt;</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">parameters</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span></code>
</p>
<h6>
<a name="geometry_index.r_tree.reference.parameters.boost__geometry__index__rstar.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.parameters.boost__geometry__index__rstar.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.parameters.boost__geometry__index__rstar.synopsis">Synopsis</a>
</h6>
<pre class="programlisting"><code class="computeroutput"><span class="keyword">template</span><span class="special">&lt;</span></code><code class="computeroutput"><span class="identifier">size_t</span> <span class="identifier">MaxElements</span></code><code class="computeroutput"><span class="special">,</span></code>
<code class="computeroutput"><span class="identifier">size_t</span> <span class="identifier">MinElements</span></code><code class="computeroutput"><span class="special">,</span></code>
<code class="computeroutput"><span class="identifier">size_t</span> <span class="identifier">OverlapCostThreshold</span></code> = <code class="computeroutput"><span class="number">0</span></code><code class="computeroutput"><span class="special">,</span></code>
<code class="computeroutput"><span class="identifier">size_t</span> <span class="identifier">ReinsertedElements</span></code> = <code class="literal"><a class="link" href="../../">detail::default_rstar_reinserted_elements_s</a></code><code class="computeroutput"><span class="special">&lt;</span><span class="identifier">MaxElements</span><span class="special">&gt;::</span><span class="identifier">value</span></code><code class="computeroutput"><span class="special">&gt;</span></code>
<code class="computeroutput"><span class="keyword">struct</span> <span class="identifier">rstar</span></code>
<code class="computeroutput"><span class="special">{</span></code>
<code class="computeroutput"> <span class="comment">// ...</span></code>
<code class="computeroutput"><span class="special">};</span></code>
</pre>
<h6>
<a name="geometry_index.r_tree.reference.parameters.boost__geometry__index__rstar.h2"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.parameters.boost__geometry__index__rstar.template_parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.parameters.boost__geometry__index__rstar.template_parameter_s_">Template
parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Parameter
</p>
</th>
<th>
<p>
Description
</p>
</th>
</tr></thead>
<tbody>
<tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">size_t</span> <span class="identifier">MaxElements</span></code>
</p>
</td>
<td>
<p>
Maximum number of elements in nodes.
</p>
</td>
</tr>
<tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">size_t</span> <span class="identifier">MinElements</span></code>
</p>
</td>
<td>
<p>
Minimum number of elements in nodes.
</p>
</td>
</tr>
<tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">size_t</span> <span class="identifier">OverlapCostThreshold</span></code>
</p>
</td>
<td>
<p>
The number of leaf node children elements above which nearly
minimum overlap cost is calculated instead of minimum overlap
cost. If 0 minimum overlap cost is always calculated.
</p>
</td>
</tr>
<tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">size_t</span> <span class="identifier">ReinsertedElements</span></code>
</p>
</td>
<td>
<p>
Number of elements reinserted by forced reinsertions algorithm.
</p>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.parameters.boost__geometry__index__dynamic_linear"></a><a name="classboost_1_1geometry_1_1index_1_1dynamic__linear"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.parameters.boost__geometry__index__dynamic_linear" title="boost::geometry::index::dynamic_linear">boost::geometry::index::dynamic_linear</a>
</h5></div></div></div>
<p>
Linear r-tree creation algorithm parameters - run-time version.
</p>
<h6>
<a name="geometry_index.r_tree.reference.parameters.boost__geometry__index__dynamic_linear.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.parameters.boost__geometry__index__dynamic_linear.header"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.parameters.boost__geometry__index__dynamic_linear.header">Header</a>
</h6>
<p>
<code class="computeroutput"><span class="preprocessor">#include</span> <span class="special">&lt;</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">parameters</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span></code>
</p>
<h6>
<a name="geometry_index.r_tree.reference.parameters.boost__geometry__index__dynamic_linear.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.parameters.boost__geometry__index__dynamic_linear.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.parameters.boost__geometry__index__dynamic_linear.synopsis">Synopsis</a>
</h6>
<pre class="programlisting"><code class="computeroutput"><span class="keyword">class</span> <span class="identifier">dynamic_linear</span></code>
<code class="computeroutput"><span class="special">{</span></code>
<code class="computeroutput"> <span class="comment">// ...</span></code>
<code class="computeroutput"><span class="special">};</span></code>
</pre>
<h6>
<a name="geometry_index.r_tree.reference.parameters.boost__geometry__index__dynamic_linear.h2"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.parameters.boost__geometry__index__dynamic_linear.constructor_s__and_destructor"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.parameters.boost__geometry__index__dynamic_linear.constructor_s__and_destructor">Constructor(s)
and destructor</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Function
</p>
</th>
<th>
<p>
Description
</p>
</th>
</tr></thead>
<tbody><tr>
<td>
<p>
<a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1dynamic__linear_1afd6fdb6746cc4b3331b7058e9819d037"><code class="computeroutput"><span class="identifier">dynamic_linear</span><span class="special">(</span><span class="identifier">size_t</span><span class="special">,</span>
<span class="identifier">size_t</span><span class="special">)</span></code></a>
</p>
</td>
<td>
<p>
The constructor.
</p>
</td>
</tr></tbody>
</table></div>
<div class="section">
<div class="titlepage"><div><div><h6 class="title">
<a name="geometry_index.r_tree.reference.parameters.boost__geometry__index__dynamic_linear.dynamic_linear_size_t__size_t_"></a><a name="classboost_1_1geometry_1_1index_1_1dynamic__linear_1afd6fdb6746cc4b3331b7058e9819d037"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.parameters.boost__geometry__index__dynamic_linear.dynamic_linear_size_t__size_t_" title="dynamic_linear(size_t, size_t)">dynamic_linear(size_t,
size_t)</a>
</h6></div></div></div>
<p>
The constructor.
</p>
<h7><a name="geometry_index.r_tree.reference.parameters.boost__geometry__index__dynamic_linear.dynamic_linear_size_t__size_t_.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.parameters.boost__geometry__index__dynamic_linear.dynamic_linear_size_t__size_t_.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.parameters.boost__geometry__index__dynamic_linear.dynamic_linear_size_t__size_t_.synopsis">Synopsis</a>
</h7><pre class="programlisting"><code class="computeroutput"><span class="identifier">dynamic_linear</span></code><code class="computeroutput"><span class="special">(</span></code><code class="computeroutput"><span class="identifier">size_t</span></code> <code class="computeroutput"><span class="identifier">max_elements</span></code><code class="computeroutput"><span class="special">,</span></code> <code class="computeroutput"><span class="identifier">size_t</span></code> <code class="computeroutput"><span class="identifier">min_elements</span></code><code class="computeroutput"><span class="special">)</span></code>
</pre>
<h7><a name="geometry_index.r_tree.reference.parameters.boost__geometry__index__dynamic_linear.dynamic_linear_size_t__size_t_.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.parameters.boost__geometry__index__dynamic_linear.dynamic_linear_size_t__size_t_.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.parameters.boost__geometry__index__dynamic_linear.dynamic_linear_size_t__size_t_.parameter_s_">Parameter(s)</a>
</h7><div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Type
</p>
</th>
<th>
<p>
Name
</p>
</th>
<th>
<p>
Description
</p>
</th>
</tr></thead>
<tbody>
<tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">size_t</span></code>
</p>
</td>
<td>
<p>
<code class="computeroutput"><span class="identifier">max_elements</span></code>
</p>
</td>
<td>
<p>
Maximum number of elements in nodes.
</p>
</td>
</tr>
<tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">size_t</span></code>
</p>
</td>
<td>
<p>
<code class="computeroutput"><span class="identifier">min_elements</span></code>
</p>
</td>
<td>
<p>
Minimum number of elements in nodes.
</p>
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.parameters.boost__geometry__index__dynamic_quadratic"></a><a name="classboost_1_1geometry_1_1index_1_1dynamic__quadratic"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.parameters.boost__geometry__index__dynamic_quadratic" title="boost::geometry::index::dynamic_quadratic">boost::geometry::index::dynamic_quadratic</a>
</h5></div></div></div>
<p>
Quadratic r-tree creation algorithm parameters - run-time version.
</p>
<h6>
<a name="geometry_index.r_tree.reference.parameters.boost__geometry__index__dynamic_quadratic.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.parameters.boost__geometry__index__dynamic_quadratic.header"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.parameters.boost__geometry__index__dynamic_quadratic.header">Header</a>
</h6>
<p>
<code class="computeroutput"><span class="preprocessor">#include</span> <span class="special">&lt;</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">parameters</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span></code>
</p>
<h6>
<a name="geometry_index.r_tree.reference.parameters.boost__geometry__index__dynamic_quadratic.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.parameters.boost__geometry__index__dynamic_quadratic.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.parameters.boost__geometry__index__dynamic_quadratic.synopsis">Synopsis</a>
</h6>
<pre class="programlisting"><code class="computeroutput"><span class="keyword">class</span> <span class="identifier">dynamic_quadratic</span></code>
<code class="computeroutput"><span class="special">{</span></code>
<code class="computeroutput"> <span class="comment">// ...</span></code>
<code class="computeroutput"><span class="special">};</span></code>
</pre>
<h6>
<a name="geometry_index.r_tree.reference.parameters.boost__geometry__index__dynamic_quadratic.h2"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.parameters.boost__geometry__index__dynamic_quadratic.constructor_s__and_destructor"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.parameters.boost__geometry__index__dynamic_quadratic.constructor_s__and_destructor">Constructor(s)
and destructor</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Function
</p>
</th>
<th>
<p>
Description
</p>
</th>
</tr></thead>
<tbody><tr>
<td>
<p>
<a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1dynamic__quadratic_1a19f526af4c76e09402164f966fdfca91"><code class="computeroutput"><span class="identifier">dynamic_quadratic</span><span class="special">(</span><span class="identifier">size_t</span><span class="special">,</span>
<span class="identifier">size_t</span><span class="special">)</span></code></a>
</p>
</td>
<td>
<p>
The constructor.
</p>
</td>
</tr></tbody>
</table></div>
<div class="section">
<div class="titlepage"><div><div><h6 class="title">
<a name="geometry_index.r_tree.reference.parameters.boost__geometry__index__dynamic_quadratic.dynamic_quadratic_size_t__size_t_"></a><a name="classboost_1_1geometry_1_1index_1_1dynamic__quadratic_1a19f526af4c76e09402164f966fdfca91"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.parameters.boost__geometry__index__dynamic_quadratic.dynamic_quadratic_size_t__size_t_" title="dynamic_quadratic(size_t, size_t)">dynamic_quadratic(size_t,
size_t)</a>
</h6></div></div></div>
<p>
The constructor.
</p>
<h7><a name="geometry_index.r_tree.reference.parameters.boost__geometry__index__dynamic_quadratic.dynamic_quadratic_size_t__size_t_.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.parameters.boost__geometry__index__dynamic_quadratic.dynamic_quadratic_size_t__size_t_.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.parameters.boost__geometry__index__dynamic_quadratic.dynamic_quadratic_size_t__size_t_.synopsis">Synopsis</a>
</h7><pre class="programlisting"><code class="computeroutput"><span class="identifier">dynamic_quadratic</span></code><code class="computeroutput"><span class="special">(</span></code><code class="computeroutput"><span class="identifier">size_t</span></code> <code class="computeroutput"><span class="identifier">max_elements</span></code><code class="computeroutput"><span class="special">,</span></code> <code class="computeroutput"><span class="identifier">size_t</span></code> <code class="computeroutput"><span class="identifier">min_elements</span></code><code class="computeroutput"><span class="special">)</span></code>
</pre>
<h7><a name="geometry_index.r_tree.reference.parameters.boost__geometry__index__dynamic_quadratic.dynamic_quadratic_size_t__size_t_.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.parameters.boost__geometry__index__dynamic_quadratic.dynamic_quadratic_size_t__size_t_.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.parameters.boost__geometry__index__dynamic_quadratic.dynamic_quadratic_size_t__size_t_.parameter_s_">Parameter(s)</a>
</h7><div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Type
</p>
</th>
<th>
<p>
Name
</p>
</th>
<th>
<p>
Description
</p>
</th>
</tr></thead>
<tbody>
<tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">size_t</span></code>
</p>
</td>
<td>
<p>
<code class="computeroutput"><span class="identifier">max_elements</span></code>
</p>
</td>
<td>
<p>
Maximum number of elements in nodes.
</p>
</td>
</tr>
<tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">size_t</span></code>
</p>
</td>
<td>
<p>
<code class="computeroutput"><span class="identifier">min_elements</span></code>
</p>
</td>
<td>
<p>
Minimum number of elements in nodes.
</p>
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.parameters.boost__geometry__index__dynamic_rstar"></a><a name="classboost_1_1geometry_1_1index_1_1dynamic__rstar"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.parameters.boost__geometry__index__dynamic_rstar" title="boost::geometry::index::dynamic_rstar">boost::geometry::index::dynamic_rstar</a>
</h5></div></div></div>
<p>
R*-tree creation algorithm parameters - run-time version.
</p>
<h6>
<a name="geometry_index.r_tree.reference.parameters.boost__geometry__index__dynamic_rstar.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.parameters.boost__geometry__index__dynamic_rstar.header"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.parameters.boost__geometry__index__dynamic_rstar.header">Header</a>
</h6>
<p>
<code class="computeroutput"><span class="preprocessor">#include</span> <span class="special">&lt;</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">parameters</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span></code>
</p>
<h6>
<a name="geometry_index.r_tree.reference.parameters.boost__geometry__index__dynamic_rstar.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.parameters.boost__geometry__index__dynamic_rstar.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.parameters.boost__geometry__index__dynamic_rstar.synopsis">Synopsis</a>
</h6>
<pre class="programlisting"><code class="computeroutput"><span class="keyword">class</span> <span class="identifier">dynamic_rstar</span></code>
<code class="computeroutput"><span class="special">{</span></code>
<code class="computeroutput"> <span class="comment">// ...</span></code>
<code class="computeroutput"><span class="special">};</span></code>
</pre>
<h6>
<a name="geometry_index.r_tree.reference.parameters.boost__geometry__index__dynamic_rstar.h2"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.parameters.boost__geometry__index__dynamic_rstar.constructor_s__and_destructor"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.parameters.boost__geometry__index__dynamic_rstar.constructor_s__and_destructor">Constructor(s)
and destructor</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Function
</p>
</th>
<th>
<p>
Description
</p>
</th>
</tr></thead>
<tbody><tr>
<td>
<p>
<a class="link" href="reference.html#classboost_1_1geometry_1_1index_1_1dynamic__rstar_1af825a8e4652b3ca3f2487fe7fdd403be"><code class="computeroutput"><span class="identifier">dynamic_rstar</span><span class="special">(</span><span class="identifier">size_t</span><span class="special">,</span>
<span class="identifier">size_t</span><span class="special">)</span></code></a>
</p>
</td>
<td>
<p>
The constructor.
</p>
</td>
</tr></tbody>
</table></div>
<div class="section">
<div class="titlepage"><div><div><h6 class="title">
<a name="geometry_index.r_tree.reference.parameters.boost__geometry__index__dynamic_rstar.dynamic_rstar_size_t__size_t_"></a><a name="classboost_1_1geometry_1_1index_1_1dynamic__rstar_1af825a8e4652b3ca3f2487fe7fdd403be"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.parameters.boost__geometry__index__dynamic_rstar.dynamic_rstar_size_t__size_t_" title="dynamic_rstar(size_t, size_t)">dynamic_rstar(size_t,
size_t)</a>
</h6></div></div></div>
<p>
The constructor.
</p>
<h7><a name="geometry_index.r_tree.reference.parameters.boost__geometry__index__dynamic_rstar.dynamic_rstar_size_t__size_t_.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.parameters.boost__geometry__index__dynamic_rstar.dynamic_rstar_size_t__size_t_.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.parameters.boost__geometry__index__dynamic_rstar.dynamic_rstar_size_t__size_t_.synopsis">Synopsis</a>
</h7><pre class="programlisting"><code class="computeroutput"><span class="identifier">dynamic_rstar</span></code><code class="computeroutput"><span class="special">(</span></code><code class="computeroutput"><span class="identifier">size_t</span></code> <code class="computeroutput"><span class="identifier">max_elements</span></code><code class="computeroutput"><span class="special">,</span></code>
<code class="computeroutput"><span class="identifier">size_t</span></code> <code class="computeroutput"><span class="identifier">min_elements</span></code><code class="computeroutput"><span class="special">,</span></code>
<code class="computeroutput"><span class="identifier">size_t</span></code> <code class="computeroutput"><span class="identifier">overlap_cost_threshold</span></code> = <code class="computeroutput"><span class="number">0</span></code><code class="computeroutput"><span class="special">,</span></code>
<code class="computeroutput"><span class="identifier">size_t</span></code> <code class="computeroutput"><span class="identifier">reinserted_elements</span></code> = <code class="computeroutput"><span class="identifier">detail</span><span class="special">::</span><span class="identifier">default_rstar_reinserted_elements_d</span><span class="special">()</span></code><code class="computeroutput"><span class="special">)</span></code>
</pre>
<h7><a name="geometry_index.r_tree.reference.parameters.boost__geometry__index__dynamic_rstar.dynamic_rstar_size_t__size_t_.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.parameters.boost__geometry__index__dynamic_rstar.dynamic_rstar_size_t__size_t_.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.parameters.boost__geometry__index__dynamic_rstar.dynamic_rstar_size_t__size_t_.parameter_s_">Parameter(s)</a>
</h7><div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Type
</p>
</th>
<th>
<p>
Name
</p>
</th>
<th>
<p>
Description
</p>
</th>
</tr></thead>
<tbody>
<tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">size_t</span></code>
</p>
</td>
<td>
<p>
<code class="computeroutput"><span class="identifier">max_elements</span></code>
</p>
</td>
<td>
<p>
Maximum number of elements in nodes.
</p>
</td>
</tr>
<tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">size_t</span></code>
</p>
</td>
<td>
<p>
<code class="computeroutput"><span class="identifier">min_elements</span></code>
</p>
</td>
<td>
<p>
Minimum number of elements in nodes.
</p>
</td>
</tr>
<tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">size_t</span></code>
</p>
</td>
<td>
<p>
<code class="computeroutput"><span class="identifier">overlap_cost_threshold</span></code>
</p>
</td>
<td>
<p>
The number of leaf node children elements above which nearly
minimum overlap cost is calculated instead of minimum overlap
cost. If 0 minimum overlap cost is always calculated.
</p>
</td>
</tr>
<tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">size_t</span></code>
</p>
</td>
<td>
<p>
<code class="computeroutput"><span class="identifier">reinserted_elements</span></code>
</p>
</td>
<td>
<p>
Number of elements reinserted by forced reinsertions algorithm.
</p>
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="geometry_index.r_tree.reference.boost__geometry__index__translator"></a><a name="structboost_1_1geometry_1_1index_1_1translator"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__translator" title="boost::geometry::index::translator">boost::geometry::index::translator</a>
</h4></div></div></div>
<p>
The default translator.
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost__geometry__index__translator.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost__geometry__index__translator.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__translator.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.boost__geometry__index__translator.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost__geometry__index__translator.header"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__translator.header">Header</a>
</h6>
<p>
<code class="computeroutput"><span class="preprocessor">#include</span> <span class="special">&lt;</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">translator</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span></code>
</p>
<h6>
<a name="geometry_index.r_tree.reference.boost__geometry__index__translator.h2"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost__geometry__index__translator.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__translator.synopsis">Synopsis</a>
</h6>
<pre class="programlisting"><code class="computeroutput"><span class="keyword">template</span><span class="special">&lt;</span></code><code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Value</span></code><code class="computeroutput"><span class="special">&gt;</span></code>
<code class="computeroutput"><span class="keyword">struct</span> <span class="identifier">translator</span></code>
<code class="computeroutput"><span class="special">{</span></code>
<code class="computeroutput"> <span class="comment">// ...</span></code>
<code class="computeroutput"><span class="special">};</span></code>
</pre>
<h6>
<a name="geometry_index.r_tree.reference.boost__geometry__index__translator.h3"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.boost__geometry__index__translator.template_parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.boost__geometry__index__translator.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><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="Predicates (boost::geometry::index::)">Predicates
(boost::geometry::index::)</a>
</h4></div></div></div>
<h6>
<a name="geometry_index.r_tree.reference.group__predicates.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__predicates.functions"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.functions">Functions</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Function
</p>
</th>
<th>
<p>
Description
</p>
</th>
</tr></thead>
<tbody>
<tr>
<td>
<p>
<a class="link" href="reference.html#group__predicates_1ga0a613a7f1d18ac33955bfdc2c5777c61"><code class="computeroutput"><span class="identifier">covered_by</span><span class="special">(</span><span class="identifier">Geometry</span> <span class="keyword">const</span>
<span class="special">&amp;)</span></code></a>
</p>
</td>
<td>
<p>
Generate <code class="literal"><a class="link" href="reference.html#group__predicates_1ga0a613a7f1d18ac33955bfdc2c5777c61">covered_by()</a></code>
predicate.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="reference.html#group__predicates_1ga351bb3b82e019ff45adf789385b8007d"><code class="computeroutput"><span class="identifier">disjoint</span><span class="special">(</span><span class="identifier">Geometry</span> <span class="keyword">const</span>
<span class="special">&amp;)</span></code></a>
</p>
</td>
<td>
<p>
Generate <code class="literal"><a class="link" href="reference.html#group__predicates_1ga351bb3b82e019ff45adf789385b8007d">disjoint()</a></code>
predicate.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="reference.html#group__predicates_1ga7301c50e0272976b9f1434536383e6d0"><code class="computeroutput"><span class="identifier">intersects</span><span class="special">(</span><span class="identifier">Geometry</span> <span class="keyword">const</span>
<span class="special">&amp;)</span></code></a>
</p>
</td>
<td>
<p>
Generate <code class="literal"><a class="link" href="reference.html#group__predicates_1ga7301c50e0272976b9f1434536383e6d0">intersects()</a></code>
predicate.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="reference.html#group__predicates_1ga5511236f56be1defcccbf11e742ccd88"><code class="computeroutput"><span class="identifier">overlaps</span><span class="special">(</span><span class="identifier">Geometry</span> <span class="keyword">const</span>
<span class="special">&amp;)</span></code></a>
</p>
</td>
<td>
<p>
Generate <code class="literal"><a class="link" href="reference.html#group__predicates_1ga5511236f56be1defcccbf11e742ccd88">overlaps()</a></code>
predicate.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="reference.html#group__predicates_1gabf9c4e76dd8a09a4c476f2f8fa8a0e4d"><code class="computeroutput"><span class="identifier">within</span><span class="special">(</span><span class="identifier">Geometry</span> <span class="keyword">const</span>
<span class="special">&amp;)</span></code></a>
</p>
</td>
<td>
<p>
Generate <code class="literal"><a class="link" href="reference.html#group__predicates_1gabf9c4e76dd8a09a4c476f2f8fa8a0e4d">within()</a></code>
predicate.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="reference.html#group__predicates_1gae7e9291c5b99041fb155d29de0860bab"><code class="computeroutput"><span class="identifier">satisfies</span><span class="special">(</span><span class="identifier">UnaryPredicate</span> <span class="keyword">const</span>
<span class="special">&amp;)</span></code></a>
</p>
</td>
<td>
<p>
Generate <a class="link" href="reference.html#group__predicates_1gae7e9291c5b99041fb155d29de0860bab">satisfies()</a>
predicate.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="reference.html#group__predicates_1gae80a2c204673a8b11c4fc137cfff6556"><code class="computeroutput"><span class="identifier">nearest</span><span class="special">(</span><span class="identifier">PointOrRelation</span> <span class="keyword">const</span>
<span class="special">&amp;,</span> <span class="keyword">unsigned</span><span class="special">)</span></code></a>
</p>
</td>
<td>
<p>
Generate <a class="link" href="reference.html#group__predicates_1gae80a2c204673a8b11c4fc137cfff6556">nearest()</a>
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.covered_by_geometry_const___"></a><a name="group__predicates_1ga0a613a7f1d18ac33955bfdc2c5777c61"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.covered_by_geometry_const___" title="covered_by(Geometry const &amp;)">covered_by(Geometry
const &amp;)</a>
</h5></div></div></div>
<p>
Generate <code class="literal"><a class="link" href="reference.html#group__predicates_1ga0a613a7f1d18ac33955bfdc2c5777c61">covered_by()</a></code>
predicate.
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__predicates.covered_by_geometry_const___.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__predicates.covered_by_geometry_const___.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.covered_by_geometry_const___.description">Description</a>
</h6>
<p>
Generate a predicate defining Value and Geometry relationship. Value
will be returned by the query if <code class="literal"><code class="computeroutput"><span class="identifier">bg</span><span class="special">::</span><span class="identifier">covered_by</span><span class="special">(</span><span class="identifier">Indexable</span><span class="special">,</span> <span class="identifier">Geometry</span><span class="special">)</span></code></code> returns true.
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__predicates.covered_by_geometry_const___.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__predicates.covered_by_geometry_const___.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.covered_by_geometry_const___.synopsis">Synopsis</a>
</h6>
<pre class="programlisting"><code class="computeroutput"><span class="keyword">template</span><span class="special">&lt;</span></code><code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Geometry</span></code><code class="computeroutput"><span class="special">&gt;</span></code>
<code class="computeroutput"><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></code><code class="computeroutput"><span class="special">(</span></code><code class="computeroutput"><span class="identifier">Geometry</span> <span class="keyword">const</span> <span class="special">&amp;</span></code> <code class="computeroutput"><span class="identifier">g</span></code><code class="computeroutput"><span class="special">)</span></code>
</pre>
<h6>
<a name="geometry_index.r_tree.reference.group__predicates.covered_by_geometry_const___.h2"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__predicates.covered_by_geometry_const___.template_parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.covered_by_geometry_const___.template_parameter_s_">Template
parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Parameter
</p>
</th>
<th>
<p>
Description
</p>
</th>
</tr></thead>
<tbody><tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">Geometry</span></code>
</p>
</td>
<td>
<p>
The Geometry type.
</p>
</td>
</tr></tbody>
</table></div>
<h6>
<a name="geometry_index.r_tree.reference.group__predicates.covered_by_geometry_const___.h3"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__predicates.covered_by_geometry_const___.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.covered_by_geometry_const___.parameter_s_">Parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Type
</p>
</th>
<th>
<p>
Name
</p>
</th>
<th>
<p>
Description
</p>
</th>
</tr></thead>
<tbody><tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">Geometry</span> <span class="keyword">const</span>
<span class="special">&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>
<h6>
<a name="geometry_index.r_tree.reference.group__predicates.covered_by_geometry_const___.h4"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__predicates.covered_by_geometry_const___.example"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.covered_by_geometry_const___.example">Example</a>
</h6>
<p>
</p>
<pre class="programlisting"><span class="identifier">bgi</span><span class="special">::</span><span class="identifier">query</span><span class="special">(</span><span class="identifier">spatial_index</span><span class="special">,</span> <span class="identifier">bgi</span><span class="special">::</span><span class="identifier">covered_by</span><span class="special">(</span><span class="identifier">box</span><span class="special">),</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">back_inserter</span><span class="special">(</span><span class="identifier">result</span><span class="special">));</span>
</pre>
<p>
</p>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.group__predicates.disjoint_geometry_const___"></a><a name="group__predicates_1ga351bb3b82e019ff45adf789385b8007d"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.disjoint_geometry_const___" title="disjoint(Geometry const &amp;)">disjoint(Geometry
const &amp;)</a>
</h5></div></div></div>
<p>
Generate <code class="literal"><a class="link" href="reference.html#group__predicates_1ga351bb3b82e019ff45adf789385b8007d">disjoint()</a></code>
predicate.
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__predicates.disjoint_geometry_const___.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__predicates.disjoint_geometry_const___.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.disjoint_geometry_const___.description">Description</a>
</h6>
<p>
Generate a predicate defining Value and Geometry relationship. Value
will be returned by the query if <code class="literal"><code class="computeroutput"><span class="identifier">bg</span><span class="special">::</span><span class="identifier">disjoint</span><span class="special">(</span><span class="identifier">Indexable</span><span class="special">,</span> <span class="identifier">Geometry</span><span class="special">)</span></code></code> returns true.
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__predicates.disjoint_geometry_const___.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__predicates.disjoint_geometry_const___.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.disjoint_geometry_const___.synopsis">Synopsis</a>
</h6>
<pre class="programlisting"><code class="computeroutput"><span class="keyword">template</span><span class="special">&lt;</span></code><code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Geometry</span></code><code class="computeroutput"><span class="special">&gt;</span></code>
<code class="computeroutput"><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></code><code class="computeroutput"><span class="special">(</span></code><code class="computeroutput"><span class="identifier">Geometry</span> <span class="keyword">const</span> <span class="special">&amp;</span></code> <code class="computeroutput"><span class="identifier">g</span></code><code class="computeroutput"><span class="special">)</span></code>
</pre>
<h6>
<a name="geometry_index.r_tree.reference.group__predicates.disjoint_geometry_const___.h2"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__predicates.disjoint_geometry_const___.template_parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.disjoint_geometry_const___.template_parameter_s_">Template
parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Parameter
</p>
</th>
<th>
<p>
Description
</p>
</th>
</tr></thead>
<tbody><tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">Geometry</span></code>
</p>
</td>
<td>
<p>
The Geometry type.
</p>
</td>
</tr></tbody>
</table></div>
<h6>
<a name="geometry_index.r_tree.reference.group__predicates.disjoint_geometry_const___.h3"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__predicates.disjoint_geometry_const___.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.disjoint_geometry_const___.parameter_s_">Parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Type
</p>
</th>
<th>
<p>
Name
</p>
</th>
<th>
<p>
Description
</p>
</th>
</tr></thead>
<tbody><tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">Geometry</span> <span class="keyword">const</span>
<span class="special">&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>
<h6>
<a name="geometry_index.r_tree.reference.group__predicates.disjoint_geometry_const___.h4"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__predicates.disjoint_geometry_const___.example"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.disjoint_geometry_const___.example">Example</a>
</h6>
<p>
</p>
<pre class="programlisting"><span class="identifier">bgi</span><span class="special">::</span><span class="identifier">query</span><span class="special">(</span><span class="identifier">spatial_index</span><span class="special">,</span> <span class="identifier">bgi</span><span class="special">::</span><span class="identifier">disjoint</span><span class="special">(</span><span class="identifier">box</span><span class="special">),</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">back_inserter</span><span class="special">(</span><span class="identifier">result</span><span class="special">));</span>
</pre>
<p>
</p>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.group__predicates.intersects_geometry_const___"></a><a name="group__predicates_1ga7301c50e0272976b9f1434536383e6d0"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.intersects_geometry_const___" title="intersects(Geometry const &amp;)">intersects(Geometry
const &amp;)</a>
</h5></div></div></div>
<p>
Generate <code class="literal"><a class="link" href="reference.html#group__predicates_1ga7301c50e0272976b9f1434536383e6d0">intersects()</a></code>
predicate.
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__predicates.intersects_geometry_const___.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__predicates.intersects_geometry_const___.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.intersects_geometry_const___.description">Description</a>
</h6>
<p>
Generate a predicate defining Value and Geometry relationship. Value
will be returned by the query if <code class="literal"><code class="computeroutput"><span class="identifier">bg</span><span class="special">::</span><span class="identifier">intersects</span><span class="special">(</span><span class="identifier">Indexable</span><span class="special">,</span> <span class="identifier">Geometry</span><span class="special">)</span></code></code> returns true.
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__predicates.intersects_geometry_const___.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__predicates.intersects_geometry_const___.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.intersects_geometry_const___.synopsis">Synopsis</a>
</h6>
<pre class="programlisting"><code class="computeroutput"><span class="keyword">template</span><span class="special">&lt;</span></code><code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Geometry</span></code><code class="computeroutput"><span class="special">&gt;</span></code>
<code class="computeroutput"><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></code><code class="computeroutput"><span class="special">(</span></code><code class="computeroutput"><span class="identifier">Geometry</span> <span class="keyword">const</span> <span class="special">&amp;</span></code> <code class="computeroutput"><span class="identifier">g</span></code><code class="computeroutput"><span class="special">)</span></code>
</pre>
<h6>
<a name="geometry_index.r_tree.reference.group__predicates.intersects_geometry_const___.h2"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__predicates.intersects_geometry_const___.template_parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.intersects_geometry_const___.template_parameter_s_">Template
parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Parameter
</p>
</th>
<th>
<p>
Description
</p>
</th>
</tr></thead>
<tbody><tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">Geometry</span></code>
</p>
</td>
<td>
<p>
The Geometry type.
</p>
</td>
</tr></tbody>
</table></div>
<h6>
<a name="geometry_index.r_tree.reference.group__predicates.intersects_geometry_const___.h3"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__predicates.intersects_geometry_const___.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.intersects_geometry_const___.parameter_s_">Parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Type
</p>
</th>
<th>
<p>
Name
</p>
</th>
<th>
<p>
Description
</p>
</th>
</tr></thead>
<tbody><tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">Geometry</span> <span class="keyword">const</span>
<span class="special">&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>
<h6>
<a name="geometry_index.r_tree.reference.group__predicates.intersects_geometry_const___.h4"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__predicates.intersects_geometry_const___.example"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.intersects_geometry_const___.example">Example</a>
</h6>
<p>
</p>
<pre class="programlisting"><span class="identifier">bgi</span><span class="special">::</span><span class="identifier">query</span><span class="special">(</span><span class="identifier">spatial_index</span><span class="special">,</span> <span class="identifier">bgi</span><span class="special">::</span><span class="identifier">intersects</span><span class="special">(</span><span class="identifier">box</span><span class="special">),</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">back_inserter</span><span class="special">(</span><span class="identifier">result</span><span class="special">));</span>
<span class="identifier">bgi</span><span class="special">::</span><span class="identifier">query</span><span class="special">(</span><span class="identifier">spatial_index</span><span class="special">,</span> <span class="identifier">bgi</span><span class="special">::</span><span class="identifier">intersects</span><span class="special">(</span><span class="identifier">ring</span><span class="special">),</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">back_inserter</span><span class="special">(</span><span class="identifier">result</span><span class="special">));</span>
<span class="identifier">bgi</span><span class="special">::</span><span class="identifier">query</span><span class="special">(</span><span class="identifier">spatial_index</span><span class="special">,</span> <span class="identifier">bgi</span><span class="special">::</span><span class="identifier">intersects</span><span class="special">(</span><span class="identifier">polygon</span><span class="special">),</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">back_inserter</span><span class="special">(</span><span class="identifier">result</span><span class="special">));</span>
</pre>
<p>
</p>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.group__predicates.overlaps_geometry_const___"></a><a name="group__predicates_1ga5511236f56be1defcccbf11e742ccd88"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.overlaps_geometry_const___" title="overlaps(Geometry const &amp;)">overlaps(Geometry
const &amp;)</a>
</h5></div></div></div>
<p>
Generate <code class="literal"><a class="link" href="reference.html#group__predicates_1ga5511236f56be1defcccbf11e742ccd88">overlaps()</a></code>
predicate.
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__predicates.overlaps_geometry_const___.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__predicates.overlaps_geometry_const___.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.overlaps_geometry_const___.description">Description</a>
</h6>
<p>
Generate a predicate defining Value and Geometry relationship. Value
will be returned by the query if <code class="literal"><code class="computeroutput"><span class="identifier">bg</span><span class="special">::</span><span class="identifier">overlaps</span><span class="special">(</span><span class="identifier">Indexable</span><span class="special">,</span> <span class="identifier">Geometry</span><span class="special">)</span></code></code> returns true.
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__predicates.overlaps_geometry_const___.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__predicates.overlaps_geometry_const___.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.overlaps_geometry_const___.synopsis">Synopsis</a>
</h6>
<pre class="programlisting"><code class="computeroutput"><span class="keyword">template</span><span class="special">&lt;</span></code><code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Geometry</span></code><code class="computeroutput"><span class="special">&gt;</span></code>
<code class="computeroutput"><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></code><code class="computeroutput"><span class="special">(</span></code><code class="computeroutput"><span class="identifier">Geometry</span> <span class="keyword">const</span> <span class="special">&amp;</span></code> <code class="computeroutput"><span class="identifier">g</span></code><code class="computeroutput"><span class="special">)</span></code>
</pre>
<h6>
<a name="geometry_index.r_tree.reference.group__predicates.overlaps_geometry_const___.h2"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__predicates.overlaps_geometry_const___.template_parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.overlaps_geometry_const___.template_parameter_s_">Template
parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Parameter
</p>
</th>
<th>
<p>
Description
</p>
</th>
</tr></thead>
<tbody><tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">Geometry</span></code>
</p>
</td>
<td>
<p>
The Geometry type.
</p>
</td>
</tr></tbody>
</table></div>
<h6>
<a name="geometry_index.r_tree.reference.group__predicates.overlaps_geometry_const___.h3"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__predicates.overlaps_geometry_const___.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.overlaps_geometry_const___.parameter_s_">Parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Type
</p>
</th>
<th>
<p>
Name
</p>
</th>
<th>
<p>
Description
</p>
</th>
</tr></thead>
<tbody><tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">Geometry</span> <span class="keyword">const</span>
<span class="special">&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>
<h6>
<a name="geometry_index.r_tree.reference.group__predicates.overlaps_geometry_const___.h4"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__predicates.overlaps_geometry_const___.example"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.overlaps_geometry_const___.example">Example</a>
</h6>
<p>
</p>
<pre class="programlisting"><span class="identifier">bgi</span><span class="special">::</span><span class="identifier">query</span><span class="special">(</span><span class="identifier">spatial_index</span><span class="special">,</span> <span class="identifier">bgi</span><span class="special">::</span><span class="identifier">overlaps</span><span class="special">(</span><span class="identifier">box</span><span class="special">),</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">back_inserter</span><span class="special">(</span><span class="identifier">result</span><span class="special">));</span>
</pre>
<p>
</p>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.group__predicates.within_geometry_const___"></a><a name="group__predicates_1gabf9c4e76dd8a09a4c476f2f8fa8a0e4d"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.within_geometry_const___" title="within(Geometry const &amp;)">within(Geometry
const &amp;)</a>
</h5></div></div></div>
<p>
Generate <code class="literal"><a class="link" href="reference.html#group__predicates_1gabf9c4e76dd8a09a4c476f2f8fa8a0e4d">within()</a></code>
predicate.
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__predicates.within_geometry_const___.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__predicates.within_geometry_const___.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.within_geometry_const___.description">Description</a>
</h6>
<p>
Generate a predicate defining Value and Geometry relationship. Value
will be returned by the query if <code class="literal"><code class="computeroutput"><span class="identifier">bg</span><span class="special">::</span><span class="identifier">within</span><span class="special">(</span><span class="identifier">Indexable</span><span class="special">,</span> <span class="identifier">Geometry</span><span class="special">)</span></code></code> returns true.
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__predicates.within_geometry_const___.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__predicates.within_geometry_const___.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.within_geometry_const___.synopsis">Synopsis</a>
</h6>
<pre class="programlisting"><code class="computeroutput"><span class="keyword">template</span><span class="special">&lt;</span></code><code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Geometry</span></code><code class="computeroutput"><span class="special">&gt;</span></code>
<code class="computeroutput"><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></code><code class="computeroutput"><span class="special">(</span></code><code class="computeroutput"><span class="identifier">Geometry</span> <span class="keyword">const</span> <span class="special">&amp;</span></code> <code class="computeroutput"><span class="identifier">g</span></code><code class="computeroutput"><span class="special">)</span></code>
</pre>
<h6>
<a name="geometry_index.r_tree.reference.group__predicates.within_geometry_const___.h2"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__predicates.within_geometry_const___.template_parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.within_geometry_const___.template_parameter_s_">Template
parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Parameter
</p>
</th>
<th>
<p>
Description
</p>
</th>
</tr></thead>
<tbody><tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">Geometry</span></code>
</p>
</td>
<td>
<p>
The Geometry type.
</p>
</td>
</tr></tbody>
</table></div>
<h6>
<a name="geometry_index.r_tree.reference.group__predicates.within_geometry_const___.h3"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__predicates.within_geometry_const___.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.within_geometry_const___.parameter_s_">Parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Type
</p>
</th>
<th>
<p>
Name
</p>
</th>
<th>
<p>
Description
</p>
</th>
</tr></thead>
<tbody><tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">Geometry</span> <span class="keyword">const</span>
<span class="special">&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>
<h6>
<a name="geometry_index.r_tree.reference.group__predicates.within_geometry_const___.h4"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__predicates.within_geometry_const___.example"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.within_geometry_const___.example">Example</a>
</h6>
<p>
</p>
<pre class="programlisting"><span class="identifier">bgi</span><span class="special">::</span><span class="identifier">query</span><span class="special">(</span><span class="identifier">spatial_index</span><span class="special">,</span> <span class="identifier">bgi</span><span class="special">::</span><span class="identifier">within</span><span class="special">(</span><span class="identifier">box</span><span class="special">),</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">back_inserter</span><span class="special">(</span><span class="identifier">result</span><span class="special">));</span>
</pre>
<p>
</p>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.group__predicates.satisfies_unarypredicate_const___"></a><a name="group__predicates_1gae7e9291c5b99041fb155d29de0860bab"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.satisfies_unarypredicate_const___" title="satisfies(UnaryPredicate const &amp;)">satisfies(UnaryPredicate
const &amp;)</a>
</h5></div></div></div>
<p>
Generate <a class="link" href="reference.html#group__predicates_1gae7e9291c5b99041fb155d29de0860bab">satisfies()</a>
predicate.
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__predicates.satisfies_unarypredicate_const___.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__predicates.satisfies_unarypredicate_const___.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.satisfies_unarypredicate_const___.description">Description</a>
</h6>
<p>
A wrapper around user-defined UnaryPredicate checking if Value should
be returned by spatial query.
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__predicates.satisfies_unarypredicate_const___.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__predicates.satisfies_unarypredicate_const___.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.satisfies_unarypredicate_const___.synopsis">Synopsis</a>
</h6>
<pre class="programlisting"><code class="computeroutput"><span class="keyword">template</span><span class="special">&lt;</span></code><code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">UnaryPredicate</span></code><code class="computeroutput"><span class="special">&gt;</span></code>
<code class="computeroutput"><span class="identifier">detail</span><span class="special">::</span><span class="identifier">satisfies</span><span class="special">&lt;</span><span class="identifier">UnaryPredicate</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">satisfies</span></code><code class="computeroutput"><span class="special">(</span></code><code class="computeroutput"><span class="identifier">UnaryPredicate</span> <span class="keyword">const</span> <span class="special">&amp;</span></code> <code class="computeroutput"><span class="identifier">pred</span></code><code class="computeroutput"><span class="special">)</span></code>
</pre>
<h6>
<a name="geometry_index.r_tree.reference.group__predicates.satisfies_unarypredicate_const___.h2"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__predicates.satisfies_unarypredicate_const___.template_parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.satisfies_unarypredicate_const___.template_parameter_s_">Template
parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Parameter
</p>
</th>
<th>
<p>
Description
</p>
</th>
</tr></thead>
<tbody><tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">UnaryPredicate</span></code>
</p>
</td>
<td>
<p>
A type of unary predicate function or function object.
</p>
</td>
</tr></tbody>
</table></div>
<h6>
<a name="geometry_index.r_tree.reference.group__predicates.satisfies_unarypredicate_const___.h3"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__predicates.satisfies_unarypredicate_const___.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.satisfies_unarypredicate_const___.parameter_s_">Parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Type
</p>
</th>
<th>
<p>
Name
</p>
</th>
<th>
<p>
Description
</p>
</th>
</tr></thead>
<tbody><tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">UnaryPredicate</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 unary predicate function or function object.
</p>
</td>
</tr></tbody>
</table></div>
<h6>
<a name="geometry_index.r_tree.reference.group__predicates.satisfies_unarypredicate_const___.h4"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__predicates.satisfies_unarypredicate_const___.example"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.satisfies_unarypredicate_const___.example">Example</a>
</h6>
<p>
</p>
<pre class="programlisting"><span class="keyword">bool</span> <span class="identifier">is_red</span><span class="special">(</span>Value <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">v</span><span class="special">)</span> <span class="special">{</span> <span class="keyword">return</span> <span class="identifier">v</span><span class="special">.</span><span class="identifier">is_red</span><span class="special">();</span> <span class="special">}</span>
<span class="keyword">struct</span> <span class="identifier">is_red_o</span> <span class="special">{</span>
<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">bool</span> <span class="keyword">operator</span><span class="special">()(</span>Value <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">v</span><span class="special">)</span> <span class="special">{</span> <span class="keyword">return</span> <span class="identifier">v</span><span class="special">.</span><span class="identifier">is_red</span><span class="special">();</span> <span class="special">}</span>
<span class="special">}</span>
<span class="comment">// ...</span>
<span class="identifier">rt</span><span class="special">.</span><span class="identifier">query</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">box</span><span class="special">)</span> <span class="special">&amp;&amp;</span> <span class="identifier">index</span><span class="special">::</span><span class="identifier">satisfies</span><span class="special">(</span><span class="identifier">is_red</span><span class="special">),</span>
<span class="identifier">std</span><span class="special">::</span><span class="identifier">back_inserter</span><span class="special">(</span><span class="identifier">result</span><span class="special">));</span>
<span class="identifier">rt</span><span class="special">.</span><span class="identifier">query</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">box</span><span class="special">)</span> <span class="special">&amp;&amp;</span> <span class="identifier">index</span><span class="special">::</span><span class="identifier">satisfies</span><span class="special">(</span><span class="identifier">is_red_o</span><span class="special">()),</span>
<span class="identifier">std</span><span class="special">::</span><span class="identifier">back_inserter</span><span class="special">(</span><span class="identifier">result</span><span class="special">));</span>
<span class="preprocessor">#ifndef</span> <span class="identifier">BOOST_NO_CXX11_LAMBDAS</span>
<span class="identifier">rt</span><span class="special">.</span><span class="identifier">query</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">box</span><span class="special">)</span> <span class="special">&amp;&amp;</span> <span class="identifier">index</span><span class="special">::</span><span class="identifier">satisfies</span><span class="special">([](</span>Value <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">v</span><span class="special">)</span> <span class="special">{</span> <span class="keyword">return</span> <span class="identifier">v</span><span class="special">.</span><span class="identifier">is_red</span><span class="special">();</span> <span class="special">}),</span>
<span class="identifier">std</span><span class="special">::</span><span class="identifier">back_inserter</span><span class="special">(</span><span class="identifier">result</span><span class="special">));</span>
<span class="preprocessor">#endif</span>
</pre>
<p>
</p>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.group__predicates.nearest_pointorrelation_const____unsigned_"></a><a name="group__predicates_1gae80a2c204673a8b11c4fc137cfff6556"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.nearest_pointorrelation_const____unsigned_" title="nearest(PointOrRelation const &amp;, unsigned)">nearest(PointOrRelation
const &amp;, unsigned)</a>
</h5></div></div></div>
<p>
Generate <a class="link" href="reference.html#group__predicates_1gae80a2c204673a8b11c4fc137cfff6556">nearest()</a>
predicate.
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__predicates.nearest_pointorrelation_const____unsigned_.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__predicates.nearest_pointorrelation_const____unsigned_.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.nearest_pointorrelation_const____unsigned_.description">Description</a>
</h6>
<p>
When nearest predicate is passed to the query, k-nearest neighbour search
will be performed.
</p>
<p>
The simplest way of defining the knn query is passing a <code class="literal"><code class="computeroutput"><span class="identifier">Point</span></code></code> to which <code class="literal"><code class="computeroutput"><span class="identifier">Values</span></code></code> must be closest.
</p>
<p>
It is possible to define how distance between values and query Point
is calculated. This is done by passing PointRelation. It can be generated
by following functions:
</p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem">
<code class="literal"><a class="link" href="reference.html#group__nearest__relations_1gace3c7dbc60840c2a61da36e975d56636">boost::geometry::index::to_nearest()</a></code>
- default,
</li>
<li class="listitem">
<code class="literal"><a class="link" href="reference.html#group__nearest__relations_1gaccbba95d864d8dcf8a694796c840fbe0">boost::geometry::index::to_centroid()</a></code>,
</li>
<li class="listitem">
<code class="literal"><a class="link" href="reference.html#group__nearest__relations_1ga67dddd8a7fcaae150970e1db0401de02">boost::geometry::index::to_furthest()</a></code>.
</li>
</ul></div>
<h6>
<a name="geometry_index.r_tree.reference.group__predicates.nearest_pointorrelation_const____unsigned_.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__predicates.nearest_pointorrelation_const____unsigned_.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.nearest_pointorrelation_const____unsigned_.synopsis">Synopsis</a>
</h6>
<pre class="programlisting"><code class="computeroutput"><span class="keyword">template</span><span class="special">&lt;</span></code><code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">PointOrRelation</span></code><code class="computeroutput"><span class="special">&gt;</span></code>
<code class="computeroutput"><span class="identifier">detail</span><span class="special">::</span><span class="identifier">nearest</span><span class="special">&lt;</span><span class="identifier">PointOrRelation</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">nearest</span></code><code class="computeroutput"><span class="special">(</span></code><code class="computeroutput"><span class="identifier">PointOrRelation</span> <span class="keyword">const</span> <span class="special">&amp;</span></code> <code class="computeroutput"><span class="identifier">point_relation</span></code><code class="computeroutput"><span class="special">,</span></code> <code class="computeroutput"><span class="keyword">unsigned</span></code> <code class="computeroutput"><span class="identifier">k</span></code><code class="computeroutput"><span class="special">)</span></code>
</pre>
<h6>
<a name="geometry_index.r_tree.reference.group__predicates.nearest_pointorrelation_const____unsigned_.h2"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__predicates.nearest_pointorrelation_const____unsigned_.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.nearest_pointorrelation_const____unsigned_.parameter_s_">Parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Type
</p>
</th>
<th>
<p>
Name
</p>
</th>
<th>
<p>
Description
</p>
</th>
</tr></thead>
<tbody>
<tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">PointOrRelation</span> <span class="keyword">const</span> <span class="special">&amp;</span></code>
</p>
</td>
<td>
<p>
<code class="computeroutput"><span class="identifier">point_relation</span></code>
</p>
</td>
<td>
<p>
The point or relation describing how the distance will be calculated.
</p>
</td>
</tr>
<tr>
<td>
<p>
<code class="computeroutput"><span class="keyword">unsigned</span></code>
</p>
</td>
<td>
<p>
<code class="computeroutput"><span class="identifier">k</span></code>
</p>
</td>
<td>
<p>
The maximum number of values to return.
</p>
</td>
</tr>
</tbody>
</table></div>
<h6>
<a name="geometry_index.r_tree.reference.group__predicates.nearest_pointorrelation_const____unsigned_.h3"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__predicates.nearest_pointorrelation_const____unsigned_.example"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.nearest_pointorrelation_const____unsigned_.example">Example</a>
</h6>
<p>
</p>
<pre class="programlisting"><span class="identifier">bgi</span><span class="special">::</span><span class="identifier">query</span><span class="special">(</span><span class="identifier">spatial_index</span><span class="special">,</span> <span class="identifier">bgi</span><span class="special">::</span><span class="identifier">nearest</span><span class="special">(</span><span class="identifier">pt</span><span class="special">,</span> <span class="number">5</span><span class="special">),</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">back_inserter</span><span class="special">(</span><span class="identifier">result</span><span class="special">));</span>
<span class="identifier">bgi</span><span class="special">::</span><span class="identifier">query</span><span class="special">(</span><span class="identifier">spatial_index</span><span class="special">,</span> <span class="identifier">bgi</span><span class="special">::</span><span class="identifier">nearest</span><span class="special">(</span><span class="identifier">pt</span><span class="special">,</span> <span class="number">5</span><span class="special">)</span> <span class="special">&amp;&amp;</span> <span class="identifier">bgi</span><span class="special">::</span><span class="identifier">intersects</span><span class="special">(</span><span class="identifier">box</span><span class="special">),</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">back_inserter</span><span class="special">(</span><span class="identifier">result</span><span class="special">));</span>
<span class="identifier">bgi</span><span class="special">::</span><span class="identifier">query</span><span class="special">(</span><span class="identifier">spatial_index</span><span class="special">,</span> <span class="identifier">bgi</span><span class="special">::</span><span class="identifier">nearest</span><span class="special">(</span><span class="identifier">bgi</span><span class="special">::</span><span class="identifier">to_centroid</span><span class="special">(</span><span class="identifier">pt</span><span class="special">),</span> <span class="number">5</span><span class="special">)</span> <span class="special">&amp;&amp;</span> <span class="identifier">bgi</span><span class="special">::</span><span class="identifier">within</span><span class="special">(</span><span class="identifier">box</span><span class="special">),</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">back_inserter</span><span class="special">(</span><span class="identifier">result</span><span class="special">));</span>
</pre>
<p>
</p>
<div class="warning"><table border="0" summary="Warning">
<tr>
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Warning]" src="http://www.boost.org/doc/libs/release/doc/src/images/warning.png"></td>
<th align="left">Warning</th>
</tr>
<tr><td align="left" valign="top"><p>
Only one <code class="literal"><a class="link" href="reference.html#group__predicates_1gae80a2c204673a8b11c4fc137cfff6556">nearest()</a></code>
predicate may be used in a query.
</p></td></tr>
</table></div>
</div>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="geometry_index.r_tree.reference.group__nearest__relations"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__nearest__relations" title="Nearest relations (boost::geometry::index::)">Nearest
relations (boost::geometry::index::)</a>
</h4></div></div></div>
<h6>
<a name="geometry_index.r_tree.reference.group__nearest__relations.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__nearest__relations.functions"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__nearest__relations.functions">Functions</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Function
</p>
</th>
<th>
<p>
Description
</p>
</th>
</tr></thead>
<tbody>
<tr>
<td>
<p>
<a class="link" href="reference.html#group__nearest__relations_1gace3c7dbc60840c2a61da36e975d56636"><code class="computeroutput"><span class="identifier">to_nearest</span><span class="special">(</span><span class="identifier">T</span> <span class="keyword">const</span>
<span class="special">&amp;)</span></code></a>
</p>
</td>
<td>
<p>
Generate <a class="link" href="reference.html#group__nearest__relations_1gace3c7dbc60840c2a61da36e975d56636">to_nearest()</a>
relationship.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="reference.html#group__nearest__relations_1gaccbba95d864d8dcf8a694796c840fbe0"><code class="computeroutput"><span class="identifier">to_centroid</span><span class="special">(</span><span class="identifier">T</span> <span class="keyword">const</span>
<span class="special">&amp;)</span></code></a>
</p>
</td>
<td>
<p>
Generate <a class="link" href="reference.html#group__nearest__relations_1gaccbba95d864d8dcf8a694796c840fbe0">to_centroid()</a>
relationship.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="reference.html#group__nearest__relations_1ga67dddd8a7fcaae150970e1db0401de02"><code class="computeroutput"><span class="identifier">to_furthest</span><span class="special">(</span><span class="identifier">T</span> <span class="keyword">const</span>
<span class="special">&amp;)</span></code></a>
</p>
</td>
<td>
<p>
Generate <a class="link" href="reference.html#group__nearest__relations_1ga67dddd8a7fcaae150970e1db0401de02">to_furthest()</a>
relationship.
</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__nearest__relations.to_nearest_t_const___"></a><a name="group__nearest__relations_1gace3c7dbc60840c2a61da36e975d56636"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__nearest__relations.to_nearest_t_const___" title="to_nearest(T const &amp;)">to_nearest(T
const &amp;)</a>
</h5></div></div></div>
<p>
Generate <a class="link" href="reference.html#group__nearest__relations_1gace3c7dbc60840c2a61da36e975d56636">to_nearest()</a>
relationship.
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__nearest__relations.to_nearest_t_const___.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__nearest__relations.to_nearest_t_const___.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__nearest__relations.to_nearest_t_const___.description">Description</a>
</h6>
<p>
Generate a nearest query Point and Value's Indexable relationship while
calculating distances. This function may be used to define that knn query
should calculate distances as smallest as possible between query Point
and Indexable's points. In other words it should be the distance to the
nearest Indexable's point. This function may be also used to define distances
bounds which indicates that Indexable's nearest point should be closer
or further than value v. This is default relation.
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__nearest__relations.to_nearest_t_const___.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__nearest__relations.to_nearest_t_const___.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__nearest__relations.to_nearest_t_const___.synopsis">Synopsis</a>
</h6>
<pre class="programlisting"><code class="computeroutput"><span class="keyword">template</span><span class="special">&lt;</span></code><code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">T</span></code><code class="computeroutput"><span class="special">&gt;</span></code>
<code class="computeroutput"><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></code><code class="computeroutput"><span class="special">(</span></code><code class="computeroutput"><span class="identifier">T</span> <span class="keyword">const</span> <span class="special">&amp;</span></code> <code class="computeroutput"><span class="identifier">v</span></code><code class="computeroutput"><span class="special">)</span></code>
</pre>
<h6>
<a name="geometry_index.r_tree.reference.group__nearest__relations.to_nearest_t_const___.h2"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__nearest__relations.to_nearest_t_const___.template_parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__nearest__relations.to_nearest_t_const___.template_parameter_s_">Template
parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Parameter
</p>
</th>
<th>
<p>
Description
</p>
</th>
</tr></thead>
<tbody><tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">T</span></code>
</p>
</td>
<td>
<p>
Type of wrapped object. This may be a Point for PointRelation
or CoordinateType for MinRelation or MaxRelation
</p>
</td>
</tr></tbody>
</table></div>
<h6>
<a name="geometry_index.r_tree.reference.group__nearest__relations.to_nearest_t_const___.h3"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__nearest__relations.to_nearest_t_const___.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__nearest__relations.to_nearest_t_const___.parameter_s_">Parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Type
</p>
</th>
<th>
<p>
Name
</p>
</th>
<th>
<p>
Description
</p>
</th>
</tr></thead>
<tbody><tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">T</span> <span class="keyword">const</span>
<span class="special">&amp;</span></code>
</p>
</td>
<td>
<p>
<code class="computeroutput"><span class="identifier">v</span></code>
</p>
</td>
<td>
<p>
Point or distance value.
</p>
</td>
</tr></tbody>
</table></div>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.group__nearest__relations.to_centroid_t_const___"></a><a name="group__nearest__relations_1gaccbba95d864d8dcf8a694796c840fbe0"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__nearest__relations.to_centroid_t_const___" title="to_centroid(T const &amp;)">to_centroid(T
const &amp;)</a>
</h5></div></div></div>
<p>
Generate <a class="link" href="reference.html#group__nearest__relations_1gaccbba95d864d8dcf8a694796c840fbe0">to_centroid()</a>
relationship.
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__nearest__relations.to_centroid_t_const___.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__nearest__relations.to_centroid_t_const___.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__nearest__relations.to_centroid_t_const___.description">Description</a>
</h6>
<p>
Generate a nearest query Point and Value's Indexable relationship while
calculating distances. This function may be used to define that knn query
should calculate distances between query Point and Indexable's centroid.
This function may be also used to define distances bounds which indicates
that Indexable's centroid should be closer or further than value v.
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__nearest__relations.to_centroid_t_const___.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__nearest__relations.to_centroid_t_const___.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__nearest__relations.to_centroid_t_const___.synopsis">Synopsis</a>
</h6>
<pre class="programlisting"><code class="computeroutput"><span class="keyword">template</span><span class="special">&lt;</span></code><code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">T</span></code><code class="computeroutput"><span class="special">&gt;</span></code>
<code class="computeroutput"><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></code><code class="computeroutput"><span class="special">(</span></code><code class="computeroutput"><span class="identifier">T</span> <span class="keyword">const</span> <span class="special">&amp;</span></code> <code class="computeroutput"><span class="identifier">v</span></code><code class="computeroutput"><span class="special">)</span></code>
</pre>
<h6>
<a name="geometry_index.r_tree.reference.group__nearest__relations.to_centroid_t_const___.h2"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__nearest__relations.to_centroid_t_const___.template_parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__nearest__relations.to_centroid_t_const___.template_parameter_s_">Template
parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Parameter
</p>
</th>
<th>
<p>
Description
</p>
</th>
</tr></thead>
<tbody><tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">T</span></code>
</p>
</td>
<td>
<p>
Type of wrapped object. This may be a Point for PointRelation
or some CoordinateType for MinRelation or MaxRelation
</p>
</td>
</tr></tbody>
</table></div>
<h6>
<a name="geometry_index.r_tree.reference.group__nearest__relations.to_centroid_t_const___.h3"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__nearest__relations.to_centroid_t_const___.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__nearest__relations.to_centroid_t_const___.parameter_s_">Parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Type
</p>
</th>
<th>
<p>
Name
</p>
</th>
<th>
<p>
Description
</p>
</th>
</tr></thead>
<tbody><tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">T</span> <span class="keyword">const</span>
<span class="special">&amp;</span></code>
</p>
</td>
<td>
<p>
<code class="computeroutput"><span class="identifier">v</span></code>
</p>
</td>
<td>
<p>
Point or distance value.
</p>
</td>
</tr></tbody>
</table></div>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.group__nearest__relations.to_furthest_t_const___"></a><a name="group__nearest__relations_1ga67dddd8a7fcaae150970e1db0401de02"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__nearest__relations.to_furthest_t_const___" title="to_furthest(T const &amp;)">to_furthest(T
const &amp;)</a>
</h5></div></div></div>
<p>
Generate <a class="link" href="reference.html#group__nearest__relations_1ga67dddd8a7fcaae150970e1db0401de02">to_furthest()</a>
relationship.
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__nearest__relations.to_furthest_t_const___.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__nearest__relations.to_furthest_t_const___.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__nearest__relations.to_furthest_t_const___.description">Description</a>
</h6>
<p>
Generate a nearest query Point and Value's Indexable relationship while
calculating distances. This function may be used to define that knn query
should calculate distances as biggest as possible between query Point
and Indexable's points. In other words it should be the distance to the
furthest Indexable's point. This function may be also used to define
distances bounds which indicates that Indexable's furthest point should
be closer or further than value v.
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__nearest__relations.to_furthest_t_const___.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__nearest__relations.to_furthest_t_const___.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__nearest__relations.to_furthest_t_const___.synopsis">Synopsis</a>
</h6>
<pre class="programlisting"><code class="computeroutput"><span class="keyword">template</span><span class="special">&lt;</span></code><code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">T</span></code><code class="computeroutput"><span class="special">&gt;</span></code>
<code class="computeroutput"><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></code><code class="computeroutput"><span class="special">(</span></code><code class="computeroutput"><span class="identifier">T</span> <span class="keyword">const</span> <span class="special">&amp;</span></code> <code class="computeroutput"><span class="identifier">v</span></code><code class="computeroutput"><span class="special">)</span></code>
</pre>
<h6>
<a name="geometry_index.r_tree.reference.group__nearest__relations.to_furthest_t_const___.h2"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__nearest__relations.to_furthest_t_const___.template_parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__nearest__relations.to_furthest_t_const___.template_parameter_s_">Template
parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Parameter
</p>
</th>
<th>
<p>
Description
</p>
</th>
</tr></thead>
<tbody><tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">T</span></code>
</p>
</td>
<td>
<p>
Type of wrapped object. This may be a Point for PointRelation
or some CoordinateType for MinRelation or MaxRelation
</p>
</td>
</tr></tbody>
</table></div>
<h6>
<a name="geometry_index.r_tree.reference.group__nearest__relations.to_furthest_t_const___.h3"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__nearest__relations.to_furthest_t_const___.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__nearest__relations.to_furthest_t_const___.parameter_s_">Parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Type
</p>
</th>
<th>
<p>
Name
</p>
</th>
<th>
<p>
Description
</p>
</th>
</tr></thead>
<tbody><tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">T</span> <span class="keyword">const</span>
<span class="special">&amp;</span></code>
</p>
</td>
<td>
<p>
<code class="computeroutput"><span class="identifier">v</span></code>
</p>
</td>
<td>
<p>
Point or distance value.
</p>
</td>
</tr></tbody>
</table></div>
</div>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="geometry_index.r_tree.reference.group__adaptors"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__adaptors" title="Adaptors (boost::geometry::index::adaptors::)">Adaptors
(boost::geometry::index::adaptors::)</a>
</h4></div></div></div>
<h6>
<a name="geometry_index.r_tree.reference.group__adaptors.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__adaptors.functions"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__adaptors.functions">Functions</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Function
</p>
</th>
<th>
<p>
Description
</p>
</th>
</tr></thead>
<tbody><tr>
<td>
<p>
<a class="link" href="reference.html#group__adaptors_1ga4716cd5423bfed3ff3e69e9ec274ac81"><code class="computeroutput"><span class="identifier">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 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.queried_predicates_const___"></a><a name="group__adaptors_1ga4716cd5423bfed3ff3e69e9ec274ac81"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__adaptors.queried_predicates_const___" title="queried(Predicates const &amp;)">queried(Predicates
const &amp;)</a>
</h5></div></div></div>
<p>
The query index adaptor generator.
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__adaptors.queried_predicates_const___.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__adaptors.queried_predicates_const___.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__adaptors.queried_predicates_const___.synopsis">Synopsis</a>
</h6>
<pre class="programlisting"><code class="computeroutput"><span class="keyword">template</span><span class="special">&lt;</span></code><code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Predicates</span></code><code class="computeroutput"><span class="special">&gt;</span></code>
<code class="computeroutput"><span class="identifier">detail</span><span class="special">::</span><span class="identifier">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">queried</span></code><code class="computeroutput"><span class="special">(</span></code><code class="computeroutput"><span class="identifier">Predicates</span> <span class="keyword">const</span> <span class="special">&amp;</span></code> <code class="computeroutput"><span class="identifier">pred</span></code><code class="computeroutput"><span class="special">)</span></code>
</pre>
<h6>
<a name="geometry_index.r_tree.reference.group__adaptors.queried_predicates_const___.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__adaptors.queried_predicates_const___.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__adaptors.queried_predicates_const___.parameter_s_">Parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Type
</p>
</th>
<th>
<p>
Name
</p>
</th>
<th>
<p>
Description
</p>
</th>
</tr></thead>
<tbody><tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">Predicates</span> <span class="keyword">const</span> <span class="special">&amp;</span></code>
</p>
</td>
<td>
<p>
<code class="computeroutput"><span class="identifier">pred</span></code>
</p>
</td>
<td>
<p>
Predicates.
</p>
</td>
</tr></tbody>
</table></div>
</div>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="geometry_index.r_tree.reference.group__inserters"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__inserters" title="Inserters (boost::geometry::index::)">Inserters
(boost::geometry::index::)</a>
</h4></div></div></div>
<h6>
<a name="geometry_index.r_tree.reference.group__inserters.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__inserters.functions"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__inserters.functions">Functions</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Function
</p>
</th>
<th>
<p>
Description
</p>
</th>
</tr></thead>
<tbody><tr>
<td>
<p>
<a class="link" href="reference.html#group__inserters_1gab22c33d31b9805250e54ee6d6d240a47"><code class="computeroutput"><span class="identifier">inserter</span><span class="special">(</span><span class="identifier">Container</span> <span class="special">&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.inserter_container___"></a><a name="group__inserters_1gab22c33d31b9805250e54ee6d6d240a47"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__inserters.inserter_container___" title="inserter(Container &amp;)">inserter(Container
&amp;)</a>
</h5></div></div></div>
<p>
Insert iterator generator.
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__inserters.inserter_container___.h0"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__inserters.inserter_container___.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__inserters.inserter_container___.description">Description</a>
</h6>
<p>
Returns insert iterator capable to insert values to the container (spatial
index) which has member function insert(value_type const&amp;) defined.
</p>
<h6>
<a name="geometry_index.r_tree.reference.group__inserters.inserter_container___.h1"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__inserters.inserter_container___.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__inserters.inserter_container___.synopsis">Synopsis</a>
</h6>
<pre class="programlisting"><code class="computeroutput"><span class="keyword">template</span><span class="special">&lt;</span></code><code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Container</span></code><code class="computeroutput"><span class="special">&gt;</span></code>
<code class="computeroutput"><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></code><code class="computeroutput"><span class="special">(</span></code><code class="computeroutput"><span class="identifier">Container</span> <span class="special">&amp;</span></code> <code class="computeroutput"><span class="identifier">c</span></code><code class="computeroutput"><span class="special">)</span></code>
</pre>
<h6>
<a name="geometry_index.r_tree.reference.group__inserters.inserter_container___.h2"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__inserters.inserter_container___.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__inserters.inserter_container___.parameter_s_">Parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Type
</p>
</th>
<th>
<p>
Name
</p>
</th>
<th>
<p>
Description
</p>
</th>
</tr></thead>
<tbody><tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">Container</span> <span class="special">&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.inserter_container___.h3"></a>
<span class="phrase"><a name="geometry_index.r_tree.reference.group__inserters.inserter_container___.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__inserters.inserter_container___.returns">Returns</a>
</h6>
<p>
The insert iterator inserting values to the container.
</p>
</div>
</div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright &#169; 2011-2013 Adam Wulkiewicz<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="rtree_examples.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>