|
|
Boost-Commit : |
Subject: [Boost-commit] svn:boost r82420 - in sandbox-branches/geometry/index: boost/geometry/extensions/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-09 11:43:17
Author: awulkiew
Date: 2013-01-09 11:43:16 EST (Wed, 09 Jan 2013)
New Revision: 82420
URL: http://svn.boost.org/trac/boost/changeset/82420
Log:
Rtree docs: added inserter, groups names changed.
Text files modified:
sandbox-branches/geometry/index/boost/geometry/extensions/index/adaptors/nearest_query.hpp | 2
sandbox-branches/geometry/index/boost/geometry/extensions/index/adaptors/spatial_query.hpp | 2
sandbox-branches/geometry/index/boost/geometry/extensions/index/inserter.hpp | 12 ++
sandbox-branches/geometry/index/boost/geometry/extensions/index/predicates.hpp | 2
sandbox-branches/geometry/index/doc/html/geometry_index/r_tree.html | 10 +-
sandbox-branches/geometry/index/doc/html/geometry_index/r_tree/reference.html | 143 ++++++++++++++++++++++++++++++++++++---
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 | 2
9 files changed, 155 insertions(+), 21 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-09 11:43:16 EST (Wed, 09 Jan 2013)
@@ -12,7 +12,7 @@
#define BOOST_GEOMETRY_EXTENSIONS_INDEX_ADAPTORS_NEAREST_QUERY_HPP
/*!
-\defgroup adaptors Spatial indexes adaptors (boost::geometry::index::adaptors::)
+\defgroup adaptors Adaptors (boost::geometry::index::adaptors::)
*/
namespace boost { namespace geometry { namespace index {
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-09 11:43:16 EST (Wed, 09 Jan 2013)
@@ -12,7 +12,7 @@
#define BOOST_GEOMETRY_EXTENSIONS_INDEX_ADAPTORS_SPATIAL_QUERY_HPP
/*!
-\defgroup adaptors Spatial indexes adaptors (boost::geometry::index::adaptors::)
+\defgroup adaptors Adaptors (boost::geometry::index::adaptors::)
*/
namespace boost { namespace geometry { namespace index {
Modified: sandbox-branches/geometry/index/boost/geometry/extensions/index/inserter.hpp
==============================================================================
--- sandbox-branches/geometry/index/boost/geometry/extensions/index/inserter.hpp (original)
+++ sandbox-branches/geometry/index/boost/geometry/extensions/index/inserter.hpp 2013-01-09 11:43:16 EST (Wed, 09 Jan 2013)
@@ -13,6 +13,10 @@
#include <iterator>
+/*!
+\defgroup inserters Inserters (boost::geometry::index::)
+*/
+
namespace boost { namespace geometry { namespace index {
template <class Container>
@@ -52,8 +56,12 @@
};
/*!
-\brief Returns insert iterator capable to insert values to the container
-(spatial index) which allows inserting values - has member function insert(value_type const&).
+\brief Insert iterator generator.
+
+Returns insert iterator capable to insert values to the container
+(spatial index) which has member function insert(value_type const&) defined.
+
+\ingroup inserters
\param c The reference to the container (spatial index) to which values will be inserted.
Modified: sandbox-branches/geometry/index/boost/geometry/extensions/index/predicates.hpp
==============================================================================
--- sandbox-branches/geometry/index/boost/geometry/extensions/index/predicates.hpp (original)
+++ sandbox-branches/geometry/index/boost/geometry/extensions/index/predicates.hpp 2013-01-09 11:43:16 EST (Wed, 09 Jan 2013)
@@ -19,7 +19,7 @@
#include <boost/geometry/algorithms/covered_by.hpp>
/*!
-\defgroup predicates Predicates (boost::geometry::index::)
+\defgroup predicates Spatial predicates (boost::geometry::index::)
*/
namespace boost { namespace geometry { namespace index {
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-09 11:43:16 EST (Wed, 09 Jan 2013)
@@ -79,14 +79,16 @@
<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>
-<dt><span class="section"><a href="r_tree/reference.html#geometry_index.r_tree.reference.group__predicates">Predicates
- (boost::geometry::index::)</a></span></dt>
+<dt><span class="section"><a href="r_tree/reference.html#geometry_index.r_tree.reference.group__predicates">Spatial
+ predicates (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>
+<dt><span class="section"><a href="r_tree/reference.html#geometry_index.r_tree.reference.group__adaptors">Adaptors
+ (boost::geometry::index::adaptors::)</a></span></dt>
<dt><span class="section"><a href="r_tree/reference.html#geometry_index.r_tree.reference.translators">Translators
(boost::geometry::index::translators::)</a></span></dt>
+<dt><span class="section"><a href="r_tree/reference.html#geometry_index.r_tree.reference.group__inserters">Inserters
+ (boost::geometry::index::)</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-09 11:43:16 EST (Wed, 09 Jan 2013)
@@ -29,21 +29,23 @@
<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>
-<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__predicates">Spatial
+ predicates (boost::geometry::index::)</a></span></dt>
<dt><span class="section"><a href="reference.html#geometry_index.r_tree.reference.group__distance__predicates">Distance
predicates (boost::geometry::index::)</a></span></dt>
-<dt><span class="section"><a href="reference.html#geometry_index.r_tree.reference.group__adaptors">Spatial
- indexes adaptors (boost::geometry::index::adaptors::)</a></span></dt>
+<dt><span class="section"><a href="reference.html#geometry_index.r_tree.reference.group__adaptors">Adaptors
+ (boost::geometry::index::adaptors::)</a></span></dt>
<dt><span class="section"><a href="reference.html#geometry_index.r_tree.reference.translators">Translators
(boost::geometry::index::translators::)</a></span></dt>
+<dt><span class="section"><a href="reference.html#geometry_index.r_tree.reference.group__inserters">Inserters
+ (boost::geometry::index::)</a></span></dt>
</dl></div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree" title="boost::geometry::index::rtree">boost::geometry::index::rtree</a>
</h4></div></div></div>
<p>
- <a class="indexterm" name="id906048"></a><a class="indexterm" name="id906053"></a><a class="indexterm" name="id906058"></a><a class="indexterm" name="id906063"></a>
+ <a class="indexterm" name="id887480"></a><a class="indexterm" name="id887485"></a><a class="indexterm" name="id887490"></a><a class="indexterm" name="id887494"></a>
The R-tree spatial index.
</p>
<h6>
@@ -5256,8 +5258,8 @@
</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>
+<a name="geometry_index.r_tree.reference.group__predicates"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates" title="Spatial predicates (boost::geometry::index::)">Spatial
+ predicates (boost::geometry::index::)</a>
</h4></div></div></div>
<div class="informaltable"><table class="table">
<colgroup>
@@ -6620,8 +6622,8 @@
</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>
+<a name="geometry_index.r_tree.reference.group__adaptors"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__adaptors" title="Adaptors (boost::geometry::index::adaptors::)">Adaptors
+ (boost::geometry::index::adaptors::)</a>
</h4></div></div></div>
<div class="informaltable"><table class="table">
<colgroup>
@@ -6954,7 +6956,7 @@
<a name="geometry_index.r_tree.reference.translators.boost_geometry_index_translator_def"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.translators.boost_geometry_index_translator_def" title="boost::geometry::index::translator::def">boost::geometry::index::translator::def</a>
</h5></div></div></div>
<p>
- <a class="indexterm" name="id942630"></a><a class="indexterm" name="id942634"></a><a class="indexterm" name="id942639"></a><a class="indexterm" name="id942644"></a><a class="indexterm" name="id942649"></a>
+ <a class="indexterm" name="id924198"></a><a class="indexterm" name="id924202"></a><a class="indexterm" name="id924207"></a><a class="indexterm" name="id924212"></a><a class="indexterm" name="id924217"></a>
The default translator.
</p>
<h6>
@@ -7028,7 +7030,7 @@
<a name="geometry_index.r_tree.reference.translators.boost_geometry_index_translator_index"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.translators.boost_geometry_index_translator_index" title="boost::geometry::index::translator::index">boost::geometry::index::translator::index</a>
</h5></div></div></div>
<p>
- <a class="indexterm" name="id942860"></a><a class="indexterm" name="id942865"></a><a class="indexterm" name="id942870"></a><a class="indexterm" name="id942874"></a><a class="indexterm" name="id942879"></a>
+ <a class="indexterm" name="id924428"></a><a class="indexterm" name="id924433"></a><a class="indexterm" name="id924438"></a><a class="indexterm" name="id924442"></a><a class="indexterm" name="id924447"></a>
The index translator.
</p>
<h6>
@@ -7201,6 +7203,125 @@
</p>
</div>
</div>
+<div class="section">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="geometry_index.r_tree.reference.group__inserters"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__inserters" title="Inserters (boost::geometry::index::)">Inserters
+ (boost::geometry::index::)</a>
+</h4></div></div></div>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ <p>
+ Function
+ </p>
+ </th>
+<th>
+ <p>
+ Description
+ </p>
+ </th>
+</tr></thead>
+<tbody><tr>
+<td>
+ <p>
+ <a class="link" href="reference.html#geometry_index.r_tree.reference.group__inserters.function0" title="inserter(Container &)"><code class="computeroutput"><span class="identifier">inserter</span><span class="special">(</span><span class="identifier">Container</span> <span class="special">&)</span></code></a>
+ </p>
+ </td>
+<td>
+ <p>
+ Insert iterator generator.
+ </p>
+ </td>
+</tr></tbody>
+</table></div>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="geometry_index.r_tree.reference.group__inserters.function0"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__inserters.function0" title="inserter(Container &)">inserter(Container
+ &)</a>
+</h5></div></div></div>
+<p>
+ Insert iterator generator.
+ </p>
+<h6>
+<a name="geometry_index.r_tree.reference.group__inserters.function0.h0"></a>
+ <span class="phrase"><a name="geometry_index.r_tree.reference.group__inserters.function0.description"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__inserters.function0.description">Description</a>
+ </h6>
+<p>
+ Returns insert iterator capable to insert values to the container (spatial
+ index) which has member function insert(value_type const&) defined.
+ </p>
+<h6>
+<a name="geometry_index.r_tree.reference.group__inserters.function0.h1"></a>
+ <span class="phrase"><a name="geometry_index.r_tree.reference.group__inserters.function0.synopsis"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__inserters.function0.synopsis">Synopsis</a>
+ </h6>
+<p>
+</p>
+<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> <span class="identifier">Container</span><span class="special">></span>
+<span class="identifier">insert_iterator</span><span class="special"><</span><span class="identifier">Container</span><span class="special">></span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">geometry</span><span class="special">::</span><span class="identifier">index</span><span class="special">::</span><span class="identifier">inserter</span><span class="special">(</span><span class="identifier">Container</span> <span class="special">&</span> <span class="identifier">c</span><span class="special">)</span></pre>
+<p>
+ </p>
+<h6>
+<a name="geometry_index.r_tree.reference.group__inserters.function0.h2"></a>
+ <span class="phrase"><a name="geometry_index.r_tree.reference.group__inserters.function0.parameters"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__inserters.function0.parameters">Parameters</a>
+ </h6>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ <p>
+ Type
+ </p>
+ </th>
+<th>
+ <p>
+ Name
+ </p>
+ </th>
+<th>
+ <p>
+ Description
+ </p>
+ </th>
+</tr></thead>
+<tbody><tr>
+<td>
+ <p>
+ <code class="computeroutput"><span class="identifier">Container</span> <span class="special">&</span></code>
+ </p>
+ </td>
+<td>
+ <p>
+ <code class="computeroutput"><span class="identifier">c</span></code>
+ </p>
+ </td>
+<td>
+ <p>
+ The reference to the container (spatial index) to which values
+ will be inserted.
+ </p>
+ </td>
+</tr></tbody>
+</table></div>
+<h6>
+<a name="geometry_index.r_tree.reference.group__inserters.function0.h3"></a>
+ <span class="phrase"><a name="geometry_index.r_tree.reference.group__inserters.function0.returns"></a></span><a class="link" href="reference.html#geometry_index.r_tree.reference.group__inserters.function0.returns">Returns</a>
+ </h6>
+<p>
+ The insert iterator inserting values to the container.
+ </p>
+</div>
+<p>
+ <br>
+ </p>
+</div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
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-09 11:43:16 EST (Wed, 09 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 09, 2013 at 16:32:37 GMT</small></p></td>
+<td align="left"><p><small>Last revised: January 09, 2013 at 16:40:37 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-09 11:43:16 EST (Wed, 09 Jan 2013)
@@ -25,5 +25,6 @@
os.system(cmd % ("group__adaptors", "geometry_index.r_tree.reference", "adaptors"))
os.system(cmd % ("structboost_1_1geometry_1_1index_1_1translator_1_1def", "geometry_index.r_tree.reference.translators", "translator_def"))
os.system(cmd % ("classboost_1_1geometry_1_1index_1_1translator_1_1index", "geometry_index.r_tree.reference.translators", "translator_index"))
+os.system(cmd % ("group__inserters", "geometry_index.r_tree.reference", "inserters"))
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-09 11:43:16 EST (Wed, 09 Jan 2013)
@@ -32,6 +32,8 @@
[endsect]
+[include generated/inserters.qbk]
+
[endsect]
[endsect]
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