Boost logo

Boost-Commit :

Date view Thread view Subject view Author view

Subject: [Boost-commit] svn:boost r82414 - in sandbox-branches/geometry/index: boost/geometry/extensions/index/adaptors doc doc/html doc/html/geometry_index doc/html/geometry_index/r_tree
From: adam.wulkiewicz_at_[hidden]
Date: 2013-01-08 18:56:12

Author: awulkiew
Date: 2013-01-08 18:56:10 EST (Tue, 08 Jan 2013)
New Revision: 82414
URL: http://svn.boost.org/trac/boost/changeset/82414

Log:
Added adaptors to the reference.
Text files modified:
   sandbox-branches/geometry/index/boost/geometry/extensions/index/adaptors/nearest_query.hpp | 21 ++
   sandbox-branches/geometry/index/boost/geometry/extensions/index/adaptors/spatial_query.hpp | 11 +
   sandbox-branches/geometry/index/doc/Doxyfile | 3
   sandbox-branches/geometry/index/doc/html/geometry_index/r_tree.html | 2
   sandbox-branches/geometry/index/doc/html/geometry_index/r_tree/reference.html | 330 +++++++++++++++++++++++++++++++++++++++
   sandbox-branches/geometry/index/doc/html/index.html | 2
   sandbox-branches/geometry/index/doc/make_qbk.py | 1
   sandbox-branches/geometry/index/doc/rtree.qbk | 1
   8 files changed, 368 insertions(+), 3 deletions(-)

Modified: sandbox-branches/geometry/index/boost/geometry/extensions/index/adaptors/nearest_query.hpp
==============================================================================
--- sandbox-branches/geometry/index/boost/geometry/extensions/index/adaptors/nearest_query.hpp (original)
+++ sandbox-branches/geometry/index/boost/geometry/extensions/index/adaptors/nearest_query.hpp 2013-01-08 18:56:10 EST (Tue, 08 Jan 2013)
@@ -11,6 +11,10 @@
 #ifndef BOOST_GEOMETRY_EXTENSIONS_INDEX_ADAPTORS_NEAREST_QUERY_HPP
 #define BOOST_GEOMETRY_EXTENSIONS_INDEX_ADAPTORS_NEAREST_QUERY_HPP
 
+/*!
+\defgroup adaptors Spatial indexes adaptors (boost::geometry::index::adaptors::)
+*/
+
 namespace boost { namespace geometry { namespace index {
 
 namespace adaptors {
@@ -65,6 +69,15 @@
 
 } // namespace detail
 
+/*!
+\brief The nearest query index adaptor generator.
+
+\ingroup adaptors
+
+\param dpred Distance predicates.
+\param k The number of values to find.
+\param pred Spatial predicates.
+*/
 template <typename DistancesPredicates, typename Predicates>
 detail::nearest_query<DistancesPredicates, Predicates>
 nearest_queried(
@@ -75,6 +88,14 @@
     return detail::nearest_query<DistancesPredicates, Predicates>(dpred, k, pred);
 }
 
+/*!
+\brief The nearest query index adaptor generator.
+
+\ingroup adaptors
+
+\param dpred Distance predicates.
+\param k The number of values to find.
+*/
 template <typename DistancesPredicates>
 detail::nearest_query<DistancesPredicates, index::detail::empty>
 nearest_queried(

Modified: sandbox-branches/geometry/index/boost/geometry/extensions/index/adaptors/spatial_query.hpp
==============================================================================
--- sandbox-branches/geometry/index/boost/geometry/extensions/index/adaptors/spatial_query.hpp (original)
+++ sandbox-branches/geometry/index/boost/geometry/extensions/index/adaptors/spatial_query.hpp 2013-01-08 18:56:10 EST (Tue, 08 Jan 2013)
@@ -11,6 +11,10 @@
 #ifndef BOOST_GEOMETRY_EXTENSIONS_INDEX_ADAPTORS_SPATIAL_QUERY_HPP
 #define BOOST_GEOMETRY_EXTENSIONS_INDEX_ADAPTORS_SPATIAL_QUERY_HPP
 
+/*!
+\defgroup adaptors Spatial indexes adaptors (boost::geometry::index::adaptors::)
+*/
+
 namespace boost { namespace geometry { namespace index {
 
 namespace adaptors {
@@ -54,6 +58,13 @@
 
 } // namespace detail
 
+/*!
+\brief The spatial query index adaptor generator.
+
+\ingroup adaptors
+
+\param pred Spatial predicates.
+*/
 template <typename Predicates>
 detail::spatial_query<Predicates>
 spatial_queried(Predicates const& pred)

Modified: sandbox-branches/geometry/index/doc/Doxyfile
==============================================================================
--- sandbox-branches/geometry/index/doc/Doxyfile (original)
+++ sandbox-branches/geometry/index/doc/Doxyfile 2013-01-08 18:56:10 EST (Tue, 08 Jan 2013)
@@ -666,7 +666,8 @@
 # with spaces.
 
 INPUT = ../boost/geometry/extensions/index/ \
- ../boost/geometry/extensions/index/rtree
+ ../boost/geometry/extensions/index/rtree \
+ ../boost/geometry/extensions/index/adaptors
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is

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-08 18:56:10 EST (Tue, 08 Jan 2013)
@@ -83,6 +83,8 @@
         (boost::geometry::index::)</a></span></dt>
 <dt><span class="section"><a href="r_tree/reference.html#geometry_index.r_tree.reference.group__distance__predicates">Distance
         predicates (boost::geometry::index::)</a></span></dt>
+<dt><span class="section"><a href="r_tree/reference.html#geometry_index.r_tree.reference.group__adaptors">Spatial
+ indexes adaptors (boost::geometry::index::adaptors::)</a></span></dt>
 </dl></dd>
 </dl></div>
 </div>

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-08 18:56:10 EST (Tue, 08 Jan 2013)
@@ -33,13 +33,15 @@
         (boost::geometry::index::)</a></span></dt>
 <dt><span class="section"><a href="reference.html#geometry_index.r_tree.reference.group__distance__predicates">Distance
         predicates (boost::geometry::index::)</a></span></dt>
+<dt><span class="section"><a href="reference.html#geometry_index.r_tree.reference.group__adaptors">Spatial
+ indexes adaptors (boost::geometry::index::adaptors::)</a></span></dt>
 </dl></div>
 <div class="section">
 <div class="titlepage"><div><div><h4 class="title">
 <a name="geometry_index.r_tree.reference.boost_geometry_index_rtree"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree" title="boost::geometry::index::rtree">boost::geometry::index::rtree</a>
 </h4></div></div></div>
 <p>
- <a class="indexterm" name="id906048"></a><a class="indexterm" name="id906053"></a><a class="indexterm" name="id906058"></a><a class="indexterm" name="id906063"></a>
+ <a class="indexterm" name="id932263"></a><a class="indexterm" name="id932268"></a><a class="indexterm" name="id932272"></a><a class="indexterm" name="id932277"></a>
 The R-tree spatial index.
         </p>
 <h6>
@@ -6453,6 +6455,332 @@
           <br>
         </p>
 </div>
+<div class="section">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="geometry_index.r_tree.reference.group__adaptors"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__adaptors" title="Spatial indexes adaptors (boost::geometry::index::adaptors::)">Spatial
+ indexes adaptors (boost::geometry::index::adaptors::)</a>
+</h4></div></div></div>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ <p>
+ Function
+ </p>
+ </th>
+<th>
+ <p>
+ Description
+ </p>
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ <p>
+ <a class="link" href="reference.html#geometry_index.r_tree.reference.group__adaptors.function0" title="nearest_queried(DistancesPredicates const &amp;, size_t, Predicates const &amp;)"><code class="computeroutput"><span class="identifier">nearest_queried</span><span class="special">(</span><span class="identifier">DistancesPredicates</span> <span class="keyword">const</span>
+ <span class="special">&amp;,</span> <span class="identifier">size_t</span><span class="special">,</span> <span class="identifier">Predicates</span>
+ <span class="keyword">const</span> <span class="special">&amp;)</span></code></a>
+ </p>
+ </td>
+<td>
+ <p>
+ The nearest query index adaptor generator.
+ </p>
+ </td>
+</tr>
+<tr>
+<td>
+ <p>
+ <a class="link" href="reference.html#geometry_index.r_tree.reference.group__adaptors.function1" title="nearest_queried(DistancesPredicates const &amp;, size_t)"><code class="computeroutput"><span class="identifier">nearest_queried</span><span class="special">(</span><span class="identifier">DistancesPredicates</span> <span class="keyword">const</span>
+ <span class="special">&amp;,</span> <span class="identifier">size_t</span><span class="special">)</span></code></a>
+ </p>
+ </td>
+<td>
+ <p>
+ The nearest query index adaptor generator.
+ </p>
+ </td>
+</tr>
+<tr>
+<td>
+ <p>
+ <a class="link" href="reference.html#geometry_index.r_tree.reference.group__adaptors.function2" title="spatial_queried(Predicates const &amp;)"><code class="computeroutput"><span class="identifier">spatial_queried</span><span class="special">(</span><span class="identifier">Predicates</span> <span class="keyword">const</span>
+ <span class="special">&amp;)</span></code></a>
+ </p>
+ </td>
+<td>
+ <p>
+ The spatial query index adaptor generator.
+ </p>
+ </td>
+</tr>
+</tbody>
+</table></div>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="geometry_index.r_tree.reference.group__adaptors.function0"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__adaptors.function0" title="nearest_queried(DistancesPredicates const &amp;, size_t, Predicates const &amp;)">nearest_queried(DistancesPredicates
+ const &amp;, size_t, Predicates const &amp;)</a>
+</h5></div></div></div>
+<p>
+ The nearest query index adaptor generator.
+ </p>
+<h6>
+<a name="geometry_index.r_tree.reference.group__adaptors.function0.h0"></a>
+ <span class="phrase"><a name="geometry_index.r_tree.reference.group__adaptors.function0.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__adaptors.function0.synopsis">Synopsis</a>
+ </h6>
+<p>
+</p>
+<pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">DistancesPredicates</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">Predicates</span><span class="special">&gt;</span>
+<span class="identifier">detail</span><span class="special">::</span><span class="identifier">nearest_query</span><span class="special">&lt;</span><span class="identifier">DistancesPredicates</span><span class="special">,</span> <span class="identifier">Predicates</span><span class="special">&gt;</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">geometry</span><span class="special">::</span><span class="identifier">index</span><span class="special">::</span><span class="identifier">adaptors</span><span class="special">::</span><span class="identifier">nearest_queried</span><span class="special">(</span><span class="identifier">DistancesPredicates</span> <span class="keyword">const</span> <span class="special">&amp;</span> <span class="identifier">dpred</span><span class="special">,</span>
+ <span class="identifier">size_t</span> <span class="identifier">k</span><span class="special">,</span>
+ <span class="identifier">Predicates</span> <span class="keyword">const</span> <span class="special">&amp;</span> <span class="identifier">pred</span><span class="special">)</span></pre>
+<p>
+ </p>
+<h6>
+<a name="geometry_index.r_tree.reference.group__adaptors.function0.h1"></a>
+ <span class="phrase"><a name="geometry_index.r_tree.reference.group__adaptors.function0.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__adaptors.function0.parameters">Parameters</a>
+ </h6>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ <p>
+ Type
+ </p>
+ </th>
+<th>
+ <p>
+ Name
+ </p>
+ </th>
+<th>
+ <p>
+ Description
+ </p>
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ <p>
+ <code class="computeroutput"><span class="identifier">DistancesPredicates</span>
+ <span class="keyword">const</span> <span class="special">&amp;</span></code>
+ </p>
+ </td>
+<td>
+ <p>
+ <code class="computeroutput"><span class="identifier">dpred</span></code>
+ </p>
+ </td>
+<td>
+ <p>
+ Distance predicates.
+ </p>
+ </td>
+</tr>
+<tr>
+<td>
+ <p>
+ <code class="computeroutput"><span class="identifier">size_t</span></code>
+ </p>
+ </td>
+<td>
+ <p>
+ <code class="computeroutput"><span class="identifier">k</span></code>
+ </p>
+ </td>
+<td>
+ <p>
+ The number of values to find.
+ </p>
+ </td>
+</tr>
+<tr>
+<td>
+ <p>
+ <code class="computeroutput"><span class="identifier">Predicates</span> <span class="keyword">const</span> <span class="special">&amp;</span></code>
+ </p>
+ </td>
+<td>
+ <p>
+ <code class="computeroutput"><span class="identifier">pred</span></code>
+ </p>
+ </td>
+<td>
+ <p>
+ Spatial predicates.
+ </p>
+ </td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<p>
+ <br>
+ </p>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="geometry_index.r_tree.reference.group__adaptors.function1"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__adaptors.function1" title="nearest_queried(DistancesPredicates const &amp;, size_t)">nearest_queried(DistancesPredicates
+ const &amp;, size_t)</a>
+</h5></div></div></div>
+<p>
+ The nearest query index adaptor generator.
+ </p>
+<h6>
+<a name="geometry_index.r_tree.reference.group__adaptors.function1.h0"></a>
+ <span class="phrase"><a name="geometry_index.r_tree.reference.group__adaptors.function1.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__adaptors.function1.synopsis">Synopsis</a>
+ </h6>
+<p>
+</p>
+<pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">DistancesPredicates</span><span class="special">&gt;</span>
+<span class="identifier">detail</span><span class="special">::</span><span class="identifier">nearest_query</span><span class="special">&lt;</span><span class="identifier">DistancesPredicates</span><span class="special">,</span> <span class="identifier">index</span><span class="special">::</span><span class="identifier">detail</span><span class="special">::</span><span class="identifier">empty</span><span class="special">&gt;</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">geometry</span><span class="special">::</span><span class="identifier">index</span><span class="special">::</span><span class="identifier">adaptors</span><span class="special">::</span><span class="identifier">nearest_queried</span><span class="special">(</span><span class="identifier">DistancesPredicates</span> <span class="keyword">const</span> <span class="special">&amp;</span> <span class="identifier">dpred</span><span class="special">,</span> <span class="identifier">size_t</span> <
span class="identifier">k</span><span class="special">)</span></pre>
+<p>
+ </p>
+<h6>
+<a name="geometry_index.r_tree.reference.group__adaptors.function1.h1"></a>
+ <span class="phrase"><a name="geometry_index.r_tree.reference.group__adaptors.function1.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__adaptors.function1.parameters">Parameters</a>
+ </h6>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ <p>
+ Type
+ </p>
+ </th>
+<th>
+ <p>
+ Name
+ </p>
+ </th>
+<th>
+ <p>
+ Description
+ </p>
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ <p>
+ <code class="computeroutput"><span class="identifier">DistancesPredicates</span>
+ <span class="keyword">const</span> <span class="special">&amp;</span></code>
+ </p>
+ </td>
+<td>
+ <p>
+ <code class="computeroutput"><span class="identifier">dpred</span></code>
+ </p>
+ </td>
+<td>
+ <p>
+ Distance predicates.
+ </p>
+ </td>
+</tr>
+<tr>
+<td>
+ <p>
+ <code class="computeroutput"><span class="identifier">size_t</span></code>
+ </p>
+ </td>
+<td>
+ <p>
+ <code class="computeroutput"><span class="identifier">k</span></code>
+ </p>
+ </td>
+<td>
+ <p>
+ The number of values to find.
+ </p>
+ </td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<p>
+ <br>
+ </p>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="geometry_index.r_tree.reference.group__adaptors.function2"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__adaptors.function2" title="spatial_queried(Predicates const &amp;)">spatial_queried(Predicates
+ const &amp;)</a>
+</h5></div></div></div>
+<p>
+ The spatial query index adaptor generator.
+ </p>
+<h6>
+<a name="geometry_index.r_tree.reference.group__adaptors.function2.h0"></a>
+ <span class="phrase"><a name="geometry_index.r_tree.reference.group__adaptors.function2.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__adaptors.function2.synopsis">Synopsis</a>
+ </h6>
+<p>
+</p>
+<pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">Predicates</span><span class="special">&gt;</span>
+<span class="identifier">detail</span><span class="special">::</span><span class="identifier">spatial_query</span><span class="special">&lt;</span><span class="identifier">Predicates</span><span class="special">&gt;</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">geometry</span><span class="special">::</span><span class="identifier">index</span><span class="special">::</span><span class="identifier">adaptors</span><span class="special">::</span><span class="identifier">spatial_queried</span><span class="special">(</span><span class="identifier">Predicates</span> <span class="keyword">const</span> <span class="special">&amp;</span> <span class="identifier">pred</span><span class="special">)</span></pre>
+<p>
+ </p>
+<h6>
+<a name="geometry_index.r_tree.reference.group__adaptors.function2.h1"></a>
+ <span class="phrase"><a name="geometry_index.r_tree.reference.group__adaptors.function2.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__adaptors.function2.parameters">Parameters</a>
+ </h6>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ <p>
+ Type
+ </p>
+ </th>
+<th>
+ <p>
+ Name
+ </p>
+ </th>
+<th>
+ <p>
+ Description
+ </p>
+ </th>
+</tr></thead>
+<tbody><tr>
+<td>
+ <p>
+ <code class="computeroutput"><span class="identifier">Predicates</span> <span class="keyword">const</span> <span class="special">&amp;</span></code>
+ </p>
+ </td>
+<td>
+ <p>
+ <code class="computeroutput"><span class="identifier">pred</span></code>
+ </p>
+ </td>
+<td>
+ <p>
+ Spatial predicates.
+ </p>
+ </td>
+</tr></tbody>
+</table></div>
+</div>
+<p>
+ <br>
+ </p>
+</div>
 </div>
 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 <td align="left"></td>

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-08 18:56:10 EST (Tue, 08 Jan 2013)
@@ -56,7 +56,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 08, 2013 at 23:37:30 GMT</small></p></td>
+<td align="left"><p><small>Last revised: January 08, 2013 at 23:53:48 GMT</small></p></td>
 <td align="right"><div class="copyright-footer"></div></td>
 </tr></table>
 <hr>

Modified: sandbox-branches/geometry/index/doc/make_qbk.py
==============================================================================
--- sandbox-branches/geometry/index/doc/make_qbk.py (original)
+++ sandbox-branches/geometry/index/doc/make_qbk.py 2013-01-08 18:56:10 EST (Tue, 08 Jan 2013)
@@ -22,5 +22,6 @@
 os.system(cmd % ("group__rtree__functions", "geometry_index.r_tree.reference", "rtree_functions"))
 os.system(cmd % ("group__predicates", "geometry_index.r_tree.reference", "predicates"))
 os.system(cmd % ("group__distance__predicates", "geometry_index.r_tree.reference", "distance_predicates"))
+os.system(cmd % ("group__adaptors", "geometry_index.r_tree.reference", "adaptors"))
 
 os.system("b2")

Modified: sandbox-branches/geometry/index/doc/rtree.qbk
==============================================================================
--- sandbox-branches/geometry/index/doc/rtree.qbk (original)
+++ sandbox-branches/geometry/index/doc/rtree.qbk 2013-01-08 18:56:10 EST (Tue, 08 Jan 2013)
@@ -23,6 +23,7 @@
 [include generated/rtree_functions.qbk]
 [include generated/predicates.qbk]
 [include generated/distance_predicates.qbk]
+[include generated/adaptors.qbk]
 
 [endsect]
 

Date view Thread view Subject view Author view

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