diff --git a/doc/generated/rtree.qbk b/doc/generated/rtree.qbk index 8e1d7c433..07610c04e 100644 --- a/doc/generated/rtree.qbk +++ b/doc/generated/rtree.qbk @@ -69,7 +69,9 @@ The Translator translates from Value to Indexable each time r-tree requires it. [[[#classboost_1_1geometry_1_1index_1_1rtree_1a80db5532eb59f7a809bd44ded265eb17] `parameters_type`][R-tree parameters type. ]] [[[#classboost_1_1geometry_1_1index_1_1rtree_1ab6618b5c7e88ed70533233fbac0f5b2e] `allocator_type`][The type of allocator used by the container. ]] [[[#classboost_1_1geometry_1_1index_1_1rtree_1a4b7187ed28a9035d68b2f7125ffae5b4] `size_type`][Unsigned integral type used by the container. ]] -[[[#classboost_1_1geometry_1_1index_1_1rtree_1ac6b09c3c32ec7ed2dee19459fdee92a2] `indexable_type`][The Indexable type to which Value is translated. ]] +[[[#classboost_1_1geometry_1_1index_1_1rtree_1a43a7adb311cafc08e23010ccb4e97fb5] `indexable_getter`][The function object extracting Indexable from Value. ]] +[[[#classboost_1_1geometry_1_1index_1_1rtree_1ad8fe544de514014a1bd87ea1b881ff9b] `value_equal`][The function object comparing objects of type Value. ]] +[[[#classboost_1_1geometry_1_1index_1_1rtree_1a4175e946d14b08f20f7126e2434e5646] `indexable_type`][The Indexable type to which Value is translated. ]] [[[#classboost_1_1geometry_1_1index_1_1rtree_1a89a6fd9a7c24f9d30422ef81ce2b959f] `bounds_type`][The Box type used by the R-tree. ]] ] @@ -105,7 +107,9 @@ The Translator translates from Value to Indexable each time r-tree requires it. [[][[link classboost_1_1geometry_1_1index_1_1rtree_1a1bec40977c175983f585c4488cf8fe3c `clear()`]][Removes all values stored in the container. ]] [[ `const`][[link classboost_1_1geometry_1_1index_1_1rtree_1a0dad06d0f117f45ed54b5c123cb41d6e `bounds()`]][Returns the box able to contain all values stored in the container. ]] [[ `const`][[link classboost_1_1geometry_1_1index_1_1rtree_1aaa834c241c191ac9de67f134564f36fa `count(ValueOrIndexable const &)`]][Count Values or Indexables stored in the container. ]] -[[ `const`][[link classboost_1_1geometry_1_1index_1_1rtree_1afef125f04ba51b50370fadc9c1b1e8bf `parameters()`]][Returns parameters. ]] +[[ `const`][[link classboost_1_1geometry_1_1index_1_1rtree_1a9076baef90a3a9c6018871fa25115a73 `parameters()`]][Returns parameters. ]] +[[ `const`][[link classboost_1_1geometry_1_1index_1_1rtree_1af391fd642a218c5fb10fc68d643a62b5 `indexable_get()`]][Returns function retrieving Indexable from Value. ]] +[[ `const`][[link classboost_1_1geometry_1_1index_1_1rtree_1a16424563d0973960ac01f7a1969eeebe `value_eq()`]][Returns function comparing Values. ]] [[ `const`][[link classboost_1_1geometry_1_1index_1_1rtree_1a17d9cef211feb7f674a5b4602f4cc81e `get_allocator()`]][Returns allocator used by the rtree. ]] ] @@ -781,14 +785,14 @@ Nothing. [endsect] -[#classboost_1_1geometry_1_1index_1_1rtree_1afef125f04ba51b50370fadc9c1b1e8bf] +[#classboost_1_1geometry_1_1index_1_1rtree_1a9076baef90a3a9c6018871fa25115a73] [section parameters()] Returns parameters. [heading Synopsis] [pre -[^[link classboost_1_1geometry_1_1index_1_1rtree_1a80db5532eb59f7a809bd44ded265eb17 parameters_type]]` const &` `parameters``()` +[^[link classboost_1_1geometry_1_1index_1_1rtree_1a80db5532eb59f7a809bd44ded265eb17 parameters_type]] `parameters``()` ] [heading Modifier(s)] @@ -799,6 +803,42 @@ Nothing. [endsect] +[#classboost_1_1geometry_1_1index_1_1rtree_1af391fd642a218c5fb10fc68d643a62b5] +[section indexable_get()] +Returns function retrieving Indexable from Value. + +[heading Synopsis] +[pre + +[^[link classboost_1_1geometry_1_1index_1_1rtree_1a43a7adb311cafc08e23010ccb4e97fb5 indexable_getter]] `indexable_get``()` +] + +[heading Modifier(s)] +``const ``[heading Returns] +The indexable_getter object. +[heading Throws] +Nothing. + +[endsect] + +[#classboost_1_1geometry_1_1index_1_1rtree_1a16424563d0973960ac01f7a1969eeebe] +[section value_eq()] +Returns function comparing Values. + +[heading Synopsis] +[pre + +[^[link classboost_1_1geometry_1_1index_1_1rtree_1ad8fe544de514014a1bd87ea1b881ff9b value_equal]] `value_eq``()` +] + +[heading Modifier(s)] +``const ``[heading Returns] +The value_equal function. +[heading Throws] +Nothing. + +[endsect] + [#classboost_1_1geometry_1_1index_1_1rtree_1a17d9cef211feb7f674a5b4602f4cc81e] [section get_allocator()] Returns allocator used by the rtree. diff --git a/doc/html/geometry_index/introduction.html b/doc/html/geometry_index/introduction.html index dd5718dbb..c00e43835 100644 --- a/doc/html/geometry_index/introduction.html +++ b/doc/html/geometry_index/introduction.html @@ -3,7 +3,7 @@
Value - type of object which will be stored in the container,
Indexable. Values types which can
be handled by the predefined function objects index::indexable<Value> and index::equal_to<Value> are defined as follows:
-Indexable = Point
| Box
@@ -128,7 +128,7 @@
If comparison of two Values is required, the predefined index::equal_to<Value>:
Point
and Box
diff --git a/doc/html/geometry_index/r_tree/introduction.html b/doc/html/geometry_index/r_tree/introduction.html
index 8dc523bbc..74f9022ec 100644
--- a/doc/html/geometry_index/r_tree/introduction.html
+++ b/doc/html/geometry_index/r_tree/introduction.html
@@ -3,7 +3,7 @@
R-tree is a tree data structure used for spatial searching. It was proposed - by Antonin Guttman in 1984 [1] as an expansion of B-tree for multi-dimensional data. It may + by Antonin Guttman in 1984 [1] as an expansion of B-tree for multi-dimensional data. It may be used to store points or volumetric data in order to perform a spatial query later. This query may return objects that are inside some area or are - close to some point in space [2]. + close to some point in space [2].
The R-tree structure is presented on the image below. Each R-tree's node @@ -51,7 +51,7 @@
The R-tree is a self-balanced data structure. The key part of balancing algorithm - is node splitting algorithm [3] [4]. Each algorithm produces different splits so the internal structure + is node splitting algorithm [3] [4]. Each algorithm produces different splits so the internal structure of a tree may be different for each one of them. In general more complex algorithms analyses elements better and produces less overlapping nodes. In the searching process less nodes must be traversed in order to find desired @@ -181,13 +181,13 @@
Key features of this implementation of the R-tree are:
-R-tree depends on Boost.Move, Boost.Container, Boost.Tuple, @@ -219,7 +219,7 @@
The spatial index was originally started by Federico J. Fernandez during @@ -227,7 +227,7 @@
@@ -235,20 +235,20 @@ J. Simonson for their support and ideas.
[1]
+
[1] Guttman, A. (1984). R-Trees: A Dynamic Index Structure for Spatial Searching
[2] +
[2] Cheung, K.; Fu, A. (1998). Enhanced Nearest Neighbour Search on the R-tree
[3] +
[3] Greene, D. (1989). An implementation and performance analysis of spatial data access methods
[4] +
[4] Beckmann, N.; Kriegel, H. P.; Schneider, R.; Seeger, B. (1990). The R*-tree: an efficient and robust access method for points and rectangles
Values which meets some predicates. Currently
supported are three types of predicates:
-For example queries may be used to retrieve Values:
-This is self-balancing spatial index capable to store various types of @@ -59,7 +59,7 @@
The user must pass a type defining the Parameters which will be used in @@ -69,7 +69,7 @@
Predefined algorithms with compile-time parameters are:
-boost::geometry::index::linear,
Predefined algorithms with run-time parameters are:
-boost::geometry::index::dynamic_linear,
The Translator translates from Value to Indexable each time r-tree requires @@ -113,14 +113,14 @@
#include <boost/geometry/index/rtree.hpp>
template<typename Value,typename Parameters,@@ -134,7 +134,7 @@
| + | +
+ + The function object extracting Indexable from Value. + + |
+
| + + | +
+ + The function object comparing objects of type Value. + + |
+
| + | @@ -316,7 +340,7 @@ |
| @@ -739,6 +763,40 @@ | |||
|
+
+ |
+
+
+ |
+
+ + Returns function retrieving Indexable from Value. + + |
+|
|
+
+ |
+
+
+ |
+
+ + Returns function comparing Values. + + |
+|
|
- Synopsis + Synopsis
- Modifier(s) + Modifier(s)@@ -783,7 +841,7 @@ - Parameter(s) + Parameter(s)- Throws + ThrowsIf allocator default constructor throws. @@ -879,7 +937,7 @@ - Synopsis + Synopsis
- Parameter(s) + Parameter(s)- Throws + ThrowsIf allocator copy constructor throws. @@ -1001,7 +1059,7 @@ - Synopsis + Synopsis
- Parameter(s) + Parameter(s)- Throws + Throws-
- Modifier(s) + Modifier(s)@@ -1191,7 +1249,7 @@ - Parameter(s) + Parameter(s)- Throws + Throws-
- Throws + ThrowsNothing. @@ -1354,20 +1412,20 @@ - Description + DescriptionIt uses parameters, translator and allocator from the source tree. - Synopsis + Synopsis
- Parameter(s) + Parameter(s)- Throws + Throws-
- Description + DescriptionIt uses Parameters and translator from the source tree. - Synopsis + Synopsis
- Parameter(s) + Parameter(s)- Throws + Throws-
- Description + DescriptionIt uses parameters, translator and allocator from the source tree. - Synopsis + Synopsis
- Parameter(s) + Parameter(s)- Throws + ThrowsNothing. @@ -1621,20 +1679,20 @@ - Description + DescriptionIt uses parameters and translator from the source tree. - Synopsis + Synopsis
- Parameter(s) + Parameter(s)- Throws + Throws-
- Description + DescriptionIt uses parameters and translator from the source tree. - Synopsis + Synopsis
- Parameter(s) + Parameter(s)- Throws + Throws-
- Description + DescriptionIt uses parameters and translator from the source tree. - Synopsis + Synopsis
- Parameter(s) + Parameter(s)- Throws + ThrowsOnly if allocators aren't equal. -
- Description + DescriptionParameters, translator and allocators are swapped as well. - Synopsis + Synopsis
- Parameter(s) + Parameter(s)- Throws + ThrowsIf allocators swap throws. @@ -1972,13 +2030,13 @@ - Synopsis + Synopsis
- Parameter(s) + Parameter(s)- Throws + Throws-
- Parameter(s) + Parameter(s)- Throws + Throws-
- Parameter(s) + Parameter(s)- Throws + Throws-
- Description + Description
In contrast to the - Synopsis + Synopsis
- Parameter(s) + Parameter(s)- Returns + Returns1 if the value was removed, 0 otherwise. - Throws + Throws-
- Description + Description
In contrast to the - Synopsis + Synopsis
- Parameter(s) + Parameter(s)- Returns + ReturnsThe number of removed values. - Throws + Throws-
- Description + Description
In contrast to the - Synopsis + Synopsis
- Parameter(s) + Parameter(s)- Returns + ReturnsThe number of removed values. - Throws + Throws-
- Description + DescriptionThis query function performs spatial and k-nearest neighbor searches. @@ -2599,7 +2657,7 @@ Spatial predicates may be generated by one of the functions listed below: -
It is possible to negate spatial predicates: -
- Functions + Functions- Returns + Returns1 if value was removed, 0 otherwise. @@ -3729,7 +3861,7 @@ - Description + Description
Remove a range of values from the container. In contrast to the - Synopsis + Synopsis
- Parameter(s) + Parameter(s)- Returns + ReturnsThe number of removed values. @@ -3860,7 +3992,7 @@ - Description + Description
Remove a range of values from the container. In contrast to the - Synopsis + Synopsis
- Parameter(s) + Parameter(s)- Returns + ReturnsThe number of removed values. @@ -3973,7 +4105,7 @@ - Description + DescriptionThis query function performs spatial and k-nearest neighbor searches. @@ -3986,7 +4118,7 @@ Spatial predicates may be generated by one of the functions listed below: -
It is possible to negate spatial predicates: -
|