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

Subject: [Boost-commit] svn:boost r85566 - in trunk: boost/geometry/index libs/geometry/doc/index/rtree
From: adam.wulkiewicz_at_[hidden]
Date: 2013-09-04 15:44:19

Author: awulkiew
Date: 2013-09-04 15:44:19 EDT (Wed, 04 Sep 2013)
New Revision: 85566
URL: http://svn.boost.org/trac/boost/changeset/85566

Log:
[geometry] docs: added description of contains() and covers() predicates.

Text files modified: 
   trunk/boost/geometry/index/rtree.hpp          |     8 ++++++++                                
   trunk/libs/geometry/doc/index/rtree/query.qbk |     4 +++-                                    
   2 files changed, 11 insertions(+), 1 deletions(-)

Modified: trunk/boost/geometry/index/rtree.hpp
==============================================================================
--- trunk/boost/geometry/index/rtree.hpp	Wed Sep  4 11:16:29 2013	(r85565)
+++ trunk/boost/geometry/index/rtree.hpp	2013-09-04 15:44:19 EDT (Wed, 04 Sep 2013)	(r85566)
@@ -232,6 +232,8 @@
     /*!
     \brief The constructor.
 
+    The tree is created using packing algorithm.
+
     \param first        The beginning of the range of Values.
     \param last         The end of the range of Values.
     \param parameters   The parameters object.
@@ -263,6 +265,8 @@
     /*!
     \brief The constructor.
 
+    The tree is created using packing algorithm.
+
     \param rng          The range of Values.
     \param parameters   The parameters object.
     \param getter       The function object extracting Indexable from Value.
@@ -691,14 +695,18 @@
     <b>Spatial predicates</b>
     
     Spatial predicates may be generated by one of the functions listed below:
+    \li \c boost::geometry::index::contains(),
     \li \c boost::geometry::index::covered_by(),
+    \li \c boost::geometry::index::covers(),
     \li \c boost::geometry::index::disjoint(),
     \li \c boost::geometry::index::intersects(),
     \li \c boost::geometry::index::overlaps(),
     \li \c boost::geometry::index::within(),
 
     It is possible to negate spatial predicates:
+    \li <tt>! boost::geometry::index::contains()</tt>,
     \li <tt>! boost::geometry::index::covered_by()</tt>,
+    \li <tt>! boost::geometry::index::covers()</tt>,
     \li <tt>! boost::geometry::index::disjoint()</tt>,
     \li <tt>! boost::geometry::index::intersects()</tt>,
     \li <tt>! boost::geometry::index::overlaps()</tt>,

Modified: trunk/libs/geometry/doc/index/rtree/query.qbk
==============================================================================
--- trunk/libs/geometry/doc/index/rtree/query.qbk	Wed Sep  4 11:16:29 2013	(r85565)
+++ trunk/libs/geometry/doc/index/rtree/query.qbk	2013-09-04 15:44:19 EDT (Wed, 04 Sep 2013)	(r85566)
@@ -63,9 +63,11 @@
 
 To use a spatial predicate one may use one of the functions defined in `boost::geometry::index` namespace.
 
- rt.query(index::intersects(box), std::back_inserter(result));
+ rt.query(index::contains(box), std::back_inserter(result));
  rt.query(index::covered_by(box), std::back_inserter(result));
+ rt.query(index::covers(box), std::back_inserter(result));
  rt.query(index::disjont(box), std::back_inserter(result));
+ rt.query(index::intersects(box), std::back_inserter(result));
  rt.query(index::overlaps(box), std::back_inserter(result));
  rt.query(index::within(box), std::back_inserter(result));