issue #76: added cds::atomicity::cache_friendly_item_counter to avoid false sharing
[libcds.git] / cds / opt / options.h
index 5ab9c169f22a1c4bc08227b9d32d8567e8e03e91..70faba7178a6c1a36a4630730072d2cc666aeb31 100644 (file)
@@ -304,15 +304,16 @@ namespace opt {
         Predefined option \p Type:
         - \p atomicity::empty_item_counter - no item counting performed. It is default policy for many
             containers
-        - \p atomicity::item_counter - the class that provides atomically item counting
-        - \p opt::v::sequential_item_counter - simple non-atomic item counter. This item counter is not intended for
+        - \p atomicity::item_counter - the class that provides atomic item counting
+        - \p atomicity::cache_friendly_item_counter - cache-friendly atomic item counter
+        - \p opt::v::sequential_item_counter - simple non-atomic item counter. This counter is not intended for
             concurrent containers and may be used only if it is explicitly noted.
 
         You may provide other implementation of \p atomicity::item_counter interface for your needs.
 
         Note, the item counting in lock-free containers cannot be exact; for example, if
         item counter for a container returns zero it is not mean that the container is empty.
-        Thus, the item counter may be used for statistical purposes only.
+        So, the item counter may be used for statistical purposes only.
     */
     template <typename Type>
     struct item_counter {