Remove MichaelMap<gc::HRC> specializations
[libcds.git] / cds / container / michael_set.h
index 9bdcfaef940bce7a2383efa138ffb52ed9edb47d..0fe47dca61b46d27acdc5df0a1f5e881101c7184 100644 (file)
@@ -3,7 +3,7 @@
 #ifndef __CDS_CONTAINER_MICHAEL_SET_H
 #define __CDS_CONTAINER_MICHAEL_SET_H
 
-#include <cds/container/michael_set_base.h>
+#include <cds/container/details/michael_set_base.h>
 #include <cds/details/allocator.h>
 
 namespace cds { namespace container {
@@ -85,7 +85,7 @@ namespace cds { namespace container {
         before end of the set. Therefore, such iteration is more suitable for debugging purpose only
 
         Remember, each iterator object requires an additional hazard pointer, that may be
-        a limited resource for \p GC like as gc::HP and gc::HRC (for gc::PTB the count of
+        a limited resource for \p GC like \p gc::HP (for gc::PTB the count of
         guards is unlimited).
 
         The iterator class supports the following minimalistic interface:
@@ -110,7 +110,7 @@ namespace cds { namespace container {
         bool operator !=(iterator const& i ) const;
         };
         \endcode
-        Note, the iterator object returned by \ref end, \p cend member functions points to \p NULL and should not be dereferenced.
+        Note, the iterator object returned by \ref end, \p cend member functions points to \p nullptr and should not be dereferenced.
 
         <b>How to use</b>
 
@@ -127,7 +127,7 @@ namespace cds { namespace container {
         MichaelList as a bucket type. Also, for ordered list we should develop a comparator for our \p Foo
         struct.
         \code
-        #include <cds/container/michael_list_ptb.h>
+        #include <cds/container/michael_list_dhp.h>
         #include <cds/container/michael_set.h>
 
         namespace cc = cds::container;
@@ -356,7 +356,7 @@ namespace cds { namespace container {
             where \p val is the item inserted. User-defined functor \p f should guarantee that during changing
             \p val no any other changes could be made on this set's item by concurrent threads.
             The user-defined functor is called only if the inserting is success. It may be passed by reference
-            using <tt>boost::ref</tt>
+            using \p std::ref
         */
         template <typename Q, typename Func>
         bool insert( Q const& val, Func f )
@@ -392,7 +392,7 @@ namespace cds { namespace container {
             The functor may change non-key fields of the \p item; however, \p func must guarantee
             that during changing no any other modifications could be made on this item by concurrent threads.
 
-            You may pass \p func argument by reference using <tt>boost::ref</tt>.
+            You may pass \p func argument by reference using \p std::ref
 
             Returns <tt> std::pair<bool, bool> </tt> where \p first is true if operation is successfull,
             \p second is true if new item has been added or \p false if the item with \p key
@@ -407,13 +407,9 @@ namespace cds { namespace container {
             return bRet;
         }
 
-#   ifdef CDS_EMPLACE_SUPPORT
         /// Inserts data of type \ref value_type constructed with <tt>std::forward<Args>(args)...</tt>
         /**
             Returns \p true if inserting successful, \p false otherwise.
-
-            @note This function is available only for compiler that supports
-            variadic template and move semantics
         */
         template <typename... Args>
         bool emplace( Args&&... args )
@@ -423,7 +419,6 @@ namespace cds { namespace container {
                 ++m_ItemCounter;
             return bRet;
         }
-#   endif
 
         /// Deletes \p key from the set
         /** \anchor cds_nonintrusive_MichaelSet_erase_val
@@ -571,7 +566,7 @@ namespace cds { namespace container {
             \endcode
             where \p item is the item found, \p val is the <tt>find</tt> function argument.
 
-            You may pass \p f argument by reference using <tt>boost::ref</tt> or cds::ref.
+            You may pass \p f argument by reference using \p std::ref.
 
             The functor may change non-key fields of \p item. Note that the functor is only guarantee
             that \p item cannot be disposed during functor is executing.
@@ -617,7 +612,7 @@ namespace cds { namespace container {
             \endcode
             where \p item is the item found, \p val is the <tt>find</tt> function argument.
 
-            You may pass \p f argument by reference using <tt>boost::ref</tt> or cds::ref.
+            You may pass \p f argument by reference using \p std::ref.
 
             The functor may change non-key fields of \p item. Note that the functor is only guarantee
             that \p item cannot be disposed during functor is executing.