Boost-Commit :

Date view	Thread view	Subject view	Author view

Subject: [Boost-commit] svn:boost r82454 - sandbox-branches/geometry/index/boost/geometry/extensions/index/rtree
From: adam.wulkiewicz_at_[hidden]
Date: 2013-01-11 22:49:20

Author: awulkiew
Date: 2013-01-11 22:49:19 EST (Fri, 11 Jan 2013)
New Revision: 82454
URL: http://svn.boost.org/trac/boost/changeset/82454

Log:
Moddified rtree description - required by doxygen to properly generate links.
Text files modified:
sandbox-branches/geometry/index/boost/geometry/extensions/index/rtree/rtree.hpp | 164 ++++++++++++++++++++--------------------
1 files changed, 82 insertions(+), 82 deletions(-)

Modified: sandbox-branches/geometry/index/boost/geometry/extensions/index/rtree/rtree.hpp
==============================================================================
--- sandbox-branches/geometry/index/boost/geometry/extensions/index/rtree/rtree.hpp (original)
+++ sandbox-branches/geometry/index/boost/geometry/extensions/index/rtree/rtree.hpp 2013-01-11 22:49:19 EST (Fri, 11 Jan 2013)
@@ -69,15 +69,15 @@

\par
Predefined algorithms with compile-time parameters are:
- \li <tt>bgi::linear<MinElements, MaxElements></tt>,
- \li <tt>bgi::quadratic<MinElements, MaxElements></tt>,
- \li <tt>bgi::rstar<MinElements, MaxElements, OverlapCostThreshold = 0, ReinsertedElements = MaxElements * 0.3></tt>.
+\li <tt>boost::geometry::index::linear</tt>,
+ \li <tt>boost::geometry::index::quadratic</tt>,
+ \li <tt>boost::geometry::index::rstar</tt>.

\par
Predefined algorithms with run-time parameters are:
- \li \c bgi::runtime::linear,
- \li \c bgi::runtime::quadratic,
- \li \c bgi::runtime::rstar.
+ \li \c boost::geometry::index::runtime::linear,
+ \li \c boost::geometry::index::runtime::quadratic,
+ \li \c boost::geometry::index::runtime::rstar.

\par Translator
The Translator translates from Value to Indexable each time r-tree requires it. Which means that this
@@ -585,20 +585,20 @@
 Spatial predicates may be a \c Geometry. In this case Values intersecting the \c Geometry are returned.

 It may be generated by one of the functions listed below:
- \li \c bgi::covered_by(geometry),
- \li \c bgi::disjoint(geometry),
- \li \c bgi::intersects(geometry) - default,
- \li \c bgi::overlaps(geometry),
- \li \c bgi::within(geometry),
- \li \c !bgi::covered_by(geometry),
- \li \c !bgi::disjoint(geometry),
- \li \c !bgi::intersects(geometry),
- \li \c !bgi::overlaps(geometry),
- \li \c !bgi::within(geometry)
- \li \c bgi::value(func).
+ \li \c boost::geometry::index::covered_by(),
+ \li \c boost::geometry::index::disjoint(),
+ \li \c boost::geometry::index::intersects() - default,
+ \li \c boost::geometry::index::overlaps(),
+ \li \c boost::geometry::index::within(),
+ \li <tt>! boost::geometry::index::covered_by()</tt>,
+ \li <tt>! boost::geometry::index::disjoint()</tt>,
+ \li <tt>! boost::geometry::index::intersects()</tt>,
+ \li <tt>! boost::geometry::index::overlaps()</tt>,
+ \li <tt>! boost::geometry::index::within()</tt>
+ \li \c boost::geometry::index::value().

 Those predicates may be passed together in
- \c std::pair<...> or \c boost::tuple<...>.
+ \c std::pair or \c boost::tuple.

 \param pred The spatial predicates or a Geometry.
 \param out_it The output iterator of the result range. E.g. an iterator generated by
@@ -631,22 +631,22 @@

 It is possible to define how distance to Value is calculated. This is done by passing PointRelation.
 It can be generated by following functions:
- \li bgi::to_nearest(Point) - default,
- \li bgi::to_centroid(Point),
- \li bgi::to_furthest(Point).
+ \li boost::geometry::index::to_nearest() - default,
+ \li boost::geometry::index::to_centroid(),
+ \li boost::geometry::index::to_furthest().

 It is possible to define define distances bounds, for example that some distance must be between
 min_distance and max_distance. This is done by passing DistancesPredicates which can be generated
 by following functions:
- \li bgi::unbounded(PointRelation) - default,
- \li bgi::min_bounded(PointRelation, MinRelation),
- \li bgi::max_bounded(PointRelation, MaxRelation),
- \li bgi::bounded(PointRelation, MinRelation, MaxRelation).
+ \li boost::geometry::index::unbounded() - default,
+ \li boost::geometry::index::min_bounded(),
+ \li boost::geometry::index::max_bounded(),
+ \li boost::geometry::index::bounded().

 MinRelation and MaxRelation describes bounds and can be generated by following functions:
- \li bgi::to_nearest(some_distance),
- \li bgi::to_centroid(some_distance),
- \li bgi::to_furthest(some_distance).
+ \li boost::geometry::index::to_nearest(),
+ \li boost::geometry::index::to_centroid(),
+ \li boost::geometry::index::to_furthest().

 \param dpred The distances predicates or a Point.

@@ -671,40 +671,40 @@

 It is possible to define how distance to Value is calculated. This is done by passing PointRelation.
 It can be generated by following functions:
- \li bgi::to_nearest(Point) - default,
- \li bgi::to_centroid(Point),
- \li bgi::to_furthest(Point).
+ \li boost::geometry::index::to_nearest() - default,
+ \li boost::geometry::index::to_centroid(),
+ \li boost::geometry::index::to_furthest().

 It is possible to define define distances bounds, for example that some distance must be between
 min_distance and max_distance. This is done by passing DistancesPredicates which can be generated
 by following functions:
- \li bgi::unbounded(PointRelation) - default,
- \li bgi::min_bounded(PointRelation, MinRelation),
- \li bgi::max_bounded(PointRelation, MaxRelation),
- \li bgi::bounded(PointRelation, MinRelation, MaxRelation).
+ \li boost::geometry::index::unbounded() - default,
+ \li boost::geometry::index::min_bounded(),
+ \li boost::geometry::index::max_bounded(),
+ \li boost::geometry::index::bounded().

 MinRelation and MaxRelation describes bounds and can be generated by following functions:
- \li bgi::to_nearest(some_distance),
- \li bgi::to_centroid(some_distance),
- \li bgi::to_furthest(some_distance).
+ \li boost::geometry::index::to_nearest(),
+ \li boost::geometry::index::to_centroid(),
+ \li boost::geometry::index::to_furthest().

 Spatial predicates may be a \c Geometry. In this case Values intersecting the \c Geometry are returned.

 It may be generated by one of the functions listed below:
- \li \c bgi::covered_by(geometry),
- \li \c bgi::disjoint(geometry),
- \li \c bgi::intersects(geometry) - default,
- \li \c bgi::overlaps(geometry),
- \li \c bgi::within(geometry),
- \li \c !bgi::covered_by(geometry),
- \li \c !bgi::disjoint(geometry),
- \li \c !bgi::intersects(geometry),
- \li \c !bgi::overlaps(geometry),
- \li \c !bgi::within(geometry)
- \li \c bgi::value(func).
+ \li \c boost::geometry::index::covered_by(),
+ \li \c boost::geometry::index::disjoint(),
+ \li \c boost::geometry::index::intersects() - default,
+ \li \c boost::geometry::index::overlaps(),
+ \li \c boost::geometry::index::within(),
+ \li <tt>! boost::geometry::index::covered_by()</tt>,
+ \li <tt>! boost::geometry::index::disjoint()</tt>,
+ \li <tt>! boost::geometry::index::intersects()</tt>,
+ \li <tt>! boost::geometry::index::overlaps()</tt>,
+ \li <tt>! boost::geometry::index::within()</tt>
+ \li \c boost::geometry::index::value().

 Those predicates may be passed together in
- \c std::pair<...> or \c boost::tuple<...>.
+ \c std::pair or \c boost::tuple.

 \param dpred The distances predicates or a Point.
 \param pred The spatial predicates or a Geometry
@@ -728,22 +728,22 @@

 It is possible to define how distance to Value is calculated. This is done by passing PointRelation.
 It can be generated by following functions:
- \li bgi::to_nearest(Point) - default,
- \li bgi::to_centroid(Point),
- \li bgi::to_furthest(Point).
+ \li boost::geometry::index::to_nearest() - default,
+ \li boost::geometry::index::to_centroid(),
+ \li boost::geometry::index::to_furthest().

 It is possible to define define distances bounds, for example that some distance must be between
 min_distance and max_distance. This is done by passing DistancesPredicates which can be generated
 by following functions:
- \li bgi::unbounded(PointRelation) - default,
- \li bgi::min_bounded(PointRelation, MinRelation),
- \li bgi::max_bounded(PointRelation, MaxRelation),
- \li bgi::bounded(PointRelation, MinRelation, MaxRelation).
+ \li boost::geometry::index::unbounded() - default,
+ \li boost::geometry::index::min_bounded(),
+ \li boost::geometry::index::max_bounded(),
+ \li boost::geometry::index::bounded().

 MinRelation and MaxRelation describes bounds and can be generated by following functions:
- \li bgi::to_nearest(some_distance),
- \li bgi::to_centroid(some_distance),
- \li bgi::to_furthest(some_distance).
+ \li boost::geometry::index::to_nearest(),
+ \li boost::geometry::index::to_centroid(),
+ \li boost::geometry::index::to_furthest().

 \param dpred The distances predicates or a Point.
 \param k The max number of values.
@@ -768,40 +768,40 @@

 It is possible to define how distance to Value is calculated. This is done by passing PointRelation.
 It can be generated by following functions:
- \li bgi::to_nearest(Point) - default,
- \li bgi::to_centroid(Point),
- \li bgi::to_furthest(Point).
+ \li boost::geometry::index::to_nearest() - default,
+ \li boost::geometry::index::to_centroid(),
+ \li boost::geometry::index::to_furthest().

 It is possible to define define distances bounds, for example that some distance must be between
 min_distance and max_distance. This is done by passing DistancesPredicates which can be generated
 by following functions:
- \li bgi::unbounded(PointRelation) - default,
- \li bgi::min_bounded(PointRelation, MinRelation),
- \li bgi::max_bounded(PointRelation, MaxRelation),
- \li bgi::bounded(PointRelation, MinRelation, MaxRelation).
+ \li boost::geometry::index::unbounded() - default,
+ \li boost::geometry::index::min_bounded(),
+ \li boost::geometry::index::max_bounded(),
+ \li boost::geometry::index::bounded().

 MinRelation and MaxRelation describes bounds and can be generated by following functions:
- \li bgi::to_nearest(some_distance),
- \li bgi::to_centroid(some_distance),
- \li bgi::to_furthest(some_distance).
+ \li boost::geometry::index::to_nearest(),
+ \li boost::geometry::index::to_centroid(),
+ \li boost::geometry::index::to_furthest().

 Spatial predicates may be a \c Geometry. In this case Values intersecting the \c Geometry are returned.

 It may be generated by one of the functions listed below:
- \li \c bgi::covered_by(geometry),
- \li \c bgi::disjoint(geometry),
- \li \c bgi::intersects(geometry) - default,
- \li \c bgi::overlaps(geometry),
- \li \c bgi::within(geometry),
- \li \c !bgi::covered_by(geometry),
- \li \c !bgi::disjoint(geometry),
- \li \c !bgi::intersects(geometry),
- \li \c !bgi::overlaps(geometry),
- \li \c !bgi::within(geometry)
- \li \c bgi::value(func).
+ \li \c boost::geometry::index::covered_by(),
+ \li \c boost::geometry::index::disjoint(),
+ \li \c boost::geometry::index::intersects() - default,
+ \li \c boost::geometry::index::overlaps(),
+ \li \c boost::geometry::index::within(),
+ \li <tt>! boost::geometry::index::covered_by()</tt>,
+ \li <tt>! boost::geometry::index::disjoint()</tt>,
+ \li <tt>! boost::geometry::index::intersects()</tt>,
+ \li <tt>! boost::geometry::index::overlaps()</tt>,
+ \li <tt>! boost::geometry::index::within()</tt>
+ \li \c boost::geometry::index::value().

 Those predicates may be passed together in
- \c std::pair<...> or \c boost::tuple<...>.
+ \c std::pair or \c boost::tuple.

 \param dpred The distances predicates or a Point
 \param k The max number of values.

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