3 // Copyright (c) 2006-2007 Matias Capeletto
5 // Distributed under the Boost Software License, Version 1.0.
6 // (See accompanying file LICENSE_1_0.txt or copy at
7 // http://www.boost.org/LICENSE_1_0.txt)
9 /// \file detail/map_view_iterator.hpp
10 /// \brief Iterator adaptors from multi-index to bimap.
12 #ifndef BOOST_BIMAP_DETAIL_MAP_VIEW_ITERATOR_HPP
13 #define BOOST_BIMAP_DETAIL_MAP_VIEW_ITERATOR_HPP
19 #include <boost/config.hpp>
23 #ifndef BOOST_BIMAP_DISABLE_SERIALIZATION
24 #include <boost/serialization/nvp.hpp>
25 #endif // BOOST_BIMAP_DISABLE_SERIALIZATION
27 #include <boost/iterator/detail/enable_if.hpp>
28 #include <boost/iterator/iterator_adaptor.hpp>
29 #include <boost/bimap/relation/support/pair_by.hpp>
32 #include <boost/bimap/relation/detail/metadata_access_builder.hpp>
33 #include <boost/bimap/relation/detail/static_access_builder.hpp>
39 /** \brief Map View Iterator adaptors from multi index to bimap.
41 These classes are based on transform iterators from Boost.Iterator.
44 template< class Tag, class BimapCore > struct map_view_iterator ;
45 template< class Tag, class BimapCore > struct const_map_view_iterator ;
47 template< class Tag, class BimapCore > struct reverse_map_view_iterator ;
48 template< class Tag, class BimapCore > struct const_reverse_map_view_iterator ;
50 template< class Tag, class BimapCore > struct local_map_view_iterator ;
51 template< class Tag, class BimapCore > struct const_local_map_view_iterator ;
54 #ifndef BOOST_BIMAP_DOXYGEN_WILL_NOT_PROCESS_THE_FOLLOWING_LINES
56 #ifndef BOOST_BIMAP_DISABLE_SERIALIZATION
57 /*===========================================================================*/
58 #define BOOST_BIMAP_MAP_VIEW_ITERATOR_SERIALIZATION_SUPPORT \
59 BOOST_SERIALIZATION_SPLIT_MEMBER() \
61 friend class ::boost::serialization::access; \
63 template< class Archive > \
64 void save(Archive & ar, const unsigned int) const \
66 ar << ::boost::serialization::make_nvp("mi_iterator",this->base()); \
69 template< class Archive > \
70 void load(Archive & ar, const unsigned int) \
72 BOOST_DEDUCED_TYPENAME base_::base_type iter; \
73 ar >> ::boost::serialization::make_nvp("mi_iterator",iter); \
74 this->base_reference() = iter; \
76 /*===========================================================================*/
78 #define BOOST_BIMAP_MAP_VIEW_ITERATOR_SERIALIZATION_SUPPORT // None
79 #endif // BOOST_BIMAP_DISABLE_SERIALIZATION
81 /*===========================================================================*/
82 #define BOOST_BIMAP_CORE_ITERATOR_TYPE_BY_BUILDER( METANAME, ITERATOR ) \
83 BOOST_BIMAP_SYMMETRIC_STATIC_ACCESS_BUILDER( METANAME, BimapCore, \
84 typedef BOOST_DEDUCED_TYPENAME BimapCore::core_type::BOOST_NESTED_TEMPLATE\
85 index<BOOST_DEDUCED_TYPENAME BimapCore::left_tag> \
86 ::type::ITERATOR type, \
87 typedef BOOST_DEDUCED_TYPENAME BimapCore::core_type::BOOST_NESTED_TEMPLATE\
88 index<BOOST_DEDUCED_TYPENAME BimapCore::right_tag> \
89 ::type::ITERATOR type \
91 /*===========================================================================*/
94 BOOST_BIMAP_CORE_ITERATOR_TYPE_BY_BUILDER( core_iterator_type_by
97 BOOST_BIMAP_CORE_ITERATOR_TYPE_BY_BUILDER( reverse_core_iterator_type_by
100 BOOST_BIMAP_CORE_ITERATOR_TYPE_BY_BUILDER( local_core_iterator_type_by
106 template< class Tag, class BimapCore >
107 struct map_view_iterator_adaptor {
108 typedef iterator_adaptor<
109 map_view_iterator<Tag,BimapCore>,
110 BOOST_DEDUCED_TYPENAME core_iterator_type_by<Tag,BimapCore>::type,
111 BOOST_DEDUCED_TYPENAME
112 ::boost::bimaps::support::value_type_by<Tag,BimapCore>::type
115 template< class Tag, class BimapCore >
116 struct map_view_iterator :
117 public map_view_iterator_adaptor<Tag,BimapCore>::type
119 typedef BOOST_DEDUCED_TYPENAME
120 map_view_iterator_adaptor<Tag,BimapCore>::type base_;
123 map_view_iterator() {}
124 map_view_iterator(BOOST_DEDUCED_TYPENAME base_::base_type const& iter)
126 map_view_iterator(map_view_iterator const & iter)
127 : base_(iter.base()) {}
129 BOOST_DEDUCED_TYPENAME base_::reference dereference() const
131 return ::boost::bimaps::relation::support::pair_by<Tag>(
132 *const_cast<BOOST_DEDUCED_TYPENAME base_::base_type::value_type*>(
138 friend class iterator_core_access;
139 BOOST_BIMAP_MAP_VIEW_ITERATOR_SERIALIZATION_SUPPORT
143 template< class Tag, class BimapCore >
144 struct const_map_view_iterator_adaptor {
145 typedef iterator_adaptor<
146 const_map_view_iterator<Tag,BimapCore>,
147 BOOST_DEDUCED_TYPENAME core_iterator_type_by<Tag,BimapCore>::type,
148 const BOOST_DEDUCED_TYPENAME
149 ::boost::bimaps::support::value_type_by<Tag,BimapCore>::type
152 template< class Tag, class BimapCore >
153 struct const_map_view_iterator :
154 public const_map_view_iterator_adaptor<Tag,BimapCore>::type
156 typedef BOOST_DEDUCED_TYPENAME
157 const_map_view_iterator_adaptor<Tag,BimapCore>::type base_;
160 const_map_view_iterator() {}
161 const_map_view_iterator(
162 BOOST_DEDUCED_TYPENAME base_::base_type const& iter)
164 const_map_view_iterator(const_map_view_iterator const & iter)
165 : base_(iter.base()) {}
166 const_map_view_iterator(map_view_iterator<Tag,BimapCore> i)
169 BOOST_DEDUCED_TYPENAME base_::reference dereference() const
171 return ::boost::bimaps::relation::support::pair_by<Tag>(*this->base());
174 friend class iterator_core_access;
175 BOOST_BIMAP_MAP_VIEW_ITERATOR_SERIALIZATION_SUPPORT
179 // reverse_map_view_iterator
181 template< class Tag, class BimapCore >
182 struct reverse_map_view_iterator_adaptor {
183 typedef iterator_adaptor<
184 reverse_map_view_iterator<Tag,BimapCore>,
185 BOOST_DEDUCED_TYPENAME
186 reverse_core_iterator_type_by<Tag,BimapCore>::type,
187 BOOST_DEDUCED_TYPENAME
188 ::boost::bimaps::support::value_type_by<Tag,BimapCore>::type
191 template< class Tag, class BimapCore >
192 struct reverse_map_view_iterator :
193 public reverse_map_view_iterator_adaptor<Tag,BimapCore>::type
195 typedef BOOST_DEDUCED_TYPENAME
196 reverse_map_view_iterator_adaptor<Tag,BimapCore>::type base_;
199 reverse_map_view_iterator() {}
200 reverse_map_view_iterator(
201 BOOST_DEDUCED_TYPENAME base_::base_type const& iter)
203 reverse_map_view_iterator(reverse_map_view_iterator const & iter)
204 : base_(iter.base()) {}
206 BOOST_DEDUCED_TYPENAME base_::reference dereference() const
208 return ::boost::bimaps::relation::support::pair_by<Tag>(
209 *const_cast<BOOST_DEDUCED_TYPENAME base_::base_type::value_type*>(
215 friend class iterator_core_access;
216 BOOST_BIMAP_MAP_VIEW_ITERATOR_SERIALIZATION_SUPPORT
219 template< class Tag, class BimapCore >
220 struct const_reverse_map_view_iterator_adaptor {
221 typedef iterator_adaptor<
222 const_reverse_map_view_iterator<Tag,BimapCore>,
223 BOOST_DEDUCED_TYPENAME
224 reverse_core_iterator_type_by<Tag,BimapCore>::type,
225 const BOOST_DEDUCED_TYPENAME
226 ::boost::bimaps::support::value_type_by<Tag,BimapCore>::type
229 template< class Tag, class BimapCore >
230 struct const_reverse_map_view_iterator :
231 public const_reverse_map_view_iterator_adaptor<Tag,BimapCore>::type
233 typedef BOOST_DEDUCED_TYPENAME
234 const_reverse_map_view_iterator_adaptor<Tag,BimapCore>::type base_;
238 const_reverse_map_view_iterator() {}
239 const_reverse_map_view_iterator(
240 BOOST_DEDUCED_TYPENAME base_::base_type const& iter)
242 const_reverse_map_view_iterator(const_reverse_map_view_iterator const & iter)
243 : base_(iter.base()) {}
244 const_reverse_map_view_iterator(reverse_map_view_iterator<Tag,BimapCore> i)
247 BOOST_DEDUCED_TYPENAME base_::reference dereference() const
249 return ::boost::bimaps::relation::support::pair_by<Tag>(*this->base());
252 friend class iterator_core_access;
253 BOOST_BIMAP_MAP_VIEW_ITERATOR_SERIALIZATION_SUPPORT
257 // local_map_view_iterator
259 template< class Tag, class BimapCore >
260 struct local_map_view_iterator_adaptor {
261 typedef iterator_adaptor<
262 local_map_view_iterator<Tag,BimapCore>,
263 BOOST_DEDUCED_TYPENAME
264 local_core_iterator_type_by<Tag,BimapCore>::type,
265 BOOST_DEDUCED_TYPENAME
266 ::boost::bimaps::support::value_type_by<Tag,BimapCore>::type
269 template< class Tag, class BimapCore >
270 struct local_map_view_iterator :
271 public local_map_view_iterator_adaptor<Tag,BimapCore>::type
273 typedef BOOST_DEDUCED_TYPENAME
274 local_map_view_iterator_adaptor<Tag,BimapCore>::type base_;
277 local_map_view_iterator() {}
278 local_map_view_iterator(
279 BOOST_DEDUCED_TYPENAME base_::base_type const& iter)
281 local_map_view_iterator(local_map_view_iterator const & iter)
282 : base_(iter.base()) {}
284 BOOST_DEDUCED_TYPENAME base_::reference dereference() const
286 return ::boost::bimaps::relation::support::pair_by<Tag>(
287 *const_cast<BOOST_DEDUCED_TYPENAME base_::base_type::value_type*>(
293 friend class iterator_core_access;
294 BOOST_BIMAP_MAP_VIEW_ITERATOR_SERIALIZATION_SUPPORT
297 template< class Tag, class BimapCore >
298 struct const_local_map_view_iterator_adaptor {
299 typedef iterator_adaptor<
300 const_local_map_view_iterator<Tag,BimapCore>,
301 BOOST_DEDUCED_TYPENAME
302 local_core_iterator_type_by<Tag,BimapCore>::type,
303 const BOOST_DEDUCED_TYPENAME
304 ::boost::bimaps::support::value_type_by<Tag,BimapCore>::type
307 template< class Tag, class BimapCore >
308 struct const_local_map_view_iterator :
309 public const_local_map_view_iterator_adaptor<Tag,BimapCore>::type
311 typedef BOOST_DEDUCED_TYPENAME
312 const_local_map_view_iterator_adaptor<Tag,BimapCore>::type base_;
315 const_local_map_view_iterator() {}
316 const_local_map_view_iterator(
317 BOOST_DEDUCED_TYPENAME base_::base_type const& iter)
319 const_local_map_view_iterator(const_local_map_view_iterator const & iter)
320 : base_(iter.base()) {}
321 const_local_map_view_iterator(local_map_view_iterator<Tag,BimapCore> i)
324 BOOST_DEDUCED_TYPENAME base_::reference dereference() const
326 return ::boost::bimaps::relation::support::pair_by<Tag>(*this->base());
329 friend class iterator_core_access;
330 BOOST_BIMAP_MAP_VIEW_ITERATOR_SERIALIZATION_SUPPORT
333 #endif // BOOST_BIMAP_DOXYGEN_WILL_NOT_PROCESS_THE_FOLLOWING_LINES
335 } // namespace detail
336 } // namespace bimaps
339 #endif // BOOST_BIMAP_DETAIL_MAP_VIEW_ITERATOR_HPP