-//$$CDS-header$$
+/*
+ This file is a part of libcds - Concurrent Data Structures library
-#ifndef __CDS_CONTAINER_SKIP_LIST_MAP_NOGC_H
-#define __CDS_CONTAINER_SKIP_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_SKIP_LIST_MAP_NOGC_H
+#define CDSLIB_CONTAINER_SKIP_LIST_MAP_NOGC_H
#include <cds/container/skip_list_set_nogc.h>
- \p K - type of a key to be stored in the map.
- \p T - type of a value to be stored in the map.
- \p Traits - map traits, default is \p skip_list::traits
- It is possible to declare option-based list with \p cds::container::skip_list::make_traits
+ It is possible to declare option-based list with \p cds::container::skip_list::make_traits
metafunction istead of \p Traits template argument.
*/
template <
{}
public:
+ ///@name Forward ordered 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 a split-list has some features:
+ - it has no post-increment operator
+ - it depends on iterator of underlying \p OrderedList
*/
typedef typename base_class::iterator iterator;
{
return base_class::begin();
}
+
/// Returns a forward const iterator addressing the first element in a map
const_iterator cbegin() const
{
{
return base_class::end();
}
+
/// Returns an const iterator that addresses the location succeeding the last element in a map
const_iterator cend() const
{
return base_class::cend();
}
+ //@}
public:
/// Inserts new node with key and default value
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::insert( std::make_pair( key_type( key ), mapped_type()));
}
/// Inserts new node
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::insert( std::make_pair( key_type( key ), mapped_type( val )));
}
/// Inserts new node and initialize it by a functor
Returns an iterator pointed to inserted value, or \p end() if inserting is failed
*/
template <typename K, typename Func>
- iterator insert_key( K const& key, Func func )
+ iterator insert_with( K const& key, Func func )
{
iterator it = insert( key );
- if ( it != end() )
- func( (*it) );
+ if ( it != end())
+ func( (*it));
return it;
}
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 data by \p key
/**
- 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.
+ The operation inserts new item if \p key is not found in the map and \p bInsert is \p true.
+ Otherwise, if \p key is found, the function returns an iterator that points to 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.
+ item found or inserted or \p end() if \p key is not found and insertion is not allowed (\p bInsert is \p false),
+ \p second is \p true if new item has been added or \p false if the item already exists.
*/
template <typename K>
- std::pair<iterator, bool> ensure( K const& key )
+ std::pair<iterator, bool> update( K const& key, bool bInsert = 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()), bInsert );
}
+ //@cond
+ template <typename K>
+ CDS_DEPRECATED("ensure() is deprecated, use update()")
+ std::pair<iterator, bool> ensure( K const& key )
+ {
+ return update( key, true );
+ }
+ //@endcond
- /// Finds the key \p key
- /** \anchor cds_nonintrusive_SkipListMap_nogc_find_val
-
+ /// 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
*/
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 key with comparing functor \p cmp
+ /// Checks whether the map contains \p key using \p pred predicate for searching
/**
- The function is an analog of \ref cds_nonintrusive_SkipListMap_nogc_find_val "find(K const&)"
- but \p pred is used for key comparing.
+ The function is similar to <tt>contains( key )</tt> but \p pred is used for key comparing.
\p Less functor has the interface like \p std::less.
- \p Less must imply the same element order as the comparator used for building the set.
+ \p Less must imply the same element order as the comparator used for building the map.
*/
template <typename K, typename Less>
+ iterator contains( K const& key, Less pred ) const
+ {
+ return base_class::contains( key, pred );
+ }
+ //@cond
+ template <typename K, typename Less>
+ CDS_DEPRECATED("deprecated, use contains()")
iterator find_with( K const& key, Less pred ) const
{
- return base_class::find_with( key, pred );
+ return contains( key, pred );
}
+ //@endcond
/// Gets minimum key from the map
/**
}} // namespace cds::container
-#endif // #ifndef __CDS_CONTAINER_SKIP_LIST_MAP_NOGC_H
+#endif // #ifndef CDSLIB_CONTAINER_SKIP_LIST_MAP_NOGC_H