StripedSet: replace ensure() with update()
[libcds.git] / cds / container / striped_set / boost_list.h
1 //$$CDS-header$$
2
3 #ifndef CDSLIB_CONTAINER_STRIPED_SET_BOOST_LIST_ADAPTER_H
4 #define CDSLIB_CONTAINER_STRIPED_SET_BOOST_LIST_ADAPTER_H
5
6 #include <boost/version.hpp>
7 #if BOOST_VERSION < 104800
8 #   error "For boost::container::list you must use boost 1.48 or above"
9 #endif
10
11 #include <algorithm>    // std::lower_bound
12 #include <functional>   // ref
13 #include <cds/container/striped_set/adapter.h>
14 #include <boost/container/list.hpp>
15
16 //@cond
17 namespace cds { namespace container {
18     namespace striped_set {
19
20         // Copy policy for boost::container::list
21         template <typename T, typename Alloc>
22         struct copy_item_policy< boost::container::list< T, Alloc > >
23         {
24             typedef boost::container::list< T, Alloc > list_type;
25             typedef typename list_type::iterator iterator;
26
27             void operator()( list_type& list, iterator itInsert, iterator itWhat )
28             {
29                 itInsert = list.insert( itInsert, *itWhat );
30             }
31         };
32
33         // Swap policy for boost::container::list
34         template <typename T, typename Alloc>
35         struct swap_item_policy< boost::container::list< T, Alloc > >
36         {
37             typedef boost::container::list< T, Alloc > list_type;
38             typedef typename list_type::iterator iterator;
39
40             void operator()( list_type& list, iterator itInsert, iterator itWhat )
41             {
42                 typename list_type::value_type newVal;
43                 itInsert = list.insert( itInsert, newVal );
44                 std::swap( *itWhat, *itInsert );
45             }
46         };
47
48         // Move policy for boost::container::list
49         template <typename T, typename Alloc>
50         struct move_item_policy< boost::container::list< T, Alloc > >
51         {
52             typedef boost::container::list< T, Alloc > list_type;
53             typedef typename list_type::iterator iterator;
54
55             void operator()( list_type& list, iterator itInsert, iterator itWhat )
56             {
57                 list.insert( itInsert, std::move( *itWhat ) );
58             }
59         };
60     }   // namespace striped_set
61 }} // namespace cds::container
62
63 namespace cds { namespace intrusive { namespace striped_set {
64
65     /// boost::container::list adapter for hash set bucket
66     template <typename T, class Alloc, typename... Options>
67     class adapt< boost::container::list<T, Alloc>, Options... >
68     {
69     public:
70         typedef boost::container::list<T, Alloc>     container_type          ;   ///< underlying container type
71
72     private:
73         /// Adapted container type
74         class adapted_container: public cds::container::striped_set::adapted_sequential_container
75         {
76         public:
77             typedef typename container_type::value_type value_type  ;   ///< value type stored in the container
78             typedef typename container_type::iterator      iterator ;   ///< container iterator
79             typedef typename container_type::const_iterator const_iterator ;    ///< container const iterator
80
81             static bool const has_find_with = true;
82             static bool const has_erase_with = true;
83
84         private:
85             //@cond
86             typedef typename cds::opt::details::make_comparator_from_option_list< value_type, Options... >::type key_comparator;
87
88             typedef typename cds::opt::select<
89                 typename cds::opt::value<
90                     typename cds::opt::find_option<
91                         cds::opt::copy_policy< cds::container::striped_set::move_item >
92                         , Options...
93                     >::type
94                 >::copy_policy
95                 , cds::container::striped_set::copy_item, cds::container::striped_set::copy_item_policy<container_type>
96                 , cds::container::striped_set::swap_item, cds::container::striped_set::swap_item_policy<container_type>
97                 , cds::container::striped_set::move_item, cds::container::striped_set::move_item_policy<container_type>
98             >::type copy_item;
99
100             struct find_predicate
101             {
102                 bool operator()( value_type const& i1, value_type const& i2) const
103                 {
104                     return key_comparator()( i1, i2 ) < 0;
105                 }
106
107                 template <typename Q>
108                 bool operator()( Q const& i1, value_type const& i2) const
109                 {
110                     return key_comparator()( i1, i2 ) < 0;
111                 }
112
113                 template <typename Q>
114                 bool operator()( value_type const& i1, Q const& i2) const
115                 {
116                     return key_comparator()( i1, i2 ) < 0;
117                 }
118             };
119             //@endcond
120
121         private:
122             //@cond
123             container_type  m_List;
124             //@endcond
125
126         public:
127             adapted_container()
128             {}
129
130             template <typename Q, typename Func>
131             bool insert( Q const& val, Func f )
132             {
133                 iterator it = std::lower_bound( m_List.begin(), m_List.end(), val, find_predicate() );
134                 if ( it == m_List.end() || key_comparator()( val, *it ) != 0 ) {
135                     value_type newItem( val );
136                     it = m_List.insert( it, newItem );
137                     f( *it );
138
139                     return true;
140                 }
141
142                 // key already exists
143                 return false;
144             }
145
146             template <typename... Args>
147             bool emplace( Args&&... args )
148             {
149                 value_type val( std::forward<Args>(args)... );
150                 iterator it = std::lower_bound( m_List.begin(), m_List.end(), val, find_predicate() );
151                 if ( it == m_List.end() || key_comparator()( val, *it ) != 0 ) {
152                     m_List.emplace( it, std::move( val ) );
153                     return true;
154                 }
155                 return false;
156             }
157
158             template <typename Q, typename Func>
159             std::pair<bool, bool> update( Q const& val, Func func, bool bAllowInsert )
160             {
161                 iterator it = std::lower_bound( m_List.begin(), m_List.end(), val, find_predicate() );
162                 if ( it == m_List.end() || key_comparator()( val, *it ) != 0 ) {
163                     // insert new
164                     if ( !bAllowInsert )
165                         return std::make_pair( false, false );
166
167                     value_type newItem( val );
168                     it = m_List.insert( it, newItem );
169                     func( true, *it, val );
170                     return std::make_pair( true, true );
171                 }
172                 else {
173                     // already exists
174                     func( false, *it, val );
175                     return std::make_pair( true, false );
176                 }
177             }
178
179             template <typename Q, typename Func>
180             bool erase( Q const& key, Func f )
181             {
182                 iterator it = std::lower_bound( m_List.begin(), m_List.end(), key, find_predicate() );
183                 if ( it == m_List.end() || key_comparator()( key, *it ) != 0 )
184                     return false;
185
186                 // key exists
187                 f( *it );
188                 m_List.erase( it );
189
190                 return true;
191             }
192
193             template <typename Q, typename Less, typename Func>
194             bool erase( Q const& key, Less pred, Func f )
195             {
196                 iterator it = std::lower_bound( m_List.begin(), m_List.end(), key, pred );
197                 if ( it == m_List.end() || pred( key, *it ) || pred( *it, key ) )
198                     return false;
199
200                 // key exists
201                 f( *it );
202                 m_List.erase( it );
203
204                 return true;
205             }
206
207             template <typename Q, typename Func>
208             bool find( Q& val, Func f )
209             {
210                 iterator it = std::lower_bound( m_List.begin(), m_List.end(), val, find_predicate() );
211                 if ( it == m_List.end() || key_comparator()( val, *it ) != 0 )
212                     return false;
213
214                 // key exists
215                 f( *it, val );
216                 return true;
217             }
218
219             template <typename Q, typename Less, typename Func>
220             bool find( Q& val, Less pred, Func f )
221             {
222                 iterator it = std::lower_bound( m_List.begin(), m_List.end(), val, pred );
223                 if ( it == m_List.end() || pred( val, *it ) || pred( *it, val ) )
224                     return false;
225
226                 // key exists
227                 f( *it, val );
228                 return true;
229             }
230
231             /// Clears the container
232             void clear()
233             {
234                 m_List.clear();
235             }
236
237             iterator begin()                { return m_List.begin(); }
238             const_iterator begin() const    { return m_List.begin(); }
239             iterator end()                  { return m_List.end(); }
240             const_iterator end() const      { return m_List.end(); }
241
242             void move_item( adapted_container& /*from*/, iterator itWhat )
243             {
244                 iterator it = std::lower_bound( m_List.begin(), m_List.end(), *itWhat, find_predicate() );
245                 assert( it == m_List.end() || key_comparator()( *itWhat, *it ) != 0 );
246
247                 copy_item()( m_List, it, itWhat );
248             }
249
250             size_t size() const
251             {
252                 return m_List.size();
253             }
254         };
255
256     public:
257         typedef adapted_container type ; ///< Result of \p adapt metafunction
258
259     };
260 }}} // namespace cds::intrsive::striped_set
261 //@endcond
262
263 #endif // #ifndef CDSLIB_CONTAINER_STRIPED_SET_BOOST_LIST_ADAPTER_H