2 This file is a part of libcds - Concurrent Data Structures library
4 (C) Copyright Maxim Khizhinsky (libcds.dev@gmail.com) 2006-2016
6 Source code repo: http://github.com/khizmax/libcds/
7 Download: http://sourceforge.net/projects/libcds/files/
9 Redistribution and use in source and binary forms, with or without
10 modification, are permitted provided that the following conditions are met:
12 * Redistributions of source code must retain the above copyright notice, this
13 list of conditions and the following disclaimer.
15 * Redistributions in binary form must reproduce the above copyright notice,
16 this list of conditions and the following disclaimer in the documentation
17 and/or other materials provided with the distribution.
19 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
20 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
22 DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
23 FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24 DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
25 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
26 CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
27 OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 #ifndef CDSLIB_CONTAINER_LAZY_KVLIST_NOGC_H
32 #define CDSLIB_CONTAINER_LAZY_KVLIST_NOGC_H
35 #include <cds/container/details/lazy_list_base.h>
36 #include <cds/intrusive/lazy_list_nogc.h>
37 #include <cds/container/details/make_lazy_kvlist.h>
39 namespace cds { namespace container {
41 /// Lazy ordered list (key-value pair, template specialization for gc::nogc)
42 /** @ingroup cds_nonintrusive_list
43 @anchor cds_nonintrusive_LazyKVList_nogc
45 This specialization is append-only list when no item
46 reclamation may be performed. The class does not support deleting of list's item.
48 See @ref cds_nonintrusive_LazyList_gc "cds::container::LazyList<cds::gc::nogc, T, Traits>"
53 #ifdef CDS_DOXYGEN_INVOKED
54 typename Traits = lazy_list::traits
59 class LazyKVList<gc::nogc, Key, Value, Traits>:
60 #ifdef CDS_DOXYGEN_INVOKED
61 protected intrusive::LazyList< gc::nogc, implementation_defined, Traits >
63 protected details::make_lazy_kvlist< cds::gc::nogc, Key, Value, Traits >::type
67 typedef details::make_lazy_kvlist< cds::gc::nogc, Key, Value, Traits > maker;
68 typedef typename maker::type base_class;
72 typedef Traits traits; ///< List traits
73 typedef cds::gc::nogc gc; ///< Garbage collector
74 #ifdef CDS_DOXYGEN_INVOKED
75 typedef Key key_type ; ///< Key type
76 typedef Value mapped_type ; ///< Type of value stored in the list
77 typedef std::pair<key_type const, mapped_type> value_type ; ///< key/value pair stored in the list
79 typedef typename maker::key_type key_type;
80 typedef typename maker::mapped_type mapped_type;
81 typedef typename maker::value_type value_type;
83 typedef typename base_class::back_off back_off; ///< Back-off strategy used
84 typedef typename maker::allocator_type allocator_type; ///< Allocator type used for allocate/deallocate the nodes
85 typedef typename base_class::item_counter item_counter; ///< Item counting policy used
86 typedef typename maker::key_comparator key_comparator; ///< key comparison functor
87 typedef typename base_class::memory_model memory_model; ///< Memory ordering. See cds::opt::memory_model option
88 static CDS_CONSTEXPR bool const c_bSort = base_class::c_bSort; ///< List type: ordered (\p true) or unordered (\p false)
92 typedef typename base_class::value_type node_type;
93 typedef typename maker::cxx_allocator cxx_allocator;
94 typedef typename maker::node_deallocator node_deallocator;
95 typedef typename base_class::key_comparator intrusive_key_comparator;
96 typedef typename base_class::node_type head_type;
101 template <typename K>
102 static node_type * alloc_node(const K& key)
104 return cxx_allocator().New( key );
107 template <typename K, typename V>
108 static node_type * alloc_node( const K& key, const V& val )
110 return cxx_allocator().New( key, val );
113 template <typename... Args>
114 static node_type * alloc_node( Args&&... args )
116 return cxx_allocator().MoveNew( std::forward<Args>(args)... );
119 static void free_node( node_type * pNode )
121 cxx_allocator().Delete( pNode );
124 struct node_disposer {
125 void operator()( node_type * pNode )
130 typedef std::unique_ptr< node_type, node_disposer > scoped_node_ptr;
134 return base_class::m_Head;
137 head_type const& head() const
139 return base_class::m_Head;
144 return base_class::m_Tail;
147 head_type const& tail() const
149 return base_class::m_Tail;
155 template <bool IsConst>
156 class iterator_type: protected base_class::template iterator_type<IsConst>
158 typedef typename base_class::template iterator_type<IsConst> iterator_base;
160 iterator_type( head_type const& refNode )
161 : iterator_base( const_cast<head_type *>( &refNode ))
164 explicit iterator_type( const iterator_base& it )
165 : iterator_base( it )
168 friend class LazyKVList;
171 explicit iterator_type( node_type& pNode )
172 : iterator_base( &pNode )
176 typedef typename cds::details::make_const_type<mapped_type, IsConst>::reference value_ref;
177 typedef typename cds::details::make_const_type<mapped_type, IsConst>::pointer value_ptr;
179 typedef typename cds::details::make_const_type<value_type, IsConst>::reference pair_ref;
180 typedef typename cds::details::make_const_type<value_type, IsConst>::pointer pair_ptr;
186 iterator_type( const iterator_type& src )
187 : iterator_base( src )
190 key_type const& key() const
192 typename iterator_base::value_ptr p = iterator_base::operator ->();
193 assert( p != nullptr );
194 return p->m_Data.first;
197 value_ref val() const
199 typename iterator_base::value_ptr p = iterator_base::operator ->();
200 assert( p != nullptr );
201 return p->m_Data.second;
204 pair_ptr operator ->() const
206 typename iterator_base::value_ptr p = iterator_base::operator ->();
207 return p ? &(p->m_Data) : nullptr;
210 pair_ref operator *() const
212 typename iterator_base::value_ref p = iterator_base::operator *();
217 iterator_type& operator ++()
219 iterator_base::operator ++();
224 iterator_type operator ++(int)
226 return iterator_base::operator ++(0);
230 bool operator ==(iterator_type<C> const& i ) const
232 return iterator_base::operator ==(i);
235 bool operator !=(iterator_type<C> const& i ) const
237 return iterator_base::operator !=(i);
245 The forward iterator for lazy list based on gc::nogc has pre- and post-increment operators.
247 The iterator interface to access item data:
248 - <tt> operator -> </tt> - returns a pointer to \ref value_type for iterator
249 - <tt> operator *</tt> - returns a reference (a const reference for \p const_iterator) to \ref value_type for iterator
250 - <tt> const key_type& key() </tt> - returns a key reference for iterator
251 - <tt> mapped_type& val() </tt> - retuns a value reference for iterator (const reference for \p const_iterator)
253 For both functions the iterator should not be equal to <tt> end() </tt>
255 typedef iterator_type<false> iterator;
257 /// Const forward iterator
259 For iterator's features and requirements see \ref iterator
261 typedef iterator_type<true> const_iterator;
263 /// Returns a forward iterator addressing the first element in a list
265 For empty list \code begin() == end() \endcode
269 iterator it( head() );
270 ++it ; // skip dummy head
274 /// Returns an iterator that addresses the location succeeding the last element in a list
276 Do not use the value returned by <tt>end</tt> function to access any item.
277 Internally, <tt>end</tt> returning value equals to nullptr.
279 The returned value can be used only to control reaching the end of the list.
280 For empty list \code begin() == end() \endcode
284 return iterator( tail());
287 /// Returns a forward const iterator addressing the first element in a list
289 const_iterator begin() const
291 const_iterator it( head() );
292 ++it ; // skip dummy head
295 const_iterator cbegin() const
297 const_iterator it( head() );
298 ++it ; // skip dummy head
303 /// Returns an const iterator that addresses the location succeeding the last element in a list
305 const_iterator end() const
307 return const_iterator( tail());
309 const_iterator cend() const
311 return const_iterator( tail());
317 iterator node_to_iterator( node_type * pNode )
320 return iterator( *pNode );
326 /// Default constructor
330 /// Desctructor clears the list
336 /// Inserts new node with key and default value
338 The function creates a node with \p key and default value, and then inserts the node created into the list.
341 - The \ref key_type should be constructible from value of type \p K.
342 In trivial case, \p K is equal to \ref key_type.
343 - The \ref mapped_type should be default-constructible.
345 Returns an iterator pointed to inserted value, or \p end() if inserting is failed
347 template <typename K>
348 iterator insert( const K& key )
350 return node_to_iterator( insert_at( head(), key ));
353 /// Inserts new node with a key and a value
355 The function creates a node with \p key and value \p val, and then inserts the node created into the list.
358 - The \ref key_type should be constructible from \p key of type \p K.
359 - The \ref mapped_type should be constructible from \p val of type \p V.
361 Returns an iterator pointed to inserted value, or \p end() if inserting is failed
363 template <typename K, typename V>
364 iterator insert( const K& key, const V& val )
366 // We cannot use insert with functor here
367 // because we cannot lock inserted node for updating
368 // Therefore, we use separate function
369 return node_to_iterator( insert_at( head(), key, val ));
372 /// Inserts new node and initialize it by a functor
374 This function inserts new node with key \p key and if inserting is successful then it calls
375 \p func functor with signature
376 \code void func( value_type& item ) ; endcode
380 void operator()( value_type& item );
384 The argument \p item of user-defined functor \p func is the reference
385 to the list's item inserted. <tt>item.second</tt> is a reference to item's value that may be changed.
386 The user-defined functor is called only if the inserting is successful.
388 The key_type should be constructible from value of type \p K.
390 The function allows to split creating of new item into two part:
391 - create item from \p key;
392 - insert new item into the list;
393 - if inserting is successful, initialize the value of item by calling \p f functor
395 This can be useful if complete initialization of object of \p mapped_type is heavyweight and
396 it is preferable that the initialization should be completed only if inserting is successful.
398 Returns an iterator pointed to inserted value, or \p end() if inserting is failed
400 template <typename K, typename Func>
401 iterator insert_with( const K& key, Func func )
403 return node_to_iterator( insert_with_at( head(), key, func ));
408 If \p key is not in the list and \p bAllowInsert is \p true,
410 the function inserts a new item.
411 Otherwise, the function returns an iterator pointing to the item found.
413 Returns <tt> std::pair<iterator, bool> </tt> where \p first is an iterator pointing to
414 item found or inserted, \p second is true if new item has been added or \p false if the item
415 already is in the list.
417 template <typename K>
418 std::pair<iterator, bool> update( const K& key, bool bAllowInsert = true )
420 std::pair< node_type *, bool > ret = update_at( head(), key, bAllowInsert );
421 return std::make_pair( node_to_iterator( ret.first ), ret.second );
424 template <typename K>
425 CDS_DEPRECATED("ensure() is deprecated, use update()")
426 std::pair<iterator, bool> ensure( const K& key )
428 return update( key, true );
432 /// Inserts data of type \ref mapped_type constructed with <tt>std::forward<Args>(args)...</tt>
434 Returns an iterator pointed to inserted value, or \p end() if inserting is failed
436 template <typename... Args>
437 iterator emplace( Args&&... args )
439 return node_to_iterator( emplace_at( head(), std::forward<Args>(args)... ));
442 /// Checks whether the list contains \p key
444 The function searches the item with key equal to \p key
445 and returns an iterator pointed to item found if the key is found,
446 and \ref end() otherwise
448 template <typename Q>
449 iterator contains( Q const& key )
451 return node_to_iterator( find_at( head(), key, intrusive_key_comparator() ) );
454 template <typename Q>
455 CDS_DEPRECATED("deprecated, use contains()")
456 iterator find( Q const& key )
458 return contains( key );
462 /// Checks whether the map contains \p key using \p pred predicate for searching (ordered list version)
464 The function is an analog of <tt>contains( key )</tt> but \p pred is used for key comparing.
465 \p Less functor has the interface like \p std::less.
466 \p Less must imply the same element order as the comparator used for building the list.
468 template <typename Q, typename Less, bool Sort = c_bSort>
469 typename std::enable_if<Sort, iterator>::type contains( Q const& key, Less pred )
472 return node_to_iterator( find_at( head(), key, typename maker::template less_wrapper<Less>::type() ) );
475 template <typename Q, typename Less, bool Sort = c_bSort>
476 CDS_DEPRECATED("deprecated, use contains()")
477 typename std::enable_if<Sort, iterator>::type find_with( Q const& key, Less pred )
479 return contains( key, pred );
483 /// Finds the key \p val using \p equal predicate for searching (unordered list version)
485 The function is an analog of <tt>contains( key )</tt> but \p equal is used for key comparing.
486 \p Equal functor has the interface like \p std::equal_to.
488 template <typename Q, typename Equal, bool Sort = c_bSort>
489 typename std::enable_if<!Sort, iterator>::type contains( Q const& key, Equal equal )
492 return node_to_iterator( find_at( head(), key, typename maker::template equal_to_wrapper<Equal>::type() ) );
495 template <typename Q, typename Equal, bool Sort = c_bSort>
496 CDS_DEPRECATED("deprecated, use contains()")
497 typename std::enable_if<!Sort, iterator>::type find_with( Q const& key, Equal equal )
499 return contains( key, equal );
503 /// Check if the list is empty
506 return base_class::empty();
509 /// Returns list's item count
511 The value returned depends on opt::item_counter option. For atomicity::empty_item_counter,
512 this function always returns 0.
514 @note Even if you use real item counter and it returns 0, this fact is not mean that the list
515 is empty. To check list emptyness use \ref empty() method.
519 return base_class::size();
524 Post-condition: the list is empty
533 node_type * insert_node_at( head_type& refHead, node_type * pNode )
535 assert( pNode != nullptr );
536 scoped_node_ptr p( pNode );
537 if ( base_class::insert_at( &refHead, *p ))
543 template <typename K>
544 node_type * insert_at( head_type& refHead, const K& key )
546 return insert_node_at( refHead, alloc_node( key ));
549 template <typename K, typename V>
550 node_type * insert_at( head_type& refHead, const K& key, const V& val )
552 return insert_node_at( refHead, alloc_node( key, val ));
555 template <typename K, typename Func>
556 node_type * insert_with_at( head_type& refHead, const K& key, Func f )
558 scoped_node_ptr pNode( alloc_node( key ));
560 if ( base_class::insert_at( &refHead, *pNode )) {
562 return pNode.release();
569 template <typename K>
570 std::pair< node_type *, bool > update_at( head_type& refHead, const K& key, bool bAllowInsert )
572 scoped_node_ptr pNode( alloc_node( key ));
573 node_type * pItemFound = nullptr;
575 std::pair<bool, bool> ret = base_class::update_at( &refHead, *pNode,
576 [&pItemFound](bool, node_type& item, node_type&){ pItemFound = &item; },
582 return std::make_pair( pItemFound, ret.second );
585 template <typename... Args>
586 node_type * emplace_at( head_type& refHead, Args&&... args )
588 return insert_node_at( refHead, alloc_node( std::forward<Args>(args)... ));
591 template <typename K, typename Compare>
592 node_type * find_at( head_type& refHead, const K& key, Compare cmp )
594 return base_class::find_at( &refHead, key, cmp );
598 template <typename K, typenam Compare, typename Func>
599 bool find_at( head_type& refHead, K& key, Compare cmp, Func f )
601 return base_class::find_at( &refHead, key, cmp, [&f]( node_type& node, K const& ){ f( node.m_Data ); });
607 }} // namespace cds::container
609 #endif // #ifndef CDSLIB_CONTAINER_LAZY_KVLIST_NOGC_H