diff --git a/doc/Doxyfile b/doc/Doxyfile index b6153ae9c..b43f01eaa 100644 --- a/doc/Doxyfile +++ b/doc/Doxyfile @@ -665,7 +665,8 @@ WARN_LOGFILE = # directories like "/usr/src/myproject". Separate the files or directories # with spaces. -INPUT = ../boost/geometry/extensions/index/rtree/rtree.hpp +INPUT = ../boost/geometry/extensions/index/ \ + ../boost/geometry/extensions/index/rtree # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is diff --git a/doc/html/geometry_index/r_tree.html b/doc/html/geometry_index/r_tree.html index a33049cd4..003a1f998 100644 --- a/doc/html/geometry_index/r_tree.html +++ b/doc/html/geometry_index/r_tree.html @@ -77,8 +77,12 @@
Reference
boost::geometry::index::rtree
-
boost::geometry::index::rtree - - global functions
+
Functions + related to the rtree (boost::geometry::index::)
+
Predicates + (boost::geometry::index::)
+
Distance + predicates (boost::geometry::index::)
diff --git a/doc/html/geometry_index/r_tree/reference.html b/doc/html/geometry_index/r_tree/reference.html index a71b8dd98..3b9a9bcd6 100644 --- a/doc/html/geometry_index/r_tree/reference.html +++ b/doc/html/geometry_index/r_tree/reference.html @@ -27,15 +27,19 @@
boost::geometry::index::rtree
-
boost::geometry::index::rtree - - global functions
+
Functions + related to the rtree (boost::geometry::index::)
+
Predicates + (boost::geometry::index::)
+
Distance + predicates (boost::geometry::index::)

boost::geometry::index::rtree

- + The R-tree spatial index.

@@ -3176,8 +3180,8 @@ The R-tree spatial index.

-boost::geometry::index::rtree - - global functions +Functions + related to the rtree (boost::geometry::index::)

@@ -3200,7 +3204,7 @@ The R-tree spatial index. @@ -3227,7 +3231,7 @@ The R-tree spatial index. @@ -3268,7 +3272,7 @@ The R-tree spatial index. @@ -3375,7 +3379,7 @@ The R-tree spatial index. @@ -3388,7 +3392,7 @@ The R-tree spatial index. @@ -3401,7 +3405,7 @@ The R-tree spatial index. @@ -3416,15 +3420,15 @@ The R-tree spatial index.

- insert(rtree<...> + insert(rtree<...> &, Value const &)

@@ -3214,7 +3218,7 @@ The R-tree spatial index.

- insert(rtree<...> + insert(rtree<...> &, Iterator, Iterator)

- insert(rtree<...> + insert(rtree<...> &, Range const &)

@@ -3241,7 +3245,7 @@ The R-tree spatial index.

- remove(rtree<...> + remove(rtree<...> &, Value const &)

@@ -3255,7 +3259,7 @@ The R-tree spatial index.

- remove(rtree<...> + remove(rtree<...> &, Iterator, Iterator)

- remove(rtree<...> + remove(rtree<...> &, Range const &)

@@ -3282,7 +3286,7 @@ The R-tree spatial index.

- spatial_query(rtree<...> + spatial_query(rtree<...> const &, Predicates const &, OutIter) @@ -3297,7 +3301,7 @@ The R-tree spatial index.

- nearest_query(rtree<...> + nearest_query(rtree<...> const &, DistancesPredicates const &, Value &) @@ -3312,7 +3316,7 @@ The R-tree spatial index.

- nearest_query(rtree<...> + nearest_query(rtree<...> const &, DistancesPredicates const &, Predicates const @@ -3329,7 +3333,7 @@ The R-tree spatial index.

- nearest_query(rtree<...> + nearest_query(rtree<...> const &, DistancesPredicates const &, size_t, @@ -3345,7 +3349,7 @@ The R-tree spatial index.

- nearest_query(rtree<...> + nearest_query(rtree<...> const &, DistancesPredicates const &, size_t, @@ -3362,7 +3366,7 @@ The R-tree spatial index.

- clear(rtree<...> + clear(rtree<...> &)

- size(rtree<...> + size(rtree<...> const &)

- empty(rtree<...> + empty(rtree<...> const &)

- box(rtree<...> + box(rtree<...> const &)

-insert(rtree<...> +insert(rtree<...> &, Value const &)

Insert a value to the index.

- - Synopsis + + Synopsis

@@ -3436,8 +3440,8 @@ The R-tree spatial index.

- - Parameters + + Parameters
@@ -3511,15 +3515,15 @@ The R-tree spatial index.

Insert a range of values to the index.

- - Synopsis + + Synopsis

@@ -3534,8 +3538,8 @@ The R-tree spatial index.

- - Parameters + + Parameters
@@ -3625,15 +3629,15 @@ The R-tree spatial index.

Insert a range of values to the index.

- - Synopsis + + Synopsis

@@ -3646,8 +3650,8 @@ The R-tree spatial index.

- - Parameters + + Parameters
@@ -3721,23 +3725,23 @@ The R-tree spatial index.

Remove a value from the container.

- - Description + + Description

Remove a value from the container. In contrast to the STL set/map erase() method this function removes only one value from the container.

- - Synopsis + + Synopsis

@@ -3749,8 +3753,8 @@ The R-tree spatial index.

- - Parameters + + Parameters
@@ -3819,8 +3823,8 @@ The R-tree spatial index.
- - Returns + + Returns

1 if value was removed, 0 otherwise. @@ -3831,15 +3835,15 @@ The R-tree spatial index.

Remove a range of values from the container.

- - Description + + Description

Remove a range of values from the container. In contrast to the STL set/map @@ -3849,8 +3853,8 @@ The R-tree spatial index. not all equal values.

- - Synopsis + + Synopsis

@@ -3865,8 +3869,8 @@ The R-tree spatial index.

- - Parameters + + Parameters
@@ -3951,8 +3955,8 @@ The R-tree spatial index.
- - Returns + + Returns

The number of removed values. @@ -3963,15 +3967,15 @@ The R-tree spatial index.

Remove a range of values from the container.

- - Description + + Description

Remove a range of values from the container. In contrast to the STL set/map @@ -3980,8 +3984,8 @@ The R-tree spatial index. not all equal values.

- - Synopsis + + Synopsis

@@ -3994,8 +3998,8 @@ The R-tree spatial index.

- - Parameters + + Parameters
@@ -4064,8 +4068,8 @@ The R-tree spatial index.
- - Returns + + Returns

The number of removed values. @@ -4076,15 +4080,15 @@ The R-tree spatial index.

Find values meeting spatial predicates.

- - Synopsis + + Synopsis

@@ -4100,8 +4104,8 @@ The R-tree spatial index.

- - Parameters + + Parameters
@@ -4186,8 +4190,8 @@ The R-tree spatial index.
- - Returns + + Returns

The number of found values. @@ -4198,15 +4202,15 @@ The R-tree spatial index.

Find the value meeting distances predicates.

- - Synopsis + + Synopsis

@@ -4221,8 +4225,8 @@ The R-tree spatial index.

- - Parameters + + Parameters
@@ -4308,8 +4312,8 @@ The R-tree spatial index.
- - Returns + + Returns

The number of found values. @@ -4320,7 +4324,7 @@ The R-tree spatial index.

@@ -4328,8 +4332,8 @@ The R-tree spatial index. Find the value meeting distances and spatial predicates.

- - Synopsis + + Synopsis

@@ -4346,8 +4350,8 @@ The R-tree spatial index.

- - Parameters + + Parameters
@@ -4450,8 +4454,8 @@ The R-tree spatial index.
- - Returns + + Returns

The number of found values. @@ -4462,15 +4466,15 @@ The R-tree spatial index.

Find k values meeting distances predicates.

- - Synopsis + + Synopsis

@@ -4487,8 +4491,8 @@ The R-tree spatial index.

- - Parameters + + Parameters
@@ -4591,8 +4595,8 @@ The R-tree spatial index.
- - Returns + + Returns

The number of found values. @@ -4603,7 +4607,7 @@ The R-tree spatial index.

@@ -4611,8 +4615,8 @@ The R-tree spatial index. Find k values meeting distances and spatial predicates.

- - Synopsis + + Synopsis

@@ -4631,8 +4635,8 @@ The R-tree spatial index.

- - Parameters + + Parameters
@@ -4752,8 +4756,8 @@ The R-tree spatial index.
- - Returns + + Returns

The number of found values. @@ -4764,15 +4768,15 @@ The R-tree spatial index.

Remove all values from the index.

- - Synopsis + + Synopsis

@@ -4784,8 +4788,8 @@ The R-tree spatial index.

- - Parameters + + Parameters
@@ -4839,15 +4843,15 @@ The R-tree spatial index.

Get the number of values stored in the index.

- - Synopsis + + Synopsis

@@ -4859,8 +4863,8 @@ The R-tree spatial index.

- - Parameters + + Parameters
@@ -4909,8 +4913,8 @@ The R-tree spatial index.
- - Returns + + Returns

The number of values stored in the index. @@ -4921,15 +4925,15 @@ The R-tree spatial index.

Query if there are no values stored in the index.

- - Synopsis + + Synopsis

@@ -4941,8 +4945,8 @@ The R-tree spatial index.

- - Parameters + + Parameters
@@ -4991,8 +4995,8 @@ The R-tree spatial index.
- - Returns + + Returns

true if there are no values in the index. @@ -5003,7 +5007,7 @@ The R-tree spatial index.

@@ -5011,8 +5015,8 @@ The R-tree spatial index. has no values.

- - Synopsis + + Synopsis

@@ -5024,8 +5028,8 @@ The R-tree spatial index.

- - Parameters + + Parameters
@@ -5074,8 +5078,8 @@ The R-tree spatial index.
- - Returns + + Returns

The box containing all stored values or an invalid box. @@ -5085,6 +5089,1370 @@ The R-tree spatial index.

+
+
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Function +

+ 		+

+ Description +

+
+

+ empty() +

+ 		+

+ Generate empty predicate. +

+
+

+ value(ValuePredicate const + &) +

+ 		+

+ Generate value predicate. +

+
+

+ covered_by(Geometry const + &) +

+ 		+

+ Generate covered_by() predicate. +

+
+

+ disjoint(Geometry const + &) +

+ 		+

+ Generate disjoint() predicate. +

+
+

+ intersects(Geometry const + &) +

+ 		+

+ Generate intersects() predicate. +

+
+

+ overlaps(Geometry const + &) +

+ 		+

+ Generate overlaps() predicate. +

+
+

+ within(Geometry const + &) +

+ 		+

+ Generate within() predicate. +

+
+
+
+

+ Generate empty predicate. +

+
+ + Synopsis +
+

+

+
detail::empty boost::geometry::index::empty()
+

+

+
+

+
+

+
+
+

+ Generate value predicate. +

+
+ + Description +
+

+ A wrapper around user-defined functor describing if Value should be returned + by spatial query. +

+
+ + Synopsis +
+

+

+
template<typename ValuePredicate>
+detail::value<ValuePredicate> boost::geometry::index::value(ValuePredicate const & vpred)
+

+

+
+ + Parameters +
+
+++++ + + + + + + + + + + +
+

+ Type +

+ 		+

+ Name +

+ 		+

+ Description +

+
+

+ ValuePredicate const & +

+ 		+

+ vpred +

+ 		+

+ The functor. +

+
+
+

+
+

+
+
+

+ Generate covered_by() predicate. +

+
+ + Description +
+

+ Generate a predicate defining Value and Geometry relationship. Value + will be returned by the query if bg::covered_by(Indexable, Geometry) + returns true. +

+
+ + Synopsis +
+

+

+
template<typename Geometry>
+detail::covered_by<Geometry> boost::geometry::index::covered_by(Geometry const & g)
+

+

+
+ + Parameters +
+
+++++ + + + + + + + + + + +
+

+ Type +

+ 		+

+ Name +

+ 		+

+ Description +

+
+

+ Geometry const + & +

+ 		+

+ g +

+ 		+

+ The Geometry object. +

+
+
+

+
+

+
+
+

+ Generate disjoint() predicate. +

+
+ + Description +
+

+ Generate a predicate defining Value and Geometry relationship. Value + will be returned by the query if bg::disjoint(Indexable, Geometry) returns + true. +

+
+ + Synopsis +
+

+

+
template<typename Geometry>
+detail::disjoint<Geometry> boost::geometry::index::disjoint(Geometry const & g)
+

+

+
+ + Parameters +
+
+++++ + + + + + + + + + + +
+

+ Type +

+ 		+

+ Name +

+ 		+

+ Description +

+
+

+ Geometry const + & +

+ 		+

+ g +

+ 		+

+ The Geometry object. +

+
+
+

+
+

+
+
+

+ Generate intersects() predicate. +

+
+ + Description +
+

+ Generate a predicate defining Value and Geometry relationship. Value + will be returned by the query if bg::intersects(Indexable, Geometry) + returns true. +

+
+ + Synopsis +
+

+

+
template<typename Geometry>
+detail::intersects<Geometry> boost::geometry::index::intersects(Geometry const & g)
+

+

+
+ + Parameters +
+
+++++ + + + + + + + + + + +
+

+ Type +

+ 		+

+ Name +

+ 		+

+ Description +

+
+

+ Geometry const + & +

+ 		+

+ g +

+ 		+

+ The Geometry object. +

+
+
+

+
+

+
+
+

+ Generate overlaps() predicate. +

+
+ + Description +
+

+ Generate a predicate defining Value and Geometry relationship. Value + will be returned by the query if bg::overlaps(Indexable, Geometry) returns + true. +

+
+ + Synopsis +
+

+

+
template<typename Geometry>
+detail::overlaps<Geometry> boost::geometry::index::overlaps(Geometry const & g)
+

+

+
+ + Parameters +
+
+++++ + + + + + + + + + + +
+

+ Type +

+ 		+

+ Name +

+ 		+

+ Description +

+
+

+ Geometry const + & +

+ 		+

+ g +

+ 		+

+ The Geometry object. +

+
+
+

+
+

+
+
+

+ Generate within() predicate. +

+
+ + Description +
+

+ Generate a predicate defining Value and Geometry relationship. Value + will be returned by the query if bg::within(Indexable, Geometry) returns + true. +

+
+ + Synopsis +
+

+

+
template<typename Geometry>
+detail::within<Geometry> boost::geometry::index::within(Geometry const & g)
+

+

+
+ + Parameters +
+
+++++ + + + + + + + + + + +
+

+ Type +

+ 		+

+ Name +

+ 		+

+ Description +

+
+

+ Geometry const + & +

+ 		+

+ g +

+ 		+

+ The Geometry object. +

+
+
+

+
+

+
+
+
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

+ Function +

+ 		+

+ Description +

+
+

+ to_nearest(T const + &) +

+ 		+

+ Generate to_nearest() Point-Indexable relationship. +

+
+

+ to_centroid(T const + &) +

+ 		+

+ Generate to_centroid() Point-Indexable relationship. +

+
+

+ to_furthest(T const + &) +

+ 		+

+ Generate to_furthest() Point-Indexable relationship. +

+
+

+ unbounded(PointRelation const + &) +

+ 		+

+ Generate unbounded() distance predicate. +

+
+

+ min_bounded(PointRelation const + &, MinRelation + const &) +

+ 		+

+ Generate min_bounded() distance predicate. +

+
+

+ max_bounded(PointRelation const + &, MaxRelation + const &) +

+ 		+

+ Generate max_bounded() distance predicate. +

+
+

+ bounded(PointRelation const + &, MinRelation + const &, + MaxRelation const + &) +

+ 		+

+ Generate bounded() distance predicate. +

+
+
+
+

+ Generate to_nearest() Point-Indexable relationship. +

+
+ + Description +
+

+ Generate a nearest query Point and Value's Indexable relationship while + calculating distances. This function may be used to define that knn query + should calculate distances as smallest as possible between query Point + and Indexable's points. In other words it should be the distance to the + nearest Indexable's point. This function may be also used to define distances + bounds which indicates that Indexable's nearest point should be closer + or further than value v. This is default relation. +

+
+ + Synopsis +
+

+

+
template<typename T>
+detail::to_nearest<T> boost::geometry::index::to_nearest(T const & v)
+

+

+
+ + Parameters +
+
+++++ + + + + + + + + + + +
+

+ Type +

+ 		+

+ Name +

+ 		+

+ Description +

+
+

+ T const + & +

+ 		+

+ v +

+ 		+

+ Point or bound value. +

+
+
+

+
+

+
+
+

+ Generate to_centroid() Point-Indexable relationship. +

+
+ + Description +
+

+ Generate a nearest query Point and Value's Indexable relationship while + calculating distances. This function may be used to define that knn query + should calculate distances between query Point and Indexable's centroid. + This function may be also used to define distances bounds which indicates + that Indexable's centroid should be closer or further than value v. +

+
+ + Synopsis +
+

+

+
template<typename T>
+detail::to_centroid<T> boost::geometry::index::to_centroid(T const & v)
+

+

+
+ + Parameters +
+
+++++ + + + + + + + + + + +
+

+ Type +

+ 		+

+ Name +

+ 		+

+ Description +

+
+

+ T const + & +

+ 		+

+ v +

+ 		+

+ Point or bound value. +

+
+
+

+
+

+
+
+

+ Generate to_furthest() Point-Indexable relationship. +

+
+ + Description +
+

+ Generate a nearest query Point and Value's Indexable relationship while + calculating distances. This function may be used to define that knn query + should calculate distances as biggest as possible between query Point + and Indexable's points. In other words it should be the distance to the + furthest Indexable's point. This function may be also used to define + distances bounds which indicates that Indexable's furthest point should + be closer or further than value v. +

+
+ + Synopsis +
+

+

+
template<typename T>
+detail::to_furthest<T> boost::geometry::index::to_furthest(T const & v)
+

+

+
+ + Parameters +
+
+++++ + + + + + + + + + + +
+

+ Type +

+ 		+

+ Name +

+ 		+

+ Description +

+
+

+ T const + & +

+ 		+

+ v +

+ 		+

+ Point or bound value. +

+
+
+

+
+

+
+
+

+ Generate unbounded() distance predicate. +

+
+ + Description +
+

+ Generate a distance predicate. This defines distances bounds which are + used by knn query. This function indicates that there is no distance + bounds and Values should be returned if distances between Point and Indexable + are the smallest. Distance calculation is defined by PointRelation. This + is default nearest predicate. +

+
+ + Synopsis +
+

+

+
template<typename PointRelation>
+detail::unbounded<PointRelation> boost::geometry::index::unbounded(PointRelation const & pr)
+

+

+
+ + Parameters +
+
+++++ + + + + + + + + + + +
+

+ Type +

+ 		+

+ Name +

+ 		+

+ Description +

+
+

+ PointRelation const & +

+ 		+

+ pr +

+ 		+

+ The point relation. This may be generated by bgi::to_nearest(Point), + bgi::to_centroid(Point) or bgi::to_furthest(Point). +

+
+
+

+
+

+
+
+

+ Generate min_bounded() distance predicate. +

+
+ + Description +
+

+ Generate a distance predicate. This defines distances bounds which are + used by knn query. This function indicates that Values should be returned + only if distances between Point and Indexable are greater or equal to + some min_distance passed in MinRelation. Check for closest Value is defined + by PointRelation. So it is possible e.g. to return Values with centroids + closest to some Point but only if nearest points are further than some + distance. +

+
+ + Synopsis +
+

+

+
template<typename PointRelation, typename MinRelation>
+detail::min_bounded<PointRelation, MinRelation> boost::geometry::index::min_bounded(PointRelation const & pr, MinRelation const & minr)
+

+

+
+ + Parameters +
+
+++++ + + + + + + + + + + + + + + + + + +
+

+ Type +

+ 		+

+ Name +

+ 		+

+ Description +

+
+

+ PointRelation const & +

+ 		+

+ pr +

+ 		+

+ The point relation. This may be generated by bgi::to_nearest(Point), + bgi::to_centroid(Point) or bgi::to_furthest(Point). +

+
+

+ MinRelation const & +

+ 		+

+ minr +

+ 		+

+ The minimum bound relation. This may be generated by bgi::to_nearest(min_distance), + bgi::to_centroid(min_distance) or bgi::to_furthest(min_distance). +

+
+
+

+
+

+
+
+

+ Generate max_bounded() distance predicate. +

+
+ + Description +
+

+ Generate a distance predicate. This defines distances bounds which are + used by knn query. This function indicates that Values should be returned + only if distances between Point and Indexable are lesser or equal to + some max_distance passed in MaxRelation. Check for closest Value is defined + by PointRelation. So it is possible e.g. to return Values with centroids + closest to some Point but only if nearest points are closer than some + distance. +

+
+ + Synopsis +
+

+

+
template<typename PointRelation, typename MaxRelation>
+detail::max_bounded<PointRelation, MaxRelation> boost::geometry::index::max_bounded(PointRelation const & pr, MaxRelation const & maxr)
+

+

+
+ + Parameters +
+
+++++ + + + + + + + + + + + + + + + + + +
+

+ Type +

+ 		+

+ Name +

+ 		+

+ Description +

+
+

+ PointRelation const & +

+ 		+

+ pr +

+ 		+

+ The point relation. This may be generated by bgi::to_nearest(Point), + bgi::to_centroid(Point) or bgi::to_furthest(Point). +

+
+

+ MaxRelation const & +

+ 		+

+ maxr +

+ 		+

+ The maximum bound relation. This may be generated by bgi::to_nearest(max_distance), + bgi::to_centroid(max_distance) or bgi::to_furthest(max_distance). +

+
+
+

+
+

+
+
+

+ Generate bounded() distance predicate. +

+
+ + Description +
+

+ Generate a distance predicate. This defines distances bounds which are + used by knn query. This function indicates that Values should be returned + only if distances between Point and Indexable are greater or equal to + some min_distance passed in MinRelation and lesser or equal to some max_distance + passed in MaxRelation. Check for closest Value is defined by PointRelation. + So it is possible e.g. to return Values with centroids closest to some + Point but only if nearest points are further than some distance and closer + than some other distance. +

+
+ + Synopsis +
+

+

+
template<typename PointRelation,
+         typename MinRelation,
+         typename MaxRelation>
+detail::bounded<PointRelation, MinRelation, MaxRelation> boost::geometry::index::bounded(PointRelation const & pr,
+                                                                                         MinRelation const & minr,
+                                                                                         MaxRelation const & maxr)
+

+

+
+ + Parameters +
+
+++++ + + + + + + + + + + + + + + + + + + + + + + +
+

+ Type +

+ 		+

+ Name +

+ 		+

+ Description +

+
+

+ PointRelation const & +

+ 		+

+ pr +

+ 		+

+ The point relation. This may be generated by bgi::to_nearest(Point), + bgi::to_centroid(Point) or bgi::to_furthest(Point). +

+
+

+ MinRelation const & +

+ 		+

+ minr +

+ 		+

+ The minimum bound relation. This may be generated by bgi::to_nearest(min_distance), + bgi::to_centroid(min_distance) or bgi::to_furthest(min_distance). +

+
+

+ MaxRelation const & +

+ 		+

+ maxr +

+ 		+

+ The maximum bound relation. This may be generated by bgi::to_nearest(max_distance), + bgi::to_centroid(max_distance) or bgi::to_furthest(max_distance). +

+
+
+

+
+

+
diff --git a/doc/html/index.html b/doc/html/index.html index db38adc81..7a164ce02 100644 --- a/doc/html/index.html +++ b/doc/html/index.html @@ -56,7 +56,7 @@
- +

Last revised: January 08, 2013 at 23:01:28 GMT

Last revised: January 08, 2013 at 23:37:30 GMT
diff --git a/doc/make_qbk.py b/doc/make_qbk.py index 1fc61d148..fa1eba72b 100755 --- a/doc/make_qbk.py +++ b/doc/make_qbk.py @@ -19,6 +19,8 @@ cmd = cmd + " > generated/%s.qbk" os.system("doxygen Doxyfile") os.system(cmd % ("classboost_1_1geometry_1_1index_1_1rtree", "geometry_index.r_tree.reference", "rtree")) -os.system(cmd % ("group__rtree__group", "geometry_index.r_tree.reference", "rtree_group")) +os.system(cmd % ("group__rtree__functions", "geometry_index.r_tree.reference", "rtree_functions")) +os.system(cmd % ("group__predicates", "geometry_index.r_tree.reference", "predicates")) +os.system(cmd % ("group__distance__predicates", "geometry_index.r_tree.reference", "distance_predicates")) os.system("b2") diff --git a/doc/rtree.qbk b/doc/rtree.qbk index 1c116f39a..68f211273 100644 --- a/doc/rtree.qbk +++ b/doc/rtree.qbk @@ -20,7 +20,9 @@ [section:reference Reference] [include generated/rtree.qbk] -[include generated/rtree_group.qbk] +[include generated/rtree_functions.qbk] +[include generated/predicates.qbk] +[include generated/distance_predicates.qbk] [endsect] diff --git a/doc/src/tools/doxygen_xml2qbk/quickbook_output.hpp b/doc/src/tools/doxygen_xml2qbk/quickbook_output.hpp index ad25d4388..8302a1dde 100644 --- a/doc/src/tools/doxygen_xml2qbk/quickbook_output.hpp +++ b/doc/src/tools/doxygen_xml2qbk/quickbook_output.hpp @@ -813,7 +813,7 @@ void quickbook_output_alt(documentation const& doc, configuration const& config, if ( !doc.group_id.empty() ) { id_prefix = doc.group_id + ".function"; - std::cout << "[section:" << doc.group_id << " " << doc.group_title << " - global functions]" << std::endl; + std::cout << "[section:" << doc.group_id << " " << doc.group_title << "]" << std::endl; } quickbook_output_function(doc.functions, function_constructor_destructor, config, id_prefix, out, true); diff --git a/include/boost/geometry/extensions/index/distance_predicates.hpp b/include/boost/geometry/extensions/index/distance_predicates.hpp index afc0d2bdf..5f4d53ed8 100644 --- a/include/boost/geometry/extensions/index/distance_predicates.hpp +++ b/include/boost/geometry/extensions/index/distance_predicates.hpp @@ -17,6 +17,10 @@ #include +/*! +\defgroup distance_predicates Distance predicates (boost::geometry::index::) +*/ + namespace boost { namespace geometry { namespace index { //TODO: awulkiew - consider storing values instead of const references @@ -102,6 +106,8 @@ struct relation< to_furthest > // relations generators /*! +\brief Generate to_nearest() Point-Indexable relationship. + Generate a nearest query Point and Value's Indexable relationship while calculating distances. This function may be used to define that knn query should calculate distances as smallest as possible between query Point and Indexable's points. In other words it @@ -109,6 +115,8 @@ should be the distance to the nearest Indexable's point. This function may be al to define distances bounds which indicates that Indexable's nearest point should be closer or further than value v. This is default relation. +\ingroup distance_predicates + \tparam T Type of wrapped object. This may be a Point for PointRelation or some Value for MinRelation or MaxRelation @@ -121,12 +129,16 @@ detail::to_nearest to_nearest(T const& v) } /*! +\brief Generate to_centroid() Point-Indexable relationship. + Generate a nearest query Point and Value's Indexable relationship while calculating distances. This function may be used to define that knn query should calculate distances between query Point and Indexable's centroid. This function may be also used to define distances bounds which indicates that Indexable's centroid should be closer or further than value v. +\ingroup distance_predicates + \tparam T Type of wrapped object. This may be a Point for PointRelation or some Value for MinRelation or MaxRelation @@ -139,6 +151,8 @@ detail::to_centroid to_centroid(T const& v) } /*! +\brief Generate to_furthest() Point-Indexable relationship. + Generate a nearest query Point and Value's Indexable relationship while calculating distances. This function may be used to define that knn query should calculate distances as biggest as possible between query Point and Indexable's points. In other words it @@ -146,6 +160,8 @@ should be the distance to the furthest Indexable's point. This function may be a to define distances bounds which indicates that Indexable's furthest point should be closer or further than value v. +\ingroup distance_predicates + \tparam T Type of wrapped object. This may be a Point for PointRelation or some Value for MinRelation or MaxRelation @@ -237,11 +253,15 @@ struct bounded // distance predicates generators /*! +\brief Generate unbounded() distance predicate. + Generate a distance predicate. This defines distances bounds which are used by knn query. This function indicates that there is no distance bounds and Values should be returned if distances between Point and Indexable are the smallest. Distance calculation is defined by PointRelation. This is default nearest predicate. +\ingroup distance_predicates + \tparam PointRelation PointRelation type. \param pr The point relation. This may be generated by bgi::to_nearest(Point), @@ -255,12 +275,16 @@ unbounded(PointRelation const& pr) } /*! +\brief Generate min_bounded() distance predicate. + Generate a distance predicate. This defines distances bounds which are used by knn query. This function indicates that Values should be returned only if distances between Point and Indexable are greater or equal to some min_distance passed in MinRelation. Check for closest Value is defined by PointRelation. So it is possible e.g. to return Values with centroids closest to some Point but only if nearest points are further than some distance. +\ingroup distance_predicates + \tparam PointRelation PointRelation type. \tparam MinRelation MinRelation type. @@ -277,12 +301,16 @@ min_bounded(PointRelation const& pr, MinRelation const& minr) } /*! +\brief Generate max_bounded() distance predicate. + Generate a distance predicate. This defines distances bounds which are used by knn query. This function indicates that Values should be returned only if distances between Point and Indexable are lesser or equal to some max_distance passed in MaxRelation. Check for closest Value is defined by PointRelation. So it is possible e.g. to return Values with centroids closest to some Point but only if nearest points are closer than some distance. +\ingroup distance_predicates + \tparam PointRelation PointRelation type. \tparam MaxRelation MaxRelation type. @@ -299,6 +327,8 @@ max_bounded(PointRelation const& pr, MaxRelation const& maxr) } /*! +\brief Generate bounded() distance predicate. + Generate a distance predicate. This defines distances bounds which are used by knn query. This function indicates that Values should be returned only if distances between Point and Indexable are greater or equal to some min_distance passed in MinRelation and lesser or equal to @@ -306,6 +336,8 @@ some max_distance passed in MaxRelation. Check for closest Value is defined by P So it is possible e.g. to return Values with centroids closest to some Point but only if nearest points are further than some distance and closer than some other distance. +\ingroup distance_predicates + \tparam PointRelation PointRelation type. \tparam MinRelation MinRelation type. \tparam MaxRelation MaxRelation type. diff --git a/include/boost/geometry/extensions/index/predicates.hpp b/include/boost/geometry/extensions/index/predicates.hpp index 3a9777d26..78f08f970 100644 --- a/include/boost/geometry/extensions/index/predicates.hpp +++ b/include/boost/geometry/extensions/index/predicates.hpp @@ -18,6 +18,10 @@ // TODO: awulkiew - temporary #include +/*! +\defgroup predicates Predicates (boost::geometry::index::) +*/ + namespace boost { namespace geometry { namespace index { namespace detail { @@ -122,7 +126,9 @@ struct not_within // generators /*! -Generate empty predicate. +\brief Generate empty predicate. + +\ingroup predicates */ inline detail::empty empty() { @@ -130,9 +136,13 @@ inline detail::empty empty() } /*! -Generate value predicate. A wrapper around user-defined functor +\brief Generate value predicate. + +A wrapper around user-defined functor describing if Value should be returned by spatial query. +\ingroup predicates + \tparam ValuePredicate Functor type. \param vpred The functor. @@ -144,10 +154,14 @@ inline detail::value value(ValuePredicate const& vpred) } /*! +\brief Generate covered_by() predicate. + Generate a predicate defining Value and Geometry relationship. Value will be returned by the query if bg::covered_by(Indexable, Geometry) returns true. +\ingroup predicates + \tparam Geometry The Geometry type. \param g The Geometry object. @@ -159,10 +173,14 @@ inline detail::covered_by covered_by(Geometry const& g) } /*! +\brief Generate disjoint() predicate. + Generate a predicate defining Value and Geometry relationship. Value will be returned by the query if bg::disjoint(Indexable, Geometry) returns true. +\ingroup predicates + \tparam Geometry The Geometry type. \param g The Geometry object. @@ -174,10 +192,14 @@ inline detail::disjoint disjoint(Geometry const& g) } /*! +\brief Generate intersects() predicate. + Generate a predicate defining Value and Geometry relationship. Value will be returned by the query if bg::intersects(Indexable, Geometry) returns true. +\ingroup predicates + \tparam Geometry The Geometry type. \param g The Geometry object. @@ -189,10 +211,14 @@ inline detail::intersects intersects(Geometry const& g) } /*! +\brief Generate overlaps() predicate. + Generate a predicate defining Value and Geometry relationship. Value will be returned by the query if bg::overlaps(Indexable, Geometry) returns true. +\ingroup predicates + \tparam Geometry The Geometry type. \param g The Geometry object. @@ -204,10 +230,14 @@ inline detail::overlaps overlaps(Geometry const& g) } //*! +//\brief Generate touches() predicate. +// //Generate a predicate defining Value and Geometry relationship. //Value will be returned by the query if bg::touches(Indexable, Geometry) //returns true. // +//\ingroup predicates +// //\tparam Geometry The Geometry type. // //\param g The Geometry object. @@ -219,10 +249,14 @@ inline detail::overlaps overlaps(Geometry const& g) //} /*! +\brief Generate within() predicate. + Generate a predicate defining Value and Geometry relationship. Value will be returned by the query if bg::within(Indexable, Geometry) returns true. +\ingroup predicates + \tparam Geometry The Geometry type. \param g The Geometry object. diff --git a/include/boost/geometry/extensions/index/rtree/rtree.hpp b/include/boost/geometry/extensions/index/rtree/rtree.hpp index c8b2752b6..fd865ded6 100644 --- a/include/boost/geometry/extensions/index/rtree/rtree.hpp +++ b/include/boost/geometry/extensions/index/rtree/rtree.hpp @@ -50,12 +50,12 @@ // TODO change the name to bounding_tree -namespace boost { namespace geometry { namespace index { - /*! -\defgroup rtree_group boost::geometry::index::rtree +\defgroup rtree_functions Functions related to the rtree (boost::geometry::index::) */ +namespace boost { namespace geometry { namespace index { + /*! \brief The R-tree spatial index. @@ -81,8 +81,6 @@ or Box concepts (which are Indexables). It also handles std::pair, and iterators. E.g. If std::pair is stored, the default translator translates from std::pair const& to Box const&. -\ingroup rtree_group - \tparam Value The type of objects stored in the container. \tparam Parameters Compile-time parameters. \tparam Translator The type of the translator which translates from Value to Indexable. @@ -1160,7 +1158,7 @@ private: /*! \brief Insert a value to the index. -\ingroup rtree_group +\ingroup rtree_functions \param tree The spatial index. \param v The value which will be stored in the index. @@ -1174,7 +1172,7 @@ inline void insert(rtree & tree, Value co /*! \brief Insert a range of values to the index. -\ingroup rtree_group +\ingroup rtree_functions \param tree The spatial index. \param first The beginning of the range of values. @@ -1189,7 +1187,7 @@ inline void insert(rtree & tree, Iterator /*! \brief Insert a range of values to the index. -\ingroup rtree_group +\ingroup rtree_functions \param tree The spatial index. \param rng The range of values. @@ -1206,7 +1204,7 @@ inline void insert(rtree & tree, Range co Remove a value from the container. In contrast to the STL set/map erase() method this function removes only one value from the container. -\ingroup rtree_group +\ingroup rtree_functions \param tree The spatial index. \param v The value which will be removed from the index. @@ -1228,7 +1226,7 @@ it doesn't take iterators pointing to values stored in this container. It remove to these passed as a range. Furthermore this function removes only one value for each one passed in the range, not all equal values. -\ingroup rtree_group +\ingroup rtree_functions \param tree The spatial index. \param first The beginning of the range of values. @@ -1250,7 +1248,7 @@ Remove a range of values from the container. In contrast to the STL set/map eras it removes values equal to these passed as a range. Furthermore this method removes only one value for each one passed in the range, not all equal values. -\ingroup rtree_group +\ingroup rtree_functions \param tree The spatial index. \param rng The range of values. @@ -1267,7 +1265,7 @@ remove(rtree & tree, Range const& rng) /*! \brief Find values meeting spatial predicates. -\ingroup rtree_group +\ingroup rtree_functions \param tree The spatial index. \param pred The spatial predicates. @@ -1284,7 +1282,7 @@ inline size_t spatial_query(rtree const& /*! \brief Find the value meeting distances predicates. -\ingroup rtree_group +\ingroup rtree_functions \param tree The spatial index. \param dpred The distances predicates. @@ -1301,7 +1299,7 @@ inline size_t nearest_query(rtree const& /*! \brief Find the value meeting distances and spatial predicates. -\ingroup rtree_group +\ingroup rtree_functions \param tree The spatial index. \param dpred The distances predicates. @@ -1319,7 +1317,7 @@ inline size_t nearest_query(rtree const& /*! \brief Find k values meeting distances predicates. -\ingroup rtree_group +\ingroup rtree_functions \param tree The spatial index. \param dpred The distances predicates. @@ -1337,7 +1335,7 @@ inline size_t nearest_query(rtree const& /*! \brief Find k values meeting distances and spatial predicates. -\ingroup rtree_group +\ingroup rtree_functions \param tree The spatial index. \param dpred The distances predicates. @@ -1356,7 +1354,7 @@ inline size_t nearest_query(rtree const& /*! \brief Remove all values from the index. -\ingroup rtree_group +\ingroup rtree_functions \param tree The spatial index. */ @@ -1369,7 +1367,7 @@ inline void clear(rtree & tree) /*! \brief Get the number of values stored in the index. -\ingroup rtree_group +\ingroup rtree_functions \param tree The spatial index. @@ -1384,7 +1382,7 @@ inline size_t size(rtree const& tree) /*! \brief Query if there are no values stored in the index. -\ingroup rtree_group +\ingroup rtree_functions \param tree The spatial index. @@ -1399,7 +1397,7 @@ inline bool empty(rtree const& tree) /*! \brief Get the box containing all stored values or an invalid box if the index has no values. -\ingroup rtree_group +\ingroup rtree_functions \param tree The spatial index.