Docfix, minor changes
[libcds.git] / cds / container / details / skip_list_base.h
index a5258968481597aebf76527d449e94ee4abdb18d..d29e8338e1b602d2d69c8f3b1b99b9d05565cf5a 100644 (file)
@@ -1,7 +1,35 @@
-//$$CDS-header$$
-
-#ifndef __CDS_CONTAINER_DETAILS_SKIP_LIST_BASE_H
-#define __CDS_CONTAINER_DETAILS_SKIP_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_SKIP_LIST_BASE_H
+#define CDSLIB_CONTAINER_DETAILS_SKIP_LIST_BASE_H
 
 #include <cds/intrusive/details/skip_list_base.h>
 #include <cds/container/details/base.h>
@@ -12,7 +40,6 @@ namespace cds { namespace container {
     /** @ingroup cds_nonintrusive_helper
     */
     namespace skip_list {
-
         /// Option specifying random level generator
         template <typename Type>
         using random_level_generator = cds::intrusive::skip_list::random_level_generator<Type>;
@@ -25,7 +52,7 @@ namespace cds { namespace container {
 
         /// Skip list internal statistics
         template <typename EventCounter = cds::atomicity::event_counter>
-        using stat = cds::intrusive::skip_list::stat < EventCounter > ;
+        using stat = cds::intrusive::skip_list::stat < EventCounter >;
 
         /// Skip list empty internal statistics
         typedef cds::intrusive::skip_list::empty_stat empty_stat;
@@ -96,7 +123,7 @@ namespace cds { namespace container {
             - \p opt::compare - key comparison 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 comparison. Default is \p std::less<T>.
-            - \p opt::item_counter - the type of item counting feature. Default is \pf atomicity::empty_item_counter that is no item counting.
+            - \p opt::item_counter - the type of item counting feature. Default is \p atomicity::empty_item_counter that is no item counting.
             - \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).
             - \p skip_list::random_level_generator - random level generator. Can be \p skip_list::xorshift, \p skip_list::turbo_pascal or
@@ -105,7 +132,7 @@ namespace cds { namespace container {
             - \p opt::allocator - allocator for skip-list node. Default is \ref CDS_DEFAULT_ALLOCATOR.
             - \p opt::back_off - back-off strategy used. If the option is not specified, the \p cds::backoff::Default is used.
             - \p opt::stat - internal statistics. Available types: \p skip_list::stat, \p skip_list::empty_stat (the default)
-            - \p opt::rcu_check_deadlock - a deadlock checking policy for RCU-based skip-list. 
+            - \p opt::rcu_check_deadlock - a deadlock checking policy for RCU-based skip-list.
                 Default is \p opt::v::rcu_throw_deadlock
 
         */
@@ -171,17 +198,19 @@ namespace cds { namespace container {
                 node_type * New( unsigned int nHeight, Q const& v )
                 {
                     unsigned char * pMem = alloc_space( nHeight );
-                    return new( pMem )
+                    node_type * p = new( pMem )
                         node_type( nHeight, nHeight > 1 ? reinterpret_cast<node_tower_item *>(pMem + c_nNodeSize) : nullptr, v );
+                    return p;
                 }
 
                 template <typename... Args>
                 node_type * New( unsigned int nHeight, Args&&... args )
                 {
                     unsigned char * pMem = alloc_space( nHeight );
-                    return new( pMem )
+                    node_type * p = new( pMem )
                         node_type( nHeight, nHeight > 1 ? reinterpret_cast<node_tower_item *>(pMem + c_nNodeSize) : nullptr,
                         std::forward<Args>(args)... );
+                    return p;
                 }
 
                 void Delete( node_type * p )
@@ -207,7 +236,7 @@ namespace cds { namespace container {
                 }
 
                 struct node_disposer {
-                    void operator()( intrusive_node_type * pNode ) const {}
+                    void operator()( intrusive_node_type * /*pNode*/ ) const {}
                 };
             };
 
@@ -288,4 +317,4 @@ namespace cds { namespace container {
 
 }} // namespace cds::container
 
-#endif // #ifndef __CDS_CONTAINER_DETAILS_SKIP_LIST_BASE_H
+#endif // #ifndef CDSLIB_CONTAINER_DETAILS_SKIP_LIST_BASE_H