-//$$CDS-header$$
-
-#ifndef __CDS_CONTAINER_MICHAEL_MAP_NOGC_H
-#define __CDS_CONTAINER_MICHAEL_MAP_NOGC_H
+/*
+ This file is a part of libcds - Concurrent Data Structures library
+
+ (C) Copyright Maxim Khizhinsky (libcds.dev@gmail.com) 2006-2016
+
+ 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_MICHAEL_MAP_NOGC_H
+#define CDSLIB_CONTAINER_MICHAEL_MAP_NOGC_H
#include <cds/container/details/michael_map_base.h>
#include <cds/gc/nogc.h>
This specialization is so-called append-only when no item
reclamation may be performed. The class does not support deleting of map item.
- See \ref cds_nonintrusive_MichaelHashMap_hp "MichaelHashMap" for description of template parameters.
+ See @ref cds_nonintrusive_MichaelHashMap_hp "MichaelHashMap" for description of template parameters.
*/
template <
class OrderedList,
protected:
//@cond
/// Calculates hash value of \p key
- size_t hash_value( key_type const & key ) const
+ template <typename K>
+ size_t hash_value( K const & key ) const
{
return m_HashFunctor( key ) & m_nHashBitmask;
}
/// Returns the bucket (ordered list) for \p key
- bucket_type& bucket( key_type const& key )
+ template <typename K>
+ bucket_type& bucket( K const& key )
{
return m_Buckets[ hash_value( key ) ];
}
//@endcond
protected:
- /// Forward iterator
- /**
- \p IsConst - constness boolean flag
-
- The forward iterator for Michael's map is based on \p OrderedList forward iterator and has some features:
- - it has no post-increment operator, only pre-increment
- - it iterates items in unordered fashion
- */
+ //@cond
template <bool IsConst>
class iterator_type: private cds::intrusive::michael_set::details::iterator< bucket_type, IsConst >
{
- //@cond
typedef cds::intrusive::michael_set::details::iterator< bucket_type, IsConst > base_class;
friend class MichaelHashMap;
- //@endcond
protected:
- //@cond
- //typedef typename base_class::bucket_type bucket_type;
typedef typename base_class::bucket_ptr bucket_ptr;
typedef typename base_class::list_iterator list_iterator;
- //typedef typename bucket_type::key_type key_type;
- //@endcond
-
public:
/// Value pointer type (const for const_iterator)
typedef typename cds::details::make_const_type<typename MichaelHashMap::mapped_type, IsConst>::pointer value_ptr;
typedef typename cds::details::make_const_type<typename MichaelHashMap::value_type, IsConst>::reference pair_ref;
protected:
- //@cond
iterator_type( list_iterator const& it, bucket_ptr pFirst, bucket_ptr pLast )
: base_class( it, pFirst, pLast )
{}
- //@endcond
public:
/// Default ctor
return !( *this == i );
}
};
-
+ //@endcond
public:
+ ///@name Forward iterators
+ //@{
/// Forward iterator
+ /**
+ The forward iterator for Michael's map 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
}
/// Returns a forward const iterator addressing the first element in a set
- //@{
const_iterator begin() const
{
return get_const_begin();
}
+
+ /// Returns a forward const iterator addressing the first element in a set
const_iterator cbegin() const
{
return get_const_begin();
}
- //@}
/// Returns an const iterator that addresses the location succeeding the last element in a set
- //@{
const_iterator end() const
{
return get_const_end();
}
+
+ /// Returns an const iterator that addresses the location succeeding the last element in a set
const_iterator cend() const
{
return get_const_end();
}
- //@}
+ //@}
private:
//@cond
public:
/// Initialize the map
- /** @copydetails cds_nonintrusive_MichaelHashMap_hp_ctor
+ /**
+ The Michael's hash map is non-expandable container. You should point the average count of items \p nMaxItemCount
+ when you create an object.
+ \p nLoadFactor parameter defines average count of items per bucket and it should be small number between 1 and 10.
+ Remember, since the bucket implementation is an ordered list, searching in the bucket is linear [<tt>O(nLoadFactor)</tt>].
+ Note, that many popular STL hash map implementation uses load factor 1.
+
+ The ctor defines hash table size as rounding <tt>nMacItemCount / nLoadFactor</tt> up to nearest power of two.
*/
MichaelHashMap(
size_t nMaxItemCount, ///< estimation of max item count in the hash set
return end();
}
- /// Ensures that the key \p key exists in the map
+ /// Updates the item
/**
- The operation inserts new item if the key \p key is not found in the map.
- Otherwise, the function returns an iterator that points to item found.
+ If \p key is not in the map 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, \p second is true if new item has been added or \p false if the item
- already is in the list.
+ 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 map.
@warning For \ref cds_nonintrusive_MichaelKVList_nogc "MichaelKVList" as the bucket see \ref cds_intrusive_item_creating "insert item troubleshooting".
\ref cds_nonintrusive_LazyKVList_nogc "LazyKVList" provides exclusive access to inserted item and does not require any node-level
synchronization.
*/
template <typename K>
- std::pair<iterator, bool> ensure( const K& key )
+ std::pair<iterator, bool> update( const K& key, bool bAllowInsert = true )
{
bucket_type& refBucket = bucket( key );
- std::pair<bucket_iterator, bool> ret = refBucket.ensure( key );
+ std::pair<bucket_iterator, bool> ret = refBucket.update( key, bAllowInsert );
if ( ret.second )
++m_ItemCounter;
-
+ else if ( ret.first == refBucket.end() )
+ return std::make_pair( end(), false );
return std::make_pair( iterator( ret.first, &refBucket, m_Buckets + bucket_count() ), ret.second );
}
+ //@cond
+ template <typename K>
+ CDS_DEPRECATED("ensure() is deprecated, use update()")
+ std::pair<iterator, bool> ensure( K const& key )
+ {
+ return update( key, true );
+ }
+ //@endcond
- /// Find the key \p key
- /** \anchor cds_nonintrusive_MichaelMap_nogc_find
-
+ /// Checks whether the map contains \p key
+ /**
The function searches the item with key equal to \p key
- and returns an iterator pointed to item found if the key is found,
- and \ref end() otherwise
+ and returns an iterator pointed to item found and \ref end() otherwise
*/
template <typename K>
- iterator find( const K& key )
+ iterator contains( K const& key )
{
bucket_type& refBucket = bucket( key );
- bucket_iterator it = refBucket.find( key );
+ bucket_iterator it = refBucket.contains( key );
if ( it != refBucket.end() )
return iterator( it, &refBucket, m_Buckets + bucket_count() );
return end();
}
+ //@cond
+ template <typename K>
+ CDS_DEPRECATED("deprecated, use contains()")
+ iterator find( K const& key )
+ {
+ return contains( key );
+ }
+ //@endcond
- /// 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_MichaelMap_nogc_find "find(K const&)"
- but \p pred is used for key comparing.
+ 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 Less must imply the same element order as the comparator used for building the map.
+ \p pred must imply the same element order as the comparator used for building the map.
+ Hash functor specified in \p Traits should accept parameters of type \p K.
*/
template <typename K, typename Less>
- iterator find_with( const K& key, Less pred )
+ iterator contains( K const& key, Less pred )
{
bucket_type& refBucket = bucket( key );
- bucket_iterator it = refBucket.find_with( key, pred );
+ bucket_iterator it = refBucket.contains( key, pred );
if ( it != refBucket.end() )
return iterator( it, &refBucket, m_Buckets + bucket_count() );
return end();
}
+ //@cond
+ template <typename K, typename Less>
+ CDS_DEPRECATED("deprecated, use contains()")
+ iterator find_with( K const& key, Less pred )
+ {
+ return contains( key, pred );
+ }
+ //@endcond
/// Clears the map (not atomic)
void clear()
};
}} // namespace cds::container
-#endif // ifndef __CDS_CONTAINER_MICHAEL_MAP_NOGC_H
+#endif // ifndef CDSLIB_CONTAINER_MICHAEL_MAP_NOGC_H
projects / libcds.git / blobdiff