Rename cds/container/skip_list_map_impl.h to cds/container/impl/skip_list_map.h
authorkhizmax <libcds.dev@gmail.com>
Sat, 27 Sep 2014 19:21:14 +0000 (23:21 +0400)
committerkhizmax <libcds.dev@gmail.com>
Sat, 27 Sep 2014 19:21:14 +0000 (23:21 +0400)
cds/container/impl/skip_list_map.h [new file with mode: 0644]
cds/container/skip_list_map_hp.h
cds/container/skip_list_map_hrc.h
cds/container/skip_list_map_impl.h [deleted file]
cds/container/skip_list_map_ptb.h
projects/Win/vc12/cds.vcxproj
projects/Win/vc12/cds.vcxproj.filters

diff --git a/cds/container/impl/skip_list_map.h b/cds/container/impl/skip_list_map.h
new file mode 100644 (file)
index 0000000..dd5e785
--- /dev/null
@@ -0,0 +1,673 @@
+//$$CDS-header$$
+
+#ifndef __CDS_CONTAINER_IMPL_SKIP_LIST_MAP_H
+#define __CDS_CONTAINER_IMPL_SKIP_LIST_MAP_H
+
+#include <cds/details/functor_wrapper.h>
+#include <cds/gc/guarded_ptr.h>
+#include <cds/container/details/guarded_ptr_cast.h>
+
+namespace cds { namespace container {
+
+    /// Lock-free skip-list map
+    /** @ingroup cds_nonintrusive_map
+        \anchor cds_nonintrusive_SkipListMap_hp
+
+        The implementation of well-known probabilistic data structure called skip-list
+        invented by W.Pugh in his papers:
+            - [1989] W.Pugh Skip Lists: A Probabilistic Alternative to Balanced Trees
+            - [1990] W.Pugh A Skip List Cookbook
+
+        A skip-list is a probabilistic data structure that provides expected logarithmic
+        time search without the need of rebalance. The skip-list is a collection of sorted
+        linked list. Nodes are ordered by key. Each node is linked into a subset of the lists.
+        Each list has a level, ranging from 0 to 32. The bottom-level list contains
+        all the nodes, and each higher-level list is a sublist of the lower-level lists.
+        Each node is created with a random top level (with a random height), and belongs
+        to all lists up to that level. The probability that a node has the height 1 is 1/2.
+        The probability that a node has the height N is 1/2 ** N (more precisely,
+        the distribution depends on an random generator provided, but our generators
+        have this property).
+
+        The lock-free variant of skip-list is implemented according to book
+            - [2008] M.Herlihy, N.Shavit "The Art of Multiprocessor Programming",
+                chapter 14.4 "A Lock-Free Concurrent Skiplist"
+
+        Template arguments:
+        - \p GC - Garbage collector used.
+        - \p K - type of a key to be stored in the list.
+        - \p T - type of a value to be stored in the list.
+        - \p Traits - type traits. See skip_list::type_traits for explanation.
+
+        It is possible to declare option-based list with cds::container::skip_list::make_traits metafunction istead of \p Traits template
+        argument.
+        Template argument list \p Options of cds::container::skip_list::make_traits metafunction are:
+        - opt::compare - key compare functor. No default functor is provided.
+            If the option is not specified, the opt::less is used.
+        - opt::less - specifies binary predicate used for key comparison. Default is \p std::less<K>.
+        - opt::item_counter - the type of item counting feature. Default is \ref atomicity::empty_item_counter that is no item counting.
+        - opt::memory_model - C++ memory ordering model. Can be opt::v::relaxed_ordering (relaxed memory model, the default)
+            or opt::v::sequential_consistent (sequentially consisnent memory model).
+        - skip_list::random_level_generator - random level generator. Can be skip_list::xorshift, skip_list::turbo_pascal or
+            user-provided one. See skip_list::random_level_generator option description for explanation.
+            Default is \p %skip_list::turbo_pascal.
+        - opt::allocator - allocator for skip-list node. Default is \ref CDS_DEFAULT_ALLOCATOR.
+        - opt::back_off - back-off strategy used. If the option is not specified, the cds::backoff::Default is used.
+        - opt::stat - internal statistics. Available types: skip_list::stat, skip_list::empty_stat (the default)
+
+        Like STL map class, %SkipListMap stores its key-value pair as <tt>std:pair< K const, T></tt>.
+
+        \warning The skip-list requires up to 67 hazard pointers that may be critical for some GCs for which
+            the guard count is limited (like as gc::HP, gc::HRC). Those GCs should be explicitly initialized with
+            hazard pointer enough: \code cds::gc::HP myhp( 67 ) \endcode. Otherwise an run-time exception may be raised
+            when you try to create skip-list object.
+
+        \note There are several specializations of \p %SkipListMap for each \p GC. You should include:
+        - <tt><cds/container/skip_list_map_hp.h></tt> for gc::HP garbage collector
+        - <tt><cds/container/skip_list_map_ptb.h></tt> for gc::PTB garbage collector
+        - <tt><cds/container/skip_list_map_rcu.h></tt> for \ref cds_nonintrusive_SkipListMap_rcu "RCU type"
+        - <tt><cds/container/skip_list_map_nogc.h></tt> for \ref cds_nonintrusive_SkipListMap_nogc "non-deletable SkipListMap"
+
+        <b>Iterators</b>
+
+        The class supports a forward iterator (\ref iterator and \ref const_iterator).
+        The iteration is ordered.
+        The iterator object is thread-safe: the element pointed by the iterator object is guarded,
+        so, the element cannot be reclaimed while the iterator object is alive.
+        However, passing an iterator object between threads is dangerous.
+
+        \warning Due to concurrent nature of skip-list map it is not guarantee that you can iterate
+        all elements in the map: any concurrent deletion can exclude the element
+        pointed by the iterator from the map, and your iteration can be terminated
+        before end of the map. Therefore, such iteration is more suitable for debugging purpose only
+
+        Remember, each iterator object requires 2 additional hazard pointers, that may be
+        a limited resource for \p GC like as gc::HP and gc::HRC (however, for gc::PTB the count of
+        guards is unlimited).
+
+        The iterator class supports the following minimalistic interface:
+        \code
+        struct iterator {
+            // Default ctor
+            iterator();
+
+            // Copy ctor
+            iterator( iterator const& s);
+
+            value_type * operator ->() const;
+            value_type& operator *() const;
+
+            // Pre-increment
+            iterator& operator ++();
+
+            // Copy assignment
+            iterator& operator = (const iterator& src);
+
+            bool operator ==(iterator const& i ) const;
+            bool operator !=(iterator const& i ) const;
+        };
+        \endcode
+        Note, the iterator object returned by \ref end, \ cend member functions points to \p nullptr and should not be dereferenced.
+
+    */
+    template <
+        typename GC,
+        typename Key,
+        typename T,
+#ifdef CDS_DOXYGEN_INVOKED
+        typename Traits = skip_list::type_traits
+#else
+        typename Traits
+#endif
+    >
+    class SkipListMap:
+#ifdef CDS_DOXYGEN_INVOKED
+        protected intrusive::SkipListSet< GC, std::pair<Key const, T>, Traits >
+#else
+        protected details::make_skip_list_map< GC, Key, T, Traits >::type
+#endif
+    {
+        //@cond
+        typedef details::make_skip_list_map< GC, Key, T, Traits >    maker;
+        typedef typename maker::type base_class;
+        //@endcond
+    public:
+        typedef typename base_class::gc          gc  ; ///< Garbage collector used
+        typedef Key     key_type    ;   ///< Key type
+        typedef T       mapped_type ;   ///< Mapped type
+#   ifdef CDS_DOXYGEN_INVOKED
+        typedef std::pair< K const, T> value_type   ;   ///< Value type stored in the map
+#   else
+        typedef typename maker::value_type  value_type;
+#   endif
+        typedef Traits  options     ;   ///< Options specified
+
+        typedef typename base_class::back_off       back_off        ;   ///< Back-off strategy used
+        typedef typename options::allocator         allocator_type  ;   ///< Allocator type used for allocate/deallocate the skip-list nodes
+        typedef typename base_class::item_counter   item_counter    ;   ///< Item counting policy used
+        typedef typename maker::key_comparator      key_comparator  ;   ///< key comparison functor
+        typedef typename base_class::memory_model   memory_model    ;   ///< Memory ordering. See cds::opt::memory_model option
+        typedef typename options::random_level_generator random_level_generator ; ///< random level generator
+        typedef typename options::stat              stat            ;   ///< internal statistics type
+
+    protected:
+        //@cond
+        typedef typename maker::node_type           node_type;
+        typedef typename maker::node_allocator      node_allocator;
+
+        typedef std::unique_ptr< node_type, typename maker::node_deallocator >    scoped_node_ptr;
+
+        //@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;
+
+    protected:
+        //@cond
+        unsigned int random_level()
+        {
+            return base_class::random_level();
+        }
+        //@endcond
+
+    public:
+        /// Default ctor
+        SkipListMap()
+            : base_class()
+        {}
+
+        /// Destructor destroys the set object
+        ~SkipListMap()
+        {}
+
+    public:
+        /// Iterator type
+        typedef skip_list::details::iterator< typename base_class::iterator >  iterator;
+
+        /// Const iterator type
+        typedef skip_list::details::iterator< typename base_class::const_iterator >   const_iterator;
+
+        /// Returns a forward iterator addressing the first element in a map
+        iterator begin()
+        {
+            return iterator( base_class::begin() );
+        }
+
+        /// Returns a forward const iterator addressing the first element in a map
+        //@{
+        const_iterator begin() const
+        {
+            return cbegin();
+        }
+        const_iterator cbegin()
+        {
+            return const_iterator( base_class::cbegin() );
+        }
+        //@}
+
+        /// Returns a forward iterator that addresses the location succeeding the last element in a map.
+        iterator end()
+        {
+            return iterator( base_class::end() );
+        }
+
+        /// Returns a forward const iterator that addresses the location succeeding the last element in a map.
+        //@{
+        const_iterator end() const
+        {
+            return cend();
+        }
+        const_iterator cend()
+        {
+            return const_iterator( base_class::cend() );
+        }
+        //@}
+
+    public:
+        /// Inserts new node with key and default value
+        /**
+            The function creates a node with \p key and default value, and then inserts the node created into the map.
+
+            Preconditions:
+            - The \ref key_type should be constructible from a value of type \p K.
+                In trivial case, \p K is equal to \ref key_type.
+            - The \ref mapped_type should be default-constructible.
+
+            Returns \p true if inserting successful, \p false otherwise.
+        */
+        template <typename K>
+        bool insert( K const& key )
+        {
+            return insert_key( key, [](value_type&){} );
+        }
+
+        /// Inserts new node
+        /**
+            The function creates a node with copy of \p val value
+            and then inserts the node created into the map.
+
+            Preconditions:
+            - The \ref key_type should be constructible from \p key of type \p K.
+            - The \ref value_type should be constructible from \p val of type \p V.
+
+            Returns \p true if \p val is inserted into the set, \p false otherwise.
+        */
+        template <typename K, typename V>
+        bool insert( K const& key, V const& val )
+        {
+            return insert_key( key, [&val](value_type& item) { item.second = val ; } );
+        }
+
+        /// Inserts new node and initialize it by a functor
+        /**
+            This function inserts new node with key \p key and if inserting is successful then it calls
+            \p func functor with signature
+            \code
+                struct functor {
+                    void operator()( value_type& item );
+                };
+            \endcode
+
+            The argument \p item of user-defined functor \p func is the reference
+            to the map's item inserted:
+                - <tt>item.first</tt> is a const reference to item's key that cannot be changed.
+                - <tt>item.second</tt> is a reference to item's value that may be changed.
+
+            The user-defined functor can be passed by reference using <tt>boost::ref</tt>
+            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:
+            - create item from \p key;
+            - insert new item into the map;
+            - if inserting is successful, initialize the value of item by calling \p func functor
+
+            This can be useful if complete initialization of object of \p value_type is heavyweight and
+            it is preferable that the initialization should be completed only if inserting is successful.
+        */
+        template <typename K, typename Func>
+        bool insert_key( const K& key, Func func )
+        {
+            scoped_node_ptr pNode( node_allocator().New( random_level(), key ));
+            if ( base_class::insert( *pNode, [&func]( node_type& item ) { cds::unref(func)( item.m_Value ); } )) {
+                pNode.release();
+                return true;
+            }
+            return false;
+        }
+
+        /// For key \p key inserts data of type \ref value_type constructed with <tt>std::forward<Args>(args)...</tt>
+        /**
+            Returns \p true if inserting successful, \p false otherwise.
+        */
+        template <typename K, typename... Args>
+        bool emplace( K&& key, Args&&... args )
+        {
+            scoped_node_ptr pNode( node_allocator().New( random_level(), std::forward<K>(key), std::forward<Args>(args)... ));
+            if ( base_class::insert( *pNode )) {
+                pNode.release();
+                return true;
+            }
+            return false;
+        }
+
+        /// Ensures that the \p key exists in the map
+        /**
+            The operation performs inserting or changing data with lock-free manner.
+
+            If the \p key not found in the map, then the new item created from \p key
+            is inserted into the map (note that in this case the \ref key_type should be
+            constructible from type \p K).
+            Otherwise, the functor \p func is called with item found.
+            The functor \p Func may be a function with signature:
+            \code
+                void func( bool bNew, value_type& item );
+            \endcode
+            or a functor:
+            \code
+                struct my_functor {
+                    void operator()( bool bNew, value_type& item );
+                };
+            \endcode
+
+            with arguments:
+            - \p bNew - \p true if the item has been inserted, \p false otherwise
+            - \p item - item of the list
+
+            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 <tt>boost::ref</tt>.
+
+            Returns <tt> std::pair<bool, bool> </tt> where \p first is true if operation is successfull,
+            \p second is true if new item has been added or \p false if the item with \p key
+            already is in the list.
+        */
+        template <typename K, typename Func>
+        std::pair<bool, bool> ensure( K const& key, Func func )
+        {
+            scoped_node_ptr pNode( node_allocator().New( random_level(), key ));
+            std::pair<bool, bool> res = base_class::ensure( *pNode,
+                [&func](bool bNew, node_type& item, node_type const& ){ cds::unref(func)( bNew, item.m_Value ); }
+            );
+            if ( res.first && res.second )
+                pNode.release();
+            return res;
+        }
+
+        /// Delete \p key from the map
+        /** \anchor cds_nonintrusive_SkipListMap_erase_val
+
+            Return \p true if \p key is found and deleted, \p false otherwise
+        */
+        template <typename K>
+        bool erase( K const& key )
+        {
+            return base_class::erase(key);
+        }
+
+        /// Deletes the item from the map using \p pred predicate for searching
+        /**
+            The function is an analog of \ref cds_nonintrusive_SkipListMap_erase_val "erase(K const&)"
+            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 map.
+        */
+        template <typename K, typename Less>
+        bool erase_with( K const& key, Less pred )
+        {
+            return base_class::erase_with( key, cds::details::predicate_wrapper< node_type, Less, typename maker::key_accessor >());
+        }
+
+        /// Delete \p key from the map
+        /** \anchor cds_nonintrusive_SkipListMap_erase_func
+
+            The function searches an item with key \p key, calls \p f functor
+            and deletes the item. If \p key is not found, the functor is not called.
+
+            The functor \p Func interface:
+            \code
+            struct extractor {
+                void operator()(value_type& item) { ... }
+            };
+            \endcode
+            The functor may be passed by reference using <tt>boost:ref</tt>
+
+            Return \p true if key is found and deleted, \p false otherwise
+        */
+        template <typename K, typename Func>
+        bool erase( K const& key, Func f )
+        {
+            return base_class::erase( key, [&f]( node_type& node) { cds::unref(f)( node.m_Value ); } );
+        }
+
+        /// Deletes the item from the map using \p pred predicate for searching
+        /**
+            The function is an analog of \ref cds_nonintrusive_SkipListMap_erase_func "erase(K const&, Func)"
+            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 map.
+        */
+        template <typename K, typename Less, typename Func>
+        bool erase_with( K const& key, Less pred, Func f )
+        {
+            return base_class::erase_with( key,
+                cds::details::predicate_wrapper< node_type, Less, typename maker::key_accessor >(),
+                [&f]( node_type& node) { cds::unref(f)( node.m_Value ); } );
+        }
+
+        /// Extracts the item from the map with specified \p key
+        /** \anchor cds_nonintrusive_SkipListMap_hp_extract
+            The function searches an item with key equal to \p key in the map,
+            unlinks it from the map, and returns it in \p ptr parameter.
+            If the item with key equal to \p key is not found the function returns \p false.
+
+            Note the compare functor should accept a parameter of type \p K that can be not the same as \p key_type.
+
+            The item extracted is freed automatically by garbage collector \p GC
+            when returned \ref 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:
+            \code
+            typedef cds::container::SkipListMap< cds::gc::HP, int, foo, my_traits >  skip_list;
+            skip_list theList;
+            // ...
+            {
+                skip_list::guarded_ptr gp;
+                if ( theList.extract( gp, 5 ) ) {
+                    // Deal with gp
+                    // ...
+                }
+                // Destructor of gp releases internal HP guard and frees the pointer
+            }
+            \endcode
+        */
+        template <typename K>
+        bool extract( guarded_ptr& ptr, K const& key )
+        {
+            return base_class::extract_( ptr.guard(), key, typename base_class::key_comparator() );
+        }
+
+        /// Extracts the item from the map with comparing functor \p pred
+        /**
+            The function is an analog of \ref cds_nonintrusive_SkipListMap_hp_extract "extract(K 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 key_type and \p K
+            in any order.
+            \p pred must imply the same element order as the comparator used for building the map.
+        */
+        template <typename K, typename Less>
+        bool extract_with( guarded_ptr& ptr, K const& key, Less pred )
+        {
+            typedef cds::details::predicate_wrapper< node_type, Less, typename maker::key_accessor >  wrapped_less;
+            return base_class::extract_( ptr.guard(), key, cds::opt::details::make_comparator_from_less<wrapped_less>() );
+        }
+
+        /// Extracts an item with minimal key from the map
+        /**
+            The function searches an item with minimal key, unlinks it, and returns the item found in \p ptr parameter.
+            If the skip-list is empty the function returns \p false.
+
+            The item extracted is freed automatically by garbage collector \p GC
+            when returned \ref 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:
+            \code
+            typedef cds::continer::SkipListMap< cds::gc::HP, int, foo, my_traits >  skip_list;
+            skip_list theList;
+            // ...
+            {
+                skip_list::guarded_ptr gp;
+                if ( theList.extract_min( gp )) {
+                    // Deal with gp
+                    //...
+                }
+                // Destructor of gp releases internal HP guard and then frees the pointer
+            }
+            \endcode
+        */
+        bool extract_min( guarded_ptr& ptr)
+        {
+            return base_class::extract_min_( ptr.guard() );
+        }
+
+        /// Extracts an item with maximal key from the map
+        /**
+            The function searches an item with maximal key, unlinks it, and returns the pointer to item found in \p ptr parameter.
+            If the skip-list is empty the function returns empty \p guarded_ptr.
+
+            The item found is freed by garbage collector \p GC automatically
+            when returned \ref 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:
+            \code
+            typedef cds::container::SkipListMap< cds::gc::HP, int, foo, my_traits >  skip_list;
+            skip_list theList;
+            // ...
+            {
+                skip_list::guarded_ptr gp;
+                if ( theList.extract_max( gp )) {
+                    // Deal with gp
+                    //...
+                }
+                // Destructor of gp releases internal HP guard and then frees the pointer
+            }
+            \endcode
+        */
+        bool extract_max( guarded_ptr& dest )
+        {
+            return base_class::extract_max_( dest.guard() );
+        }
+
+        /// Find the key \p key
+        /** \anchor cds_nonintrusive_SkipListMap_find_cfunc
+
+            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 );
+            };
+            \endcode
+            where \p item is the item found.
+
+            You can pass \p f argument by reference using <tt>boost::ref</tt> or cds::ref.
+
+            The functor may change \p item.second.
+
+            The function returns \p true if \p key is found, \p false otherwise.
+        */
+        template <typename K, typename Func>
+        bool find( K const& key, Func f )
+        {
+            return base_class::find( key, [&f](node_type& item, K const& ) { cds::unref(f)( item.m_Value );});
+        }
+
+        /// Finds the key \p val using \p pred predicate for searching
+        /**
+            The function is an analog of \ref cds_nonintrusive_SkipListMap_find_cfunc "find(K const&, Func)"
+            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 map.
+        */
+        template <typename K, typename Less, typename Func>
+        bool find_with( K const& key, Less pred, Func f )
+        {
+            return base_class::find_with( key,
+                cds::details::predicate_wrapper< node_type, Less, typename maker::key_accessor >(),
+                [&f](node_type& item, K const& ) { cds::unref(f)( item.m_Value );});
+        }
+
+        /// Find the key \p key
+        /** \anchor cds_nonintrusive_SkipListMap_find_val
+
+            The function searches the item with key equal to \p key
+            and returns \p true if it is found, and \p false otherwise.
+        */
+        template <typename K>
+        bool find( K const& key )
+        {
+            return base_class::find( key );
+        }
+
+        /// Finds the key \p val using \p pred predicate for searching
+        /**
+            The function is an analog of \ref cds_nonintrusive_SkipListMap_find_val "find(K const&)"
+            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 map.
+        */
+        template <typename K, typename Less>
+        bool find_with( K const& key, Less pred )
+        {
+            return base_class::find_with( key, cds::details::predicate_wrapper< node_type, Less, typename maker::key_accessor >() );
+        }
+
+        /// Finds the key \p key and return the item found
+        /** \anchor cds_nonintrusive_SkipListMap_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.
+
+            It is safe when a concurrent thread erases the item returned in \p ptr guarded pointer.
+            In this case the item will be freed later by garbage collector \p GC automatically
+            when \p guarded_ptr object will be destroyed or released.
+            @note Each \p guarded_ptr object uses one GC's guard which can be limited resource.
+
+            Usage:
+            \code
+            typedef cds::container::SkipListMap< cds::gc::HP, int, foo, my_traits >  skip_list;
+            skip_list theList;
+            // ...
+            {
+                skip_list::guarded_ptr gp;
+                if ( theList.get( gp, 5 ) ) {
+                    // Deal with gp
+                    //...
+                }
+                // Destructor of guarded_ptr releases internal HP guard
+            }
+            \endcode
+
+            Note the compare functor specified for class \p Traits template parameter
+            should accept a parameter of type \p K that can be not the same as \p value_type.
+        */
+        template <typename K>
+        bool get( guarded_ptr& ptr, K const& key )
+        {
+            return base_class::get_with_( ptr.guard(), key, typename base_class::key_comparator() );
+        }
+
+        /// Finds the key \p key and return the item found
+        /**
+            The function is an analog of \ref cds_nonintrusive_SkipListMap_hp_get "get( guarded_ptr& ptr, K 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 key_type and \p K
+            in any order.
+            \p pred must imply the same element order as the comparator used for building the map.
+        */
+        template <typename K, typename Less>
+        bool get_with( guarded_ptr& ptr, K const& key, Less pred )
+        {
+            typedef cds::details::predicate_wrapper< node_type, Less, typename maker::key_accessor > wrapped_less;
+            return base_class::get_with_( ptr.guard(), key, cds::opt::details::make_comparator_from_less< wrapped_less >());
+        }
+
+        /// Clears the map
+        void clear()
+        {
+            base_class::clear();
+        }
+
+        /// Checks if the map is empty
+        /**
+            Emptiness is checked by item counting: if item count is zero then the map is empty.
+        */
+        bool empty() const
+        {
+            return base_class::empty();
+        }
+
+        /// Returns item count in the map
+        size_t size() const
+        {
+            return base_class::size();
+        }
+
+        /// Returns const reference to internal statistics
+        stat const& statistics() const
+        {
+            return base_class::statistics();
+        }
+
+    };
+}} // namespace cds::container
+
+#endif // #ifndef __CDS_CONTAINER_IMPL_SKIP_LIST_MAP_H
index 2db501575466ad80b568030b99463755d4e401e8..fca351f29a3bb57d5d1221b3c8a9487bedc51103 100644 (file)
@@ -6,6 +6,6 @@
 #include <cds/container/details/skip_list_base.h>
 #include <cds/intrusive/skip_list_hp.h>
 #include <cds/container/details/make_skip_list_map.h>
-#include <cds/container/skip_list_map_impl.h>
+#include <cds/container/impl/skip_list_map.h>
 
 #endif  // #ifndef __CDS_CONTAINER_SKIP_LIST_MAP_HP_H
index c573d096e7a16c84ded59e52fc97b9b8e09d37e5..84d8d1af198ab541be0377f7882c200be54a913b 100644 (file)
@@ -6,6 +6,6 @@
 #include <cds/container/details/skip_list_base.h>
 #include <cds/intrusive/skip_list_hrc.h>
 #include <cds/container/details/make_skip_list_map.h>
-#include <cds/container/skip_list_map_impl.h>
+#include <cds/container/impl/skip_list_map.h>
 
 #endif  // #ifndef __CDS_CONTAINER_SKIP_LIST_MAP_HRC_H
diff --git a/cds/container/skip_list_map_impl.h b/cds/container/skip_list_map_impl.h
deleted file mode 100644 (file)
index 10afe27..0000000
+++ /dev/null
@@ -1,674 +0,0 @@
-//$$CDS-header$$
-
-#ifndef __CDS_CONTAINER_SKIP_LIST_MAP_IMPL_H
-#define __CDS_CONTAINER_SKIP_LIST_MAP_IMPL_H
-
-#include <cds/details/functor_wrapper.h>
-#include <cds/gc/guarded_ptr.h>
-#include <cds/container/details/guarded_ptr_cast.h>
-
-namespace cds { namespace container {
-
-    /// Lock-free skip-list map
-    /** @ingroup cds_nonintrusive_map
-        \anchor cds_nonintrusive_SkipListMap_hp
-
-        The implementation of well-known probabilistic data structure called skip-list
-        invented by W.Pugh in his papers:
-            - [1989] W.Pugh Skip Lists: A Probabilistic Alternative to Balanced Trees
-            - [1990] W.Pugh A Skip List Cookbook
-
-        A skip-list is a probabilistic data structure that provides expected logarithmic
-        time search without the need of rebalance. The skip-list is a collection of sorted
-        linked list. Nodes are ordered by key. Each node is linked into a subset of the lists.
-        Each list has a level, ranging from 0 to 32. The bottom-level list contains
-        all the nodes, and each higher-level list is a sublist of the lower-level lists.
-        Each node is created with a random top level (with a random height), and belongs
-        to all lists up to that level. The probability that a node has the height 1 is 1/2.
-        The probability that a node has the height N is 1/2 ** N (more precisely,
-        the distribution depends on an random generator provided, but our generators
-        have this property).
-
-        The lock-free variant of skip-list is implemented according to book
-            - [2008] M.Herlihy, N.Shavit "The Art of Multiprocessor Programming",
-                chapter 14.4 "A Lock-Free Concurrent Skiplist"
-
-        Template arguments:
-        - \p GC - Garbage collector used.
-        - \p K - type of a key to be stored in the list.
-        - \p T - type of a value to be stored in the list.
-        - \p Traits - type traits. See skip_list::type_traits for explanation.
-
-        It is possible to declare option-based list with cds::container::skip_list::make_traits metafunction istead of \p Traits template
-        argument.
-        Template argument list \p Options of cds::container::skip_list::make_traits metafunction are:
-        - opt::compare - key compare functor. No default functor is provided.
-            If the option is not specified, the opt::less is used.
-        - opt::less - specifies binary predicate used for key comparison. Default is \p std::less<K>.
-        - opt::item_counter - the type of item counting feature. Default is \ref atomicity::empty_item_counter that is no item counting.
-        - opt::memory_model - C++ memory ordering model. Can be opt::v::relaxed_ordering (relaxed memory model, the default)
-            or opt::v::sequential_consistent (sequentially consisnent memory model).
-        - skip_list::random_level_generator - random level generator. Can be skip_list::xorshift, skip_list::turbo_pascal or
-            user-provided one. See skip_list::random_level_generator option description for explanation.
-            Default is \p %skip_list::turbo_pascal.
-        - opt::allocator - allocator for skip-list node. Default is \ref CDS_DEFAULT_ALLOCATOR.
-        - opt::back_off - back-off strategy used. If the option is not specified, the cds::backoff::Default is used.
-        - opt::stat - internal statistics. Available types: skip_list::stat, skip_list::empty_stat (the default)
-
-        Like STL map class, %SkipListMap stores its key-value pair as <tt>std:pair< K const, T></tt>.
-
-        \warning The skip-list requires up to 67 hazard pointers that may be critical for some GCs for which
-            the guard count is limited (like as gc::HP, gc::HRC). Those GCs should be explicitly initialized with
-            hazard pointer enough: \code cds::gc::HP myhp( 67 ) \endcode. Otherwise an run-time exception may be raised
-            when you try to create skip-list object.
-
-        \note There are several specializations of \p %SkipListMap for each \p GC. You should include:
-        - <tt><cds/container/skip_list_map_hp.h></tt> for gc::HP garbage collector
-        - <tt><cds/container/skip_list_map_hrc.h></tt> for gc::HRC garbage collector
-        - <tt><cds/container/skip_list_map_ptb.h></tt> for gc::PTB garbage collector
-        - <tt><cds/container/skip_list_map_rcu.h></tt> for \ref cds_nonintrusive_SkipListMap_rcu "RCU type"
-        - <tt><cds/container/skip_list_map_nogc.h></tt> for \ref cds_nonintrusive_SkipListMap_nogc "non-deletable SkipListMap"
-
-        <b>Iterators</b>
-
-        The class supports a forward iterator (\ref iterator and \ref const_iterator).
-        The iteration is ordered.
-        The iterator object is thread-safe: the element pointed by the iterator object is guarded,
-        so, the element cannot be reclaimed while the iterator object is alive.
-        However, passing an iterator object between threads is dangerous.
-
-        \warning Due to concurrent nature of skip-list map it is not guarantee that you can iterate
-        all elements in the map: any concurrent deletion can exclude the element
-        pointed by the iterator from the map, and your iteration can be terminated
-        before end of the map. Therefore, such iteration is more suitable for debugging purpose only
-
-        Remember, each iterator object requires 2 additional hazard pointers, that may be
-        a limited resource for \p GC like as gc::HP and gc::HRC (however, for gc::PTB the count of
-        guards is unlimited).
-
-        The iterator class supports the following minimalistic interface:
-        \code
-        struct iterator {
-            // Default ctor
-            iterator();
-
-            // Copy ctor
-            iterator( iterator const& s);
-
-            value_type * operator ->() const;
-            value_type& operator *() const;
-
-            // Pre-increment
-            iterator& operator ++();
-
-            // Copy assignment
-            iterator& operator = (const iterator& src);
-
-            bool operator ==(iterator const& i ) const;
-            bool operator !=(iterator const& i ) const;
-        };
-        \endcode
-        Note, the iterator object returned by \ref end, \ cend member functions points to \p nullptr and should not be dereferenced.
-
-    */
-    template <
-        typename GC,
-        typename Key,
-        typename T,
-#ifdef CDS_DOXYGEN_INVOKED
-        typename Traits = skip_list::type_traits
-#else
-        typename Traits
-#endif
-    >
-    class SkipListMap:
-#ifdef CDS_DOXYGEN_INVOKED
-        protected intrusive::SkipListSet< GC, std::pair<Key const, T>, Traits >
-#else
-        protected details::make_skip_list_map< GC, Key, T, Traits >::type
-#endif
-    {
-        //@cond
-        typedef details::make_skip_list_map< GC, Key, T, Traits >    maker;
-        typedef typename maker::type base_class;
-        //@endcond
-    public:
-        typedef typename base_class::gc          gc  ; ///< Garbage collector used
-        typedef Key     key_type    ;   ///< Key type
-        typedef T       mapped_type ;   ///< Mapped type
-#   ifdef CDS_DOXYGEN_INVOKED
-        typedef std::pair< K const, T> value_type   ;   ///< Value type stored in the map
-#   else
-        typedef typename maker::value_type  value_type;
-#   endif
-        typedef Traits  options     ;   ///< Options specified
-
-        typedef typename base_class::back_off       back_off        ;   ///< Back-off strategy used
-        typedef typename options::allocator         allocator_type  ;   ///< Allocator type used for allocate/deallocate the skip-list nodes
-        typedef typename base_class::item_counter   item_counter    ;   ///< Item counting policy used
-        typedef typename maker::key_comparator      key_comparator  ;   ///< key comparison functor
-        typedef typename base_class::memory_model   memory_model    ;   ///< Memory ordering. See cds::opt::memory_model option
-        typedef typename options::random_level_generator random_level_generator ; ///< random level generator
-        typedef typename options::stat              stat            ;   ///< internal statistics type
-
-    protected:
-        //@cond
-        typedef typename maker::node_type           node_type;
-        typedef typename maker::node_allocator      node_allocator;
-
-        typedef std::unique_ptr< node_type, typename maker::node_deallocator >    scoped_node_ptr;
-
-        //@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;
-
-    protected:
-        //@cond
-        unsigned int random_level()
-        {
-            return base_class::random_level();
-        }
-        //@endcond
-
-    public:
-        /// Default ctor
-        SkipListMap()
-            : base_class()
-        {}
-
-        /// Destructor destroys the set object
-        ~SkipListMap()
-        {}
-
-    public:
-        /// Iterator type
-        typedef skip_list::details::iterator< typename base_class::iterator >  iterator;
-
-        /// Const iterator type
-        typedef skip_list::details::iterator< typename base_class::const_iterator >   const_iterator;
-
-        /// Returns a forward iterator addressing the first element in a map
-        iterator begin()
-        {
-            return iterator( base_class::begin() );
-        }
-
-        /// Returns a forward const iterator addressing the first element in a map
-        //@{
-        const_iterator begin() const
-        {
-            return cbegin();
-        }
-        const_iterator cbegin()
-        {
-            return const_iterator( base_class::cbegin() );
-        }
-        //@}
-
-        /// Returns a forward iterator that addresses the location succeeding the last element in a map.
-        iterator end()
-        {
-            return iterator( base_class::end() );
-        }
-
-        /// Returns a forward const iterator that addresses the location succeeding the last element in a map.
-        //@{
-        const_iterator end() const
-        {
-            return cend();
-        }
-        const_iterator cend()
-        {
-            return const_iterator( base_class::cend() );
-        }
-        //@}
-
-    public:
-        /// Inserts new node with key and default value
-        /**
-            The function creates a node with \p key and default value, and then inserts the node created into the map.
-
-            Preconditions:
-            - The \ref key_type should be constructible from a value of type \p K.
-                In trivial case, \p K is equal to \ref key_type.
-            - The \ref mapped_type should be default-constructible.
-
-            Returns \p true if inserting successful, \p false otherwise.
-        */
-        template <typename K>
-        bool insert( K const& key )
-        {
-            return insert_key( key, [](value_type&){} );
-        }
-
-        /// Inserts new node
-        /**
-            The function creates a node with copy of \p val value
-            and then inserts the node created into the map.
-
-            Preconditions:
-            - The \ref key_type should be constructible from \p key of type \p K.
-            - The \ref value_type should be constructible from \p val of type \p V.
-
-            Returns \p true if \p val is inserted into the set, \p false otherwise.
-        */
-        template <typename K, typename V>
-        bool insert( K const& key, V const& val )
-        {
-            return insert_key( key, [&val](value_type& item) { item.second = val ; } );
-        }
-
-        /// Inserts new node and initialize it by a functor
-        /**
-            This function inserts new node with key \p key and if inserting is successful then it calls
-            \p func functor with signature
-            \code
-                struct functor {
-                    void operator()( value_type& item );
-                };
-            \endcode
-
-            The argument \p item of user-defined functor \p func is the reference
-            to the map's item inserted:
-                - <tt>item.first</tt> is a const reference to item's key that cannot be changed.
-                - <tt>item.second</tt> is a reference to item's value that may be changed.
-
-            The user-defined functor can be passed by reference using <tt>boost::ref</tt>
-            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:
-            - create item from \p key;
-            - insert new item into the map;
-            - if inserting is successful, initialize the value of item by calling \p func functor
-
-            This can be useful if complete initialization of object of \p value_type is heavyweight and
-            it is preferable that the initialization should be completed only if inserting is successful.
-        */
-        template <typename K, typename Func>
-        bool insert_key( const K& key, Func func )
-        {
-            scoped_node_ptr pNode( node_allocator().New( random_level(), key ));
-            if ( base_class::insert( *pNode, [&func]( node_type& item ) { cds::unref(func)( item.m_Value ); } )) {
-                pNode.release();
-                return true;
-            }
-            return false;
-        }
-
-        /// For key \p key inserts data of type \ref value_type constructed with <tt>std::forward<Args>(args)...</tt>
-        /**
-            Returns \p true if inserting successful, \p false otherwise.
-        */
-        template <typename K, typename... Args>
-        bool emplace( K&& key, Args&&... args )
-        {
-            scoped_node_ptr pNode( node_allocator().New( random_level(), std::forward<K>(key), std::forward<Args>(args)... ));
-            if ( base_class::insert( *pNode )) {
-                pNode.release();
-                return true;
-            }
-            return false;
-        }
-
-        /// Ensures that the \p key exists in the map
-        /**
-            The operation performs inserting or changing data with lock-free manner.
-
-            If the \p key not found in the map, then the new item created from \p key
-            is inserted into the map (note that in this case the \ref key_type should be
-            constructible from type \p K).
-            Otherwise, the functor \p func is called with item found.
-            The functor \p Func may be a function with signature:
-            \code
-                void func( bool bNew, value_type& item );
-            \endcode
-            or a functor:
-            \code
-                struct my_functor {
-                    void operator()( bool bNew, value_type& item );
-                };
-            \endcode
-
-            with arguments:
-            - \p bNew - \p true if the item has been inserted, \p false otherwise
-            - \p item - item of the list
-
-            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 <tt>boost::ref</tt>.
-
-            Returns <tt> std::pair<bool, bool> </tt> where \p first is true if operation is successfull,
-            \p second is true if new item has been added or \p false if the item with \p key
-            already is in the list.
-        */
-        template <typename K, typename Func>
-        std::pair<bool, bool> ensure( K const& key, Func func )
-        {
-            scoped_node_ptr pNode( node_allocator().New( random_level(), key ));
-            std::pair<bool, bool> res = base_class::ensure( *pNode,
-                [&func](bool bNew, node_type& item, node_type const& ){ cds::unref(func)( bNew, item.m_Value ); }
-            );
-            if ( res.first && res.second )
-                pNode.release();
-            return res;
-        }
-
-        /// Delete \p key from the map
-        /** \anchor cds_nonintrusive_SkipListMap_erase_val
-
-            Return \p true if \p key is found and deleted, \p false otherwise
-        */
-        template <typename K>
-        bool erase( K const& key )
-        {
-            return base_class::erase(key);
-        }
-
-        /// Deletes the item from the map using \p pred predicate for searching
-        /**
-            The function is an analog of \ref cds_nonintrusive_SkipListMap_erase_val "erase(K const&)"
-            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 map.
-        */
-        template <typename K, typename Less>
-        bool erase_with( K const& key, Less pred )
-        {
-            return base_class::erase_with( key, cds::details::predicate_wrapper< node_type, Less, typename maker::key_accessor >());
-        }
-
-        /// Delete \p key from the map
-        /** \anchor cds_nonintrusive_SkipListMap_erase_func
-
-            The function searches an item with key \p key, calls \p f functor
-            and deletes the item. If \p key is not found, the functor is not called.
-
-            The functor \p Func interface:
-            \code
-            struct extractor {
-                void operator()(value_type& item) { ... }
-            };
-            \endcode
-            The functor may be passed by reference using <tt>boost:ref</tt>
-
-            Return \p true if key is found and deleted, \p false otherwise
-        */
-        template <typename K, typename Func>
-        bool erase( K const& key, Func f )
-        {
-            return base_class::erase( key, [&f]( node_type& node) { cds::unref(f)( node.m_Value ); } );
-        }
-
-        /// Deletes the item from the map using \p pred predicate for searching
-        /**
-            The function is an analog of \ref cds_nonintrusive_SkipListMap_erase_func "erase(K const&, Func)"
-            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 map.
-        */
-        template <typename K, typename Less, typename Func>
-        bool erase_with( K const& key, Less pred, Func f )
-        {
-            return base_class::erase_with( key,
-                cds::details::predicate_wrapper< node_type, Less, typename maker::key_accessor >(),
-                [&f]( node_type& node) { cds::unref(f)( node.m_Value ); } );
-        }
-
-        /// Extracts the item from the map with specified \p key
-        /** \anchor cds_nonintrusive_SkipListMap_hp_extract
-            The function searches an item with key equal to \p key in the map,
-            unlinks it from the map, and returns it in \p ptr parameter.
-            If the item with key equal to \p key is not found the function returns \p false.
-
-            Note the compare functor should accept a parameter of type \p K that can be not the same as \p key_type.
-
-            The item extracted is freed automatically by garbage collector \p GC
-            when returned \ref 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:
-            \code
-            typedef cds::container::SkipListMap< cds::gc::HP, int, foo, my_traits >  skip_list;
-            skip_list theList;
-            // ...
-            {
-                skip_list::guarded_ptr gp;
-                if ( theList.extract( gp, 5 ) ) {
-                    // Deal with gp
-                    // ...
-                }
-                // Destructor of gp releases internal HP guard and frees the pointer
-            }
-            \endcode
-        */
-        template <typename K>
-        bool extract( guarded_ptr& ptr, K const& key )
-        {
-            return base_class::extract_( ptr.guard(), key, typename base_class::key_comparator() );
-        }
-
-        /// Extracts the item from the map with comparing functor \p pred
-        /**
-            The function is an analog of \ref cds_nonintrusive_SkipListMap_hp_extract "extract(K 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 key_type and \p K
-            in any order.
-            \p pred must imply the same element order as the comparator used for building the map.
-        */
-        template <typename K, typename Less>
-        bool extract_with( guarded_ptr& ptr, K const& key, Less pred )
-        {
-            typedef cds::details::predicate_wrapper< node_type, Less, typename maker::key_accessor >  wrapped_less;
-            return base_class::extract_( ptr.guard(), key, cds::opt::details::make_comparator_from_less<wrapped_less>() );
-        }
-
-        /// Extracts an item with minimal key from the map
-        /**
-            The function searches an item with minimal key, unlinks it, and returns the item found in \p ptr parameter.
-            If the skip-list is empty the function returns \p false.
-
-            The item extracted is freed automatically by garbage collector \p GC
-            when returned \ref 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:
-            \code
-            typedef cds::continer::SkipListMap< cds::gc::HP, int, foo, my_traits >  skip_list;
-            skip_list theList;
-            // ...
-            {
-                skip_list::guarded_ptr gp;
-                if ( theList.extract_min( gp )) {
-                    // Deal with gp
-                    //...
-                }
-                // Destructor of gp releases internal HP guard and then frees the pointer
-            }
-            \endcode
-        */
-        bool extract_min( guarded_ptr& ptr)
-        {
-            return base_class::extract_min_( ptr.guard() );
-        }
-
-        /// Extracts an item with maximal key from the map
-        /**
-            The function searches an item with maximal key, unlinks it, and returns the pointer to item found in \p ptr parameter.
-            If the skip-list is empty the function returns empty \p guarded_ptr.
-
-            The item found is freed by garbage collector \p GC automatically
-            when returned \ref 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:
-            \code
-            typedef cds::container::SkipListMap< cds::gc::HP, int, foo, my_traits >  skip_list;
-            skip_list theList;
-            // ...
-            {
-                skip_list::guarded_ptr gp;
-                if ( theList.extract_max( gp )) {
-                    // Deal with gp
-                    //...
-                }
-                // Destructor of gp releases internal HP guard and then frees the pointer
-            }
-            \endcode
-        */
-        bool extract_max( guarded_ptr& dest )
-        {
-            return base_class::extract_max_( dest.guard() );
-        }
-
-        /// Find the key \p key
-        /** \anchor cds_nonintrusive_SkipListMap_find_cfunc
-
-            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 );
-            };
-            \endcode
-            where \p item is the item found.
-
-            You can pass \p f argument by reference using <tt>boost::ref</tt> or cds::ref.
-
-            The functor may change \p item.second.
-
-            The function returns \p true if \p key is found, \p false otherwise.
-        */
-        template <typename K, typename Func>
-        bool find( K const& key, Func f )
-        {
-            return base_class::find( key, [&f](node_type& item, K const& ) { cds::unref(f)( item.m_Value );});
-        }
-
-        /// Finds the key \p val using \p pred predicate for searching
-        /**
-            The function is an analog of \ref cds_nonintrusive_SkipListMap_find_cfunc "find(K const&, Func)"
-            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 map.
-        */
-        template <typename K, typename Less, typename Func>
-        bool find_with( K const& key, Less pred, Func f )
-        {
-            return base_class::find_with( key,
-                cds::details::predicate_wrapper< node_type, Less, typename maker::key_accessor >(),
-                [&f](node_type& item, K const& ) { cds::unref(f)( item.m_Value );});
-        }
-
-        /// Find the key \p key
-        /** \anchor cds_nonintrusive_SkipListMap_find_val
-
-            The function searches the item with key equal to \p key
-            and returns \p true if it is found, and \p false otherwise.
-        */
-        template <typename K>
-        bool find( K const& key )
-        {
-            return base_class::find( key );
-        }
-
-        /// Finds the key \p val using \p pred predicate for searching
-        /**
-            The function is an analog of \ref cds_nonintrusive_SkipListMap_find_val "find(K const&)"
-            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 map.
-        */
-        template <typename K, typename Less>
-        bool find_with( K const& key, Less pred )
-        {
-            return base_class::find_with( key, cds::details::predicate_wrapper< node_type, Less, typename maker::key_accessor >() );
-        }
-
-        /// Finds the key \p key and return the item found
-        /** \anchor cds_nonintrusive_SkipListMap_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.
-
-            It is safe when a concurrent thread erases the item returned in \p ptr guarded pointer.
-            In this case the item will be freed later by garbage collector \p GC automatically
-            when \p guarded_ptr object will be destroyed or released.
-            @note Each \p guarded_ptr object uses one GC's guard which can be limited resource.
-
-            Usage:
-            \code
-            typedef cds::container::SkipListMap< cds::gc::HP, int, foo, my_traits >  skip_list;
-            skip_list theList;
-            // ...
-            {
-                skip_list::guarded_ptr gp;
-                if ( theList.get( gp, 5 ) ) {
-                    // Deal with gp
-                    //...
-                }
-                // Destructor of guarded_ptr releases internal HP guard
-            }
-            \endcode
-
-            Note the compare functor specified for class \p Traits template parameter
-            should accept a parameter of type \p K that can be not the same as \p value_type.
-        */
-        template <typename K>
-        bool get( guarded_ptr& ptr, K const& key )
-        {
-            return base_class::get_with_( ptr.guard(), key, typename base_class::key_comparator() );
-        }
-
-        /// Finds the key \p key and return the item found
-        /**
-            The function is an analog of \ref cds_nonintrusive_SkipListMap_hp_get "get( guarded_ptr& ptr, K 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 key_type and \p K
-            in any order.
-            \p pred must imply the same element order as the comparator used for building the map.
-        */
-        template <typename K, typename Less>
-        bool get_with( guarded_ptr& ptr, K const& key, Less pred )
-        {
-            typedef cds::details::predicate_wrapper< node_type, Less, typename maker::key_accessor > wrapped_less;
-            return base_class::get_with_( ptr.guard(), key, cds::opt::details::make_comparator_from_less< wrapped_less >());
-        }
-
-        /// Clears the map
-        void clear()
-        {
-            base_class::clear();
-        }
-
-        /// Checks if the map is empty
-        /**
-            Emptiness is checked by item counting: if item count is zero then the map is empty.
-        */
-        bool empty() const
-        {
-            return base_class::empty();
-        }
-
-        /// Returns item count in the map
-        size_t size() const
-        {
-            return base_class::size();
-        }
-
-        /// Returns const reference to internal statistics
-        stat const& statistics() const
-        {
-            return base_class::statistics();
-        }
-
-    };
-}} // namespace cds::container
-
-#endif // #ifndef __CDS_CONTAINER_SKIP_LIST_MAP_IMPL_H
index 64536b4939b680094c0f800bbea24cb70ac33fad..dd6dbb8e8f14449eadf7070387246bef93e19ec4 100644 (file)
@@ -6,6 +6,6 @@
 #include <cds/container/details/skip_list_base.h>
 #include <cds/intrusive/skip_list_ptb.h>
 #include <cds/container/details/make_skip_list_map.h>
-#include <cds/container/skip_list_map_impl.h>
+#include <cds/container/impl/skip_list_map.h>
 
 #endif  // #ifndef __CDS_CONTAINER_SKIP_LIST_SET_PTB_H
index 48fcf3d4a86f271aabe9da1f79074fe82cc235bc..12d4513af42742f9781a15bae54ae13b3599ff77 100644 (file)
     <ClInclude Include="..\..\..\cds\container\impl\lazy_list.h" />\r
     <ClInclude Include="..\..\..\cds\container\impl\michael_kvlist.h" />\r
     <ClInclude Include="..\..\..\cds\container\impl\michael_list.h" />\r
+    <ClInclude Include="..\..\..\cds\container\impl\skip_list_map.h" />\r
     <ClInclude Include="..\..\..\cds\container\lazy_kvlist_rcu.h" />\r
     <ClInclude Include="..\..\..\cds\container\lazy_list_rcu.h" />\r
     <ClInclude Include="..\..\..\cds\container\michael_kvlist_rcu.h" />\r
     <ClInclude Include="..\..\..\cds\container\mspriority_queue.h" />\r
     <ClInclude Include="..\..\..\cds\container\skip_list_map_hp.h" />\r
     <ClInclude Include="..\..\..\cds\container\skip_list_map_hrc.h" />\r
-    <ClInclude Include="..\..\..\cds\container\skip_list_map_impl.h" />\r
     <ClInclude Include="..\..\..\cds\container\skip_list_map_nogc.h" />\r
     <ClInclude Include="..\..\..\cds\container\skip_list_map_ptb.h" />\r
     <ClInclude Include="..\..\..\cds\container\skip_list_map_rcu.h" />\r
index 209f65a7a18472cb219888292208293661077462..3e7474b44d09fb014e0b990c47080ec49eeb14a3 100644 (file)
     <ClInclude Include="..\..\..\cds\container\skip_list_map_hrc.h">\r
       <Filter>Header Files\cds\container</Filter>\r
     </ClInclude>\r
-    <ClInclude Include="..\..\..\cds\container\skip_list_map_impl.h">\r
-      <Filter>Header Files\cds\container</Filter>\r
-    </ClInclude>\r
     <ClInclude Include="..\..\..\cds\container\skip_list_map_ptb.h">\r
       <Filter>Header Files\cds\container</Filter>\r
     </ClInclude>\r
     <ClInclude Include="..\..\..\cds\container\details\skip_list_base.h">\r
       <Filter>Header Files\cds\container\details</Filter>\r
     </ClInclude>\r
+    <ClInclude Include="..\..\..\cds\container\impl\skip_list_map.h">\r
+      <Filter>Header Files\cds\container\impl</Filter>\r
+    </ClInclude>\r
   </ItemGroup>\r
 </Project>
\ No newline at end of file