[Boost-commit] svn:boost r84296 - in trunk/libs/geometry/doc: html index index/rtree

Subject: [Boost-commit] svn:boost r84296 - in trunk/libs/geometry/doc: html index index/rtree
From: adam.wulkiewicz_at_[hidden]
Date: 2013-05-16 06:17:26

Author: awulkiew
Date: 2013-05-16 06:17:25 EDT (Thu, 16 May 2013)
New Revision: 84296
URL: http://svn.boost.org/trac/boost/changeset/84296

Log:
geometry.index docs: experimental features commented, sections replaced by headings in queries description
Text files modified: 
   trunk/libs/geometry/doc/html/index.html              |     4 +---                                    
   trunk/libs/geometry/doc/index/index.qbk              |     2 +-                                      
   trunk/libs/geometry/doc/index/rtree/experimental.qbk |     5 +++--                                   
   trunk/libs/geometry/doc/index/rtree/query.qbk        |    28 ++++++++--------------------            
   4 files changed, 13 insertions(+), 26 deletions(-)

Modified: trunk/libs/geometry/doc/html/index.html
==============================================================================
--- trunk/libs/geometry/doc/html/index.html	(original)
+++ trunk/libs/geometry/doc/html/index.html	2013-05-16 06:17:25 EDT (Thu, 16 May 2013)
@@ -57,8 +57,6 @@
       and Modification</a></span></dt>
 <dt><span class="section">Queries</span></dt>
 <dt><span class="section">Examples</span></dt>
-<dt><span class="section"><a href="geometry/spatial_indexes/experimental_features.html">Experimental
-      Features</a></span></dt>
 </dl></dd>
 <dt><span class="section">Reference</span></dt>
 <dd><dl>
@@ -111,7 +109,7 @@
 </ul></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: May 13, 2013 at 00:36:10 GMT</small></p></td>
+<td align="left"><p><small>Last revised: May 16, 2013 at 10:14:50 GMT</small></p></td>
 <td align="right"><div class="copyright-footer"></div></td>
 </tr></table>
 <hr>

Modified: trunk/libs/geometry/doc/index/index.qbk
==============================================================================
--- trunk/libs/geometry/doc/index/index.qbk	(original)
+++ trunk/libs/geometry/doc/index/index.qbk	2013-05-16 06:17:25 EDT (Thu, 16 May 2013)
@@ -40,4 +40,4 @@
 [include rtree/creation.qbk]
 [include rtree/query.qbk]
 [include rtree/examples.qbk]
-[include rtree/experimental.qbk]
+[/include rtree/experimental.qbk]

Modified: trunk/libs/geometry/doc/index/rtree/experimental.qbk
==============================================================================
--- trunk/libs/geometry/doc/index/rtree/experimental.qbk	(original)
+++ trunk/libs/geometry/doc/index/rtree/experimental.qbk	2013-05-16 06:17:25 EDT (Thu, 16 May 2013)
@@ -33,14 +33,15 @@
 
 [heading Path query]
 
-Path query returns `k` first `__value__`s intersecting a path defined by a `Linestring`. The result of a query returning first 5
+Path query returns `k` first `__value__`s intersecting a path defined by a `Segment` or a`Linestring`. The result of a query returning first 5
 values intersecting a path is presented below. Path's flow is denoted by blue arrows, returned values are orange.
 
 [$img/index/rtree/path.png]
  
-To perform this query one may pass a `path()` predicate taking a `Linestring` and maximum number of `__value__`s which
+To perform this query one may pass a `path()` predicate taking a `Segment` or a `Linestring` and maximum number of `__value__`s which
 should be returned:
 
+ rtree.query(index::path(segment, k), std::back_inserter(returned_values));
  rtree.query(index::path(linestring, k), std::back_inserter(returned_values));
 
 [warning Only one distance predicate may be used in a query. This means that there can be only one `nearest()` or `path()` predicate passed. Passing more of them will result in compile-time error.]

Modified: trunk/libs/geometry/doc/index/rtree/query.qbk
==============================================================================
--- trunk/libs/geometry/doc/index/rtree/query.qbk	(original)
+++ trunk/libs/geometry/doc/index/rtree/query.qbk	2013-05-16 06:17:25 EDT (Thu, 16 May 2013)
@@ -22,7 +22,7 @@
 * are nearest to some point,
 * overlapping a box and has user-defined property.
 
-[section Performing a query]
+[h4 Performing a query]
 
 There are three ways to perform a query presented below. All of them returns `__value__`s intersecting some
 region defined as a `__box__`.
@@ -45,9 +45,7 @@
  BOOST_FOREACH(__value__ & v, rt | index::adaptors::queried(bgi::intersects(box_region)))
    ; // do something with v
 
-[endsect]
-
-[section Spatial predicates]
+[h4 Spatial predicates]
 
 Queries using spatial predicates returns `__value__`s which are related somehow to some Geometry - box, polygon, etc.
 Names of spatial predicates correspond to names of __boost_geometry__ algorithms. Examples of some
@@ -77,11 +75,9 @@
  // the same as
  rt.query(index::disjoint(box), std::back_inserter(result));
 
-[endsect]
-
-[section Distance predicates]
+[h4 Distance predicates]
 
-[h4 Nearest neighbours queries]
+[h5 Nearest neighbours queries]
 
 Nearest neighbours queries returns `__value__`s which are closest to some point in space.
 Additionally it is possible to define how the distance to the `Value` should be calculated.
@@ -89,7 +85,7 @@
 
 [$img/index/rtree/knn.png]
 
-[h4 k nearest neighbours]
+[h5 k nearest neighbours]
 
 There are three ways of performing knn queries. Following queries returns
 `k` `__value__`s closest to some point in space. For `__box__`es
@@ -113,9 +109,7 @@
  BOOST_FOREACH(__value__ & v, rt | index::adaptors::queried(index::nearest(pt, k)))
    ; // do something with v
 
-[endsect]
-
-[section User-defined unary predicate]
+[h4 User-defined unary predicate]
 
 The user may pass a `UnaryPredicate` - function, function object or lambda expression taking const reference to Value and returning bool.
 This object may be passed to the query in order to check if `__value__` should be returned by the query. To do it one
@@ -161,9 +155,7 @@
  rt.query(index::intersects(box) && !index::satisfies(is_not_red),
           std::back_inserter(result));
 
-[endsect]
-
-[section Passing a set of predicates]
+[h4 Passing a set of predicates]
 
 It's possible to use some number of predicates in one query by connecting them with `operator&&` e.g. `Pred1 && Pred2 && Pred3 && ...`.
 
@@ -185,9 +177,7 @@
  BOOST_FOREACH(Value & v, rt | index::adaptors::queried(index::nearest(pt, k) && index::covered_by(b)))
    ; // do something with v
 
-[endsect]
-
-[section Inserting query results into the other R-tree]
+[h4 Inserting query results into the other R-tree]
 
 There are several ways of inserting Values returned by a query to the other R-tree container.
 The most basic way is creating a temporary container for Values and insert them later.
@@ -214,6 +204,4 @@
 
  RTree rt4(rt1 | bgi::adaptors::queried(bgi::intersects(Box(/*...*/)))));
 
-[endsect]
-
 [endsect] [/ Queries /]