--- /dev/null
+/*
+ This file is a part of libcds - Concurrent Data Structures library
+
+ (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_NOGC_H
+#define CDSLIB_CONTAINER_SPLIT_LIST_SET_NOGC_H
+
+#include <cds/intrusive/split_list_nogc.h>
+#include <cds/container/details/split_list_base.h>
+#include <cds/gc/nogc.h>
+#include <cds/container/details/make_split_list_set.h>
+
+namespace cds { namespace container {
+
+ /// Split-ordered list set (template specialization for \p gc::nogc)
+ /** @ingroup cds_nonintrusive_set
+ \anchor cds_nonintrusive_SplitListSet_nogc
+
+ This specialization is so-called append-only container when no item
+ reclamation may be performed. The class does not support deleting of list item.
+
+ See \ref cds_nonintrusive_SplitListSet_hp "SplitListSet" for description of template parameters.
+
+ @warning Many member functions return an iterator pointing to an item.
+ The iterator can be used to set up field of the item,
+ but you should provide an exclusive access to it,
+ see \ref cds_intrusive_item_creating "insert item troubleshooting".
+ */
+ template <
+ class T,
+#ifdef CDS_DOXYGEN_INVOKED
+ class Traits = split_list::traits
+#else
+ class Traits
+#endif
+ >
+ class SplitListSet< cds::gc::nogc, T, Traits>
+#ifdef CDS_DOXYGEN_INVOKED
+ :protected intrusive::SplitListSet<cds::gc::nogc, typename Traits::ordered_list, Traits>
+#else
+ :protected details::make_split_list_set< cds::gc::nogc, T, typename Traits::ordered_list, split_list::details::wrap_set_traits<T, Traits> >::type
+#endif
+ {
+ protected:
+ //@cond
+ typedef details::make_split_list_set< cds::gc::nogc, T, typename Traits::ordered_list, split_list::details::wrap_set_traits<T, Traits> > maker;
+ typedef typename maker::type base_class;
+ //@endcond
+
+ public:
+ typedef cds::gc::nogc gc; ///< Garbage collector
+ typedef T value_type; ///< type of value to be stored in the list
+ typedef Traits traits; ///< List traits
+
+ typedef typename maker::ordered_list ordered_list; ///< Underlying ordered list class
+ typedef typename base_class::key_comparator key_comparator; ///< key comparison functor
+
+ /// Hash functor for \ref 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::stat stat; ///< Internal statistics
+
+ protected:
+ //@cond
+ typedef typename maker::cxx_node_allocator cxx_node_allocator;
+ typedef typename maker::node_type node_type;
+
+ template <typename Q>
+ static node_type * alloc_node(Q const& v )
+ {
+ return cxx_node_allocator().New( v );
+ }
+
+ 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;
+ //@endcond
+
+ public:
+ /// Initialize split-ordered list of default capacity
+ /**
+ The default capacity is defined in bucket table constructor.
+ 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()
+ {}
+
+ /// Initialize split-ordered list
+ SplitListSet(
+ size_t nItemCount ///< estimated average of item count
+ , size_t nLoadFactor = 1 ///< load factor - average item count per bucket. Small integer up to 10, default is 1.
+ )
+ : base_class( nItemCount, nLoadFactor )
+ {}
+
+ protected:
+ //@cond
+ template <bool IsConst>
+ class iterator_type: protected base_class::template iterator_type<IsConst>
+ {
+ typedef typename base_class::template iterator_type<IsConst> iterator_base_class;
+ friend class SplitListSet;
+
+ public:
+ /// Value pointer type (const for const iterator)
+ typedef typename cds::details::make_const_type<value_type, IsConst>::pointer value_ptr;
+ /// Value reference type (const for const iterator)
+ typedef typename cds::details::make_const_type<value_type, IsConst>::reference value_ref;
+
+ public:
+ /// Default ctor
+ iterator_type()
+ {}
+
+ /// Copy ctor
+ iterator_type( iterator_type const& src )
+ : iterator_base_class( src )
+ {}
+
+ protected:
+ explicit iterator_type( iterator_base_class const& src )
+ : iterator_base_class( src )
+ {}
+
+ public:
+ /// Dereference operator
+ value_ptr operator ->() const
+ {
+ return &(iterator_base_class::operator->()->m_Value);
+ }
+
+ /// Dereference operator
+ value_ref operator *() const
+ {
+ return iterator_base_class::operator*().m_Value;
+ }
+
+ /// Pre-increment
+ iterator_type& operator ++()
+ {
+ iterator_base_class::operator++();
+ return *this;
+ }
+
+ /// Assignment operator
+ iterator_type& operator = (iterator_type const& src)
+ {
+ iterator_base_class::operator=(src);
+ return *this;
+ }
+
+ /// Equality operator
+ template <bool C>
+ bool operator ==(iterator_type<C> const& i ) const
+ {
+ return iterator_base_class::operator==(i);
+ }
+
+ /// Equality operator
+ template <bool C>
+ bool operator !=(iterator_type<C> const& i ) const
+ {
+ return iterator_base_class::operator!=(i);
+ }
+ };
+ //@endcond
+
+ public:
+ ///@name Forward iterators
+ //@{
+ /// Forward iterator
+ /**
+ The forward iterator for split-list is based on \p OrderedList forward iterator and has some features:
+ - it has no post-increment operator
+ - it iterates items in unordered fashion
+
+ 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
+ typedef iterator_type<true> const_iterator;
+
+ /// Returns a forward iterator addressing the first element in a set
+ /**
+ For empty set \code begin() == end() \endcode
+ */
+ iterator begin()
+ {
+ return iterator( base_class::begin());
+ }
+
+ /// Returns an iterator that addresses the location succeeding the last element in a set
+ /**
+ Do not use the value returned by <tt>end</tt> function to access any item.
+ The returned value can be used only to control reaching the end of the set.
+ For empty set \code begin() == end() \endcode
+ */
+ iterator end()
+ {
+ return iterator( base_class::end());
+ }
+
+ /// Returns a forward const iterator addressing the first element in a set
+ const_iterator begin() const
+ {
+ 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 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());
+ }
+ //@}
+
+ protected:
+ //@cond
+ iterator insert_node( node_type * pNode )
+ {
+ assert( pNode != nullptr );
+ scoped_node_ptr p(pNode);
+
+ iterator it( base_class::insert_( *pNode ));
+ if ( it != end()) {
+ p.release();
+ return it;
+ }
+
+ return end();
+ }
+ //@endcond
+
+ public:
+ /// Inserts new node
+ /**
+ The function inserts \p val in the set if it does not contain
+ an item with key equal to \p val.
+ The \p value_type should be constructible from a value of type \p Q.
+
+ Return an iterator pointing to inserted item if success \p end() otherwise
+ */
+ template <typename Q>
+ iterator insert( const Q& val )
+ {
+ return insert_node( alloc_node( val ));
+ }
+
+ /// Inserts data of type \p value_type created from \p args
+ /**
+ Return an iterator pointing to inserted item if success \p end() otherwise
+ */
+ template <typename... Args>
+ iterator emplace( Args&&... args )
+ {
+ return insert_node( alloc_node( std::forward<Args>(args)... ));
+ }
+
+ /// Updates the item
+ /**
+ If \p key is not in the set and \p bAllowInsert is \p true, the function inserts a new item.
+ Otherwise, the function returns an iterator pointing to the item found.
+
+ Returns <tt> std::pair<iterator, bool> </tt> where \p first is an iterator pointing to
+ item found or inserted (if inserting is not allowed and \p key is not found, the iterator will be \p end()),
+
+ \p second is true if new item has been added or \p false if the item
+ already is in the set.
+
+ @warning If the set is based on \ref cds_nonintrusive_MichaelList_nogc "MichaelList",
+
+ see \ref cds_intrusive_item_creating "insert item troubleshooting".
+ \ref cds_nonintrusive_LazyList_nogc "LazyList" as the base provides exclusive access to inserted item
+
+ and does not require any node-level synchronization.
+ */
+ template <typename Q>
+ std::pair<iterator, bool> update( Q const& key, bool bAllowInsert = true )
+ {
+ scoped_node_ptr pNode( alloc_node( key ));
+
+ std::pair<typename base_class::iterator, bool> ret = base_class::update_( *pNode,
+
+ [](bool /*bNew*/, node_type& /*item*/, node_type& /*val*/){},
+ bAllowInsert );
+ if ( ret.first != base_class::end() && ret.second ) {
+ pNode.release();
+ return std::make_pair( iterator(ret.first), ret.second );
+ }
+
+ return std::make_pair( iterator(ret.first), ret.second );
+ }
+ //@cond
+ template <typename Q>
+ CDS_DEPRECATED("ensure() is deprecated, use update()")
+ std::pair<iterator, bool> ensure( const Q& val )
+ {
+ return update( val, true );
+ }
+ //@endcond
+
+ /// Checks whether the set contains \p key
+ /**
+ The function searches the item with key equal to \p key
+ and returns an iterator pointed to item found and \ref end() otherwise
+ */
+ template <typename Q>
+ iterator contains( Q const& key )
+ {
+ return iterator( base_class::find_( key ));
+ }
+ //@cond
+ template <typename Q>
+ CDS_DEPRECATED("deprecated, use contains()")
+ iterator find( Q const& key )
+ {
+ return contains( key );
+ }
+ //@endcond
+
+ /// Checks whether the set contains \p key using \p pred predicate for searching
+ /**
+ The function is an analog of <tt>contains( key )</tt> but \p pred is used for key comparing.
+ \p Less functor has the interface like \p std::less.
+ \p pred must imply the same element order as the comparator used for building the set.
+ */
+ template <typename Q, typename Less>
+ iterator contains( Q const& key, Less pred )
+ {
+ CDS_UNUSED( pred );
+ return iterator( base_class::find_with_( key, typename maker::template predicate_wrapper<Less>::type()));
+ }
+ //@cond
+ // eprecated, use contains()
+ template <typename Q, typename Less>
+ iterator find_with( Q const& key, Less pred )
+ {
+ return contains( key, pred );
+ }
+ //@endcond
+
+ /// Clears the set (not atomic, for debugging purposes only)
+ void clear()
+ {
+ base_class::clear();
+ }
+
+ /// Checks if the set is empty
+ /**
+ Emptiness is checked by item counting: if item count is zero then the set is empty.
+ Thus, the correct item counting feature is an important part of split-list set implementation.
+ */
+ bool empty() const
+ {
+ return base_class::empty();
+ }
+
+ /// Returns item count in the set
+ size_t size() const
+ {
+ 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();
+ }
+ };
+
+}} // namespace cds::container
+
+#endif // #ifndef CDSLIB_CONTAINER_SPLIT_LIST_SET_NOGC_H
projects / c11concurrency-benchmarks.git / blobdiff