From 03e2584500d52c1f9fde168de44360d16a22e590 Mon Sep 17 00:00:00 2001 From: khizmax Date: Sat, 21 Nov 2015 12:11:53 +0300 Subject: [PATCH] EllenBinTree doc fixed --- cds/intrusive/ellen_bintree_rcu.h | 9 ++++----- cds/intrusive/impl/ellen_bintree.h | 6 +++--- 2 files changed, 7 insertions(+), 8 deletions(-) diff --git a/cds/intrusive/ellen_bintree_rcu.h b/cds/intrusive/ellen_bintree_rcu.h index ff998baf..c7278a30 100644 --- a/cds/intrusive/ellen_bintree_rcu.h +++ b/cds/intrusive/ellen_bintree_rcu.h @@ -54,11 +54,10 @@ namespace cds { namespace intrusive { a priority queue. 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 unbalanced. The complexity of operations is O(log N) + @attention Recall the tree is unbalanced. The complexity of operations is O(log N) for uniformly distributed random keys, but in worst case the complexity is O(N). @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 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 Predicate requirements @@ -110,9 +112,6 @@ namespace cds { namespace intrusive { }; \endcode - @note Before including 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 Usage diff --git a/cds/intrusive/impl/ellen_bintree.h b/cds/intrusive/impl/ellen_bintree.h index 20bcbd68..21fd7c29 100644 --- a/cds/intrusive/impl/ellen_bintree.h +++ b/cds/intrusive/impl/ellen_bintree.h @@ -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 unbalanced. The complexity of operations is O(log N) + @attention Recall the tree is unbalanced. The complexity of operations is O(log N) for uniformly distributed random keys, but in worst case the complexity is O(N). @note Do not include header file explicitly. -- 2.34.1