|
|
Boost-Commit : |
Subject: [Boost-commit] svn:boost r82510 - in sandbox-branches/geometry/index: boost/geometry/extensions/index/rtree doc doc/generated doc/html doc/html/geometry_index doc/html/geometry_index/r_tree doc/rtree doc/src/tools/doxygen_xml2qbk
From: adam.wulkiewicz_at_[hidden]
Date: 2013-01-16 09:39:03
Author: awulkiew
Date: 2013-01-16 09:39:01 EST (Wed, 16 Jan 2013)
New Revision: 82510
URL: http://svn.boost.org/trac/boost/changeset/82510
Log:
rtree: added bg::envelope() and bg::return_envelope().
doxygen_qbk2xml: added template parameters to detailed function output.
Text files modified:
sandbox-branches/geometry/index/boost/geometry/extensions/index/rtree/rtree.hpp | 43 ++
sandbox-branches/geometry/index/doc/generated/distance_predicates.qbk | 46 ++
sandbox-branches/geometry/index/doc/generated/predicates.qbk | 36 +
sandbox-branches/geometry/index/doc/generated/rtree_functions.qbk | 57 ++
sandbox-branches/geometry/index/doc/html/geometry_index/r_tree.html | 2
sandbox-branches/geometry/index/doc/html/geometry_index/r_tree/introduction.html | 23 +
sandbox-branches/geometry/index/doc/html/geometry_index/r_tree/reference.html | 809 ++++++++++++++++++++++++++++++++++++++-
sandbox-branches/geometry/index/doc/html/index.html | 5
sandbox-branches/geometry/index/doc/index.qbk | 2
sandbox-branches/geometry/index/doc/rtree/introduction.qbk | 10
sandbox-branches/geometry/index/doc/src/tools/doxygen_xml2qbk/quickbook_output.hpp | 76 ++-
11 files changed, 1051 insertions(+), 58 deletions(-)
Modified: sandbox-branches/geometry/index/boost/geometry/extensions/index/rtree/rtree.hpp
==============================================================================
--- sandbox-branches/geometry/index/boost/geometry/extensions/index/rtree/rtree.hpp (original)
+++ sandbox-branches/geometry/index/boost/geometry/extensions/index/rtree/rtree.hpp 2013-01-16 09:39:01 EST (Wed, 16 Jan 2013)
@@ -51,7 +51,7 @@
// TODO change the name to bounding_tree
/*!
-\defgroup rtree_functions Functions related to the rtree (boost::geometry::index::)
+\defgroup rtree_functions Functions related to the rtree
*/
namespace boost { namespace geometry { namespace index {
@@ -1548,4 +1548,45 @@
}}} // namespace boost::geometry::index
+#include <boost/geometry/algorithms/envelope.hpp>
+
+namespace boost { namespace geometry {
+
+/*!
+\brief Get the box containing all stored values or an invalid box if the index has no values.
+
+It calls \c rtree::box().
+
+\ingroup rtree_functions
+
+\param tree The spatial index.
+\param box The object to which box containing all stored values or an invalid box will be assigned.
+*/
+template <typename Value, typename Options, typename Translator, typename Allocator, typename Box>
+void envelope(index::rtree<Value, Options, Translator, Allocator> const& tree, Box & box)
+{
+ envelope(tree.box(), box);
+}
+
+/*!
+\brief Get the box containing all stored values or an invalid box if the index has no values.
+
+It calls \c rtree::box().
+
+\ingroup rtree_functions
+
+\tparam Box The type of returned Box.
+
+\param tree The spatial index.
+
+\return The box containing all stored values or an invalid box.
+*/
+template <typename Box, typename Value, typename Options, typename Translator, typename Allocator>
+Box return_envelope(index::rtree<Value, Options, Translator, Allocator> const& tree)
+{
+ return return_envelope(tree.box());
+}
+
+}} //namespace boost::geometry
+
#endif // BOOST_GEOMETRY_EXTENSIONS_INDEX_RTREE_RTREE_HPP
Modified: sandbox-branches/geometry/index/doc/generated/distance_predicates.qbk
==============================================================================
--- sandbox-branches/geometry/index/doc/generated/distance_predicates.qbk (original)
+++ sandbox-branches/geometry/index/doc/generated/distance_predicates.qbk 2013-01-16 09:39:01 EST (Wed, 16 Jan 2013)
@@ -24,6 +24,12 @@
`detail::to_nearest<T> boost::geometry::index::to_nearest``(``T const &` `v``)`
]
+[heading Template parameter(s)]
+[table
+[[Parameter] [Description]]
+[[`T`][Type of wrapped object. This may be a Point for PointRelation or some Value for MinRelation or MaxRelation]]
+]
+
[heading Parameter(s)]
[table
[[Type][Name][Description]]
@@ -42,6 +48,12 @@
`detail::to_centroid<T> boost::geometry::index::to_centroid``(``T const &` `v``)`
]
+[heading Template parameter(s)]
+[table
+[[Parameter] [Description]]
+[[`T`][Type of wrapped object. This may be a Point for PointRelation or some Value for MinRelation or MaxRelation]]
+]
+
[heading Parameter(s)]
[table
[[Type][Name][Description]]
@@ -60,6 +72,12 @@
`detail::to_furthest<T> boost::geometry::index::to_furthest``(``T const &` `v``)`
]
+[heading Template parameter(s)]
+[table
+[[Parameter] [Description]]
+[[`T`][Type of wrapped object. This may be a Point for PointRelation or some Value for MinRelation or MaxRelation]]
+]
+
[heading Parameter(s)]
[table
[[Type][Name][Description]]
@@ -78,6 +96,12 @@
`detail::unbounded<PointRelation> boost::geometry::index::unbounded``(``PointRelation const &` `pr``)`
]
+[heading Template parameter(s)]
+[table
+[[Parameter] [Description]]
+[[`PointRelation`][PointRelation type.]]
+]
+
[heading Parameter(s)]
[table
[[Type][Name][Description]]
@@ -96,6 +120,13 @@
`detail::min_bounded<PointRelation, MinRelation> boost::geometry::index::min_bounded``(``PointRelation const &` `pr``,` `MinRelation const &` `minr``)`
]
+[heading Template parameter(s)]
+[table
+[[Parameter] [Description]]
+[[`PointRelation`][PointRelation type. ]]
+[[`MinRelation`][MinRelation type.]]
+]
+
[heading Parameter(s)]
[table
[[Type][Name][Description]]
@@ -115,6 +146,13 @@
`detail::max_bounded<PointRelation, MaxRelation> boost::geometry::index::max_bounded``(``PointRelation const &` `pr``,` `MaxRelation const &` `maxr``)`
]
+[heading Template parameter(s)]
+[table
+[[Parameter] [Description]]
+[[`PointRelation`][PointRelation type. ]]
+[[`MaxRelation`][MaxRelation type.]]
+]
+
[heading Parameter(s)]
[table
[[Type][Name][Description]]
@@ -138,6 +176,14 @@
`MaxRelation const &` `maxr``)`
]
+[heading Template parameter(s)]
+[table
+[[Parameter] [Description]]
+[[`PointRelation`][PointRelation type. ]]
+[[`MinRelation`][MinRelation type. ]]
+[[`MaxRelation`][MaxRelation type.]]
+]
+
[heading Parameter(s)]
[table
[[Type][Name][Description]]
Modified: sandbox-branches/geometry/index/doc/generated/predicates.qbk
==============================================================================
--- sandbox-branches/geometry/index/doc/generated/predicates.qbk (original)
+++ sandbox-branches/geometry/index/doc/generated/predicates.qbk 2013-01-16 09:39:01 EST (Wed, 16 Jan 2013)
@@ -36,6 +36,12 @@
`detail::value<ValuePredicate> boost::geometry::index::value``(``ValuePredicate const &` `vpred``)`
]
+[heading Template parameter(s)]
+[table
+[[Parameter] [Description]]
+[[`ValuePredicate`][Functor type.]]
+]
+
[heading Parameter(s)]
[table
[[Type][Name][Description]]
@@ -54,6 +60,12 @@
`detail::covered_by<Geometry> boost::geometry::index::covered_by``(``Geometry const &` `g``)`
]
+[heading Template parameter(s)]
+[table
+[[Parameter] [Description]]
+[[`Geometry`][The Geometry type.]]
+]
+
[heading Parameter(s)]
[table
[[Type][Name][Description]]
@@ -72,6 +84,12 @@
`detail::disjoint<Geometry> boost::geometry::index::disjoint``(``Geometry const &` `g``)`
]
+[heading Template parameter(s)]
+[table
+[[Parameter] [Description]]
+[[`Geometry`][The Geometry type.]]
+]
+
[heading Parameter(s)]
[table
[[Type][Name][Description]]
@@ -90,6 +108,12 @@
`detail::intersects<Geometry> boost::geometry::index::intersects``(``Geometry const &` `g``)`
]
+[heading Template parameter(s)]
+[table
+[[Parameter] [Description]]
+[[`Geometry`][The Geometry type.]]
+]
+
[heading Parameter(s)]
[table
[[Type][Name][Description]]
@@ -108,6 +132,12 @@
`detail::overlaps<Geometry> boost::geometry::index::overlaps``(``Geometry const &` `g``)`
]
+[heading Template parameter(s)]
+[table
+[[Parameter] [Description]]
+[[`Geometry`][The Geometry type.]]
+]
+
[heading Parameter(s)]
[table
[[Type][Name][Description]]
@@ -126,6 +156,12 @@
`detail::within<Geometry> boost::geometry::index::within``(``Geometry const &` `g``)`
]
+[heading Template parameter(s)]
+[table
+[[Parameter] [Description]]
+[[`Geometry`][The Geometry type.]]
+]
+
[heading Parameter(s)]
[table
[[Type][Name][Description]]
Modified: sandbox-branches/geometry/index/doc/generated/rtree_functions.qbk
==============================================================================
--- sandbox-branches/geometry/index/doc/generated/rtree_functions.qbk (original)
+++ sandbox-branches/geometry/index/doc/generated/rtree_functions.qbk 2013-01-16 09:39:01 EST (Wed, 16 Jan 2013)
@@ -1,6 +1,6 @@
[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
[/ Generated from xml/group__rtree__functions.xml]
-[section:group__rtree__functions Functions related to the rtree (boost::geometry::index::)]
+[section:group__rtree__functions Functions related to the rtree]
[heading Functions]
[table
[[Function][Description]]
@@ -19,6 +19,8 @@
[[[link group__rtree__functions_1gaec0b88a9d8b408753e3069134f1598c7 `size(rtree<...> const &)`]][Get the number of values stored in the index. ]]
[[[link group__rtree__functions_1ga459e3d404fec7cbd66794714cbdd129e `empty(rtree<...> const &)`]][Query if there are no values stored in the index. ]]
[[[link group__rtree__functions_1ga46aead88abd7f18f0e1eedb991bbb39d `box(rtree<...> const &)`]][Get the box containing all stored values or an invalid box if the index has no values. ]]
+[[[link group__rtree__functions_1gab3425094aa846b167789ac76114696f6 `envelope(index::rtree<...> const &, Box &)`]][Get the box containing all stored values or an invalid box if the index has no values. ]]
+[[[link group__rtree__functions_1gaab92d20f98edefccee1e76c1349a5127 `return_envelope(index::rtree<...> const &)`]][Get the box containing all stored values or an invalid box if the index has no values. ]]
]
[#group__rtree__functions_1gac0ac9ed0e01f7494a5a3059e75d3c5cc]
@@ -418,5 +420,58 @@
The box containing all stored values or an invalid box.
[endsect]
+[#group__rtree__functions_1gab3425094aa846b167789ac76114696f6]
+[section envelope(index::rtree<...> const &, Box &)]
+Get the box containing all stored values or an invalid box if the index has no values.
+
+[heading Description]
+It calls [^[link group__rtree__functions_1ga46aead88abd7f18f0e1eedb991bbb39d rtree::box()]].[heading Synopsis]
+[pre
+`template<``typename Value``,`
+ `typename Options``,`
+ `typename Translator``,`
+ `typename Allocator``,`
+ `typename Box``>`
+`void boost::geometry::envelope``(``index::rtree< Value, Options, Translator, Allocator > const &` `tree``,` `Box &` `box``)`
+]
+
+[heading Parameter(s)]
+[table
+[[Type][Name][Description]]
+[[`index::rtree< Value, Options, Translator, Allocator > const &`][ `tree` ][The spatial index. ]]
+[[`Box &`][ `box` ][The object to which box containing all stored values or an invalid box will be assigned. ]]
+]
+[endsect]
+
+[#group__rtree__functions_1gaab92d20f98edefccee1e76c1349a5127]
+[section return_envelope(index::rtree<...> const &)]
+Get the box containing all stored values or an invalid box if the index has no values.
+
+[heading Description]
+It calls [^[link group__rtree__functions_1ga46aead88abd7f18f0e1eedb991bbb39d rtree::box()]].[heading Synopsis]
+[pre
+`template<``typename Box``,`
+ `typename Value``,`
+ `typename Options``,`
+ `typename Translator``,`
+ `typename Allocator``>`
+`Box boost::geometry::return_envelope``(``index::rtree< Value, Options, Translator, Allocator > const &` `tree``)`
+]
+
+[heading Template parameter(s)]
+[table
+[[Parameter] [Description]]
+[[`Box`][The type of returned Box.]]
+]
+
+[heading Parameter(s)]
+[table
+[[Type][Name][Description]]
+[[`index::rtree< Value, Options, Translator, Allocator > const &`][ `tree` ][The spatial index.]]
+]
+[heading Returns]
+The box containing all stored values or an invalid box.
+[endsect]
+
[endsect]
Modified: sandbox-branches/geometry/index/doc/html/geometry_index/r_tree.html
==============================================================================
--- sandbox-branches/geometry/index/doc/html/geometry_index/r_tree.html (original)
+++ sandbox-branches/geometry/index/doc/html/geometry_index/r_tree.html 2013-01-16 09:39:01 EST (Wed, 16 Jan 2013)
@@ -78,7 +78,7 @@
<dd><dl>
<dt><span class="section">boost::geometry::index::rtree</span></dt>
<dt><span class="section"><a href="r_tree/reference.html#geometry_index.r_tree.reference.group__rtree__functions">Functions
- related to the rtree (boost::geometry::index::)</a></span></dt>
+ related to the rtree</a></span></dt>
<dt><span class="section"><a href="r_tree/reference.html#geometry_index.r_tree.reference.parameters">R-tree
parameters</a></span></dt>
<dt><span class="section"><a href="r_tree/reference.html#geometry_index.r_tree.reference.group__predicates">Spatial
Modified: sandbox-branches/geometry/index/doc/html/geometry_index/r_tree/introduction.html
==============================================================================
--- sandbox-branches/geometry/index/doc/html/geometry_index/r_tree/introduction.html (original)
+++ sandbox-branches/geometry/index/doc/html/geometry_index/r_tree/introduction.html 2013-01-16 09:39:01 EST (Wed, 16 Jan 2013)
@@ -177,6 +177,11 @@
</tr>
</tbody>
</table></div>
+<h5>
+<a name="geometry_index.r_tree.introduction.h0"></a>
+ <span><a name="geometry_index.r_tree.introduction.implementation_details"></a></span><a class="link" href="introduction.html#geometry_index.r_tree.introduction.implementation_details">Implementation
+ details</a>
+ </h5>
<p>
Key features of this implementation of the R-tree are:
</p>
@@ -200,6 +205,24 @@
one.
</li>
</ul></div>
+<h5>
+<a name="geometry_index.r_tree.introduction.h1"></a>
+ <span><a name="geometry_index.r_tree.introduction.contributors"></a></span><a class="link" href="introduction.html#geometry_index.r_tree.introduction.contributors">Contributors</a>
+ </h5>
+<p>
+ The spatial index was originally started by Federico J. Fernandez during
+ the Google-Of-Summer project 2008, mentored by Hartmut Kaiser.
+ </p>
+<h5>
+<a name="geometry_index.r_tree.introduction.h2"></a>
+ <span><a name="geometry_index.r_tree.introduction.spatial_thanks"></a></span><a class="link" href="introduction.html#geometry_index.r_tree.introduction.spatial_thanks">Spatial
+ thanks</a>
+ </h5>
+<p>
+ I'd like to thank Barend Gehrels, Bruno Lalande, Lucanus J. Simonson for
+ their support and ideas, as well as the members of the Boost.Geometry mailing
+ list for their help.
+ </p>
<div class="footnotes">
<br><hr width="100" align="left">
<div class="footnote"><p><sup>[<a id="ftn.geometry_index.r_tree.introduction.f0" href="#geometry_index.r_tree.introduction.f0" class="para">1</a>] </sup>
Modified: sandbox-branches/geometry/index/doc/html/geometry_index/r_tree/reference.html
==============================================================================
--- sandbox-branches/geometry/index/doc/html/geometry_index/r_tree/reference.html (original)
+++ sandbox-branches/geometry/index/doc/html/geometry_index/r_tree/reference.html 2013-01-16 09:39:01 EST (Wed, 16 Jan 2013)
@@ -28,7 +28,7 @@
<div class="toc"><dl>
<dt><span class="section">boost::geometry::index::rtree</span></dt>
<dt><span class="section"><a href="reference.html#geometry_index.r_tree.reference.group__rtree__functions">Functions
- related to the rtree (boost::geometry::index::)</a></span></dt>
+ related to the rtree</a></span></dt>
<dt><span class="section"><a href="reference.html#geometry_index.r_tree.reference.parameters">R-tree
parameters</a></span></dt>
<dt><span class="section"><a href="reference.html#geometry_index.r_tree.reference.group__predicates">Spatial
@@ -47,7 +47,7 @@
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree"></a><a name="classboost_1_1geometry_1_1index_1_1rtree"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree" title="boost::geometry::index::rtree">boost::geometry::index::rtree</a>
</h4></div></div></div>
<p>
- <a class="indexterm" name="idp9871960"></a><a class="indexterm" name="idp9872272"></a><a class="indexterm" name="idp9872584"></a><a class="indexterm" name="idp9872896"></a>
+ <a class="indexterm" name="idp9821064"></a><a class="indexterm" name="idp9821376"></a><a class="indexterm" name="idp9821688"></a><a class="indexterm" name="idp9822000"></a>
The R-tree spatial index.
</p>
<h6>
@@ -3740,8 +3740,8 @@
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
-<a name="geometry_index.r_tree.reference.group__rtree__functions"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions" title="Functions related to the rtree (boost::geometry::index::)">Functions
- related to the rtree (boost::geometry::index::)</a>
+<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>
@@ -3979,6 +3979,35 @@
</p>
</td>
</tr>
+<tr>
+<td>
+ <p>
+ <a class="link" href="reference.html#group__rtree__functions_1gab3425094aa846b167789ac76114696f6"><code class="computeroutput"><span class="identifier">envelope</span><span class="special">(</span><span class="identifier">index</span><span class="special">::</span><span class="identifier">rtree</span><span class="special"><...></span>
+ <span class="keyword">const</span> <span class="special">&,</span>
+ <span class="identifier">Box</span> <span class="special">&)</span></code></a>
+ </p>
+ </td>
+<td>
+ <p>
+ Get the box containing all stored values or an invalid box if
+ the index has no values.
+ </p>
+ </td>
+</tr>
+<tr>
+<td>
+ <p>
+ <a class="link" href="reference.html#group__rtree__functions_1gaab92d20f98edefccee1e76c1349a5127"><code class="computeroutput"><span class="identifier">return_envelope</span><span class="special">(</span><span class="identifier">index</span><span class="special">::</span><span class="identifier">rtree</span><span class="special"><...></span>
+ <span class="keyword">const</span> <span class="special">&)</span></code></a>
+ </p>
+ </td>
+<td>
+ <p>
+ Get the box containing all stored values or an invalid box if
+ the index has no values.
+ </p>
+ </td>
+</tr>
</tbody>
</table></div>
<div class="section">
@@ -5679,6 +5708,224 @@
The box containing all stored values or an invalid box.
</p>
</div>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="geometry_index.r_tree.reference.group__rtree__functions.envelope_index__rtree______const____box___"></a><a name="group__rtree__functions_1gab3425094aa846b167789ac76114696f6"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.envelope_index__rtree______const____box___" title="envelope(index::rtree<...> const &, Box &)">envelope(index::rtree<...>
+ const &, Box &)</a>
+</h5></div></div></div>
+<p>
+ Get the box containing all stored values or an invalid box if the index
+ has no values.
+ </p>
+<h6>
+<a name="geometry_index.r_tree.reference.group__rtree__functions.envelope_index__rtree______const____box___.h0"></a>
+ <span><a name="geometry_index.r_tree.reference.group__rtree__functions.envelope_index__rtree______const____box___.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.envelope_index__rtree______const____box___.description">Description</a>
+ </h6>
+<p>
+ It calls <code class="literal"><a class="link" href="reference.html#group__rtree__functions_1ga46aead88abd7f18f0e1eedb991bbb39d">rtree::box()</a></code>.
+ </p>
+<h6>
+<a name="geometry_index.r_tree.reference.group__rtree__functions.envelope_index__rtree______const____box___.h1"></a>
+ <span><a name="geometry_index.r_tree.reference.group__rtree__functions.envelope_index__rtree______const____box___.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.envelope_index__rtree______const____box___.synopsis">Synopsis</a>
+ </h6>
+<pre class="programlisting"><code class="computeroutput"><span class="keyword">template</span><span class="special"><</span></code><code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Value</span></code><code class="computeroutput"><span class="special">,</span></code>
+ <code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Options</span></code><code class="computeroutput"><span class="special">,</span></code>
+ <code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Translator</span></code><code class="computeroutput"><span class="special">,</span></code>
+ <code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Allocator</span></code><code class="computeroutput"><span class="special">,</span></code>
+ <code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Box</span></code><code class="computeroutput"><span class="special">></span></code>
+<code class="computeroutput"><span class="keyword">void</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">geometry</span><span class="special">::</span><span class="identifier">envelope</span></code><code class="computeroutput"><span class="special">(</span></code><code class="computeroutput"><span class="identifier">index</span><span class="special">::</span><span class="identifier">rtree</span><span class="special"><</span> <span class="identifier">Value</span><span class="special">,</span> <span class="identifier">Options</span><span class="special">,</span> <span class="identifier">Translator</span><span class="special">,</span> <span class="identifier">Allocator</span> <span class="special">></span> <span class="keyword">const</span> <span class="special">&</span></code> <code class="computeroutput"><span class="identifier">tree</span></code><code class="computeroutput"><span class="special">,</span></code> <code class="computeroutput"><span c
lass="identifier">Box</span> <span class="special">&</span></code> <code class="computeroutput"><span class="identifier">box</span></code><code class="computeroutput"><span class="special">)</span></code>
+</pre>
+<h6>
+<a name="geometry_index.r_tree.reference.group__rtree__functions.envelope_index__rtree______const____box___.h2"></a>
+ <span><a name="geometry_index.r_tree.reference.group__rtree__functions.envelope_index__rtree______const____box___.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.envelope_index__rtree______const____box___.parameter_s_">Parameter(s)</a>
+ </h6>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ <p>
+ Type
+ </p>
+ </th>
+<th>
+ <p>
+ Name
+ </p>
+ </th>
+<th>
+ <p>
+ Description
+ </p>
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ <p>
+ <code class="computeroutput"><span class="identifier">index</span><span class="special">::</span><span class="identifier">rtree</span><span class="special"><</span>
+ <span class="identifier">Value</span><span class="special">,</span>
+ <span class="identifier">Options</span><span class="special">,</span>
+ <span class="identifier">Translator</span><span class="special">,</span>
+ <span class="identifier">Allocator</span> <span class="special">></span>
+ <span class="keyword">const</span> <span class="special">&</span></code>
+ </p>
+ </td>
+<td>
+ <p>
+ <code class="computeroutput"><span class="identifier">tree</span></code>
+ </p>
+ </td>
+<td>
+ <p>
+ The spatial index.
+ </p>
+ </td>
+</tr>
+<tr>
+<td>
+ <p>
+ <code class="computeroutput"><span class="identifier">Box</span> <span class="special">&</span></code>
+ </p>
+ </td>
+<td>
+ <p>
+ <code class="computeroutput"><span class="identifier">box</span></code>
+ </p>
+ </td>
+<td>
+ <p>
+ The object to which box containing all stored values or an
+ invalid box will be assigned.
+ </p>
+ </td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="geometry_index.r_tree.reference.group__rtree__functions.return_envelope_index__rtree______const___"></a><a name="group__rtree__functions_1gaab92d20f98edefccee1e76c1349a5127"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.return_envelope_index__rtree______const___" title="return_envelope(index::rtree<...> const &)">return_envelope(index::rtree<...>
+ const &)</a>
+</h5></div></div></div>
+<p>
+ Get the box containing all stored values or an invalid box if the index
+ has no values.
+ </p>
+<h6>
+<a name="geometry_index.r_tree.reference.group__rtree__functions.return_envelope_index__rtree______const___.h0"></a>
+ <span><a name="geometry_index.r_tree.reference.group__rtree__functions.return_envelope_index__rtree______const___.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.return_envelope_index__rtree______const___.description">Description</a>
+ </h6>
+<p>
+ It calls <code class="literal"><a class="link" href="reference.html#group__rtree__functions_1ga46aead88abd7f18f0e1eedb991bbb39d">rtree::box()</a></code>.
+ </p>
+<h6>
+<a name="geometry_index.r_tree.reference.group__rtree__functions.return_envelope_index__rtree______const___.h1"></a>
+ <span><a name="geometry_index.r_tree.reference.group__rtree__functions.return_envelope_index__rtree______const___.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.return_envelope_index__rtree______const___.synopsis">Synopsis</a>
+ </h6>
+<pre class="programlisting"><code class="computeroutput"><span class="keyword">template</span><span class="special"><</span></code><code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Box</span></code><code class="computeroutput"><span class="special">,</span></code>
+ <code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Value</span></code><code class="computeroutput"><span class="special">,</span></code>
+ <code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Options</span></code><code class="computeroutput"><span class="special">,</span></code>
+ <code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Translator</span></code><code class="computeroutput"><span class="special">,</span></code>
+ <code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Allocator</span></code><code class="computeroutput"><span class="special">></span></code>
+<code class="computeroutput"><span class="identifier">Box</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">geometry</span><span class="special">::</span><span class="identifier">return_envelope</span></code><code class="computeroutput"><span class="special">(</span></code><code class="computeroutput"><span class="identifier">index</span><span class="special">::</span><span class="identifier">rtree</span><span class="special"><</span> <span class="identifier">Value</span><span class="special">,</span> <span class="identifier">Options</span><span class="special">,</span> <span class="identifier">Translator</span><span class="special">,</span> <span class="identifier">Allocator</span> <span class="special">></span> <span class="keyword">const</span> <span class="special">&</span></code> <code class="computeroutput"><span class="identifier">tree</span></code><code class="computeroutput"><span class="special">)</span></code>
+</pre>
+<h6>
+<a name="geometry_index.r_tree.reference.group__rtree__functions.return_envelope_index__rtree______const___.h2"></a>
+ <span><a name="geometry_index.r_tree.reference.group__rtree__functions.return_envelope_index__rtree______const___.template_parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.return_envelope_index__rtree______const___.template_parameter_s_">Template
+ parameter(s)</a>
+ </h6>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ <p>
+ Parameter
+ </p>
+ </th>
+<th>
+ <p>
+ Description
+ </p>
+ </th>
+</tr></thead>
+<tbody><tr>
+<td>
+ <p>
+ <code class="computeroutput"><span class="identifier">Box</span></code>
+ </p>
+ </td>
+<td>
+ <p>
+ The type of returned Box.
+ </p>
+ </td>
+</tr></tbody>
+</table></div>
+<h6>
+<a name="geometry_index.r_tree.reference.group__rtree__functions.return_envelope_index__rtree______const___.h3"></a>
+ <span><a name="geometry_index.r_tree.reference.group__rtree__functions.return_envelope_index__rtree______const___.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.return_envelope_index__rtree______const___.parameter_s_">Parameter(s)</a>
+ </h6>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ <p>
+ Type
+ </p>
+ </th>
+<th>
+ <p>
+ Name
+ </p>
+ </th>
+<th>
+ <p>
+ Description
+ </p>
+ </th>
+</tr></thead>
+<tbody><tr>
+<td>
+ <p>
+ <code class="computeroutput"><span class="identifier">index</span><span class="special">::</span><span class="identifier">rtree</span><span class="special"><</span>
+ <span class="identifier">Value</span><span class="special">,</span>
+ <span class="identifier">Options</span><span class="special">,</span>
+ <span class="identifier">Translator</span><span class="special">,</span>
+ <span class="identifier">Allocator</span> <span class="special">></span>
+ <span class="keyword">const</span> <span class="special">&</span></code>
+ </p>
+ </td>
+<td>
+ <p>
+ <code class="computeroutput"><span class="identifier">tree</span></code>
+ </p>
+ </td>
+<td>
+ <p>
+ The spatial index.
+ </p>
+ </td>
+</tr></tbody>
+</table></div>
+<h6>
+<a name="geometry_index.r_tree.reference.group__rtree__functions.return_envelope_index__rtree______const___.h4"></a>
+ <span><a name="geometry_index.r_tree.reference.group__rtree__functions.return_envelope_index__rtree______const___.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.return_envelope_index__rtree______const___.returns">Returns</a>
+ </h6>
+<p>
+ The box containing all stored values or an invalid box.
+ </p>
+</div>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
@@ -5690,7 +5937,7 @@
<a name="geometry_index.r_tree.reference.parameters.boost_geometry_index_linear"></a><a name="structboost_1_1geometry_1_1index_1_1linear"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.parameters.boost_geometry_index_linear" title="boost::geometry::index::linear">boost::geometry::index::linear</a>
</h5></div></div></div>
<p>
- <a class="indexterm" name="idp11678856"></a><a class="indexterm" name="idp11679184"></a><a class="indexterm" name="idp11679528"></a><a class="indexterm" name="idp11679872"></a>
+ <a class="indexterm" name="idp11719952"></a><a class="indexterm" name="idp11720280"></a><a class="indexterm" name="idp11720624"></a><a class="indexterm" name="idp11720968"></a>
Linear r-tree creation algorithm parameters.
</p>
<h6>
@@ -5765,7 +6012,7 @@
<a name="geometry_index.r_tree.reference.parameters.boost_geometry_index_quadratic"></a><a name="structboost_1_1geometry_1_1index_1_1quadratic"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.parameters.boost_geometry_index_quadratic" title="boost::geometry::index::quadratic">boost::geometry::index::quadratic</a>
</h5></div></div></div>
<p>
- <a class="indexterm" name="idp11704920"></a><a class="indexterm" name="idp11705248"></a><a class="indexterm" name="idp11705592"></a><a class="indexterm" name="idp11705936"></a>
+ <a class="indexterm" name="idp11746048"></a><a class="indexterm" name="idp11746376"></a><a class="indexterm" name="idp11746720"></a><a class="indexterm" name="idp11747064"></a>
Quadratic r-tree creation algorithm parameters.
</p>
<h6>
@@ -5840,7 +6087,7 @@
<a name="geometry_index.r_tree.reference.parameters.boost_geometry_index_rstar"></a><a name="structboost_1_1geometry_1_1index_1_1rstar"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.parameters.boost_geometry_index_rstar" title="boost::geometry::index::rstar">boost::geometry::index::rstar</a>
</h5></div></div></div>
<p>
- <a class="indexterm" name="idp11731008"></a><a class="indexterm" name="idp11731336"></a><a class="indexterm" name="idp11731680"></a><a class="indexterm" name="idp11732024"></a>
+ <a class="indexterm" name="idp11772064"></a><a class="indexterm" name="idp11772392"></a><a class="indexterm" name="idp11772736"></a><a class="indexterm" name="idp11773080"></a>
R*-tree creation algorithm parameters.
</p>
<h6>
@@ -5944,7 +6191,7 @@
<a name="geometry_index.r_tree.reference.parameters.boost_geometry_index_runtime_linear"></a><a name="classboost_1_1geometry_1_1index_1_1runtime_1_1linear"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.parameters.boost_geometry_index_runtime_linear" title="boost::geometry::index::runtime::linear">boost::geometry::index::runtime::linear</a>
</h5></div></div></div>
<p>
- <a class="indexterm" name="idp11766776"></a><a class="indexterm" name="idp11767104"></a><a class="indexterm" name="idp11767448"></a><a class="indexterm" name="idp11767792"></a><a class="indexterm" name="idp11768136"></a>
+ <a class="indexterm" name="idp11807784"></a><a class="indexterm" name="idp11808112"></a><a class="indexterm" name="idp11808456"></a><a class="indexterm" name="idp11808800"></a><a class="indexterm" name="idp11809144"></a>
Linear r-tree creation algorithm parameters.
</p>
<h6>
@@ -6080,7 +6327,7 @@
<a name="geometry_index.r_tree.reference.parameters.boost_geometry_index_runtime_quadratic"></a><a name="classboost_1_1geometry_1_1index_1_1runtime_1_1quadratic"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.parameters.boost_geometry_index_runtime_quadratic" title="boost::geometry::index::runtime::quadratic">boost::geometry::index::runtime::quadratic</a>
</h5></div></div></div>
<p>
- <a class="indexterm" name="idp11807672"></a><a class="indexterm" name="idp11808000"></a><a class="indexterm" name="idp11808344"></a><a class="indexterm" name="idp11808688"></a><a class="indexterm" name="idp11809032"></a>
+ <a class="indexterm" name="idp11848672"></a><a class="indexterm" name="idp11849000"></a><a class="indexterm" name="idp11849344"></a><a class="indexterm" name="idp11849688"></a><a class="indexterm" name="idp11850032"></a>
Quadratic r-tree creation algorithm parameters.
</p>
<h6>
@@ -6216,7 +6463,7 @@
<a name="geometry_index.r_tree.reference.parameters.boost_geometry_index_runtime_rstar"></a><a name="classboost_1_1geometry_1_1index_1_1runtime_1_1rstar"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.parameters.boost_geometry_index_runtime_rstar" title="boost::geometry::index::runtime::rstar">boost::geometry::index::runtime::rstar</a>
</h5></div></div></div>
<p>
- <a class="indexterm" name="idp11848784"></a><a class="indexterm" name="idp11849112"></a><a class="indexterm" name="idp11849456"></a><a class="indexterm" name="idp11849800"></a><a class="indexterm" name="idp11850144"></a>
+ <a class="indexterm" name="idp11889800"></a><a class="indexterm" name="idp11890128"></a><a class="indexterm" name="idp11890472"></a><a class="indexterm" name="idp11890816"></a><a class="indexterm" name="idp11891160"></a>
R*-tree creation algorithm parameters.
</p>
<h6>
@@ -6550,6 +6797,41 @@
</pre>
<h6>
<a name="geometry_index.r_tree.reference.group__predicates.value_valuepredicate_const___.h2"></a>
+ <span><a name="geometry_index.r_tree.reference.group__predicates.value_valuepredicate_const___.template_parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.value_valuepredicate_const___.template_parameter_s_">Template
+ parameter(s)</a>
+ </h6>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ <p>
+ Parameter
+ </p>
+ </th>
+<th>
+ <p>
+ Description
+ </p>
+ </th>
+</tr></thead>
+<tbody><tr>
+<td>
+ <p>
+ <code class="computeroutput"><span class="identifier">ValuePredicate</span></code>
+ </p>
+ </td>
+<td>
+ <p>
+ Functor type.
+ </p>
+ </td>
+</tr></tbody>
+</table></div>
+<h6>
+<a name="geometry_index.r_tree.reference.group__predicates.value_valuepredicate_const___.h3"></a>
<span><a name="geometry_index.r_tree.reference.group__predicates.value_valuepredicate_const___.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.value_valuepredicate_const___.parameter_s_">Parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
@@ -6620,23 +6902,18 @@
</pre>
<h6>
<a name="geometry_index.r_tree.reference.group__predicates.covered_by_geometry_const___.h2"></a>
- <span><a name="geometry_index.r_tree.reference.group__predicates.covered_by_geometry_const___.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>
+ <span><a name="geometry_index.r_tree.reference.group__predicates.covered_by_geometry_const___.template_parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.covered_by_geometry_const___.template_parameter_s_">Template
+ parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
-<col>
</colgroup>
<thead><tr>
<th>
<p>
- Type
- </p>
- </th>
-<th>
- <p>
- Name
+ Parameter
</p>
</th>
<th>
@@ -6648,17 +6925,57 @@
<tbody><tr>
<td>
<p>
- <code class="computeroutput"><span class="identifier">Geometry</span> <span class="keyword">const</span>
- <span class="special">&</span></code>
+ <code class="computeroutput"><span class="identifier">Geometry</span></code>
</p>
</td>
<td>
<p>
- <code class="computeroutput"><span class="identifier">g</span></code>
+ The Geometry type.
</p>
</td>
-<td>
- <p>
+</tr></tbody>
+</table></div>
+<h6>
+<a name="geometry_index.r_tree.reference.group__predicates.covered_by_geometry_const___.h3"></a>
+ <span><a name="geometry_index.r_tree.reference.group__predicates.covered_by_geometry_const___.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.covered_by_geometry_const___.parameter_s_">Parameter(s)</a>
+ </h6>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ <p>
+ Type
+ </p>
+ </th>
+<th>
+ <p>
+ Name
+ </p>
+ </th>
+<th>
+ <p>
+ Description
+ </p>
+ </th>
+</tr></thead>
+<tbody><tr>
+<td>
+ <p>
+ <code class="computeroutput"><span class="identifier">Geometry</span> <span class="keyword">const</span>
+ <span class="special">&</span></code>
+ </p>
+ </td>
+<td>
+ <p>
+ <code class="computeroutput"><span class="identifier">g</span></code>
+ </p>
+ </td>
+<td>
+ <p>
The Geometry object.
</p>
</td>
@@ -6691,6 +7008,41 @@
</pre>
<h6>
<a name="geometry_index.r_tree.reference.group__predicates.disjoint_geometry_const___.h2"></a>
+ <span><a name="geometry_index.r_tree.reference.group__predicates.disjoint_geometry_const___.template_parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.disjoint_geometry_const___.template_parameter_s_">Template
+ parameter(s)</a>
+ </h6>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ <p>
+ Parameter
+ </p>
+ </th>
+<th>
+ <p>
+ Description
+ </p>
+ </th>
+</tr></thead>
+<tbody><tr>
+<td>
+ <p>
+ <code class="computeroutput"><span class="identifier">Geometry</span></code>
+ </p>
+ </td>
+<td>
+ <p>
+ The Geometry type.
+ </p>
+ </td>
+</tr></tbody>
+</table></div>
+<h6>
+<a name="geometry_index.r_tree.reference.group__predicates.disjoint_geometry_const___.h3"></a>
<span><a name="geometry_index.r_tree.reference.group__predicates.disjoint_geometry_const___.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.disjoint_geometry_const___.parameter_s_">Parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
@@ -6762,6 +7114,41 @@
</pre>
<h6>
<a name="geometry_index.r_tree.reference.group__predicates.intersects_geometry_const___.h2"></a>
+ <span><a name="geometry_index.r_tree.reference.group__predicates.intersects_geometry_const___.template_parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.intersects_geometry_const___.template_parameter_s_">Template
+ parameter(s)</a>
+ </h6>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ <p>
+ Parameter
+ </p>
+ </th>
+<th>
+ <p>
+ Description
+ </p>
+ </th>
+</tr></thead>
+<tbody><tr>
+<td>
+ <p>
+ <code class="computeroutput"><span class="identifier">Geometry</span></code>
+ </p>
+ </td>
+<td>
+ <p>
+ The Geometry type.
+ </p>
+ </td>
+</tr></tbody>
+</table></div>
+<h6>
+<a name="geometry_index.r_tree.reference.group__predicates.intersects_geometry_const___.h3"></a>
<span><a name="geometry_index.r_tree.reference.group__predicates.intersects_geometry_const___.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.intersects_geometry_const___.parameter_s_">Parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
@@ -6833,6 +7220,41 @@
</pre>
<h6>
<a name="geometry_index.r_tree.reference.group__predicates.overlaps_geometry_const___.h2"></a>
+ <span><a name="geometry_index.r_tree.reference.group__predicates.overlaps_geometry_const___.template_parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.overlaps_geometry_const___.template_parameter_s_">Template
+ parameter(s)</a>
+ </h6>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ <p>
+ Parameter
+ </p>
+ </th>
+<th>
+ <p>
+ Description
+ </p>
+ </th>
+</tr></thead>
+<tbody><tr>
+<td>
+ <p>
+ <code class="computeroutput"><span class="identifier">Geometry</span></code>
+ </p>
+ </td>
+<td>
+ <p>
+ The Geometry type.
+ </p>
+ </td>
+</tr></tbody>
+</table></div>
+<h6>
+<a name="geometry_index.r_tree.reference.group__predicates.overlaps_geometry_const___.h3"></a>
<span><a name="geometry_index.r_tree.reference.group__predicates.overlaps_geometry_const___.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.overlaps_geometry_const___.parameter_s_">Parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
@@ -6904,6 +7326,41 @@
</pre>
<h6>
<a name="geometry_index.r_tree.reference.group__predicates.within_geometry_const___.h2"></a>
+ <span><a name="geometry_index.r_tree.reference.group__predicates.within_geometry_const___.template_parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.within_geometry_const___.template_parameter_s_">Template
+ parameter(s)</a>
+ </h6>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ <p>
+ Parameter
+ </p>
+ </th>
+<th>
+ <p>
+ Description
+ </p>
+ </th>
+</tr></thead>
+<tbody><tr>
+<td>
+ <p>
+ <code class="computeroutput"><span class="identifier">Geometry</span></code>
+ </p>
+ </td>
+<td>
+ <p>
+ The Geometry type.
+ </p>
+ </td>
+</tr></tbody>
+</table></div>
+<h6>
+<a name="geometry_index.r_tree.reference.group__predicates.within_geometry_const___.h3"></a>
<span><a name="geometry_index.r_tree.reference.group__predicates.within_geometry_const___.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.within_geometry_const___.parameter_s_">Parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
@@ -7113,6 +7570,42 @@
</pre>
<h6>
<a name="geometry_index.r_tree.reference.group__distance__predicates.to_nearest_t_const___.h2"></a>
+ <span><a name="geometry_index.r_tree.reference.group__distance__predicates.to_nearest_t_const___.template_parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.to_nearest_t_const___.template_parameter_s_">Template
+ parameter(s)</a>
+ </h6>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ <p>
+ Parameter
+ </p>
+ </th>
+<th>
+ <p>
+ Description
+ </p>
+ </th>
+</tr></thead>
+<tbody><tr>
+<td>
+ <p>
+ <code class="computeroutput"><span class="identifier">T</span></code>
+ </p>
+ </td>
+<td>
+ <p>
+ Type of wrapped object. This may be a Point for PointRelation
+ or some Value for MinRelation or MaxRelation
+ </p>
+ </td>
+</tr></tbody>
+</table></div>
+<h6>
+<a name="geometry_index.r_tree.reference.group__distance__predicates.to_nearest_t_const___.h3"></a>
<span><a name="geometry_index.r_tree.reference.group__distance__predicates.to_nearest_t_const___.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.to_nearest_t_const___.parameter_s_">Parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
@@ -7187,6 +7680,42 @@
</pre>
<h6>
<a name="geometry_index.r_tree.reference.group__distance__predicates.to_centroid_t_const___.h2"></a>
+ <span><a name="geometry_index.r_tree.reference.group__distance__predicates.to_centroid_t_const___.template_parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.to_centroid_t_const___.template_parameter_s_">Template
+ parameter(s)</a>
+ </h6>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ <p>
+ Parameter
+ </p>
+ </th>
+<th>
+ <p>
+ Description
+ </p>
+ </th>
+</tr></thead>
+<tbody><tr>
+<td>
+ <p>
+ <code class="computeroutput"><span class="identifier">T</span></code>
+ </p>
+ </td>
+<td>
+ <p>
+ Type of wrapped object. This may be a Point for PointRelation
+ or some Value for MinRelation or MaxRelation
+ </p>
+ </td>
+</tr></tbody>
+</table></div>
+<h6>
+<a name="geometry_index.r_tree.reference.group__distance__predicates.to_centroid_t_const___.h3"></a>
<span><a name="geometry_index.r_tree.reference.group__distance__predicates.to_centroid_t_const___.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.to_centroid_t_const___.parameter_s_">Parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
@@ -7263,6 +7792,42 @@
</pre>
<h6>
<a name="geometry_index.r_tree.reference.group__distance__predicates.to_furthest_t_const___.h2"></a>
+ <span><a name="geometry_index.r_tree.reference.group__distance__predicates.to_furthest_t_const___.template_parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.to_furthest_t_const___.template_parameter_s_">Template
+ parameter(s)</a>
+ </h6>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ <p>
+ Parameter
+ </p>
+ </th>
+<th>
+ <p>
+ Description
+ </p>
+ </th>
+</tr></thead>
+<tbody><tr>
+<td>
+ <p>
+ <code class="computeroutput"><span class="identifier">T</span></code>
+ </p>
+ </td>
+<td>
+ <p>
+ Type of wrapped object. This may be a Point for PointRelation
+ or some Value for MinRelation or MaxRelation
+ </p>
+ </td>
+</tr></tbody>
+</table></div>
+<h6>
+<a name="geometry_index.r_tree.reference.group__distance__predicates.to_furthest_t_const___.h3"></a>
<span><a name="geometry_index.r_tree.reference.group__distance__predicates.to_furthest_t_const___.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.to_furthest_t_const___.parameter_s_">Parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
@@ -7337,6 +7902,41 @@
</pre>
<h6>
<a name="geometry_index.r_tree.reference.group__distance__predicates.unbounded_pointrelation_const___.h2"></a>
+ <span><a name="geometry_index.r_tree.reference.group__distance__predicates.unbounded_pointrelation_const___.template_parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.unbounded_pointrelation_const___.template_parameter_s_">Template
+ parameter(s)</a>
+ </h6>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ <p>
+ Parameter
+ </p>
+ </th>
+<th>
+ <p>
+ Description
+ </p>
+ </th>
+</tr></thead>
+<tbody><tr>
+<td>
+ <p>
+ <code class="computeroutput"><span class="identifier">PointRelation</span></code>
+ </p>
+ </td>
+<td>
+ <p>
+ PointRelation type.
+ </p>
+ </td>
+</tr></tbody>
+</table></div>
+<h6>
+<a name="geometry_index.r_tree.reference.group__distance__predicates.unbounded_pointrelation_const___.h3"></a>
<span><a name="geometry_index.r_tree.reference.group__distance__predicates.unbounded_pointrelation_const___.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.unbounded_pointrelation_const___.parameter_s_">Parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
@@ -7416,6 +8016,55 @@
</pre>
<h6>
<a name="geometry_index.r_tree.reference.group__distance__predicates.min_bounded_pointrelation_const____minrelation_const___.h2"></a>
+ <span><a name="geometry_index.r_tree.reference.group__distance__predicates.min_bounded_pointrelation_const____minrelation_const___.template_parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.min_bounded_pointrelation_const____minrelation_const___.template_parameter_s_">Template
+ parameter(s)</a>
+ </h6>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ <p>
+ Parameter
+ </p>
+ </th>
+<th>
+ <p>
+ Description
+ </p>
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ <p>
+ <code class="computeroutput"><span class="identifier">PointRelation</span></code>
+ </p>
+ </td>
+<td>
+ <p>
+ PointRelation type.
+ </p>
+ </td>
+</tr>
+<tr>
+<td>
+ <p>
+ <code class="computeroutput"><span class="identifier">MinRelation</span></code>
+ </p>
+ </td>
+<td>
+ <p>
+ MinRelation type.
+ </p>
+ </td>
+</tr>
+</tbody>
+</table></div>
+<h6>
+<a name="geometry_index.r_tree.reference.group__distance__predicates.min_bounded_pointrelation_const____minrelation_const___.h3"></a>
<span><a name="geometry_index.r_tree.reference.group__distance__predicates.min_bounded_pointrelation_const____minrelation_const___.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.min_bounded_pointrelation_const____minrelation_const___.parameter_s_">Parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
@@ -7517,6 +8166,55 @@
</pre>
<h6>
<a name="geometry_index.r_tree.reference.group__distance__predicates.max_bounded_pointrelation_const____maxrelation_const___.h2"></a>
+ <span><a name="geometry_index.r_tree.reference.group__distance__predicates.max_bounded_pointrelation_const____maxrelation_const___.template_parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.max_bounded_pointrelation_const____maxrelation_const___.template_parameter_s_">Template
+ parameter(s)</a>
+ </h6>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ <p>
+ Parameter
+ </p>
+ </th>
+<th>
+ <p>
+ Description
+ </p>
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ <p>
+ <code class="computeroutput"><span class="identifier">PointRelation</span></code>
+ </p>
+ </td>
+<td>
+ <p>
+ PointRelation type.
+ </p>
+ </td>
+</tr>
+<tr>
+<td>
+ <p>
+ <code class="computeroutput"><span class="identifier">MaxRelation</span></code>
+ </p>
+ </td>
+<td>
+ <p>
+ MaxRelation type.
+ </p>
+ </td>
+</tr>
+</tbody>
+</table></div>
+<h6>
+<a name="geometry_index.r_tree.reference.group__distance__predicates.max_bounded_pointrelation_const____maxrelation_const___.h3"></a>
<span><a name="geometry_index.r_tree.reference.group__distance__predicates.max_bounded_pointrelation_const____maxrelation_const___.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.max_bounded_pointrelation_const____maxrelation_const___.parameter_s_">Parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
@@ -7623,6 +8321,67 @@
</pre>
<h6>
<a name="geometry_index.r_tree.reference.group__distance__predicates.bounded_pointrelation_const____minrelation_const____maxrelation_const___.h2"></a>
+ <span><a name="geometry_index.r_tree.reference.group__distance__predicates.bounded_pointrelation_const____minrelation_const____maxrelation_const___.template_parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.bounded_pointrelation_const____minrelation_const____maxrelation_const___.template_parameter_s_">Template
+ parameter(s)</a>
+ </h6>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ <p>
+ Parameter
+ </p>
+ </th>
+<th>
+ <p>
+ Description
+ </p>
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ <p>
+ <code class="computeroutput"><span class="identifier">PointRelation</span></code>
+ </p>
+ </td>
+<td>
+ <p>
+ PointRelation type.
+ </p>
+ </td>
+</tr>
+<tr>
+<td>
+ <p>
+ <code class="computeroutput"><span class="identifier">MinRelation</span></code>
+ </p>
+ </td>
+<td>
+ <p>
+ MinRelation type.
+ </p>
+ </td>
+</tr>
+<tr>
+<td>
+ <p>
+ <code class="computeroutput"><span class="identifier">MaxRelation</span></code>
+ </p>
+ </td>
+<td>
+ <p>
+ MaxRelation type.
+ </p>
+ </td>
+</tr>
+</tbody>
+</table></div>
+<h6>
+<a name="geometry_index.r_tree.reference.group__distance__predicates.bounded_pointrelation_const____minrelation_const____maxrelation_const___.h3"></a>
<span><a name="geometry_index.r_tree.reference.group__distance__predicates.bounded_pointrelation_const____minrelation_const____maxrelation_const___.parameter_s_"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.bounded_pointrelation_const____minrelation_const____maxrelation_const___.parameter_s_">Parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
@@ -8036,7 +8795,7 @@
<a name="geometry_index.r_tree.reference.translators.boost_geometry_index_translator_def"></a><a name="structboost_1_1geometry_1_1index_1_1translator_1_1def"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.translators.boost_geometry_index_translator_def" title="boost::geometry::index::translator::def">boost::geometry::index::translator::def</a>
</h5></div></div></div>
<p>
- <a class="indexterm" name="idp12447560"></a><a class="indexterm" name="idp12447888"></a><a class="indexterm" name="idp12448232"></a><a class="indexterm" name="idp12448576"></a><a class="indexterm" name="idp12448920"></a>
+ <a class="indexterm" name="idp12570712"></a><a class="indexterm" name="idp12571040"></a><a class="indexterm" name="idp12571384"></a><a class="indexterm" name="idp12571728"></a><a class="indexterm" name="idp12572072"></a>
The default translator.
</p>
<h6>
@@ -8106,7 +8865,7 @@
<a name="geometry_index.r_tree.reference.translators.boost_geometry_index_translator_index"></a><a name="classboost_1_1geometry_1_1index_1_1translator_1_1index"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.translators.boost_geometry_index_translator_index" title="boost::geometry::index::translator::index">boost::geometry::index::translator::index</a>
</h5></div></div></div>
<p>
- <a class="indexterm" name="idp12472840"></a><a class="indexterm" name="idp12473168"></a><a class="indexterm" name="idp12473512"></a><a class="indexterm" name="idp12473856"></a><a class="indexterm" name="idp12474200"></a>
+ <a class="indexterm" name="idp12595984"></a><a class="indexterm" name="idp12596312"></a><a class="indexterm" name="idp12596656"></a><a class="indexterm" name="idp12597000"></a><a class="indexterm" name="idp12597344"></a>
The index translator.
</p>
<h6>
Modified: sandbox-branches/geometry/index/doc/html/index.html
==============================================================================
--- sandbox-branches/geometry/index/doc/html/index.html (original)
+++ sandbox-branches/geometry/index/doc/html/index.html 2013-01-16 09:39:01 EST (Wed, 16 Jan 2013)
@@ -25,9 +25,6 @@
<div><div class="author"><h3 class="author">
<span class="firstname">Adam</span> <span class="surname">Wulkiewicz</span>
</h3></div></div>
-<div><div class="author"><h3 class="author">
-<span class="firstname">Federico J.</span> <span class="surname">Fernandez</span>
-</h3></div></div>
<div><p class="copyright">Copyright © 2011, 2012 Adam Wulkiewicz</p></div>
<div><p class="copyright">Copyright © 2008 Federico J. Fernandez</p></div>
<div><div class="legalnotice">
@@ -56,7 +53,7 @@
</div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
-<td align="left"><p><small>Last revised: January 16, 2013 at 04:04:59 GMT</small></p></td>
+<td align="left"><p><small>Last revised: January 16, 2013 at 14:36:02 GMT</small></p></td>
<td align="right"><div class="copyright-footer"></div></td>
</tr></table>
<hr>
Modified: sandbox-branches/geometry/index/doc/index.qbk
==============================================================================
--- sandbox-branches/geometry/index/doc/index.qbk (original)
+++ sandbox-branches/geometry/index/doc/index.qbk 2013-01-16 09:39:01 EST (Wed, 16 Jan 2013)
@@ -10,7 +10,7 @@
[library Geometry Index
[quickbook 1.5]
- [authors [Wulkiewicz, Adam],[Fernandez, Federico J.]]
+ [authors [Wulkiewicz, Adam]]
[copyright 2011-2012 Adam Wulkiewicz, 2008 Federico J. Fernandez]
[purpose Documentation of Boost.Geometry Index library]
[license
Modified: sandbox-branches/geometry/index/doc/rtree/introduction.qbk
==============================================================================
--- sandbox-branches/geometry/index/doc/rtree/introduction.qbk (original)
+++ sandbox-branches/geometry/index/doc/rtree/introduction.qbk 2013-01-16 09:39:01 EST (Wed, 16 Jan 2013)
@@ -42,6 +42,8 @@
[[*100k knn queries*] [3.49s] [1.59s] [0.84s]]
]
+[heading Implementation details]
+
Key features of this implementation of the __rtree__ are:
* capable to store arbitrary __value__ type,
@@ -50,6 +52,14 @@
* parameters (including maximal and minimal number of elements) may be passed as compile- or run-time parameters - compile-time version is faster,
* advanced queries - e.g. search for 5 nearest values further than some minimal distance and intersecting some region but not within the other one.
+[heading Contributors]
+
+The spatial index was originally started by Federico J. Fernandez during the Google-Of-Summer project 2008, mentored by Hartmut Kaiser.
+
+[heading Spatial thanks]
+
+I'd like to thank Barend Gehrels, Bruno Lalande, Lucanus J. Simonson for their support and ideas, as well as the members of the Boost.Geometry mailing list for their help.
+
[endsect]
Modified: sandbox-branches/geometry/index/doc/src/tools/doxygen_xml2qbk/quickbook_output.hpp
==============================================================================
--- sandbox-branches/geometry/index/doc/src/tools/doxygen_xml2qbk/quickbook_output.hpp (original)
+++ sandbox-branches/geometry/index/doc/src/tools/doxygen_xml2qbk/quickbook_output.hpp 2013-01-16 09:39:01 EST (Wed, 16 Jan 2013)
@@ -979,6 +979,30 @@
<< std::endl;
}
+template <typename Range>
+bool has_brief_description(Range const& rng)
+{
+ typedef typename Range::value_type V;
+ BOOST_FOREACH(V const& bc, rng)
+ {
+ if ( !bc.brief_description.empty() )
+ return true;
+ }
+ return false;
+}
+
+template <typename Range>
+bool has_brief_description(Range const& rng, function_type t)
+{
+ typedef typename Range::value_type V;
+ BOOST_FOREACH(V const& bc, rng)
+ {
+ if ( bc.type == t && !bc.brief_description.empty() )
+ return true;
+ }
+ return false;
+}
+
void quickbook_output_functions_details(std::vector<function> const& functions,
function_type type,
configuration const& config,
@@ -1013,8 +1037,33 @@
quickbook_synopsis_alt(f, out);
quickbook_markup(f.qbk_markup, markup_after, markup_synopsis, out);
+ // Template parameters
+ if ( !f.template_parameters.empty() && has_brief_description(f.template_parameters) )
+ {
+ out << "[heading Template parameter(s)]" << std::endl
+ << "[table" << std::endl
+ << "[[Parameter] [Description]]" << std::endl;
+
+ BOOST_FOREACH(parameter const& p, f.template_parameters)
+ {
+ if ( p.brief_description.empty() )
+ continue;
+
+ out << "[[`";
+ if ( p.fulltype.find("typename ") == 0 )
+ out << p.fulltype.substr(9);
+ else if ( p.fulltype.find("class ") == 0 )
+ out << p.fulltype.substr(6);
+ else
+ out << p.fulltype;
+ out << "`][" << p.brief_description << "]]" << std::endl;
+ }
+ out << "]" << std::endl
+ << std::endl;
+ }
+
// Parameters
- if ( !f.parameters.empty() )
+ if ( !f.parameters.empty() && has_brief_description(f.parameters) )
{
out << "[heading Parameter(s)]" << std::endl;
out << "[table " << std::endl;
@@ -1152,30 +1201,6 @@
}
}
-template <typename Range>
-bool has_brief_description(Range const& rng)
-{
- typedef typename Range::value_type V;
- BOOST_FOREACH(V const& bc, rng)
- {
- if ( !bc.brief_description.empty() )
- return true;
- }
- return false;
-}
-
-template <typename Range>
-bool has_brief_description(Range const& rng, function_type t)
-{
- typedef typename Range::value_type V;
- BOOST_FOREACH(V const& bc, rng)
- {
- if ( bc.type == t && !bc.brief_description.empty() )
- return true;
- }
- return false;
-}
-
void quickbook_output_alt(class_or_struct const& cos, configuration const& config, std::ostream& out)
{
// Skip namespace
@@ -1300,6 +1325,7 @@
if (display_ctors && counts[function_constructor_destructor] > 0)
quickbook_output_functions_details(cos.functions, function_constructor_destructor, config, out);
+
if (display_members && counts[function_member] > 0)
quickbook_output_functions_details(cos.functions, function_member, config, out);
Boost-Commit list run by bdawes at acm.org, david.abrahams at rcn.com, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk