Removed redundant spaces
[libcds.git] / cds / container / striped_set / boost_stable_vector.h
index 9a8b8062c84d1050c4f888127c8750275933cc1a..b83508b535601699c02bfbb34f5f95796d2f50a7 100644 (file)
@@ -1,7 +1,35 @@
-//$$CDS-header$$
+/*
+    This file is a part of libcds - Concurrent Data Structures library
 
-#ifndef __CDS_CONTAINER_STRIPED_SET_BOOST_STABLE_VECTOR_ADAPTER_H
-#define __CDS_CONTAINER_STRIPED_SET_BOOST_STABLE_VECTOR_ADAPTER_H
+    (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_STRIPED_SET_BOOST_STABLE_VECTOR_ADAPTER_H
+#define CDSLIB_CONTAINER_STRIPED_SET_BOOST_STABLE_VECTOR_ADAPTER_H
 
 #include <boost/version.hpp>
 #if BOOST_VERSION < 104800
@@ -125,30 +153,10 @@ namespace cds { namespace intrusive { namespace striped_set {
             //@endcond
 
         public:
-
-            /// Insert value \p val of type \p Q into the container
-            /**
-                The function allows to split creating of new item into two part:
-                - create item with key only from \p val
-                - try to insert new item into the container
-                - if inserting is success, calls \p f functor to initialize value-field of the new item.
-
-                The functor signature is:
-                \code
-                    void func( value_type& item );
-                \endcode
-                where \p item is the item inserted.
-
-                The type \p Q may differ from \ref value_type of items storing in the container.
-                Therefore, the \p value_type should be comparable with type \p Q and constructible from type \p Q,
-
-                The user-defined functor is called only if the inserting is success. It may be passed by reference
-                using \p std::ref
-            */
             template <typename Q, typename Func>
             bool insert( const Q& val, Func f )
             {
-                iterator it = std::lower_bound( m_Vector.begin(), m_Vector.end(), val, find_predicate() );
+                iterator it = std::lower_bound( m_Vector.begin(), m_Vector.end(), val, find_predicate());
                 if ( it == m_Vector.end() || key_comparator()( val, *it ) != 0 ) {
                     value_type newItem( val );
                     it = m_Vector.insert( it, newItem );
@@ -162,53 +170,23 @@ namespace cds { namespace intrusive { namespace striped_set {
             bool emplace( Args&&... args )
             {
                 value_type val( std::forward<Args>(args)... );
-                iterator it = std::lower_bound( m_Vector.begin(), m_Vector.end(), val, find_predicate() );
+                iterator it = std::lower_bound( m_Vector.begin(), m_Vector.end(), val, find_predicate());
                 if ( it == m_Vector.end() || key_comparator()( val, *it ) != 0 ) {
-                    it = m_Vector.emplace( it, std::move( val ) );
+                    it = m_Vector.emplace( it, std::move( val ));
                     return true;
                 }
                 return false;
             }
 
-            /// Ensures that the \p item exists in the container
-            /**
-                The operation performs inserting or changing data.
-
-                If the \p val key not found in the container, then the new item created from \p val
-                is inserted. Otherwise, the functor \p func is called with the item found.
-                The \p Func functor has interface:
-                \code
-                    void func( bool bNew, value_type& item, const Q& val );
-                \endcode
-                or like a functor:
-                \code
-                    struct my_functor {
-                        void operator()( bool bNew, value_type& item, const Q& val );
-                    };
-                \endcode
-
-                where arguments are:
-                - \p bNew - \p true if the item has been inserted, \p false otherwise
-                - \p item - container's item
-                - \p val - argument \p val passed into the \p ensure function
-
-                The functor may change non-key fields of the \p item.
-
-                The type \p Q may differ from \ref value_type of items storing in the container.
-                Therefore, the \p value_type should be comparable with type \p Q and constructible from type \p Q,
-
-                You may pass \p func argument by reference using \p std::ref
-
-                Returns <tt> std::pair<bool, bool> </tt> where \p first is true if operation is successfull,
-                \p second is true if new item has been added or \p false if the item with \p val key
-                already exists.
-            */
             template <typename Q, typename Func>
-            std::pair<bool, bool> ensure( const Q& val, Func func )
+            std::pair<bool, bool> update( const Q& val, Func func, bool bAllowInsert )
             {
-                iterator it = std::lower_bound( m_Vector.begin(), m_Vector.end(), val, find_predicate() );
+                iterator it = std::lower_bound( m_Vector.begin(), m_Vector.end(), val, find_predicate());
                 if ( it == m_Vector.end() || key_comparator()( val, *it ) != 0 ) {
                     // insert new
+                    if ( !bAllowInsert )
+                        return std::make_pair( false, false );
+
                     value_type newItem( val );
                     it = m_Vector.insert( it, newItem );
                     func( true, *it, val );
@@ -221,28 +199,10 @@ namespace cds { namespace intrusive { namespace striped_set {
                 }
             }
 
-            /// Delete \p key
-            /**
-                The function searches an item with key \p key, calls \p f functor
-                and deletes the item. If \p key is not found, the functor is not called.
-
-                The functor \p Func interface is:
-                \code
-                struct extractor {
-                    void operator()(value_type const& val);
-                };
-                \endcode
-                The functor may be passed by reference using <tt>boost:ref</tt>
-
-                The type \p Q may differ from \ref value_type of items storing in the container.
-                Therefore, the \p value_type should be comparable with type \p Q.
-
-                Return \p true if key is found and deleted, \p false otherwise
-            */
             template <typename Q, typename Func>
             bool erase( const Q& key, Func f )
             {
-                iterator it = std::lower_bound( m_Vector.begin(), m_Vector.end(), key, find_predicate() );
+                iterator it = std::lower_bound( m_Vector.begin(), m_Vector.end(), key, find_predicate());
                 if ( it == m_Vector.end() || key_comparator()( key, *it ) != 0 )
                     return false;
 
@@ -256,7 +216,7 @@ namespace cds { namespace intrusive { namespace striped_set {
             bool erase( const Q& key, Less pred, Func f )
             {
                 iterator it = std::lower_bound( m_Vector.begin(), m_Vector.end(), key, pred );
-                if ( it == m_Vector.end() || pred( key, *it ) || pred( *it, key ) )
+                if ( it == m_Vector.end() || pred( key, *it ) || pred( *it, key ))
                     return false;
 
                 // key exists
@@ -265,32 +225,10 @@ namespace cds { namespace intrusive { namespace striped_set {
                 return true;
             }
 
-            /// Find the key \p val
-            /**
-                The function searches the item with key equal to \p val and calls the functor \p f for item found.
-                The interface of \p Func functor is:
-                \code
-                struct functor {
-                    void operator()( value_type& item, Q& val );
-                };
-                \endcode
-                where \p item is the item found, \p val is the <tt>find</tt> function argument.
-
-                You may pass \p f argument by reference using \p std::ref
-
-                The functor may change non-key fields of \p item.
-                The \p val argument is non-const since it can be used as \p f functor destination i.e., the functor
-                may modify both arguments.
-
-                The type \p Q may differ from \ref value_type of items storing in the container.
-                Therefore, the \p value_type should be comparable with type \p Q.
-
-                The function returns \p true if \p val is found, \p false otherwise.
-            */
             template <typename Q, typename Func>
             bool find( Q& val, Func f )
             {
-                iterator it = std::lower_bound( m_Vector.begin(), m_Vector.end(), val, find_predicate() );
+                iterator it = std::lower_bound( m_Vector.begin(), m_Vector.end(), val, find_predicate());
                 if ( it == m_Vector.end() || key_comparator()( val, *it ) != 0 )
                     return false;
 
@@ -303,7 +241,7 @@ namespace cds { namespace intrusive { namespace striped_set {
             bool find( Q& val, Less pred, Func f )
             {
                 iterator it = std::lower_bound( m_Vector.begin(), m_Vector.end(), val, pred );
-                if ( it == m_Vector.end() || pred( val, *it ) || pred( *it, val ) )
+                if ( it == m_Vector.end() || pred( val, *it ) || pred( *it, val ))
                     return false;
 
                 // key exists
@@ -324,7 +262,7 @@ namespace cds { namespace intrusive { namespace striped_set {
 
             void move_item( adapted_container& /*from*/, iterator itWhat )
             {
-                iterator it = std::lower_bound( m_Vector.begin(), m_Vector.end(), *itWhat, find_predicate() );
+                iterator it = std::lower_bound( m_Vector.begin(), m_Vector.end(), *itWhat, find_predicate());
                 assert( it == m_Vector.end() || key_comparator()( *itWhat, *it ) != 0 );
 
                 copy_item()( m_Vector, it, itWhat );
@@ -341,8 +279,6 @@ namespace cds { namespace intrusive { namespace striped_set {
 
     };
 }}} // namespace cds::intrusive::striped_set
-
-
 //@endcond
 
-#endif // #ifndef __CDS_CONTAINER_STRIPED_SET_BOOST_STABLE_VECTOR_ADAPTER_H
+#endif // #ifndef CDSLIB_CONTAINER_STRIPED_SET_BOOST_STABLE_VECTOR_ADAPTER_H