Boost-Commit :

Date view	Thread view	Subject view	Author view

Subject: [Boost-commit] svn:boost r75712 - in sandbox-branches/geometry/index/doc: . html html/index
From: adam.wulkiewicz_at_[hidden]
Date: 2011-11-28 08:47:05

Author: awulkiew
Date: 2011-11-28 08:47:04 EST (Mon, 28 Nov 2011)
New Revision: 75712
URL: http://svn.boost.org/trac/boost/changeset/75712

Log:
formatting changed in docs
Text files modified:
   sandbox-branches/geometry/index/doc/html/index.html | 16 ++++----
   sandbox-branches/geometry/index/doc/html/index/rtree.html | 73 ++++++++++++++++++++-------------------
   sandbox-branches/geometry/index/doc/index.xml | 45 +++++++++++++-----------
   3 files changed, 70 insertions(+), 64 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 08:47:04 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="id824565"></a><p>Use, modification and distribution is subject to the Boost
+<a name="id798351"></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,13 @@
<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 neighbor queries</span></dt>
+<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 neighbor 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 08:47:04 EST (Mon, 28 Nov 2011)
@@ -25,13 +25,13 @@
<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 neighbor queries</span></dt>
+<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 neighbor queries</span></dt>
</dl></div>
<p>
R-tree is a self-balancing search tree with nodes stored with their axis aligned
@@ -42,7 +42,7 @@
</p>
<div class="section">
<div class="titlepage"><div><div><h3 class="title">
-<a name="id824613"></a>R-tree creation</h3></div></div></div>
+<a name="id798399"></a>R-tree creation</h3></div></div></div>
<p>
R-tree has 4 parameters:
</p>
@@ -53,22 +53,22 @@
</p>
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
<li class="listitem">
-Value - type of object which will be stored in the container.
+<code class="computeroutput">Value</code> - type of object which will be stored in the container.
</li>
<li class="listitem">
-Parameters - compile-time parameters, e.g. inserting/splitting algorithm with min and max nodes' elements numbers.
+<code class="computeroutput">Parameters</code> - compile-time parameters, e.g. inserting/splitting algorithm with min and max nodes' elements numbers.
</li>
<li class="listitem">
-Translator - type of object translating Value objects to Indexable objects (Point or Box) which R-tree can handle.
+<code class="computeroutput">Translator</code> - type of object translating Value objects to Indexable objects (<code class="computeroutput">Point</code> or <code class="computeroutput">Box</code>) which R-tree can handle.
</li>
<li class="listitem">
-Allocator - the allocator.
+<code class="computeroutput">Allocator</code> - the allocator.
</li>
</ul></div>
<p>
</p>
<p>
-In order to create a R-tree object storing values of type std::pair<Box, int> one may use the following code
+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;
@@ -80,33 +80,34 @@
</div>
<div class="section">
<div class="titlepage"><div><div><h3 class="title">
-<a name="id824657"></a>Values, Indexables and default Translator</h3></div></div></div>
+<a name="id798477"></a>Values, Indexables and default Translator</h3></div></div></div>
<p>
R-tree may store Values of any type as long as there is passed the Translator which knows how to interpret
those Values and extract an object understandable by the R-tree. Those objects are called Indexables
and they are simply of type adapted to Point or Box concept. Default translator
-index::translator::def<Value> is able to handle Points, Boxes, std::pairs, pointers and iterators.
+<code class="computeroutput">index::translator::def<Value></code> is able to handle <code class="computeroutput">Point</code>, <code class="computeroutput">Box</code>,
+<code class="computeroutput">std::pair<...></code>, pointer, iterator or smart pointer.
</p>
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
-<li class="listitem">Indexable = Point | Box</li>
-<li class="listitem">BasicValue = Indexable | std::pair<Indexable, T> | std::pair<T, Indexable></li>
-<li class="listitem">Value = BasicValue | BasicValue* | Iterator<BasicValue></li>
+<li class="listitem"><code class="computeroutput">Indexable = Point | Box</code></li>
+<li class="listitem"><code class="computeroutput">BasicValue = Indexable | std::pair<Indexable, T> | std::pair<T, Indexable></code></li>
+<li class="listitem"><code class="computeroutput">Value = BasicValue | BasicValue* | Iterator<BasicValue> | SmartPtr<BasicValue></code></li>
</ul></div>
<p>
Examples of Value types:
</p>
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
-<li class="listitem">geometry::model::point<...></li>
-<li class="listitem">geometry::model::point_xy<...></li>
-<li class="listitem">geometry::model::box<...></li>
-<li class="listitem">std::pair≤geometry::model::box<...>, size_t></li>
+<li class="listitem"><code class="computeroutput">geometry::model::point<...></code></li>
+<li class="listitem"><code class="computeroutput">geometry::model::point_xy<...></code></li>
+<li class="listitem"><code class="computeroutput">geometry::model::box<...></code></li>
+<li class="listitem"><code class="computeroutput">std::pair<geometry::model::box<...>, size_t></code></li>
</ul></div>
<p>
</p>
</div>
<div class="section">
<div class="titlepage"><div><div><h3 class="title">
-<a name="id824700"></a>Inserting and splitting algorithms</h3></div></div></div>
+<a name="id798556"></a>Inserting and splitting algorithms</h3></div></div></div>
<p>
Values 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
@@ -137,7 +138,7 @@
</div>
<div class="section">
<div class="titlepage"><div><div><h3 class="title">
-<a name="id824739"></a>Inserting and removing Values</h3></div></div></div>
+<a name="id798596"></a>Inserting and removing Values</h3></div></div></div>
<p>
Create
</p>
@@ -150,22 +151,24 @@
Insert and remove by method call
</p>
<pre class="programlisting">
-rt.insert(std::make_pair(Box(...), 0));
-rt.remove(std::make_pair(Box(...), 0));
+Value v = std::make_pair(Box(...), 0);
+rt.insert(v);
+rt.remove(v);
</pre>
<p>
or by function call
</p>
<pre class="programlisting">
-index::insert(rt, std::make_pair(Box(...), 0));
-index::remove(rt, std::make_pair(Box(...), 0));
+Value v = std::make_pair(Box(...), 0);
+index::insert(rt, v);
+index::remove(rt, v);
</pre>
<p>
</p>
</div>
<div class="section">
<div class="titlepage"><div><div><h3 class="title">
-<a name="id824765"></a>Spatial queries</h3></div></div></div>
+<a name="id798621"></a>Spatial queries</h3></div></div></div>
<p>
There are three ways to perform a spatial query. Following queries returns
Values intersecting some box_region.
@@ -188,7 +191,7 @@
</pre>
</li>
<li class="listitem">
-Use of operator | (as with ranges)
+Use of <code class="computeroutput">operator |</code> (as with ranges)
<pre class="programlisting">
Box box_region(...);
BOOST_FOREACH(Value &v, rt | index::query_filtered(box_region))
@@ -201,7 +204,7 @@
</div>
<div class="section">
<div class="titlepage"><div><div><h3 class="title">
-<a name="id824804"></a>Spatial predicates</h3></div></div></div>
+<a name="id798665"></a>Spatial predicates</h3></div></div></div>
<p>
It is possible to define other relations between queried Values and region/regions
of interest. Names of predicates corresponds to names of Boost.Geometry algorithms.
@@ -225,7 +228,7 @@
rt.query(index::disjoint(box), std::back_inserter(result));
</pre>
<p>
-It's possible to use some number of predicates by passing std::pair<P1, P2>
+It's possible to use some number of predicates by passing <code class="computeroutput">std::pair<Pred1, Pred2></code>
</p>
<pre class="programlisting">
rt.query(
@@ -233,7 +236,7 @@
, std::back_inserter(result));
</pre>
<p>
-or boost::tuple<P1, P2, P3, ...>
+or <code class="computeroutput">boost::tuple<Pred1, Pred2, Pred3, ...></code>
</p>
<pre class="programlisting">
rt.query(
@@ -241,7 +244,7 @@
, std::back_inserter(result));
</pre>
<p>
-There is special predicate index::value taking user-defined function/functor
+There is special predicate <code class="computeroutput">index::value(Fun)</code> taking user-defined function/functor
which checks if Value should be returned by the query.
</p>
<pre class="programlisting">
@@ -261,7 +264,7 @@
</div>
<div class="section">
<div class="titlepage"><div><div><h3 class="title">
-<a name="id824839"></a>Nearest neighbor queries</h3></div></div></div>
+<a name="id798716"></a>Nearest neighbor queries</h3></div></div></div>
TODO
</div>
</div>

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 08:47:04 EST (Mon, 28 Nov 2011)
@@ -65,21 +65,21 @@
</programlisting>
<itemizedlist>
<listitem>
-Value - type of object which will be stored in the container.
+<code>Value</code> - type of object which will be stored in the container.
</listitem>
<listitem>
-Parameters - compile-time parameters, e.g. inserting/splitting algorithm with min and max nodes' elements numbers.
+<code>Parameters</code> - compile-time parameters, e.g. inserting/splitting algorithm with min and max nodes' elements numbers.
</listitem>
<listitem>
-Translator - type of object translating Value objects to Indexable objects (Point or Box) which R-tree can handle.
+<code>Translator</code> - type of object translating Value objects to Indexable objects (<code>Point</code> or <code>Box</code>) which R-tree can handle.
</listitem>
<listitem>
-Allocator - the allocator.
+<code>Allocator</code> - the allocator.
</listitem>
</itemizedlist>
</para>
<para>
-In order to create a R-tree object storing values of type std::pair<Box, int> one may use the following code
+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;
@@ -94,18 +94,19 @@
R-tree may store Values of any type as long as there is passed the Translator which knows how to interpret
those Values and extract an object understandable by the R-tree. Those objects are called Indexables
and they are simply of type adapted to Point or Box concept. Default translator
-index::translator::def<Value> is able to handle Points, Boxes, std::pairs, pointers and iterators.
+<code>index::translator::def<Value></code> is able to handle <code>Point</code>, <code>Box</code>,
+<code>std::pair<...></code>, pointer, iterator or smart pointer.
<itemizedlist>
-<listitem>Indexable = Point | Box</listitem>
-<listitem>BasicValue = Indexable | std::pair<Indexable, T> | std::pair<T, Indexable></listitem>
-<listitem>Value = BasicValue | BasicValue* | Iterator<BasicValue></listitem>
+<listitem><code>Indexable = Point | Box</code></listitem>
+<listitem><code>BasicValue = Indexable | std::pair<Indexable, T> | std::pair<T, Indexable></code></listitem>
+<listitem><code>Value = BasicValue | BasicValue* | Iterator<BasicValue> | SmartPtr<BasicValue></code></listitem>
</itemizedlist>
Examples of Value types:
<itemizedlist>
-<listitem>geometry::model::point<...></listitem>
-<listitem>geometry::model::point_xy<...></listitem>
-<listitem>geometry::model::box<...></listitem>
-<listitem>std::pair≤geometry::model::box<...>, size_t></listitem>
+<listitem><code>geometry::model::point<...></code></listitem>
+<listitem><code>geometry::model::point_xy<...></code></listitem>
+<listitem><code>geometry::model::box<...></code></listitem>
+<listitem><code>std::pair<geometry::model::box<...>, size_t></code></listitem>
</itemizedlist>
</para>
</section>
@@ -150,13 +151,15 @@
</programlisting>
Insert and remove by method call
<programlisting>
-rt.insert(std::make_pair(Box(...), 0));
-rt.remove(std::make_pair(Box(...), 0));
+Value v = std::make_pair(Box(...), 0);
+rt.insert(v);
+rt.remove(v);
</programlisting>
or by function call
<programlisting>
-index::insert(rt, std::make_pair(Box(...), 0));
-index::remove(rt, std::make_pair(Box(...), 0));
+Value v = std::make_pair(Box(...), 0);
+index::insert(rt, v);
+index::remove(rt, v);
</programlisting>
</para>
</section>
@@ -184,7 +187,7 @@
</programlisting>
</listitem>
<listitem>
-Use of operator | (as with ranges)
+Use of <code>operator |</code> (as with ranges)
<programlisting>
Box box_region(...);
BOOST_FOREACH(Value &v, rt | index::query_filtered(box_region))
@@ -216,19 +219,19 @@
// the same as
rt.query(index::disjoint(box), std::back_inserter(result));
</programlisting>
-It's possible to use some number of predicates by passing std::pair<P1, P2>
+It's possible to use some number of predicates by passing <code>std::pair<Pred1, Pred2></code>
<programlisting>
rt.query(
   std::make_pair(index::intersects(box1), !index::within(box2))
   , std::back_inserter(result));
</programlisting>
-or boost::tuple<P1, P2, P3, ...>
+or <code>boost::tuple<Pred1, Pred2, Pred3, ...></code>
<programlisting>
rt.query(
   boost::make_tuple(index::intersects(box1), !index::within(box2), index::overlaps(box3))
   , std::back_inserter(result));
</programlisting>
-There is special predicate index::value taking user-defined function/functor
+There is special predicate <code>index::value(Fun)</code> taking user-defined function/functor
which checks if Value should be returned by the query.
<programlisting>
bool fun(Value const& v)

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