-//$$CDS-header$$
-
-#ifndef __CDS_CONTAINER_DETAILS_LAZY_LIST_BASE_H
-#define __CDS_CONTAINER_DETAILS_LAZY_LIST_BASE_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_DETAILS_LAZY_LIST_BASE_H
+#define CDSLIB_CONTAINER_DETAILS_LAZY_LIST_BASE_H
#include <cds/container/details/base.h>
#include <cds/intrusive/details/lazy_list_base.h>
/** @ingroup cds_nonintrusive_helper
*/
namespace lazy_list {
- /// Lazy list default type traits
+ /// LazyList traits
/**
Either \p compare or \p less or both must be specified.
*/
- struct type_traits
+ struct traits
{
/// allocator used to allocate new node
typedef CDS_DEFAULT_ALLOCATOR allocator;
- /// Key comparison functor
+ /// Key comparing functor
/**
No default functor is provided. If the option is not specified, the \p less is used.
*/
typedef opt::none compare;
- /// specifies binary predicate used for key comparison.
+ /// Specifies binary predicate used for key comparing
/**
Default is \p std::less<T>.
*/
typedef opt::none less;
- /// Lock type used to lock modifying items
+ /// Specifies binary functor used for comparing keys for equality
/**
- Default is cds::lock::Spin
+ No default functor is provided. If \p equal_to option is not spcified, \p compare is used, if \p compare is not
+ specified, \p less is used.
*/
- typedef cds::lock::Spin lock_type;
+ typedef opt::none equal_to;
- /// back-off strategy used
+ /// Specifies list ordering policy.
/**
- If the option is not specified, the cds::backoff::Default is used.
+ If \p sort is \p true, than list maintains items in sorted order, otherwise items are unordered. Default is \p true.
+ Note that if \p sort is \p false then lookup operations scan entire list.
*/
- typedef cds::backoff::Default back_off;
+ static const bool sort = true;
- /// Item counter
+ /// Lock type used to lock modifying items
/**
- The type for item counting feature.
- Default is no item counter (\ref atomicity::empty_item_counter)
+ Default is cds::sync::spin
*/
- typedef atomicity::empty_item_counter item_counter;
+ typedef cds::sync::spin lock_type;
- /// Link fields checking feature
- /**
- Default is \ref intrusive::opt::debug_check_link
- */
- static const opt::link_check_type link_checker = opt::debug_check_link;
+ /// back-off strategy used
+ typedef cds::backoff::Default back_off;
+
+ /// Item counting feature; by default, disabled. Use \p cds::atomicity::item_counter to enable item counting
+ typedef atomicity::empty_item_counter item_counter;
/// C++ memory ordering model
/**
- List of available memory ordering see opt::memory_model
+ Can be \p opt::v::relaxed_ordering (relaxed memory model, the default)
+ or \p opt::v::sequential_consistent (sequentially consisnent memory model).
*/
typedef opt::v::relaxed_ordering memory_model;
/// RCU deadlock checking policy (only for \ref cds_intrusive_LazyList_rcu "RCU-based LazyList")
/**
- List of available options see opt::rcu_check_deadlock
+ List of available options see \p opt::rcu_check_deadlock
*/
typedef opt::v::rcu_throw_deadlock rcu_check_deadlock;
// key accessor (opt::none = internal key type is equal to user key type)
typedef opt::none key_accessor;
- // for internal use only!!!
- typedef opt::none boundary_node_type;
-
//@endcond
};
- /// Metafunction converting option list to traits for LazyList
+ /// Metafunction converting option list to \p lazy_list::traits
/**
- This is a wrapper for <tt> cds::opt::make_options< type_traits, Options...> </tt>
-
- See \ref LazyList, \ref type_traits, \ref cds::opt::make_options.
+ \p Options are:
+ - \p opt::lock_type - lock type for node-level locking. Default \p is cds::sync::spin. Note that <b>each</b> node
+ of the list has member of type \p lock_type, therefore, heavy-weighted locking primitive is not
+ acceptable as candidate for \p lock_type.
+ - \p opt::compare - key compare functor. No default functor is provided.
+ If the option is not specified, the \p opt::less is used.
+ - \p opt::less - specifies binary predicate used for key compare. Default is \p std::less<T>.
+ - \p opt::equal_to - specifies binary functor for comparing keys for equality. No default is provided. If \p equal_to is
+ not specified, \p compare is used, if \p compare is not specified, \p less is used.
+ - \p opt::sort - specifies ordering policy. Default value is \p true.
+ - \p opt::back_off - back-off strategy used. If the option is not specified, \p cds::backoff::Default is used.
+ - \p opt::item_counter - the type of item counting feature. Default is disabled (\p atomicity::empty_item_counter).
+ To enable item counting use \p atomicity::item_counter.
+ - \p opt::allocator - the allocator used for creating and freeing list's item. Default is \ref CDS_DEFAULT_ALLOCATOR macro.
+ - \p opt::memory_model - C++ memory ordering model. Can be \p opt::v::relaxed_ordering (relaxed memory model, the default)
+ or \p opt::v::sequential_consistent (sequentially consisnent memory model).
*/
template <typename... Options>
struct make_traits {
typedef implementation_defined type ; ///< Metafunction result
# else
typedef typename cds::opt::make_options<
- typename cds::opt::find_type_traits< type_traits, Options... >::type
+ typename cds::opt::find_type_traits< traits, Options... >::type
,Options...
>::type type;
#endif
} // namespace lazy_list
// Forward declarations
- template <typename GC, typename T, typename Traits=lazy_list::type_traits>
+ template <typename GC, typename T, typename Traits=lazy_list::traits>
class LazyList;
- template <typename GC, typename Key, typename Value, typename Traits=lazy_list::type_traits>
+ template <typename GC, typename Key, typename Value, typename Traits=lazy_list::traits>
class LazyKVList;
// Tag for selecting lazy list implementation
This struct is empty and it is used only as a tag for selecting LazyList
as ordered list implementation in declaration of some classes.
- See split_list::type_traits::ordered_list as an example.
+ See \p split_list::traits::ordered_list as an example.
*/
struct lazy_list_tag
{};
-
}} // namespace cds::container
-#endif // #ifndef __CDS_CONTAINER_DETAILS_LAZY_LIST_BASE_H
+#endif // #ifndef CDSLIB_CONTAINER_DETAILS_LAZY_LIST_BASE_H
projects / libcds.git / blobdiff