EllenBinTree doc fixed
authorkhizmax <libcds.dev@gmail.com>
Sat, 21 Nov 2015 09:11:53 +0000 (12:11 +0300)
committerkhizmax <libcds.dev@gmail.com>
Sat, 21 Nov 2015 09:11:53 +0000 (12:11 +0300)
cds/intrusive/ellen_bintree_rcu.h
cds/intrusive/impl/ellen_bintree.h

index ff998baf40256c7ae34669351196275a9d342f2f..c7278a3036ede0add087bceb2aad82537f0b4e93 100644 (file)
@@ -54,11 +54,10 @@ namespace cds { namespace intrusive {
         a <i>priority queue</i>. In this case you should provide unique compound key, for example,
         the priority value plus some uniformly distributed random value.
 
-        @warning Recall the tree is <b>unbalanced</b>. The complexity of operations is <tt>O(log N)</tt>
+        @attention Recall the tree is <b>unbalanced</b>. The complexity of operations is <tt>O(log N)</tt>
         for uniformly distributed random keys, but in worst case the complexity is <tt>O(N)</tt>.
 
         @note In the current implementation we do not use helping technique described in the original paper.
-        In Hazard Pointer schema helping is too complicated and does not give any observable benefits.
         Instead of helping, when a thread encounters a concurrent operation it just spins waiting for
         the operation done. Such solution allows greatly simplify the implementation of tree.
 
@@ -72,6 +71,9 @@ namespace cds { namespace intrusive {
             It is possible to declare option-based tree with \p ellen_bintree::make_traits metafunction
             instead of \p Traits template argument.
 
+        @note Before including <tt><cds/intrusive/ellen_bintree_rcu.h></tt> you should include appropriate RCU header file,
+        see \ref cds_urcu_gc "RCU type" for list of existing RCU class and corresponding header files.
+
         @anchor cds_intrusive_EllenBinTree_rcu_less
         <b>Predicate requirements</b>
 
@@ -110,9 +112,6 @@ namespace cds { namespace intrusive {
         };
         \endcode
 
-        @note Before including <tt><cds/intrusive/ellen_bintree_rcu.h></tt> you should include appropriate RCU header file,
-        see \ref cds_urcu_gc "RCU type" for list of existing RCU class and corresponding header files.
-
         @anchor cds_intrusive_EllenBinTree_usage
         <b>Usage</b>
 
index 20bcbd68ca7e66224e85336ec69c70d406d9cd9c..21fd7c29396754ab683316bf9c9e6d5c1e014238 100644 (file)
@@ -33,11 +33,11 @@ namespace cds { namespace intrusive {
         the priority value plus some uniformly distributed random value.
 
         @note In the current implementation we do not use helping technique described in the original paper.
-        In Hazard Pointer schema helping is too complicated and does not give any observable benefits.
+        In Hazard Pointer schema the helping is too complicated and does not give any observable benefits.
         Instead of helping, when a thread encounters a concurrent operation it just spins waiting for
-        the operation done. Such solution allows greatly simplify the implementation of tree.
+        the operation done. Such solution allows greatly simplify implementation of the tree.
 
-        @warning Recall the tree is <b>unbalanced</b>. The complexity of operations is <tt>O(log N)</tt>
+        @attention Recall the tree is <b>unbalanced</b>. The complexity of operations is <tt>O(log N)</tt>
         for uniformly distributed random keys, but in worst case the complexity is <tt>O(N)</tt>.
 
         @note Do not include <tt><cds/intrusive/impl/ellen_bintree.h></tt> header file explicitly.