From: khizmax Date: Fri, 7 Nov 2014 16:39:13 +0000 (+0300) Subject: Remove std::ref and boost::ref from docs X-Git-Tag: v2.0.0~126 X-Git-Url: http://plrg.eecs.uci.edu/git/?p=libcds.git;a=commitdiff_plain;h=ba8f90c18cb0f1087573692b6e7aacc183233233 Remove std::ref and boost::ref from docs --- diff --git a/cds/container/cuckoo_map.h b/cds/container/cuckoo_map.h index a6043b0a..a6755b88 100644 --- a/cds/container/cuckoo_map.h +++ b/cds/container/cuckoo_map.h @@ -507,9 +507,6 @@ namespace cds { namespace container { - item.first is a const reference to item's key that cannot be changed. - item.second is a reference to item's value that may be changed. - The user-defined functor can be passed by reference using \p std::ref - and it is called only if inserting is successful. - The key_type should be constructible from value of type \p K. The function allows to split creating of new item into two part: @@ -571,8 +568,6 @@ namespace cds { namespace container { The functor may change any fields of the \p item.second that is \ref value_type. - You may pass \p func argument by reference using \p std::ref - Returns std::pair 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 already is in the list. @@ -636,7 +631,6 @@ namespace cds { namespace container { void operator()(value_type& item) { ... } }; \endcode - The functor may be passed by reference using boost:ref Return \p true if key is found and deleted, \p false otherwise @@ -686,8 +680,6 @@ namespace cds { namespace container { \endcode where \p item is the item found. - You can pass \p f argument by reference using \p std::ref - The functor may change \p item.second. The function returns \p true if \p key is found, \p false otherwise. diff --git a/cds/container/cuckoo_set.h b/cds/container/cuckoo_set.h index 605f2a43..12172e4b 100644 --- a/cds/container/cuckoo_set.h +++ b/cds/container/cuckoo_set.h @@ -536,8 +536,7 @@ namespace cds { namespace container { The type \p Q can differ from \ref value_type of items storing in the set. Therefore, the \p value_type should be constructible from type \p Q. - The user-defined functor is called only if the inserting is success. It can be passed by reference - using \p std::ref + The user-defined functor is called only if the inserting is success. */ template bool insert( Q const& val, Func f ) @@ -589,8 +588,6 @@ namespace cds { namespace container { The functor can change non-key fields of the \p item. - You can pass \p func argument by value or by reference using \p std::ref - Returns std::pair 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 val key already exists. @@ -659,7 +656,6 @@ namespace cds { namespace container { void operator()(value_type const& val); }; \endcode - The functor can be passed by value or by reference using boost:ref Return \p true if key is found and deleted, \p false otherwise */ @@ -707,8 +703,6 @@ namespace cds { namespace container { \endcode where \p item is the item found, \p val is the find function argument. - You can pass \p f argument by value or by reference using \p std::ref - The functor can change non-key fields of \p item. The \p val argument is non-const since it can be used as \p f functor destination i.e., the functor can modify both arguments. @@ -751,8 +745,6 @@ namespace cds { namespace container { \endcode where \p item is the item found, \p val is the find function argument. - You can pass \p f argument by value or by reference using \p std::ref - The functor can change non-key fields of \p item. The type \p Q can differ from \ref value_type of items storing in the container. diff --git a/cds/container/ellen_bintree_map_rcu.h b/cds/container/ellen_bintree_map_rcu.h index 00b0b646..a45a8620 100644 --- a/cds/container/ellen_bintree_map_rcu.h +++ b/cds/container/ellen_bintree_map_rcu.h @@ -212,9 +212,6 @@ namespace cds { namespace container { - item.first is a const reference to item's key that cannot be changed. - item.second is a reference to item's value that may be changed. - The user-defined functor can be passed by reference using \p std::ref - and it is called only if inserting is successful. - The key_type should be constructible from value of type \p K. The function allows to split creating of new item into two part: @@ -280,8 +277,6 @@ namespace cds { namespace container { The functor may change any fields of the \p item.second that is \ref value_type. - You may pass \p func argument by reference using \p std::ref - RCU \p synchronize method can be called. RCU should not be locked. Returns std::pair where \p first is true if operation is successfull, @@ -338,7 +333,6 @@ namespace cds { namespace container { void operator()(value_type& item) { ... } }; \endcode - The functor may be passed by reference using boost:ref RCU \p synchronize method can be called. RCU should not be locked. @@ -451,8 +445,6 @@ namespace cds { namespace container { \endcode where \p item is the item found. - You can pass \p f argument by reference using \p std::ref - The functor may change \p item.second. The function applies RCU lock internally. diff --git a/cds/container/ellen_bintree_set_rcu.h b/cds/container/ellen_bintree_set_rcu.h index ad0b9842..1a201c0f 100644 --- a/cds/container/ellen_bintree_set_rcu.h +++ b/cds/container/ellen_bintree_set_rcu.h @@ -223,8 +223,7 @@ namespace cds { namespace container { \endcode 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 \p std::ref + The user-defined functor is called only if the inserting is success. RCU \p synchronize method can be called. RCU should not be locked. */ @@ -264,8 +263,6 @@ 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 \p std::ref - RCU \p synchronize method can be called. RCU should not be locked. Returns std::pair where \p first is true if operation is successfull, @@ -341,7 +338,6 @@ namespace cds { namespace container { void operator()(value_type const& val); }; \endcode - The functor may be passed by reference using boost:ref Since the key of MichaelHashSet's \p value_type is not explicitly specified, template parameter \p Q defines the key type searching in the list. @@ -462,8 +458,6 @@ namespace cds { namespace container { \endcode where \p item is the item found, \p val is the find function argument. - 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. The functor does not serialize simultaneous access to the set's \p item. If such access is @@ -511,8 +505,6 @@ namespace cds { namespace container { \endcode where \p item is the item found, \p val is the find function argument. - 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. The functor does not serialize simultaneous access to the set's \p item. If such access is diff --git a/cds/container/impl/ellen_bintree_map.h b/cds/container/impl/ellen_bintree_map.h index dbbe0914..8f60db75 100644 --- a/cds/container/impl/ellen_bintree_map.h +++ b/cds/container/impl/ellen_bintree_map.h @@ -395,8 +395,6 @@ namespace cds { namespace container { \endcode where \p item is the item found. - You can pass \p f argument by reference using std::ref. - The functor may change \p item.second. The function returns \p true if \p key is found, \p false otherwise. diff --git a/cds/container/impl/ellen_bintree_set.h b/cds/container/impl/ellen_bintree_set.h index 72c8f292..366ab1f0 100644 --- a/cds/container/impl/ellen_bintree_set.h +++ b/cds/container/impl/ellen_bintree_set.h @@ -410,8 +410,6 @@ namespace cds { namespace container { \endcode where \p item is the item found, \p key is the find function argument. - 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. The functor does not serialize simultaneous access to the set's \p item. If such access is diff --git a/cds/container/impl/lazy_kvlist.h b/cds/container/impl/lazy_kvlist.h index b71876e4..b2a6425b 100644 --- a/cds/container/impl/lazy_kvlist.h +++ b/cds/container/impl/lazy_kvlist.h @@ -487,7 +487,6 @@ namespace cds { namespace container { void operator()(value_type& val) { ... } }; \endcode - The functor may be passed by reference with boost:ref Returns \p true if key is found and deleted, \p false otherwise */ @@ -591,8 +590,6 @@ namespace cds { namespace container { \endcode where \p item is the item found. - You may pass \p f argument by reference using \p std::ref. - The functor may change item.second that is reference to value of node. Note that the function is only guarantee that \p item cannot be deleted during functor is executing. The function does not serialize simultaneous access to the list \p item. If such access is diff --git a/cds/container/impl/lazy_list.h b/cds/container/impl/lazy_list.h index eada04e0..6605dbfa 100644 --- a/cds/container/impl/lazy_list.h +++ b/cds/container/impl/lazy_list.h @@ -566,8 +566,6 @@ namespace cds { namespace container { \endcode where \p item is the item found, \p key is the find function argument. - 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 function is only guarantee that \p item cannot be deleted during functor is executing. The function does not serialize simultaneous access to the list \p item. If such access is diff --git a/cds/container/impl/michael_kvlist.h b/cds/container/impl/michael_kvlist.h index 70225fbc..c6d94c87 100644 --- a/cds/container/impl/michael_kvlist.h +++ b/cds/container/impl/michael_kvlist.h @@ -491,7 +491,6 @@ namespace cds { namespace container { void operator()(value_type& val) { ... } }; \endcode - The functor may be passed by reference with boost:ref Return \p true if key is found and deleted, \p false otherwise @@ -600,8 +599,6 @@ namespace cds { namespace container { \endcode where \p item is the item found. - You may pass \p f argument by reference using \p std::ref - The functor may change item.second that is reference to value of node. Note that the function is only guarantee that \p item cannot be deleted during functor is executing. The function does not serialize simultaneous access to the list \p item. If such access is diff --git a/cds/container/impl/michael_list.h b/cds/container/impl/michael_list.h index d9a1ab94..16e306a2 100644 --- a/cds/container/impl/michael_list.h +++ b/cds/container/impl/michael_list.h @@ -447,7 +447,6 @@ namespace cds { namespace container { void operator()(const value_type& val) { ... } }; \endcode - The functor may be passed by reference with boost:ref Since the key of MichaelList's item type \p value_type is not explicitly specified, template parameter \p Q should contain the complete key to search in the list. diff --git a/cds/container/lazy_kvlist_rcu.h b/cds/container/lazy_kvlist_rcu.h index 12e7c297..b460c6d6 100644 --- a/cds/container/lazy_kvlist_rcu.h +++ b/cds/container/lazy_kvlist_rcu.h @@ -485,7 +485,6 @@ namespace cds { namespace container { void operator()(value_type& val) { ... } }; \endcode - The functor may be passed by reference with boost:ref RCU \p synchronize method can be called. RCU should not be locked. @@ -607,8 +606,6 @@ namespace cds { namespace container { \endcode where \p item is the item found. - You may pass \p f argument by reference using \p std::ref. - The functor may change item.second that is reference to value of node. Note that the function is only guarantee that \p item cannot be deleted during functor is executing. The function does not serialize simultaneous access to the list \p item. If such access is diff --git a/cds/container/lazy_list_rcu.h b/cds/container/lazy_list_rcu.h index 744e7669..0d834427 100644 --- a/cds/container/lazy_list_rcu.h +++ b/cds/container/lazy_list_rcu.h @@ -457,7 +457,6 @@ namespace cds { namespace container { void operator()(value_type const& val) { ... } }; \endcode - The functor may be passed by reference with boost:ref Since the key of LazyList's item type \p T is not explicitly specified, template parameter \p Q defines the key type searching in the list. @@ -585,8 +584,6 @@ namespace cds { namespace container { \endcode where \p item is the item found, \p key is the \p find() function argument. - 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 function is only guarantee that \p item cannot be deleted during functor is executing. The function does not serialize simultaneous access to the list \p item. If such access is diff --git a/cds/container/michael_kvlist_nogc.h b/cds/container/michael_kvlist_nogc.h index 4a041995..755d7c53 100644 --- a/cds/container/michael_kvlist_nogc.h +++ b/cds/container/michael_kvlist_nogc.h @@ -372,8 +372,6 @@ namespace cds { namespace container { to the list's item inserted. item.second is a reference to item's value that may be changed. User-defined functor \p func should guarantee that during changing item's value no any other changes could be made on this list's item by concurrent threads. - The user-defined functor can be passed by reference using \p std::ref - and it is called only if the inserting is successful. The key_type should be constructible from value of type \p K. diff --git a/cds/container/michael_kvlist_rcu.h b/cds/container/michael_kvlist_rcu.h index 420d367c..0b0e4958 100644 --- a/cds/container/michael_kvlist_rcu.h +++ b/cds/container/michael_kvlist_rcu.h @@ -369,8 +369,6 @@ namespace cds { namespace container { to the list's item inserted. item.second is a reference to item's value that may be changed. User-defined functor \p func should guarantee that during changing item's value no any other changes could be made on this list's item by concurrent threads. - The user-defined functor can be passed by reference using \p std::ref - and it is called only if inserting is successful. The key_type should be constructible from value of type \p K. @@ -419,8 +417,6 @@ namespace cds { namespace container { 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 \p std::ref - The function makes RCU lock internally. Returns std::pair where \p first is true if operation is successfull, @@ -484,7 +480,6 @@ namespace cds { namespace container { void operator()(value_type& val) { ... } }; \endcode - The functor may be passed by reference with boost:ref RCU \p synchronize method can be called. RCU should not be locked. diff --git a/cds/container/michael_list_rcu.h b/cds/container/michael_list_rcu.h index 18a99a0a..4c3d502e 100644 --- a/cds/container/michael_list_rcu.h +++ b/cds/container/michael_list_rcu.h @@ -341,8 +341,6 @@ namespace cds { namespace container { The argument \p itemValue of user-defined functor \p func is the reference to the list's item inserted. User-defined functor \p func should guarantee that during changing item's value no any other changes could be made on this list's item by concurrent threads. - The user-defined functor can be passed by reference using \p std::ref - and it is called only if the inserting is success. The type \p Q should contain the complete key of the node. The object of \ref value_type should be constructible from \p key of type \p Q. diff --git a/cds/container/michael_map_rcu.h b/cds/container/michael_map_rcu.h index e06c318e..54cd1b57 100644 --- a/cds/container/michael_map_rcu.h +++ b/cds/container/michael_map_rcu.h @@ -494,7 +494,6 @@ namespace cds { namespace container { void operator()(value_type& item) { ... } }; \endcode - The functor may be passed by reference using boost:ref RCU \p synchronize method can be called. RCU should not be locked. diff --git a/cds/container/michael_set.h b/cds/container/michael_set.h index a15d7d29..ff431034 100644 --- a/cds/container/michael_set.h +++ b/cds/container/michael_set.h @@ -560,8 +560,6 @@ namespace cds { namespace container { \endcode where \p item is the item found, \p key is the find function argument. - 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. The functor does not serialize simultaneous access to the set's \p item. If such access is diff --git a/cds/container/skip_list_set_rcu.h b/cds/container/skip_list_set_rcu.h index 56ceb71a..b7cdfbc9 100644 --- a/cds/container/skip_list_set_rcu.h +++ b/cds/container/skip_list_set_rcu.h @@ -291,8 +291,7 @@ namespace cds { namespace container { \endcode 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 \p std::ref + The user-defined functor is called only if the inserting is success. RCU \p synchronize method can be called. RCU should not be locked. */ @@ -332,8 +331,6 @@ 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 \p std::ref - RCU \p synchronize method can be called. RCU should not be locked. Returns std::pair where \p first is true if operation is successfull, @@ -409,7 +406,6 @@ namespace cds { namespace container { void operator()(value_type const& val); }; \endcode - The functor may be passed by reference using boost:ref Since the key of MichaelHashSet's \p value_type is not explicitly specified, template parameter \p Q defines the key type searching in the list. @@ -521,8 +517,6 @@ namespace cds { namespace container { \endcode where \p item is the item found, \p val is the find function argument. - 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. The functor does not serialize simultaneous access to the set's \p item. If such access is @@ -570,8 +564,6 @@ namespace cds { namespace container { \endcode where \p item is the item found, \p val is the find function argument. - 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. The functor does not serialize simultaneous access to the set's \p item. If such access is diff --git a/cds/container/split_list_map.h b/cds/container/split_list_map.h index 07d7a1c1..05ecd615 100644 --- a/cds/container/split_list_map.h +++ b/cds/container/split_list_map.h @@ -385,7 +385,6 @@ namespace cds { namespace container { void operator()(value_type& item) { ... } }; \endcode - The functor may be passed by reference using boost:ref Return \p true if key is found and deleted, \p false otherwise */ diff --git a/cds/container/split_list_map_rcu.h b/cds/container/split_list_map_rcu.h index a363c656..65da6217 100644 --- a/cds/container/split_list_map_rcu.h +++ b/cds/container/split_list_map_rcu.h @@ -426,7 +426,6 @@ namespace cds { namespace container { void operator()(value_type& item) { ... } }; \endcode - The functor may be passed by reference using boost:ref RCU \p synchronize method can be called. RCU should not be locked. @@ -519,8 +518,6 @@ namespace cds { namespace container { \endcode where \p item is the item found. - You may pass \p f argument by reference using \p std::ref. - The functor may change \p item.second. Note that the functor is only guarantee that \p item cannot be disposed during functor is executing. The functor does not serialize simultaneous access to the map's \p item. If such access is diff --git a/cds/container/split_list_set.h b/cds/container/split_list_set.h index 74702f0b..60f86b38 100644 --- a/cds/container/split_list_set.h +++ b/cds/container/split_list_set.h @@ -602,8 +602,6 @@ namespace cds { namespace container { \endcode where \p item is the item found, \p key is the find function argument. - 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. The functor does not serialize simultaneous access to the set's \p item. If such access is diff --git a/cds/container/striped_map.h b/cds/container/striped_map.h index 6bfa8838..3c23860e 100644 --- a/cds/container/striped_map.h +++ b/cds/container/striped_map.h @@ -622,9 +622,6 @@ template - item.first is a const reference to item's key that cannot be changed. - item.second is a reference to item's value that may be changed. - The user-defined functor can be passed by reference using \p std::ref - and it is called only if inserting is successful. - The key_type should be constructible from value of type \p K. The function allows to split creating of new item into two part: @@ -691,8 +688,6 @@ template The functor may change any fields of the \p item.second that is \ref mapped_type. - You may pass \p func argument by reference using \p std::ref - Returns std::pair 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 already is in the list. @@ -758,7 +753,6 @@ template void operator()(value_type& item) { ... } }; \endcode - The functor may be passed by reference using boost:ref Return \p true if key is found and deleted, \p false otherwise @@ -800,8 +794,6 @@ template \endcode where \p item is the item found. - You can pass \p f argument by reference using \p std::ref. - The functor may change \p item.second. The function returns \p true if \p key is found, \p false otherwise. diff --git a/cds/container/striped_set.h b/cds/container/striped_set.h index 18147ba5..720a1b5d 100644 --- a/cds/container/striped_set.h +++ b/cds/container/striped_set.h @@ -588,8 +588,7 @@ namespace cds { namespace container { The type \p Q can differ from \ref value_type of items storing in the set. Therefore, the \p value_type should be constructible from type \p Q. - The user-defined functor is called only if the inserting is success. It can be passed by reference - using \p std::ref + The user-defined functor is called only if the inserting is success. */ template bool insert( Q const& val, Func f ) @@ -658,8 +657,6 @@ namespace cds { namespace container { The functor can change non-key fields of the \p item. - You can pass \p func argument by value or by reference using \p std::ref - Returns std::pair 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 val key already exists. @@ -726,7 +723,6 @@ namespace cds { namespace container { void operator()(value_type const& val); }; \endcode - The functor can be passed by value or by reference using boost:ref Return \p true if key is found and deleted, \p false otherwise */ @@ -788,8 +784,6 @@ namespace cds { namespace container { \endcode where \p item is the item found, \p val is the find function argument. - You can pass \p f argument by value or by reference using \p std::ref. - The functor can change non-key fields of \p item. The \p val argument is non-const since it can be used as \p f functor destination i.e., the functor can modify both arguments. @@ -835,8 +829,6 @@ namespace cds { namespace container { \endcode where \p item is the item found, \p val is the find function argument. - You can pass \p f argument by value or by reference using \p std::ref. - The functor can change non-key fields of \p item. The type \p Q can differ from \ref value_type of items storing in the container. diff --git a/cds/container/striped_set/adapter.h b/cds/container/striped_set/adapter.h index fb2a34e6..a7da7a61 100644 --- a/cds/container/striped_set/adapter.h +++ b/cds/container/striped_set/adapter.h @@ -62,8 +62,7 @@ namespace cds { namespace container { The type \p Q can differ from \ref value_type of items storing in the container. Therefore, the \p value_type should be comparable with type \p Q and constructible from type \p Q, - The user-defined functor is called only if the inserting is success. It can be passed by reference - using \p std::ref + The user-defined functor is called only if the inserting is success.
Inserts data of type \ref value_type constructed with std::forward(args)... @@ -101,8 +100,6 @@ namespace cds { namespace container { The type \p Q can differ from \ref value_type of items storing in the container. Therefore, the \p value_type should be comparable with type \p Q and constructible from type \p Q, - You can pass \p func argument by reference using \p std::ref - Returns std::pair 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 val key already exists. @@ -120,7 +117,6 @@ namespace cds { namespace container { void operator()(value_type const& val); }; \endcode - The functor can be passed by reference using boost:ref The type \p Q can differ from \ref value_type of items storing in the container. Therefore, the \p value_type should be comparable with type \p Q. @@ -140,8 +136,6 @@ namespace cds { namespace container { \endcode where \p item is the item found, \p val is the find function argument. - You can pass \p f argument by reference using \p std::ref - The functor can change non-key fields of \p item. The \p val argument is non-const since it can be used as \p f functor destination i.e., the functor can modify both arguments. diff --git a/cds/container/striped_set/boost_stable_vector.h b/cds/container/striped_set/boost_stable_vector.h index 9a8b8062..bc5e6a02 100644 --- a/cds/container/striped_set/boost_stable_vector.h +++ b/cds/container/striped_set/boost_stable_vector.h @@ -142,8 +142,7 @@ namespace cds { namespace intrusive { namespace striped_set { The type \p Q may differ from \ref value_type of items storing in the container. Therefore, the \p value_type should be comparable with type \p Q and constructible from type \p Q, - The user-defined functor is called only if the inserting is success. It may be passed by reference - using \p std::ref + The user-defined functor is called only if the inserting is success. */ template bool insert( const Q& val, Func f ) @@ -197,8 +196,6 @@ namespace cds { namespace intrusive { namespace striped_set { The type \p Q may differ from \ref value_type of items storing in the container. Therefore, the \p value_type should be comparable with type \p Q and constructible from type \p Q, - You may pass \p func argument by reference using \p std::ref - Returns std::pair 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 val key already exists. @@ -232,7 +229,6 @@ namespace cds { namespace intrusive { namespace striped_set { void operator()(value_type const& val); }; \endcode - The functor may be passed by reference using boost:ref The type \p Q may differ from \ref value_type of items storing in the container. Therefore, the \p value_type should be comparable with type \p Q. @@ -276,8 +272,6 @@ namespace cds { namespace intrusive { namespace striped_set { \endcode where \p item is the item found, \p val is the find function argument. - You may pass \p f argument by reference using \p std::ref - The functor may change non-key fields of \p item. The \p val argument is non-const since it can be used as \p f functor destination i.e., the functor may modify both arguments. diff --git a/cds/intrusive/cuckoo_set.h b/cds/intrusive/cuckoo_set.h index e54f8237..7b637e40 100644 --- a/cds/intrusive/cuckoo_set.h +++ b/cds/intrusive/cuckoo_set.h @@ -2365,8 +2365,7 @@ namespace cds { namespace intrusive { \endcode where \p val is the item inserted. - The user-defined functor is called only if the inserting is success and can be passed by reference - using \p std::ref + The user-defined functor is called only if the inserting is success. */ template bool insert( value_type& val, Func f ) @@ -2448,8 +2447,6 @@ namespace cds { namespace intrusive { The functor may change non-key fields of the \p item. - You may pass \p func argument by reference using \p std::ref. - Returns std::pair where \p first is \p true if operation is successful, \p second is \p true if new item has been added or \p false if the item with \p key already is in the set. @@ -2591,7 +2588,6 @@ namespace cds { namespace intrusive { void operator()( value_type const& item ); }; \endcode - The functor may be passed by reference with boost:ref If the item with key equal to \p val is not found the function return \p nullptr. @@ -2628,8 +2624,6 @@ namespace cds { namespace intrusive { \endcode where \p item is the item found, \p val is the find function argument. - You can pass \p f argument by reference using \p std::ref. - The functor may change non-key fields of \p item. The \p val argument is non-const since it can be used as \p f functor destination i.e., the functor @@ -2671,8 +2665,6 @@ namespace cds { namespace intrusive { \endcode where \p item is the item found, \p val is the find function argument. - You can pass \p f argument by reference using \p std::ref. - The functor may change non-key fields of \p item. The \p val argument is non-const since it can be used as \p f functor destination i.e., the functor diff --git a/cds/intrusive/ellen_bintree_rcu.h b/cds/intrusive/ellen_bintree_rcu.h index 4cec1fc0..79b9e751 100644 --- a/cds/intrusive/ellen_bintree_rcu.h +++ b/cds/intrusive/ellen_bintree_rcu.h @@ -919,7 +919,6 @@ namespace cds { namespace intrusive { void operator()( value_type const& item ); }; \endcode - The functor can be passed by reference with boost:ref If the item with key equal to \p key is not found the function return \p false. diff --git a/cds/intrusive/impl/ellen_bintree.h b/cds/intrusive/impl/ellen_bintree.h index dc54c619..06baed3b 100644 --- a/cds/intrusive/impl/ellen_bintree.h +++ b/cds/intrusive/impl/ellen_bintree.h @@ -505,7 +505,6 @@ namespace cds { namespace intrusive { void operator()( value_type const& item ); }; \endcode - The functor can be passed by reference with boost:ref If the item with key equal to \p key is not found the function return \p false. @@ -670,8 +669,6 @@ namespace cds { namespace intrusive { \endcode where \p item is the item found, \p key is the find function argument. - You can pass \p f argument by value or by reference using \p std::ref. - The functor can change non-key fields of \p item. Note that the functor is only guarantee that \p item cannot be disposed during functor is executing. The functor does not serialize simultaneous access to the tree \p item. If such access is diff --git a/cds/intrusive/lazy_list_rcu.h b/cds/intrusive/lazy_list_rcu.h index adad3206..38cae1d9 100644 --- a/cds/intrusive/lazy_list_rcu.h +++ b/cds/intrusive/lazy_list_rcu.h @@ -653,8 +653,6 @@ namespace cds { namespace intrusive { \endcode where \p item is the item found, \p key is the find function argument. - You may pass \p f argument by reference using \p std::ref. - The functor may change non-key fields of \p item. While the functor \p f is calling the item found \p item is locked. diff --git a/cds/intrusive/michael_list_nogc.h b/cds/intrusive/michael_list_nogc.h index 64f5c3dd..c9110290 100644 --- a/cds/intrusive/michael_list_nogc.h +++ b/cds/intrusive/michael_list_nogc.h @@ -321,8 +321,6 @@ namespace cds { namespace intrusive { 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 can pass \p func argument by value or by reference using \p std::ref. - Returns std::pair 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 already is in the list. diff --git a/cds/intrusive/michael_set.h b/cds/intrusive/michael_set.h index 6dcff726..c56ae091 100644 --- a/cds/intrusive/michael_set.h +++ b/cds/intrusive/michael_set.h @@ -515,7 +515,6 @@ namespace cds { namespace intrusive { void operator()( value_type const& item ); }; \endcode - The functor may be passed by reference with boost:ref If the item with key equal to \p key is not found the function return \p false. @@ -615,8 +614,6 @@ namespace cds { namespace intrusive { \endcode where \p item is the item found, \p key is the find function argument. - You can 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. The functor does not serialize simultaneous access to the set \p item. If such access is diff --git a/cds/intrusive/michael_set_rcu.h b/cds/intrusive/michael_set_rcu.h index 1e1859bf..ebc00195 100644 --- a/cds/intrusive/michael_set_rcu.h +++ b/cds/intrusive/michael_set_rcu.h @@ -359,7 +359,6 @@ namespace cds { namespace intrusive { void operator()( value_type const& item ); }; \endcode - The functor may be passed by reference with boost:ref If the item with key equal to \p key is not found the function return \p false. diff --git a/cds/intrusive/skip_list_nogc.h b/cds/intrusive/skip_list_nogc.h index fe209b96..42594679 100644 --- a/cds/intrusive/skip_list_nogc.h +++ b/cds/intrusive/skip_list_nogc.h @@ -697,8 +697,6 @@ namespace cds { namespace intrusive { The functor can 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 can pass \p func argument by value or by reference using \p std::ref. - Returns std::pair where \p first is \p true if operation is successfull, \p second is \p true if new item has been added or \p false if the item with \p key already is in the set. @@ -760,8 +758,6 @@ namespace cds { namespace intrusive { \endcode where \p item is the item found, \p key is the find function argument. - You can pass \p f argument by value or by reference using \p std::ref. - The functor can change non-key fields of \p item. Note that the functor is only guarantee that \p item cannot be disposed during functor is executing. The functor does not serialize simultaneous access to the set \p item. If such access is diff --git a/cds/intrusive/skip_list_rcu.h b/cds/intrusive/skip_list_rcu.h index 18927600..5569052a 100644 --- a/cds/intrusive/skip_list_rcu.h +++ b/cds/intrusive/skip_list_rcu.h @@ -1442,8 +1442,7 @@ retry: \endcode 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 and may be passed by reference - using \p std::ref. + The user-defined functor is called only if the inserting is success. RCU \p synchronize method can be called. RCU should not be locked. */ @@ -1840,8 +1839,6 @@ retry: \endcode where \p item is the item found, \p key is the find function argument. - You can pass \p f argument by value or by reference using \p std::ref. - The functor can change non-key fields of \p item. Note that the functor is only guarantee that \p item cannot be disposed during functor is executing. The functor does not serialize simultaneous access to the set \p item. If such access is diff --git a/cds/intrusive/split_list.h b/cds/intrusive/split_list.h index 8225b147..e19e483d 100644 --- a/cds/intrusive/split_list.h +++ b/cds/intrusive/split_list.h @@ -782,7 +782,6 @@ namespace cds { namespace intrusive { void operator()( value_type const& item ); }; \endcode - The functor can be passed by reference with boost:ref If the item with key equal to \p key is not found the function return \p false. @@ -866,8 +865,6 @@ namespace cds { namespace intrusive { \endcode where \p item is the item found, \p key is the find function argument. - You can pass \p f argument by value or by reference using \p std::ref. - The functor can change non-key fields of \p item. Note that the functor is only guarantee that \p item cannot be disposed during functor is executing. The functor does not serialize simultaneous access to the set \p item. If such access is diff --git a/cds/intrusive/split_list_rcu.h b/cds/intrusive/split_list_rcu.h index 603500f5..12fae063 100644 --- a/cds/intrusive/split_list_rcu.h +++ b/cds/intrusive/split_list_rcu.h @@ -663,7 +663,6 @@ namespace cds { namespace intrusive { void operator()( value_type const& item ); }; \endcode - The functor can be passed by reference with boost:ref If the item with key equal to \p key is not found the function return \p false. @@ -769,8 +768,6 @@ namespace cds { namespace intrusive { \endcode where \p item is the item found, \p key is the find function argument. - You can pass \p f argument by value or by reference using \p std::ref. - The functor can change non-key fields of \p item. Note that the functor is only guarantee that \p item cannot be disposed during functor is executing. The functor does not serialize simultaneous access to the set \p item. If such access is diff --git a/cds/intrusive/striped_set.h b/cds/intrusive/striped_set.h index 4f799d3d..f9990d1f 100644 --- a/cds/intrusive/striped_set.h +++ b/cds/intrusive/striped_set.h @@ -486,9 +486,6 @@ namespace cds { namespace intrusive { void func( value_type& val ); \endcode where \p val is the item inserted. - - The user-defined functor is called only if the inserting is success and can be passed by reference - using \p std::ref. */ template bool insert( value_type& val, Func f ) @@ -528,8 +525,6 @@ namespace cds { namespace intrusive { The functor may change non-key fields of the \p item. - You may pass \p func argument by reference using \p std::ref. - Returns std::pair where \p first is \p true if operation is successful, \p second is \p true if new item has been added or \p false if the item with \p key already is in the set. @@ -617,7 +612,6 @@ namespace cds { namespace intrusive { void operator()( value_type const& item ); }; \endcode - The functor may be passed by reference with boost:ref If the item with key equal to \p val is not found the function return \p false. @@ -671,8 +665,6 @@ namespace cds { namespace intrusive { \endcode where \p item is the item found, \p val is the find function argument. - You can pass \p f argument by reference using \p std::ref. - The functor may change non-key fields of \p item. The \p val argument is non-const since it can be used as \p f functor destination i.e., the functor @@ -713,8 +705,6 @@ namespace cds { namespace intrusive { \endcode where \p item is the item found, \p val is the find function argument. - You can pass \p f argument by reference using \p std::ref. - The functor may change non-key fields of \p item. The \p val argument is non-const since it can be used as \p f functor destination i.e., the functor diff --git a/cds/intrusive/striped_set/adapter.h b/cds/intrusive/striped_set/adapter.h index fa18554f..7811ba88 100644 --- a/cds/intrusive/striped_set/adapter.h +++ b/cds/intrusive/striped_set/adapter.h @@ -47,8 +47,7 @@ namespace cds { namespace intrusive { \endcode where \p item is the item inserted. - The user-defined functor \p f is called only if the inserting is success. It can be passed by reference - using \p std::ref + The user-defined functor \p f is called only if the inserting is success.
Ensures that the \p item exists in the container @@ -79,8 +78,6 @@ namespace cds { namespace intrusive { The functor can change non-key fields of the \p item. - You can pass \p f argument by reference using \p std::ref - Returns std::pair 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 val key already exists. @@ -102,7 +99,6 @@ namespace cds { namespace intrusive { void operator()(value_type& val); }; \endcode - The functor can be passed by reference using boost:ref The type \p Q can differ from \ref value_type of items storing in the container. Therefore, the \p value_type should be comparable with type \p Q. @@ -125,8 +121,6 @@ namespace cds { namespace intrusive { \endcode where \p item is the item found, \p val is the find function argument. - You can pass \p f argument by reference using \p std::ref. - The functor can change non-key fields of \p item. The \p val argument may be non-const since it can be used as \p f functor destination i.e., the functor can modify both arguments. diff --git a/cds/intrusive/vyukov_mpmc_cycle_queue.h b/cds/intrusive/vyukov_mpmc_cycle_queue.h index 3b4ccdd0..9bf03c8b 100644 --- a/cds/intrusive/vyukov_mpmc_cycle_queue.h +++ b/cds/intrusive/vyukov_mpmc_cycle_queue.h @@ -181,7 +181,6 @@ namespace cds { namespace intrusive { void operator ()( T * val ); }; \endcode - You can pass \p disposer by reference using \p std::ref. The disposer will be called immediately for each item. */ template