-//$$CDS-header$$
+/*
+ This file is a part of libcds - Concurrent Data Structures library
-#ifndef __CDS_CONTAINER_SPLIT_LIST_SET_H
-#define __CDS_CONTAINER_SPLIT_LIST_SET_H
+ (C) Copyright Maxim Khizhinsky (libcds.dev@gmail.com) 2006-2017
+
+ Source code repo: http://github.com/khizmax/libcds/
+ Download: http://sourceforge.net/projects/libcds/files/
+
+ Redistribution and use in source and binary forms, with or without
+ modification, are permitted provided that the following conditions are met:
+
+ * Redistributions of source code must retain the above copyright notice, this
+ list of conditions and the following disclaimer.
+
+ * Redistributions in binary form must reproduce the above copyright notice,
+ this list of conditions and the following disclaimer in the documentation
+ and/or other materials provided with the distribution.
+
+ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+ FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+*/
+
+#ifndef CDSLIB_CONTAINER_SPLIT_LIST_SET_H
+#define CDSLIB_CONTAINER_SPLIT_LIST_SET_H
#include <cds/intrusive/split_list.h>
#include <cds/container/details/make_split_list_set.h>
-#include <cds/details/functor_wrapper.h>
+#include <cds/container/details/guarded_ptr_cast.h>
namespace cds { namespace container {
- [2003] Ori Shalev, Nir Shavit "Split-Ordered Lists - Lock-free Resizable Hash Tables"
- [2008] Nir Shavit "The Art of Multiprocessor Programming"
- See intrusive::SplitListSet for a brief description of the split-list algorithm.
+ See \p intrusive::SplitListSet for a brief description of the split-list algorithm.
Template parameters:
- \p GC - Garbage collector used
- - \p T - type stored in the split-list. The type must be default- and copy-constructible.
- - \p Traits - type traits, default is split_list::type_traits. Instead of declaring split_list::type_traits -based
- struct you may apply option-based notation with split_list::make_traits metafunction.
+ - \p T - type to be stored in the split-list.
+ - \p Traits - type traits, default is \p split_list::traits. Instead of declaring \p split_list::traits -based
+ struct you may apply option-based notation with \p split_list::make_traits metafunction.
There are the specializations:
- for \ref cds_urcu_desc "RCU" - declared in <tt>cd/container/split_list_set_rcu.h</tt>,
\par Usage
- You should decide what garbage collector you want, and what ordered list you want to use. Split-ordered list
- is original data structure based on an ordered list. Suppose, you want construct split-list set based on gc::PTB GC
- and LazyList as ordered list implementation. So, you beginning your program with following include:
+ You should decide what garbage collector you want, and what ordered list you want to use as a base. Split-ordered list
+ is original data structure based on an ordered list.
+
+ Suppose, you want construct split-list set based on \p gc::DHP GC
+ and \p LazyList as ordered list implementation. So, you beginning your program with following include:
\code
- #include <cds/container/lazy_list_ptb.h>
+ #include <cds/container/lazy_list_dhp.h>
#include <cds/container/split_list_set.h>
namespace cc = cds::container;
std::string strValue ; // value field
};
\endcode
- The inclusion order is important: first, include header for ordered-list implementation (for this example, <tt>cds/container/lazy_list_ptb.h</tt>),
+ The inclusion order is important: first, include header for ordered-list implementation (for this example, <tt>cds/container/lazy_list_dhp.h</tt>),
then the header for split-list set <tt>cds/container/split_list_set.h</tt>.
Now, you should declare traits for split-list set. The main parts of traits are a hash functor for the set and a comparing functor for ordered list.
Note that we define several function in <tt>foo_hash</tt> and <tt>foo_less</tt> functors for different argument types since we want call our \p %SplitListSet
object by the key of type <tt>int</tt> and by the value of type <tt>foo</tt>.
- The second attention: instead of using \p %LazyList in \p %SplitListSet traits we use a tag <tt>cds::contaner::lazy_list_tag</tt> for the lazy list.
+ The second attention: instead of using \p %LazyList in \p %SplitListSet traits we use a tag \p cds::contaner::lazy_list_tag for the lazy list.
The split-list requires significant support from underlying ordered list class and it is not good idea to dive you
into deep implementation details of split-list and ordered list interrelations. The tag paradigm simplifies split-list interface.
};
// SplitListSet traits
- struct foo_set_traits: public cc::split_list::type_traits
+ struct foo_set_traits: public cc::split_list::traits
{
- typedef cc::lazy_list_tag ordered_list ; // what type of ordered list we want to use
- typedef foo_hash hash ; // hash functor for our data stored in split-list set
+ typedef cc::lazy_list_tag ordered_list; // what type of ordered list we want to use
+ typedef foo_hash hash; // hash functor for our data stored in split-list set
// Type traits for our LazyList class
- struct ordered_list_traits: public cc::lazy_list::type_traits
+ struct ordered_list_traits: public cc::lazy_list::traits
{
typedef foo_less less ; // use our foo_less as comparator to order list nodes
};
Now you are ready to declare our set class based on \p %SplitListSet:
\code
- typedef cc::SplitListSet< cds::gc::PTB, foo, foo_set_traits > foo_set;
+ typedef cc::SplitListSet< cds::gc::DHP, foo, foo_set_traits > foo_set;
\endcode
- You may use the modern option-based declaration instead of classic type-traits-based one:
+ You may use the modern option-based declaration instead of classic traits-based one:
\code
- typedef cc:SplitListSet<
- cs::gc::PTB // GC used
+ typedef cc::SplitListSet<
+ cs::gc::DHP // GC used
,foo // type of data stored
,cc::split_list::make_traits< // metafunction to build split-list traits
- cc::split_list::ordered_list<cc::lazy_list_tag> // tag for underlying ordered list implementation
+ cc::split_list::ordered_list<cc::lazy_list_tag> // tag for underlying ordered list implementation
,cc::opt::hash< foo_hash > // hash functor
,cc::split_list::ordered_list_traits< // ordered list traits desired
- cc::lazy_list::make_traits< // metafunction to build lazy list traits
- cc::opt::less< foo_less > // less-based compare functor
+ cc::lazy_list::make_traits< // metafunction to build lazy list traits
+ cc::opt::less< foo_less > // less-based compare functor
>::type
>
>::type
Now, the set of type \p foo_set is ready to use in your program.
- Note that in this example we show only mandatory type_traits parts, optional ones is the default and they are inherited
- from cds::container::split_list::type_traits.
- The <b>cds</b> library contains many other options for deep tuning of behavior of the split-list and
- ordered-list containers.
+ Note that in this example we show only mandatory \p traits parts, optional ones is the default and they are inherited
+ from \p cds::container::split_list::traits.
+ There are many other options for deep tuning the split-list and ordered-list containers.
*/
template <
class GC,
class T,
#ifdef CDS_DOXYGEN_INVOKED
- class Traits = split_list::type_traits
+ class Traits = split_list::traits
#else
class Traits
#endif
//@endcond
public:
- typedef Traits options ; ///< \p Traits template argument
- typedef typename maker::gc gc ; ///< Garbage collector
- typedef typename maker::value_type value_type ; ///< type of value stored in the list
- typedef typename maker::ordered_list ordered_list ; ///< Underlying ordered list class
+ typedef GC gc; ///< Garbage collector
+ typedef T value_type; ///< Type of vlue to be stored in split-list
+ typedef Traits traits; ///< \p Traits template argument
+ typedef typename maker::ordered_list ordered_list; ///< Underlying ordered list class
typedef typename base_class::key_comparator key_comparator; ///< key compare functor
/// Hash functor for \p %value_type and all its derivatives that you use
- typedef typename base_class::hash hash;
- typedef typename base_class::item_counter item_counter ; ///< Item counter type
+ typedef typename base_class::hash hash;
+ typedef typename base_class::item_counter item_counter; ///< Item counter type
+ typedef typename base_class::stat stat; ///< Internal statistics
+
+ /// Count of hazard pointer required
+ static CDS_CONSTEXPR const size_t c_nHazardPtrCount = base_class::c_nHazardPtrCount;
protected:
//@cond
- typedef typename maker::cxx_node_allocator cxx_node_allocator;
- typedef typename maker::node_type node_type;
+ typedef typename maker::cxx_node_allocator cxx_node_allocator;
+ typedef typename maker::node_type node_type;
//@endcond
public:
/// Guarded pointer
- typedef cds::gc::guarded_ptr< gc, node_type, value_type, details::guarded_ptr_cast_set<node_type, value_type> > guarded_ptr;
+ typedef typename gc::template guarded_ptr< node_type, value_type, details::guarded_ptr_cast_set<node_type, value_type> > guarded_ptr;
protected:
//@cond
- template <typename Q>
- static node_type * alloc_node(Q const& v )
- {
- return cxx_node_allocator().New( v );
- }
-
- template <typename Q, typename Func>
- bool find_( Q& val, Func f )
- {
- return base_class::find( val, [&f]( node_type& item, Q& val ) { cds::unref(f)(item.m_Value, val) ; } );
- }
-
- template <typename Q, typename Less, typename Func>
- bool find_with_( Q& val, Less pred, Func f )
- {
- return base_class::find_with( val, typename maker::template predicate_wrapper<Less>::type(),
- [&f]( node_type& item, Q& val ) { cds::unref(f)(item.m_Value, val) ; } );
- }
-
- template <typename... Args>
- static node_type * alloc_node( Args&&... args )
- {
- return cxx_node_allocator().MoveNew( std::forward<Args>(args)...);
- }
-
- static void free_node( node_type * pNode )
- {
- cxx_node_allocator().Delete( pNode );
- }
-
- struct node_disposer {
- void operator()( node_type * pNode )
- {
- free_node( pNode );
- }
- };
- typedef std::unique_ptr< node_type, node_disposer > scoped_node_ptr;
-
- bool insert_node( node_type * pNode )
- {
- assert( pNode != nullptr );
- scoped_node_ptr p(pNode);
-
- if ( base_class::insert( *pNode ) ) {
- p.release();
- return true;
- }
-
- return false;
- }
-
- //@endcond
-
- protected:
- /// Forward iterator
- /**
- \p IsConst - constness boolean flag
-
- The forward iterator for a split-list has the following features:
- - it has no post-increment operator
- - it depends on underlying ordered list iterator
- - The iterator object cannot be moved across thread boundary since it contains GC's guard that is thread-private GC data.
- - Iterator ensures thread-safety even if you delete the item that iterator points to. However, in case of concurrent
- deleting operations it is no guarantee that you iterate all item in the split-list.
-
- Therefore, the use of iterators in concurrent environment is not good idea. Use it for debug purpose only.
- */
template <bool IsConst>
class iterator_type: protected base_class::template iterator_type<IsConst>
{
- //@cond
typedef typename base_class::template iterator_type<IsConst> iterator_base_class;
friend class SplitListSet;
- //@endcond
+
public:
/// Value pointer type (const for const iterator)
typedef typename cds::details::make_const_type<value_type, IsConst>::pointer value_ptr;
{}
protected:
- //@cond
explicit iterator_type( iterator_base_class const& src )
: iterator_base_class( src )
{}
- //@endcond
public:
/// Dereference operator
return iterator_base_class::operator!=(i);
}
};
+ //@endcond
public:
/// Initializes split-ordered list of default capacity
/**
The default capacity is defined in bucket table constructor.
- See intrusive::split_list::expandable_bucket_table, intrusive::split_list::static_bucket_table
- which selects by intrusive::split_list::dynamic_bucket_table option.
+ See \p intrusive::split_list::expandable_bucket_table, \p intrusive::split_list::static_bucket_table
+ which selects by \p split_list::dynamic_bucket_table option.
*/
SplitListSet()
: base_class()
/// Initializes split-ordered list
SplitListSet(
- size_t nItemCount ///< estimate average of item count
- , size_t nLoadFactor = 1 ///< load factor - average item count per bucket. Small integer up to 8, default is 1.
+ size_t nItemCount ///< estimated average of item count
+ , size_t nLoadFactor = 1 ///< the load factor - average item count per bucket. Small integer up to 8, default is 1.
)
: base_class( nItemCount, nLoadFactor )
{}
public:
+ ///@name Forward iterators (only for debugging purpose)
+ //@{
/// Forward iterator
+ /**
+ The forward iterator for a split-list has the following features:
+ - it has no post-increment operator
+ - it depends on underlying ordered list iterator
+ - The iterator object cannot be moved across thread boundary because it contains GC's guard that is thread-private GC data.
+ - Iterator ensures thread-safety even if you delete the item that iterator points to. However, in case of concurrent
+ deleting operations it is no guarantee that you iterate all item in the split-list.
+ Moreover, a crash is possible when you try to iterate the next element that has been deleted by concurrent thread.
+
+ @warning Use this iterator on the concurrent container for debugging purpose only.
+
+ The iterator interface:
+ \code
+ class iterator {
+ public:
+ // Default constructor
+ iterator();
+
+ // Copy construtor
+ iterator( iterator const& src );
+
+ // Dereference operator
+ value_type * operator ->() const;
+
+ // Dereference operator
+ value_type& operator *() const;
+
+ // Preincrement operator
+ iterator& operator ++();
+
+ // Assignment operator
+ iterator& operator = (iterator const& src);
+
+ // Equality operators
+ bool operator ==(iterator const& i ) const;
+ bool operator !=(iterator const& i ) const;
+ };
+ \endcode
+ */
typedef iterator_type<false> iterator;
/// Const forward iterator
*/
iterator begin()
{
- return iterator( base_class::begin() );
+ return iterator( base_class::begin());
}
/// Returns an iterator that addresses the location succeeding the last element in a set
*/
iterator end()
{
- return iterator( base_class::end() );
+ return iterator( base_class::end());
}
/// Returns a forward const iterator addressing the first element in a set
const_iterator begin() const
{
- return const_iterator( base_class::begin() );
+ return cbegin();
+ }
+ /// Returns a forward const iterator addressing the first element in a set
+ const_iterator cbegin() const
+ {
+ return const_iterator( base_class::cbegin());
}
/// Returns an const iterator that addresses the location succeeding the last element in a set
const_iterator end() const
{
- return const_iterator( base_class::end() );
+ return cend();
}
+ /// Returns an const iterator that addresses the location succeeding the last element in a set
+ const_iterator cend() const
+ {
+ return const_iterator( base_class::cend());
+ }
+ //@}
public:
/// Inserts new node
Returns \p true if \p val is inserted into the set, \p false otherwise.
*/
template <typename Q>
- bool insert( Q const& val )
+ bool insert( Q&& val )
{
- return insert_node( alloc_node( val ) );
+ return insert_node( alloc_node( std::forward<Q>( val )));
}
/// Inserts new node
\code
void func( value_type& val );
\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 <tt>boost::ref</tt>
+ where \p val is the item inserted.
+
+ The user-defined functor is called only if the inserting is success.
+
+ @warning For \ref cds_intrusive_MichaelList_hp "MichaelList" as the bucket see \ref cds_intrusive_item_creating "insert item troubleshooting".
+ \ref cds_intrusive_LazyList_hp "LazyList" provides exclusive access to inserted item and does not require any node-level
+ synchronization.
*/
template <typename Q, typename Func>
- bool insert( Q const& val, Func f )
+ bool insert( Q&& val, Func f )
{
- scoped_node_ptr pNode( alloc_node( val ));
+ scoped_node_ptr pNode( alloc_node( std::forward<Q>( val )));
- if ( base_class::insert( *pNode, [&f](node_type& node) { cds::unref(f)( node.m_Value ) ; } )) {
+ if ( base_class::insert( *pNode, [&f](node_type& node) { f( node.m_Value ) ; } )) {
pNode.release();
return true;
}
return false;
}
- /// Inserts data of type \p %value_type constructed with <tt>std::forward<Args>(args)...</tt>
+ /// Inserts data of type \p value_type created from \p args
/**
Returns \p true if inserting successful, \p false otherwise.
*/
return insert_node( alloc_node( std::forward<Args>(args)...));
}
- /// Ensures that the \p item exists in the set
+ /// Inserts or updates the node (only for \p IterableList -based set)
/**
The operation performs inserting or changing data with lock-free manner.
- If the \p val key not found in the set, then the new item created from \p val
- is inserted into the set. Otherwise, the functor \p func is called with the item found.
- The functor \p Func should be a function with signature:
- \code
- void func( bool bNew, value_type& item, const Q& val );
- \endcode
- or a functor:
+ If the item \p val is not found in the set, then \p val is inserted iff \p bAllowInsert is \p true.
+ Otherwise, the current element is changed to \p val, the old element will be retired later.
+
+ Returns std::pair<bool, bool> where \p first is \p true if operation is successful,
+ \p second is \p true if \p val has been added or \p false if the item with that key
+ already in the set.
+ */
+ template <typename Q>
+#ifdef CDS_DOXYGEN_INVOKED
+ std::pair<bool, bool>
+#else
+ typename std::enable_if<
+ std::is_same< Q, Q>::value && is_iterable_list< ordered_list >::value,
+ std::pair<bool, bool>
+ >::type
+#endif
+ upsert( Q&& val, bool bAllowInsert = true )
+ {
+ scoped_node_ptr pNode( alloc_node( std::forward<Q>( val )));
+
+ auto bRet = base_class::upsert( *pNode, bAllowInsert );
+
+ if ( bRet.first )
+ pNode.release();
+ return bRet;
+ }
+
+ /// Updates the node
+ /**
+ The operation performs inserting or changing data with lock-free manner.
+
+ If \p key is not found in the set, then \p key is inserted iff \p bAllowInsert is \p true.
+ Otherwise, the functor \p func is called with item found.
+
+ The functor \p func signature depends of ordered list:
+
+ <b>for \p MichaelList, \p LazyList</b>
\code
- struct my_functor {
- void operator()( bool bNew, value_type& item, const Q& val );
+ struct functor {
+ void operator()( bool bNew, value_type& item, Q const& val );
};
\endcode
-
with arguments:
- \p bNew - \p true if the item has been inserted, \p false otherwise
- \p item - item of the set
- - \p val - argument \p val passed into the \p ensure function
+ - \p val - argument \p val passed into the \p %update() function
- 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.
+ The functor may change non-key fields of the \p item.
- You may pass \p func argument by reference using <tt>boost::ref</tt>.
+ <b>for \p IterableList</b>
+ \code
+ void func( value_type& val, value_type * old );
+ \endcode
+ where
+ - \p val - a new data constructed from \p key
+ - \p old - old value that will be retired. If new item has been inserted then \p old is \p nullptr.
- Returns <tt> std::pair<bool, bool> </tt> where \p first is true if operation is successfull,
+ Returns <tt> std::pair<bool, bool> </tt> where \p first is true if operation is successful,
\p second is true if new item has been added or \p false if the item with \p key
already is in the set.
+
+ @warning For \ref cds_intrusive_MichaelList_hp "MichaelList" and \ref cds_nonintrusive_IterableList_gc "IterableList"
+ as the bucket see \ref cds_intrusive_item_creating "insert item troubleshooting".
+ \ref cds_intrusive_LazyList_hp "LazyList" provides exclusive access to inserted item and does not require any node-level
+ synchronization.
*/
template <typename Q, typename Func>
- std::pair<bool, bool> ensure( Q const& val, Func func )
+#ifdef CDS_DOXYGEN_INVOKED
+ std::pair<bool, bool>
+#else
+ typename std::enable_if<
+ std::is_same<Q, Q>::value && !is_iterable_list<ordered_list>::value,
+ std::pair<bool, bool>
+ >::type
+#endif
+ update( Q&& val, Func func, bool bAllowInsert = true )
{
- scoped_node_ptr pNode( alloc_node( val ));
+ scoped_node_ptr pNode( alloc_node( std::forward<Q>( val )));
- std::pair<bool, bool> bRet = base_class::ensure( *pNode,
+ auto bRet = base_class::update( *pNode,
[&func, &val]( bool bNew, node_type& item, node_type const& /*val*/ ) {
- cds::unref(func)( bNew, item.m_Value, val );
- } );
+ func( bNew, item.m_Value, val );
+ }, bAllowInsert );
if ( bRet.first && bRet.second )
pNode.release();
return bRet;
}
+ //@cond
+ template <typename Q, typename Func>
+ typename std::enable_if<
+ std::is_same<Q, Q>::value && is_iterable_list<ordered_list>::value,
+ std::pair<bool, bool>
+ >::type
+ update( Q&& val, Func func, bool bAllowInsert = true )
+ {
+ scoped_node_ptr pNode( alloc_node( std::forward<Q>( val )));
+
+ auto bRet = base_class::update( *pNode,
+ [&func]( node_type& item, node_type* old ) {
+ func( item.m_Value, old ? &old->m_Value : nullptr );
+ }, bAllowInsert );
+
+ if ( bRet.first )
+ pNode.release();
+ return bRet;
+ }
+ //@endcond
+
+ //@cond
+ template <typename Q, typename Func>
+ CDS_DEPRECATED("ensure() is deprecated, use update()")
+ std::pair<bool, bool> ensure( Q const& val, Func func )
+ {
+ return update( val, func, true );
+ }
+ //@endcond
/// Deletes \p key from the set
/** \anchor cds_nonintrusive_SplitListSet_erase_val
template <typename Q, typename Less>
bool erase_with( Q const& key, Less pred )
{
- return base_class::erase_with( key, typename maker::template predicate_wrapper<Less>::type() );
+ CDS_UNUSED( pred );
+ return base_class::erase_with( key, typename maker::template predicate_wrapper<Less>::type());
}
/// Deletes \p key from the set
void operator()(value_type const& val);
};
\endcode
- The functor may be passed by reference using <tt>boost:ref</tt>
- Since the key of SplitListSet's \p value_type is not explicitly specified,
+ Since the key of split-list \p value_type is not explicitly specified,
template parameter \p Q defines the key type searching in the list.
The list item comparator should be able to compare the values of the type \p value_type
and the type \p Q.
template <typename Q, typename Func>
bool erase( Q const& key, Func f )
{
- return base_class::erase( key, [&f](node_type& node) { cds::unref(f)( node.m_Value ); } );
+ return base_class::erase( key, [&f](node_type& node) { f( node.m_Value ); } );
}
/// Deletes the item from the set using \p pred predicate for searching
template <typename Q, typename Less, typename Func>
bool erase_with( Q const& key, Less pred, Func f )
{
+ CDS_UNUSED( pred );
return base_class::erase_with( key, typename maker::template predicate_wrapper<Less>::type(),
- [&f](node_type& node) { cds::unref(f)( node.m_Value ); } );
+ [&f](node_type& node) { f( node.m_Value ); } );
+ }
+
+ /// Deletes the item pointed by iterator \p iter (only for \p IterableList based set)
+ /**
+ Returns \p true if the operation is successful, \p false otherwise.
+ The function can return \p false if the node the iterator points to has already been deleted
+ by other thread.
+
+ The function does not invalidate the iterator, it remains valid and can be used for further traversing.
+
+ @note \p %erase_at() is supported only for \p %SplitListSet based on \p IterableList.
+ */
+#ifdef CDS_DOXYGEN_INVOKED
+ bool erase_at( iterator const& iter )
+#else
+ template <typename Iterator>
+ typename std::enable_if< std::is_same<Iterator, iterator>::value && is_iterable_list< ordered_list >::value, bool >::type
+ erase_at( Iterator const& iter )
+#endif
+ {
+ return base_class::erase_at( static_cast<typename iterator::iterator_base_class const&>( iter ));
}
+
/// Extracts the item with specified \p key
/** \anchor cds_nonintrusive_SplitListSet_hp_extract
The function searches an item with key equal to \p key,
- unlinks it from the set, and returns it in \p dest parameter.
- If the item with key equal to \p key is not found the function returns \p false.
+ unlinks it from the set, and returns it as \p guarded_ptr.
+ If \p key is not found the function returns an empty guarded pointer.
Note the compare functor should accept a parameter of type \p Q that may be not the same as \p value_type.
- The extracted item is freed automatically when returned \ref guarded_ptr object will be destroyed or released.
+ The extracted item is freed automatically when returned \p guarded_ptr object will be destroyed or released.
@note Each \p guarded_ptr object uses the GC's guard that can be limited resource.
Usage:
splitlist_set theSet;
// ...
{
- splitlist_set::guarded_ptr gp;
- theSet.extract( gp, 5 );
- // Deal with gp
- // ...
-
+ splitlist_set::guarded_ptr gp(theSet.extract( 5 ));
+ if ( gp ) {
+ // Deal with gp
+ // ...
+ }
// Destructor of gp releases internal HP guard
}
\endcode
*/
template <typename Q>
- bool extract( guarded_ptr& dest, Q const& key )
+ guarded_ptr extract( Q const& key )
{
- return extract_( dest.guard(), key );
+ return extract_( key );
}
/// Extracts the item using compare functor \p pred
/**
- The function is an analog of \ref cds_nonintrusive_SplitListSet_hp_extract "extract(guarded_ptr&, Q const&)"
+ The function is an analog of \ref cds_nonintrusive_SplitListSet_hp_extract "extract(Q const&)"
but \p pred predicate is used for key comparing.
\p Less functor has the semantics like \p std::less but should take arguments of type \ref value_type and \p Q
\p pred must imply the same element order as the comparator used for building the set.
*/
template <typename Q, typename Less>
- bool extract_with( guarded_ptr& dest, Q const& key, Less pred )
+ guarded_ptr extract_with( Q const& key, Less pred )
{
- return extract_with_( dest.guard(), key, pred );
+ return extract_with_( key, pred );
}
- /// Finds the key \p val
+ /// Finds the key \p key
/** \anchor cds_nonintrusive_SplitListSet_find_func
- The function searches the item with key equal to \p val and calls the functor \p f for item found.
+ The function searches the item with key equal to \p key and calls the functor \p f for item found.
The interface of \p Func functor is:
\code
struct functor {
- void operator()( value_type& item, Q& val );
+ void operator()( value_type& item, Q& key );
};
\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.
+ where \p item is the item found, \p key is the <tt>find</tt> function argument.
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
possible you must provide your own synchronization schema on item level to exclude unsafe item modifications.
- The \p val argument is non-const since it can be used as \p f functor destination i.e., the functor
+ The \p key argument is non-const since it can be used as \p f functor destination i.e., the functor
may modify both arguments.
Note the hash functor specified for class \p Traits template parameter
should accept a parameter of type \p Q that can be not the same as \p value_type.
- The function returns \p true if \p val is found, \p false otherwise.
+ The function returns \p true if \p key is found, \p false otherwise.
*/
template <typename Q, typename Func>
- bool find( Q& val, Func f )
+ bool find( Q& key, Func f )
+ {
+ return find_( key, f );
+ }
+ //@cond
+ template <typename Q, typename Func>
+ bool find( Q const& key, Func f )
{
- return find_( val, f );
+ return find_( key, f );
}
+ //@endcond
- /// Finds the key \p val using \p pred predicate for searching
+ /// Finds \p key and returns iterator pointed to the item found (only for \p IterableList -based set)
+ /**
+ If \p key is not found the function returns \p end().
+
+ @note This function is supported only for the set based on \p IterableList
+ */
+ template <typename Q>
+#ifdef CDS_DOXYGEN_INVOKED
+ iterator
+#else
+ typename std::enable_if< std::is_same<Q,Q>::value && is_iterable_list< ordered_list >::value, iterator >::type
+#endif
+ find( Q& key )
+ {
+ return find_iterator_( key );
+ }
+ //@cond
+ template <typename Q>
+ typename std::enable_if< std::is_same<Q, Q>::value && is_iterable_list< ordered_list >::value, iterator >::type
+ find( Q const& key )
+ {
+ return find_iterator_( key );
+ }
+ //@endcond
+
+
+ /// Finds the key \p key using \p pred predicate for searching
/**
The function is an analog of \ref cds_nonintrusive_SplitListSet_find_func "find(Q&, Func)"
but \p pred is used for key comparing.
\p Less must imply the same element order as the comparator used for building the set.
*/
template <typename Q, typename Less, typename Func>
- bool find_with( Q& val, Less pred, Func f )
+ bool find_with( Q& key, Less pred, Func f )
{
- return find_with_( val, pred, f );
+ return find_with_( key, pred, f );
}
-
- /// Finds the key \p val
- /** \anchor cds_nonintrusive_SplitListSet_find_cfunc
-
- The function searches the item with key equal to \p val and calls the functor \p f for item found.
- The interface of \p Func functor is:
- \code
- struct functor {
- void operator()( value_type& item, Q const& val );
- };
- \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.
-
- 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
- possible you must provide your own synchronization schema on item level to exclude unsafe item modifications.
-
- Note the hash functor specified for class \p Traits template parameter
- should accept a parameter of type \p Q that can be not the same as \p value_type.
-
- The function returns \p true if \p val is found, \p false otherwise.
- */
- template <typename Q, typename Func>
- bool find( Q const& val, Func f )
+ //@cond
+ template <typename Q, typename Less, typename Func>
+ bool find_with( Q const& key, Less pred, Func f )
{
- return find_( val, f );
+ return find_with_( key, pred, f );
}
+ //@endcond
- /// Finds the key \p val using \p pred predicate for searching
+ /// Finds \p key using \p pred predicate and returns iterator pointed to the item found (only for \p IterableList -based set)
/**
- The function is an analog of \ref cds_nonintrusive_SplitListSet_find_cfunc "find(Q const&, Func)"
- but \p pred is used for key comparing.
+ The function is an analog of \p find(Q&) but \p pred is used for key comparing.
\p Less functor has the interface like \p std::less.
- \p Less must imply the same element order as the comparator used for building the set.
+ \p pred must imply the same element order as the comparator used for building the set.
+
+ If \p key is not found the function returns \p end().
+
+ @note This function is supported only for the set based on \p IterableList
*/
- template <typename Q, typename Less, typename Func>
- bool find_with( Q const& val, Less pred, Func f )
+ template <typename Q, typename Less>
+#ifdef CDS_DOXYGEN_INVOKED
+ iterator
+#else
+ typename std::enable_if< std::is_same<Q, Q>::value && is_iterable_list< ordered_list >::value, iterator >::type
+#endif
+ find_with( Q& key, Less pred )
{
- return find_with_( val, pred, f );
+ return find_iterator_with_( key, pred );
}
+ //@cond
+ template <typename Q, typename Less>
+ typename std::enable_if< std::is_same<Q, Q>::value && is_iterable_list< ordered_list >::value, iterator >::type
+ find_with( Q const& key, Less pred )
+ {
+ return find_iterator_with_( key, pred );
+ }
+ //@endcond
- /// Finds the key \p val
- /** \anchor cds_nonintrusive_SplitListSet_find_val
-
- The function searches the item with key equal to \p val
+ /// Checks whether the set contains \p key
+ /**
+ The function searches the item with key equal to \p key
and returns \p true if it is found, and \p false otherwise.
Note the hash functor specified for class \p Traits template parameter
- should accept a parameter of type \p Q that can be not the same as \ref value_type.
+ should accept a parameter of type \p Q that can be not the same as \p value_type.
+ Otherwise, you may use \p contains( Q const&, Less pred ) functions with explicit predicate for key comparing.
*/
template <typename Q>
- bool find( Q const& val )
+ bool contains( Q const& key )
{
- return base_class::find( val );
+ return base_class::contains( key );
}
- /// Finds the key \p val using \p pred predicate for searching
+ /// Checks whether the map contains \p key using \p pred predicate for searching
/**
- The function is an analog of \ref cds_nonintrusive_SplitListSet_find_val "find(Q const&)"
- but \p pred is used for key comparing.
+ The function is similar to <tt>contains( key )</tt> but \p pred is used for key comparing.
\p Less functor has the interface like \p std::less.
- \p Less must imply the same element order as the comparator used for building the set.
+ \p Less must imply the same element order as the comparator used for building the map.
*/
template <typename Q, typename Less>
- bool find_with( Q const& val, Less pred )
+ bool contains( Q const& key, Less pred )
{
- return base_class::find_with( val, typename maker::template predicate_wrapper<Less>::type() );
+ CDS_UNUSED( pred );
+ return base_class::contains( key, typename maker::template predicate_wrapper<Less>::type());
}
/// Finds the key \p key and return the item found
/** \anchor cds_nonintrusive_SplitListSet_hp_get
The function searches the item with key equal to \p key
- and assigns the item found to guarded pointer \p ptr.
- The function returns \p true if \p key is found, and \p false otherwise.
- If \p key is not found the \p ptr parameter is not changed.
+ and returns the item found as \p guarded_ptr.
+ If \p key is not found the function returns an empty guarded pointer.
@note Each \p guarded_ptr object uses one GC's guard which can be limited resource.
splitlist_set theSet;
// ...
{
- splitlist_set::guarded_ptr gp;
- if ( theSet.get( gp, 5 )) {
+ splitlist_set::guarded_ptr gp(theSet.get( 5 ));
+ if ( gp ) {
// Deal with gp
//...
}
should accept a parameter of type \p Q that can be not the same as \p value_type.
*/
template <typename Q>
- bool get( guarded_ptr& ptr, Q const& key )
+ guarded_ptr get( Q const& key )
{
- return get_( ptr.guard(), key );
+ return get_( key );
}
/// Finds \p key and return the item found
/**
- The function is an analog of \ref cds_nonintrusive_SplitListSet_hp_get "get( guarded_ptr&, Q const&)"
+ The function is an analog of \ref cds_nonintrusive_SplitListSet_hp_get "get( Q const&)"
but \p pred is used for comparing the keys.
\p Less functor has the semantics like \p std::less but should take arguments of type \ref value_type and \p Q
\p pred must imply the same element order as the comparator used for building the set.
*/
template <typename Q, typename Less>
- bool get_with( guarded_ptr& ptr, Q const& key, Less pred )
+ guarded_ptr get_with( Q const& key, Less pred )
{
- return get_with_( ptr.guard(), key, pred );
+ return get_with_( key, pred );
}
- /// Clears the set (non-atomic)
- /**
- The function unlink all items from the set.
- The function is not atomic and not lock-free and should be used for debugging only.
- */
+ /// Clears the set (not atomic)
void clear()
{
base_class::clear();
return base_class::size();
}
+ /// Returns internal statistics
+ stat const& statistics() const
+ {
+ return base_class::statistics();
+ }
+
+ /// Returns internal statistics for \p ordered_list
+ typename ordered_list::stat const& list_statistics() const
+ {
+ return base_class::list_statistics();
+ }
+
protected:
//@cond
using base_class::extract_;
using base_class::get_;
+ template <typename... Args>
+ static node_type * alloc_node( Args&&... args )
+ {
+ return cxx_node_allocator().MoveNew( std::forward<Args>( args )... );
+ }
+
+ static void free_node( node_type * pNode )
+ {
+ cxx_node_allocator().Delete( pNode );
+ }
+
+ template <typename Q, typename Func>
+ bool find_( Q& val, Func f )
+ {
+ return base_class::find( val, [&f]( node_type& item, Q& v ) { f( item.m_Value, v ); } );
+ }
+
+ template <typename Q>
+ typename std::enable_if< std::is_same<Q,Q>::value && is_iterable_list< ordered_list >::value, iterator>::type
+ find_iterator_( Q& val )
+ {
+ return iterator( base_class::find( val ));
+ }
+
+ template <typename Q, typename Less, typename Func>
+ bool find_with_( Q& val, Less pred, Func f )
+ {
+ CDS_UNUSED( pred );
+ return base_class::find_with( val, typename maker::template predicate_wrapper<Less>::type(),
+ [&f]( node_type& item, Q& v ) { f( item.m_Value, v ); } );
+ }
+
template <typename Q, typename Less>
- bool extract_with_( typename gc::Guard& guard, Q const& key, Less pred )
+ typename std::enable_if< std::is_same<Q, Q>::value && is_iterable_list< ordered_list >::value, iterator>::type
+ find_iterator_with_( Q& val, Less pred )
{
- return base_class::extract_with_( guard, key, typename maker::template predicate_wrapper<Less>::type() );
+ CDS_UNUSED( pred );
+ return iterator( base_class::find_with( val, typename maker::template predicate_wrapper<Less>::type()));
+ }
+
+ struct node_disposer {
+ void operator()( node_type * pNode )
+ {
+ free_node( pNode );
+ }
+ };
+ typedef std::unique_ptr< node_type, node_disposer > scoped_node_ptr;
+
+ bool insert_node( node_type * pNode )
+ {
+ assert( pNode != nullptr );
+ scoped_node_ptr p( pNode );
+
+ if ( base_class::insert( *pNode )) {
+ p.release();
+ return true;
+ }
+ return false;
}
template <typename Q, typename Less>
- bool get_with_( typename gc::Guard& guard, Q const& key, Less pred )
+ guarded_ptr extract_with_( Q const& key, Less pred )
{
- return base_class::get_with_( guard, key, typename maker::template predicate_wrapper<Less>::type() );
+ CDS_UNUSED( pred );
+ return base_class::extract_with_( key, typename maker::template predicate_wrapper<Less>::type());
}
- //@endcond
+ template <typename Q, typename Less>
+ guarded_ptr get_with_( Q const& key, Less pred )
+ {
+ CDS_UNUSED( pred );
+ return base_class::get_with_( key, typename maker::template predicate_wrapper<Less>::type());
+ }
+ //@endcond
};
-
}} // namespace cds::container
-#endif // #ifndef __CDS_CONTAINER_SPLIT_LIST_SET_H
+#endif // #ifndef CDSLIB_CONTAINER_SPLIT_LIST_SET_H
projects / libcds.git / blobdiff