2 This file is a part of libcds - Concurrent Data Structures library
4 (C) Copyright Maxim Khizhinsky (libcds.dev@gmail.com) 2006-2017
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_LIST_NOGC_H
32 #define CDSLIB_CONTAINER_LAZY_LIST_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_list.h>
39 namespace cds { namespace container {
41 /// Lazy ordered single-linked list (template specialization for gc::nogc)
42 /** @ingroup cds_nonintrusive_list
43 \anchor cds_nonintrusive_LazyList_nogc
45 This specialization is so-called append-only when no item
46 reclamation may be performed. The class does not support deleting of list item.
48 The list can be ordered if \p Traits::sort is \p true that is default
49 or unordered otherwise. Unordered list can be maintained by \p equal_to
50 relationship (\p Traits::equal_to), but for the ordered list \p less
51 or \p compare relations should be specified in \p Traits.
53 See @ref cds_nonintrusive_LazyList_gc "cds::container::LazyList<cds::gc::nogc, T, Traits>"
57 #ifdef CDS_DOXYGEN_INVOKED
58 typename Traits = lazy_list::traits
63 class LazyList<cds::gc::nogc, T, Traits>:
64 #ifdef CDS_DOXYGEN_INVOKED
65 protected intrusive::LazyList< gc::nogc, T, Traits >
67 protected details::make_lazy_list< cds::gc::nogc, T, Traits >::type
71 typedef details::make_lazy_list< cds::gc::nogc, T, Traits > maker;
72 typedef typename maker::type base_class;
76 typedef cds::gc::nogc gc; ///< Garbage collector
77 typedef T value_type; ///< Type of value stored in the list
78 typedef Traits traits; ///< List traits
80 typedef typename base_class::back_off back_off; ///< Back-off strategy used
81 typedef typename maker::allocator_type allocator_type; ///< Allocator type used for allocate/deallocate the nodes
82 typedef typename base_class::item_counter item_counter; ///< Item counting policy used
83 typedef typename maker::key_comparator key_comparator; ///< key comparing functor
84 typedef typename base_class::memory_model memory_model; ///< Memory ordering. See cds::opt::memory_model option
85 typedef typename base_class::stat stat; ///< Internal statistics
87 static CDS_CONSTEXPR bool const c_bSort = base_class::c_bSort; ///< List type: ordered (\p true) or unordered (\p false)
90 // Rebind traits (split-list support)
91 template <typename... Options>
92 struct rebind_traits {
96 , typename cds::opt::make_options< traits, Options...>::type
101 template <typename Stat>
102 using select_stat_wrapper = typename base_class::template select_stat_wrapper< Stat >;
107 typedef typename base_class::value_type node_type;
108 typedef typename maker::cxx_allocator cxx_allocator;
109 typedef typename maker::node_deallocator node_deallocator;
110 typedef typename base_class::key_comparator intrusive_key_comparator;
112 typedef typename base_class::node_type head_type;
114 struct node_disposer {
115 void operator()( node_type * pNode )
120 typedef std::unique_ptr< node_type, node_disposer > scoped_node_ptr;
125 template <bool IsConst>
126 class iterator_type: protected base_class::template iterator_type<IsConst>
128 typedef typename base_class::template iterator_type<IsConst> iterator_base;
130 iterator_type( head_type const& pNode )
131 : iterator_base( const_cast<head_type *>(&pNode))
134 explicit iterator_type( const iterator_base& it )
135 : iterator_base( it )
138 friend class LazyList;
141 explicit iterator_type( node_type& pNode )
142 : iterator_base( &pNode )
146 typedef typename cds::details::make_const_type<value_type, IsConst>::pointer value_ptr;
147 typedef typename cds::details::make_const_type<value_type, IsConst>::reference value_ref;
152 iterator_type( const iterator_type& src )
153 : iterator_base( src )
156 value_ptr operator ->() const
158 typename iterator_base::value_ptr p = iterator_base::operator ->();
159 return p ? &(p->m_Value) : nullptr;
162 value_ref operator *() const
164 return (iterator_base::operator *()).m_Value;
168 iterator_type& operator ++()
170 iterator_base::operator ++();
175 iterator_type operator ++(int)
177 return iterator_base::operator ++(0);
181 bool operator ==(iterator_type<C> const& i ) const
183 return iterator_base::operator ==(i);
186 bool operator !=(iterator_type<C> const& i ) const
188 return iterator_base::operator !=(i);
194 ///@name Forward iterators
196 /// Returns a forward iterator addressing the first element in a list
198 For empty list \code begin() == end() \endcode
200 typedef iterator_type<false> iterator;
202 /// Const forward iterator
204 For iterator's features and requirements see \ref iterator
206 typedef iterator_type<true> const_iterator;
208 /// Returns a forward iterator addressing the first element in a list
210 For empty list \code begin() == end() \endcode
214 iterator it( head());
215 ++it ; // skip dummy head node
219 /// Returns an iterator that addresses the location succeeding the last element in a list
221 Do not use the value returned by <tt>end</tt> function to access any item.
223 The returned value can be used only to control reaching the end of the list.
224 For empty list \code begin() == end() \endcode
228 return iterator( tail());
231 /// Returns a forward const iterator addressing the first element in a list
232 const_iterator begin() const
234 const_iterator it( head());
235 ++it ; // skip dummy head node
239 /// Returns a forward const iterator addressing the first element in a list
240 const_iterator cbegin() const
242 const_iterator it( head());
243 ++it ; // skip dummy head node
247 /// Returns an const iterator that addresses the location succeeding the last element in a list
248 const_iterator end() const
250 return const_iterator( tail());
253 /// Returns an const iterator that addresses the location succeeding the last element in a list
254 const_iterator cend() const
256 return const_iterator( tail());
261 /// Default constructor
266 template <typename Stat, typename = std::enable_if<std::is_same<stat, lazy_list::wrapped_stat<Stat>>::value >>
267 explicit LazyList( Stat& st )
272 /// Desctructor clears the list
280 The function inserts \p val in the list if the list does not contain
281 an item with key equal to \p val.
283 Return an iterator pointing to inserted item if success \ref end() otherwise
285 template <typename Q>
286 iterator insert( Q&& val )
288 return node_to_iterator( insert_at( head(), std::forward<Q>( val )));
291 /// Inserts data of type \p value_type created from \p args
293 Return an iterator pointing to inserted item if success \ref end() otherwise
295 template <typename... Args>
296 iterator emplace( Args&&... args )
298 return node_to_iterator( emplace_at( head(), std::forward<Args>(args)... ));
303 If \p key is not in the list and \p bAllowInsert is \p true,
304 the function inserts a new item.
305 Otherwise, the function returns an iterator pointing to the item found.
307 Returns <tt> std::pair<iterator, bool> </tt> where \p first is an iterator pointing to
308 item found or inserted, \p second is true if new item has been added or \p false if the item
309 already is in the list.
311 template <typename Q>
312 std::pair<iterator, bool> update( Q&& val, bool bAllowInsert = true )
314 std::pair< node_type *, bool > ret = update_at( head(), std::forward<Q>( val ), bAllowInsert );
315 return std::make_pair( node_to_iterator( ret.first ), ret.second );
318 template <typename Q>
319 CDS_DEPRECATED("ensure() is deprecated, use update()")
320 std::pair<iterator, bool> ensure( Q const& val )
322 return update( val, true );
326 /// Checks whether the list contains \p key
328 The function searches the item with key equal to \p key
329 and returns an iterator pointed to item found if the key is found,
330 and \ref end() otherwise
332 template <typename Q>
333 iterator contains( Q const& key )
335 return node_to_iterator( find_at( head(), key, intrusive_key_comparator()));
338 template <typename Q>
339 CDS_DEPRECATED("deprecated, use contains()")
340 iterator find( Q const& key )
342 return contains( key );
346 /// Checks whether the map contains \p key using \p pred predicate for searching (ordered list version)
348 The function is an analog of <tt>contains( key )</tt> but \p pred is used for key comparing.
349 \p Less functor has the interface like \p std::less.
350 \p Less must imply the same element order as the comparator used for building the list.
352 template <typename Q, typename Less, bool Sort = c_bSort>
353 typename std::enable_if<Sort, iterator>::type contains( Q const& key, Less pred )
356 return node_to_iterator( find_at( head(), key, typename maker::template less_wrapper<Less>::type()));
359 template <typename Q, typename Less, bool Sort = c_bSort>
360 CDS_DEPRECATED("deprecated, use contains()")
361 typename std::enable_if<Sort, iterator>::type find_with( Q const& key, Less pred )
363 return contains( key, pred );
367 /// Finds the key \p val using \p equal predicate for searching (unordered list version)
369 The function is an analog of <tt>contains( key )</tt> but \p equal is used for key comparing.
370 \p Equal functor has the interface like \p std::equal_to.
372 template <typename Q, typename Equal, bool Sort = c_bSort>
373 typename std::enable_if<!Sort, iterator>::type contains( Q const& key, Equal equal )
376 return node_to_iterator( find_at( head(), key, typename maker::template equal_to_wrapper<Equal>::type()));
379 template <typename Q, typename Equal, bool Sort = c_bSort>
380 CDS_DEPRECATED("deprecated, use contains()")
381 typename std::enable_if<!Sort, iterator>::type find_with( Q const& key, Equal equal )
383 return contains( key, equal );
387 /// Check if the list is empty
390 return base_class::empty();
393 /// Returns list's item count
395 The value returned depends on \p Traits::item_counter type. For \p atomicity::empty_item_counter,
396 this function always returns 0.
398 @note Even if you use real item counter and it returns 0, this fact is not mean that the list
399 is empty. To check list emptyness use \ref empty() method.
403 return base_class::size();
406 /// Returns const reference to internal statistics
407 stat const& statistics() const
409 return base_class::statistics();
420 static value_type& node_to_value( node_type& n )
425 static node_type * alloc_node()
427 return cxx_allocator().New();
430 static node_type * alloc_node( value_type const& v )
432 return cxx_allocator().New( v );
435 template <typename... Args>
436 static node_type * alloc_node( Args&&... args )
438 return cxx_allocator().MoveNew( std::forward<Args>( args )... );
441 static void free_node( node_type * pNode )
443 cxx_allocator().Delete( pNode );
448 return base_class::m_Head;
451 head_type const& head() const
453 return base_class::m_Head;
458 return base_class::m_Tail;
461 head_type const& tail() const
463 return base_class::m_Tail;
466 iterator node_to_iterator( node_type * pNode )
469 return iterator( *pNode );
473 iterator insert_node( node_type * pNode )
475 return node_to_iterator( insert_node_at( head(), pNode ));
478 node_type * insert_node_at( head_type& refHead, node_type * pNode )
480 assert( pNode != nullptr );
481 scoped_node_ptr p( pNode );
482 if ( base_class::insert_at( &refHead, *p ))
488 template <typename Q>
489 node_type * insert_at( head_type& refHead, Q&& val )
491 return insert_node_at( refHead, alloc_node( std::forward<Q>( val )));
494 template <typename... Args>
495 node_type * emplace_at( head_type& refHead, Args&&... args )
497 return insert_node_at( refHead, alloc_node( std::forward<Args>(args)... ));
500 template <typename Q>
501 std::pair< node_type *, bool > update_at( head_type& refHead, Q&& val, bool bAllowInsert )
503 scoped_node_ptr pNode( alloc_node( std::forward<Q>( val )));
504 node_type * pItemFound = nullptr;
506 std::pair<bool, bool> ret = base_class::update_at( &refHead, *pNode,
507 [&pItemFound](bool, node_type& item, node_type&) { pItemFound = &item; },
513 return std::make_pair( pItemFound, ret.second );
516 template <typename Q, typename Compare>
517 node_type * find_at( head_type& refHead, Q const& key, Compare cmp )
519 return base_class::find_at( &refHead, key, cmp );
524 }} // namespace cds::container
526 #endif // #ifndef CDSLIB_CONTAINER_LAZY_LIST_NOGC_H