-//$$CDS-header$$
+/*
+ This file is a part of libcds - Concurrent Data Structures library
-#ifndef __CDS_CONTAINER_SPLIT_LIST_MAP_NOGC_H
-#define __CDS_CONTAINER_SPLIT_LIST_MAP_NOGC_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_MAP_NOGC_H
+#define CDSLIB_CONTAINER_SPLIT_LIST_MAP_NOGC_H
#include <cds/container/split_list_set_nogc.h>
#include <cds/details/binary_functor_wrapper.h>
/** @ingroup cds_nonintrusive_map
\anchor cds_nonintrusive_SplitListMap_nogc
- This specialization is intended for so-called persistent usage when no item
- reclamation may be performed. The class does not support deleting of list item.
+ This specialization is so-called append-only.
+ The map does not support the removal of list item.
See \ref cds_nonintrusive_SplitListMap_hp "SplitListMap" for description of template parameters.
- The interface of the specialization is a slightly different.
+ @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 <
typename Key,
typename Value,
#ifdef CDS_DOXYGEN_INVOKED
- class Traits = split_list::type_traits
+ class Traits = split_list::traits
#else
class Traits
#endif
> base_class;
//@endcond
public:
- typedef typename base_class::gc gc ; ///< Garbage collector
- typedef Key key_type ; ///< key type
- typedef Value mapped_type ; ///< type of value stored in the map
+ typedef cds::gc::nogc gc; ///< Garbage collector
+ typedef Key key_type; ///< key type
+ typedef Value mapped_type; ///< type of value stored in the map
typedef std::pair<key_type const, mapped_type> value_type ; ///< Pair type
typedef typename base_class::ordered_list ordered_list; ///< Underlying ordered list class
- typedef typename base_class::key_comparator key_comparator ; ///< key comparison functor
+ typedef typename base_class::key_comparator key_comparator; ///< key comparison functor
- typedef typename base_class::hash hash ; ///< Hash functor for \ref key_type
- typedef typename base_class::item_counter item_counter ; ///< Item counter type
+ typedef typename base_class::hash hash; ///< Hash functor for \ref key_type
+ typedef typename base_class::item_counter item_counter; ///< Item counter type
+ typedef typename base_class::stat stat; ///< Internal statistics
protected:
//@cond
- typedef typename base_class::options::type_traits::key_accessor key_accessor;
+ typedef typename base_class::traits::key_accessor key_accessor;
//@endcond
public:
- /// Forward iterator (see SplitListSet::iterator)
+ ///@name Forward iterators
+ //@{
+ /// Forward iterator
/**
- Remember, the iterator <tt>operator -> </tt> and <tt>operator *</tt> returns \ref value_type pointer and reference.
- To access item key and value use <tt>it->first</tt> and <tt>it->second</tt> respectively.
+ 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 typename base_class::iterator iterator;
- /// Const forward iterator (see SplitListSet::const_iterator)
+ /// Const forward iterator
typedef typename base_class::const_iterator const_iterator;
/// Returns a forward iterator addressing the first element in a map
}
/// Returns a forward const iterator addressing the first element in a map
- //@{
const_iterator begin() const
{
return base_class::begin();
}
- const_iterator cbegin()
+
+ /// Returns a forward const iterator addressing the first element in a map
+ const_iterator cbegin() const
{
return base_class::cbegin();
}
- //@}
/// Returns an const iterator that addresses the location succeeding the last element in a map
- //@{
const_iterator end() const
{
return base_class::end();
}
- const_iterator cend()
+
+ /// Returns an const iterator that addresses the location succeeding the last element in a map
+ const_iterator cend() const
{
return base_class::cend();
}
- //@}
+ //@}
public:
/// Initialize split-ordered map of default capacity
/**
The default capacity is defined in bucket table constructor.
- See intrusive::split_list::expandable_bucket_table, intrusive::split_list::static_ducket_table
- which selects by intrusive::split_list::dynamic_bucket_table option.
+ See \p intrusive::split_list::expandable_bucket_table, \p intrusive::split_list::static_ducket_table
+ which selects by \p intrusive::split_list::traits::dynamic_bucket_table.
*/
SplitListMap()
: base_class()
/// Initialize split-ordered map
SplitListMap(
- size_t nItemCount ///< estimate average item count
+ size_t nItemCount ///< estimated average 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 )
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 value of type \p K.
+ - The \p key_type should be constructible from value of type \p K.
In trivial case, \p K is equal to \ref key_type.
- - The \ref mapped_type should be default-constructible.
+ - The \p mapped_type should be default-constructible.
Returns an iterator pointed to inserted value, or \p end() if inserting is failed
*/
iterator insert( K const& key )
{
//TODO: pass arguments by reference (make_pair makes copy)
- return base_class::insert( std::make_pair( key, mapped_type() ) );
+ return base_class::emplace( key_type( key ), mapped_type());
}
/// Inserts new node
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 mapped_type should be constructible from \p val of type \p V.
+ - The \p key_type should be constructible from \p key of type \p K.
+ - The \p mapped_type should be constructible from \p val of type \p V.
Returns an iterator pointed to inserted value, or \p end() if inserting is failed
*/
template <typename K, typename V>
iterator insert( K const& key, V const& val )
{
- //TODO: pass arguments by reference (make_pair makes copy)
- return base_class::insert( std::make_pair( key, val ) );
+ return base_class::emplace( key_type( key ), mapped_type( val ));
}
/// Inserts new node and initialize it by a functor
\endcode
The argument \p item of user-defined functor \p func is the reference
- to the map's item inserted. <tt>item.second</tt> is a reference to item's value that may be changed.
+ to the map's item inserted. \p item.second is a reference to item's value that may be changed.
User-defined functor \p func should guarantee that during changing item's value no any other changes
could be made on this map's item by concurrent threads.
- The user-defined functor can be passed by reference using <tt>boost::ref</tt>
- and it is called only if the inserting is successful.
+ The user-defined functor is called only if the inserting is successful.
- The key_type should be constructible from value of type \p K.
+ The \p 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;
Returns an iterator pointed to inserted value, or \p end() if inserting is failed
*/
template <typename K, typename Func>
- iterator insert_key( const K& key, Func func )
+ iterator insert_with( const K& key, Func func )
{
iterator it = insert( key );
- if ( it != end() )
- cds::unref( func )( (*it) );
+ if ( it != end())
+ func( (*it));
return it;
}
- /// For key \p key inserts data of type \ref mapped_type constructed with <tt>std::forward<Args>(args)...</tt>
+ /// For key \p key inserts data of type \p mapped_type created in-place from \p args
/**
\p key_type should be constructible from type \p K
template <typename K, typename... Args>
iterator emplace( K&& key, Args&&... args )
{
- return base_class::emplace( std::forward<K>(key), std::move(mapped_type(std::forward<Args>(args)...)));
+ return base_class::emplace( key_type( std::forward<K>( key )), mapped_type( std::forward<Args>( args )...));
}
- /// 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 (if inserting is not allowed and \p key is not found, the iterator will be \p end()),
- 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.
+ \p second is true if new item has been added or \p false if the item
+ already is in the map.
*/
template <typename K>
- std::pair<iterator, bool> ensure( K const& key )
+ std::pair<iterator, bool> update( K const& key, bool bAllowInsert = true )
{
//TODO: pass arguments by reference (make_pair makes copy)
- return base_class::ensure( std::make_pair( key, mapped_type() ));
+ return base_class::update( std::make_pair( key_type( key ), mapped_type()), bAllowInsert );
}
+ //@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_SplitListMap_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 contains( K const& key )
+ {
+ return base_class::contains( key );
+ }
+ //@cond
+ template <typename K>
+ CDS_DEPRECATED("deprecated, use contains()")
iterator find( K const& key )
{
- return base_class::find( 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_SplitListMap_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.
*/
template <typename K, typename Less>
+ iterator contains( K const& key, Less pred )
+ {
+ CDS_UNUSED( pred );
+ return base_class::contains( key, cds::details::predicate_wrapper<value_type, Less, key_accessor>());
+ }
+ //@cond
+ template <typename K, typename Less>
+ CDS_DEPRECATED("deprecated, use contains()")
iterator find_with( K const& key, Less pred )
{
- return base_class::find_with( key, cds::details::predicate_wrapper<value_type, Less, key_accessor>() );
+ return contains( key, pred );
+ }
+ //@endcond
+
+
+ /// Clears the set (not atomic, for debugging purposes only)
+ void clear()
+ {
+ base_class::clear();
}
/// Checks if the map is empty
{
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 __CDS_CONTAINER_SPLIT_LIST_MAP_NOGC_H
+#endif // #ifndef CDSLIB_CONTAINER_SPLIT_LIST_MAP_NOGC_H
projects / libcds.git / blobdiff