|
|
Boost-Commit : |
Subject: [Boost-commit] svn:boost r75718 - in sandbox-branches/geometry/index/doc: . html html/index
From: adam.wulkiewicz_at_[hidden]
Date: 2011-11-28 19:17:11
Author: awulkiew
Date: 2011-11-28 19:17:08 EST (Mon, 28 Nov 2011)
New Revision: 75718
URL: http://svn.boost.org/trac/boost/changeset/75718
Log:
r-tree doc structure slightly changed.
Text files modified:
sandbox-branches/geometry/index/doc/html/index.html | 14 ++---
sandbox-branches/geometry/index/doc/html/index/rtree.html | 106 ++++++++++++++++++++++++++-------------
sandbox-branches/geometry/index/doc/index.xml | 45 +++++++++++++---
3 files changed, 110 insertions(+), 55 deletions(-)
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 2011-11-28 19:17:08 EST (Mon, 28 Nov 2011)
@@ -31,7 +31,7 @@
<div><p class="copyright">Copyright © 2008 Federico J. Fernandez</p></div>
<div><p class="copyright">Copyright © 2011 Adam Wulkiewicz</p></div>
<div><div class="legalnotice">
-<a name="id789613"></a><p>Use, modification and distribution is subject to the Boost
+<a name="id821289"></a><p>Use, modification and distribution is subject to the Boost
Software License, Version 1.0. (See accompanying file
<code class="filename">LICENSE_1_0.txt</code> or copy at http://www.boost.org/LICENSE_1_0.txt)</p>
</div></div>
@@ -42,13 +42,11 @@
<dt><span class="section">Introduction</span></dt>
<dt><span class="section">R-tree</span></dt>
<dd><dl>
-<dt><span class="section">R-tree creation</span></dt>
-<dt><span class="section">Values, Indexables and default Translator</span></dt>
-<dt><span class="section">Inserting and splitting algorithms</span></dt>
-<dt><span class="section">Inserting and removing Values</span></dt>
-<dt><span class="section">Spatial queries</span></dt>
-<dt><span class="section">Spatial predicates</span></dt>
-<dt><span class="section">Nearest neighbors queries</span></dt>
+<dt><span class="section">Introduction</span></dt>
+<dt><span class="section">R-tree creation</span></dt>
+<dt><span class="section">Inserting and removing Values</span></dt>
+<dt><span class="section">Spatial queries</span></dt>
+<dt><span class="section">Nearest neighbors queries</span></dt>
</dl></dd>
</dl>
</div>
Modified: sandbox-branches/geometry/index/doc/html/index/rtree.html
==============================================================================
--- sandbox-branches/geometry/index/doc/html/index/rtree.html (original)
+++ sandbox-branches/geometry/index/doc/html/index/rtree.html 2011-11-28 19:17:08 EST (Mon, 28 Nov 2011)
@@ -25,14 +25,15 @@
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="index.rtree"></a>R-tree</h2></div></div></div>
<div class="toc"><dl>
-<dt><span class="section">R-tree creation</span></dt>
-<dt><span class="section">Values, Indexables and default Translator</span></dt>
-<dt><span class="section">Inserting and splitting algorithms</span></dt>
-<dt><span class="section">Inserting and removing Values</span></dt>
-<dt><span class="section">Spatial queries</span></dt>
-<dt><span class="section">Spatial predicates</span></dt>
-<dt><span class="section">Nearest neighbors queries</span></dt>
+<dt><span class="section">Introduction</span></dt>
+<dt><span class="section">R-tree creation</span></dt>
+<dt><span class="section">Inserting and removing Values</span></dt>
+<dt><span class="section">Spatial queries</span></dt>
+<dt><span class="section">Nearest neighbors queries</span></dt>
</dl></div>
+<div class="section">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="id821333"></a>Introduction</h3></div></div></div>
<p>
R-tree is a self-balancing search tree with nodes stored with their axis aligned
bounding boxes. Each node's box describes the space occupied by children nodes.
@@ -40,9 +41,42 @@
(geometric objects representations). Minimal and maximal numbers of values/children
which may be stored inside the node are user defined.
</p>
+<p>
+In order to use the R-tree one must include folowing file.
+</p>
+<pre class="programlisting">
+#include <boost/geometry/extensions/index/rtree/rtree.hpp>
+</pre>
+<p>
+</p>
+</div>
<div class="section">
<div class="titlepage"><div><div><h3 class="title">
-<a name="id789661"></a>R-tree creation</h3></div></div></div>
+<a name="id821353"></a>R-tree creation</h3></div></div></div>
+<div class="toc"><dl>
+<dt><span class="section">Quick start</span></dt>
+<dt><span class="section">R-tree template parameters</span></dt>
+<dt><span class="section">Values, Indexables and default Translator</span></dt>
+<dt><span class="section">Inserting and splitting algorithms</span></dt>
+</dl></div>
+<div class="section">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="id821359"></a>Quick start</h4></div></div></div>
+<p>
+In order to create a R-tree object storing values of type
+<code class="computeroutput">std::pair<Box, int></code> one may use the following code
+</p>
+<pre class="programlisting">
+using namespace boost::geometry;
+typedef std::pair<Box, int> Value;
+index::rtree< Value, index::quadratic<32, 8> > rt;
+</pre>
+<p>
+</p>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="id821381"></a>R-tree template parameters</h4></div></div></div>
<p>
R-tree has 4 parameters:
</p>
@@ -70,21 +104,10 @@
</ul></div>
<p>
</p>
-<p>
-In order to create a R-tree object storing values of type
-<code class="computeroutput">std::pair<Box, int></code> one may use the following code
-</p>
-<pre class="programlisting">
-using namespace boost::geometry;
-typedef std::pair<Box, int> Value;
-index::rtree< Value, index::quadratic<32, 8> > rt;
-</pre>
-<p>
-</p>
</div>
<div class="section">
-<div class="titlepage"><div><div><h3 class="title">
-<a name="id789748"></a>Values, Indexables and default Translator</h3></div></div></div>
+<div class="titlepage"><div><div><h4 class="title">
+<a name="id821454"></a>Values, Indexables and default Translator</h4></div></div></div>
<p>
R-tree may store <code class="computeroutput">Value</code>s of any type as long as there is passed
the <code class="computeroutput">Translator</code> which knows how to interpret those <code class="computeroutput">Value</code>s
@@ -112,8 +135,8 @@
</p>
</div>
<div class="section">
-<div class="titlepage"><div><div><h3 class="title">
-<a name="id789861"></a>Inserting and splitting algorithms</h3></div></div></div>
+<div class="titlepage"><div><div><h4 class="title">
+<a name="id821567"></a>Inserting and splitting algorithms</h4></div></div></div>
<p>
<code class="computeroutput">Value</code>s may be inserted to the R-tree in many various ways. Final structure of nodes depends
on algorithms used in the process, especially nodes' splitting algorithm. Currently, three
@@ -142,9 +165,10 @@
<p>
</p>
</div>
+</div>
<div class="section">
<div class="titlepage"><div><div><h3 class="title">
-<a name="id789906"></a>Inserting and removing Values</h3></div></div></div>
+<a name="id821613"></a>Inserting and removing Values</h3></div></div></div>
<p>
Create
</p>
@@ -174,7 +198,14 @@
</div>
<div class="section">
<div class="titlepage"><div><div><h3 class="title">
-<a name="id789931"></a>Spatial queries</h3></div></div></div>
+<a name="id821638"></a>Spatial queries</h3></div></div></div>
+<div class="toc"><dl>
+<dt><span class="section">Basic queries</span></dt>
+<dt><span class="section">Spatial predicates</span></dt>
+</dl></div>
+<div class="section">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="id821644"></a>Basic queries</h4></div></div></div>
<p>
There are three ways to perform a spatial query. Following queries returns
<code class="computeroutput">Value</code>s intersecting some box_region.
@@ -209,8 +240,8 @@
</p>
</div>
<div class="section">
-<div class="titlepage"><div><div><h3 class="title">
-<a name="id789980"></a>Spatial predicates</h3></div></div></div>
+<div class="titlepage"><div><div><h4 class="title">
+<a name="id821693"></a>Spatial predicates</h4></div></div></div>
<p>
It is possible to define other relations between queried <code class="computeroutput">Value</code>s and region/regions
of interest. Names of predicates corresponds to names of Boost.Geometry algorithms.
@@ -268,18 +299,19 @@
<p>
</p>
</div>
+</div>
<div class="section">
<div class="titlepage"><div><div><h3 class="title">
-<a name="id790041"></a>Nearest neighbors queries</h3></div></div></div>
+<a name="id829402"></a>Nearest neighbors queries</h3></div></div></div>
<div class="toc"><dl>
-<dt><span class="section">k nearest neighbors</span></dt>
-<dt><span class="section">One nearest neighbor</span></dt>
-<dt><span class="section">Distances predicates</span></dt>
-<dt><span class="section">Using spatial predicates</span></dt>
+<dt><span class="section">k nearest neighbors</span></dt>
+<dt><span class="section">One nearest neighbor</span></dt>
+<dt><span class="section">Distances predicates</span></dt>
+<dt><span class="section">Using spatial predicates</span></dt>
</dl></div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
-<a name="id790047"></a>k nearest neighbors</h4></div></div></div>
+<a name="id829408"></a>k nearest neighbors</h4></div></div></div>
<p>
There are three ways of performing knn queries. Following queries returns
k <code class="computeroutput">Value</code>s closest to some point in space. For <code class="computeroutput">Box</code>es
@@ -316,7 +348,7 @@
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
-<a name="id797757"></a>One nearest neighbor</h4></div></div></div>
+<a name="id829471"></a>One nearest neighbor</h4></div></div></div>
<p>
Another type of nearest neighbor query is searching for the one closest <code class="computeroutput">Value</code>.
If it is found, 1 is returned by the method or function. This kind of query
@@ -345,7 +377,7 @@
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
-<a name="id797793"></a>Distances predicates</h4></div></div></div>
+<a name="id829507"></a>Distances predicates</h4></div></div></div>
<p>
It is possible to define if calculated distance between query point and <code class="computeroutput">Value</code> should be
greater, lesser or between some other distances. Those are called <code class="computeroutput">DistancesPredicate</code>s and
@@ -402,9 +434,9 @@
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
-<a name="id797832"></a>Using spatial predicates</h4></div></div></div>
+<a name="id829546"></a>Using spatial predicates</h4></div></div></div>
<p>
-It is possible to use spatial predicates described before in knn queries.
+It is possible to use spatial predicates described before in nearest neighbors queries.
</p>
<pre class="programlisting">
Value returned_value;
Modified: sandbox-branches/geometry/index/doc/index.xml
==============================================================================
--- sandbox-branches/geometry/index/doc/index.xml (original)
+++ sandbox-branches/geometry/index/doc/index.xml 2011-11-28 19:17:08 EST (Mon, 28 Nov 2011)
@@ -48,6 +48,9 @@
<section id="index.rtree">
<title>R-tree</title>
+
+<section>
+<title>Introduction</title>
<para>
R-tree is a self-balancing search tree with nodes stored with their axis aligned
bounding boxes. Each node's box describes the space occupied by children nodes.
@@ -56,8 +59,32 @@
which may be stored inside the node are user defined.
</para>
+<para>
+In order to use the R-tree one must include folowing file.
+<programlisting>
+#include <boost/geometry/extensions/index/rtree/rtree.hpp>
+</programlisting>
+</para>
+</section>
+
<section>
<title>R-tree creation</title>
+
+<section>
+<title>Quick start</title>
+<para>
+In order to create a R-tree object storing values of type
+<code>std::pair<Box, int></code> one may use the following code
+<programlisting>
+using namespace boost::geometry;
+typedef std::pair<Box, int> Value;
+index::rtree< Value, index::quadratic<32, 8> > rt;
+</programlisting>
+</para>
+</section>
+
+<section>
+<title>R-tree template parameters</title>
<para>
R-tree has 4 parameters:
<programlisting>
@@ -81,15 +108,6 @@
</listitem>
</itemizedlist>
</para>
-<para>
-In order to create a R-tree object storing values of type
-<code>std::pair<Box, int></code> one may use the following code
-<programlisting>
-using namespace boost::geometry;
-typedef std::pair<Box, int> Value;
-index::rtree< Value, index::quadratic<32, 8> > rt;
-</programlisting>
-</para>
</section>
<section>
@@ -146,6 +164,8 @@
</para>
</section>
+</section>
+
<section>
<title>Inserting and removing Values</title>
<para>
@@ -172,6 +192,9 @@
<section>
<title>Spatial queries</title>
+
+<section>
+<title>Basic queries</title>
<para>
There are three ways to perform a spatial query. Following queries returns
<code>Value</code>s intersecting some box_region.
@@ -254,6 +277,8 @@
</para>
</section>
+</section>
+
<section>
<title>Nearest neighbors queries</title>
@@ -378,7 +403,7 @@
<section>
<title>Using spatial predicates</title>
<para>
-It is possible to use spatial predicates described before in knn queries.
+It is possible to use spatial predicates described before in nearest neighbors queries.
<programlisting>
Value returned_value;
std::vector<Value> returned_values;
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