From 5e2db81daf3ed6091412bbed7f9e39c8a62d762d Mon Sep 17 00:00:00 2001 From: Adam Wulkiewicz Date: Sun, 3 Mar 2013 13:55:24 +0000 Subject: [PATCH] rtree: indexable_getter and value_equal description added. [SVN r83280] --- doc/generated/rtree.qbk | 48 +- doc/html/geometry_index/introduction.html | 2 +- doc/html/geometry_index/r_tree.html | 2 +- .../r_tree/creation_and_modification.html | 8 +- .../geometry_index/r_tree/introduction.html | 28 +- doc/html/geometry_index/r_tree/queries.html | 6 +- doc/html/geometry_index/r_tree/reference.html | 684 +++++++++++------- .../geometry_index/r_tree/rtree_examples.html | 2 +- .../r_tree/rtree_quickstart.html | 4 +- doc/html/index.html | 4 +- include/boost/geometry/index/rtree.hpp | 5 +- 11 files changed, 484 insertions(+), 309 deletions(-) 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 @@ Introduction - + diff --git a/doc/html/geometry_index/r_tree.html b/doc/html/geometry_index/r_tree.html index e66d1de71..5ffa01253 100644 --- a/doc/html/geometry_index/r_tree.html +++ b/doc/html/geometry_index/r_tree.html @@ -3,7 +3,7 @@ R-tree - + diff --git a/doc/html/geometry_index/r_tree/creation_and_modification.html b/doc/html/geometry_index/r_tree/creation_and_modification.html index 0a04217d9..ffb24455d 100644 --- a/doc/html/geometry_index/r_tree/creation_and_modification.html +++ b/doc/html/geometry_index/r_tree/creation_and_modification.html @@ -3,7 +3,7 @@ Creation and modification - + @@ -59,7 +59,7 @@ EqualTo = index::equal_to<Value>, Allocator = std::allocator<Value> > -