[Boost-commit] svn:boost r80151 - sandbox-branches/geometry/index/boost/geometry/extensions/index/rtree

Subject: [Boost-commit] svn:boost r80151 - sandbox-branches/geometry/index/boost/geometry/extensions/index/rtree
From: adam.wulkiewicz_at_[hidden]
Date: 2012-08-22 21:04:01

Author: awulkiew
Date: 2012-08-22 21:04:00 EDT (Wed, 22 Aug 2012)
New Revision: 80151
URL: http://svn.boost.org/trac/boost/changeset/80151

Log:
Predefined r-tree creation algorithms parameters described.
Text files modified: 
   sandbox-branches/geometry/index/boost/geometry/extensions/index/rtree/options.hpp |    22 ++++++++++++++++++++++                  
   1 files changed, 22 insertions(+), 0 deletions(-)

Modified: sandbox-branches/geometry/index/boost/geometry/extensions/index/rtree/options.hpp
==============================================================================
--- sandbox-branches/geometry/index/boost/geometry/extensions/index/rtree/options.hpp	(original)
+++ sandbox-branches/geometry/index/boost/geometry/extensions/index/rtree/options.hpp	2012-08-22 21:04:00 EDT (Wed, 22 Aug 2012)
@@ -41,6 +41,12 @@
 //if ( m_max_elems_per_node < 2 )
 //    m_max_elems_per_node = 2;
 
+/*!
+Linear r-tree creation algorithm parameters.
+
+\tparam MaxElements     Maximum number of elements in nodes.
+\tparam MinElements     Minimum number of elements in nodes.
+*/
 template <size_t MaxElements, size_t MinElements>
 struct linear
 {
@@ -48,6 +54,12 @@
     static const size_t min_elements = MinElements;
 };
 
+/*!
+Quadratic r-tree creation algorithm parameters.
+
+\tparam MaxElements     Maximum number of elements in nodes.
+\tparam MinElements     Minimum number of elements in nodes.
+*/
 template <size_t MaxElements, size_t MinElements>
 struct quadratic
 {
@@ -65,6 +77,16 @@
 
 }} // namespace options::detail
 
+/*!
+Quadratic r-tree creation algorithm parameters.
+
+\tparam MaxElements             Maximum number of elements in nodes.
+\tparam MinElements             Minimum number of elements in nodes.
+\tparam OverlapCostThreshold    The number of leaf node children elements above which
+                                nearly minimum overlap cost is calculated instead of minimum
+                                overlap cost. If 0 minimum overlap cost is always calculated.
+\tparam ReinsertedElements      Number of elements reinserted by forced reinsertions algorithm.
+*/
 template <size_t MaxElements,
           size_t MinElements,
           size_t OverlapCostThreshold = 0,