bimap/views/unordered_map_view.hpp

0001 // Boost.Bimap
0002 //
0003 // Copyright (c) 2006-2007 Matias Capeletto
0004 //
0005 // Distributed under the Boost Software License, Version 1.0.
0006 // (See accompanying file LICENSE_1_0.txt or copy at
0007 // http://www.boost.org/LICENSE_1_0.txt)
0008
0009 /// \file views/unordered_map_view.hpp
0010 /// \brief View of a side of a bimap that is signature compatible with tr1::unordered_map.
0011
0012 #ifndef BOOST_BIMAP_VIEWS_UNOREDERED_MAP_VIEW_HPP
0013 #define BOOST_BIMAP_VIEWS_UNOREDERED_MAP_VIEW_HPP
0014
0015 #if defined(_MSC_VER)
0016 #pragma once
0017 #endif
0018
0019 #include <boost/config.hpp>
0020
0021 #include <utility>
0022
0023 #include <boost/bimap/container_adaptor/unordered_map_adaptor.hpp>
0024 #include <boost/bimap/detail/map_view_base.hpp>
0025
0026 namespace boost {
0027 namespace bimaps {
0028 namespace views {
0029
0030 /// \brief Map View of a bimap, signature compatible with tr1::unordered_map.
0031 /**
0032
0033 This class uses container_adaptor and iterator_adaptor to wrapped a index of the
0034 multi_index bimap core so it can be used as a tr1::unordered_map.
0035
0036 See also const_unordered_map_view.
0037                                                                              **/
0038
0039
0040 template< class Tag, class BimapType >
0041 class unordered_map_view
0042 :
0043     public BOOST_BIMAP_MAP_VIEW_CONTAINER_ADAPTOR(
0044         unordered_map_adaptor,
0045         Tag,BimapType,
0046         local_map_view_iterator,const_local_map_view_iterator
0047     ),
0048
0049     public ::boost::bimaps::detail::map_view_base<
0050                 unordered_map_view<Tag,BimapType>,Tag,BimapType >,
0051     public ::boost::bimaps::detail::
0052                 unique_map_view_access<
0053                     unordered_map_view<Tag,BimapType>, Tag,  BimapType>::type
0054
0055 {
0056     typedef BOOST_BIMAP_MAP_VIEW_CONTAINER_ADAPTOR(
0057         unordered_map_adaptor,
0058         Tag,BimapType,
0059         local_map_view_iterator,const_local_map_view_iterator
0060
0061     ) base_;
0062
0063     BOOST_BIMAP_MAP_VIEW_BASE_FRIEND(unordered_map_view,Tag,BimapType)
0064
0065     typedef BOOST_DEDUCED_TYPENAME ::boost::bimaps::detail::
0066         unique_map_view_access<
0067             unordered_map_view<Tag,BimapType>, Tag,  BimapType
0068
0069         >::type unique_map_view_access_;
0070
0071     public:
0072
0073     typedef std::pair<
0074         BOOST_DEDUCED_TYPENAME base_::iterator,
0075         BOOST_DEDUCED_TYPENAME base_::iterator
0076     > range_type;
0077
0078     typedef std::pair<
0079         BOOST_DEDUCED_TYPENAME base_::const_iterator,
0080         BOOST_DEDUCED_TYPENAME base_::const_iterator
0081     > const_range_type;
0082
0083     typedef BOOST_DEDUCED_TYPENAME base_::value_type::info_type info_type;
0084
0085     unordered_map_view(BOOST_DEDUCED_TYPENAME base_::base_type & c)
0086         : base_(c) {}
0087
0088     using unique_map_view_access_::at;
0089     using unique_map_view_access_::operator[];
0090
0091     unordered_map_view & operator=(const unordered_map_view & v)
0092     {
0093         this->base() = v.base();
0094         return *this;
0095     }
0096
0097     // It can be used enable_if here but the error message when there
0098     // is no info is very clear like this
0099
0100     template< class CompatibleKey >
0101     const info_type & info_at(const CompatibleKey& k) const
0102     {
0103         BOOST_DEDUCED_TYPENAME base_::const_iterator iter = this->find(k);
0104         if( iter == this->end() )
0105         {
0106             ::boost::throw_exception(
0107                 std::out_of_range("bimap<>: invalid key")
0108             );
0109         }
0110         return iter->info;
0111     }
0112
0113     template< class CompatibleKey >
0114     info_type & info_at(const CompatibleKey& k)
0115     {
0116         BOOST_DEDUCED_TYPENAME base_::iterator iter = this->find(k);
0117         if( iter == this->end() )
0118         {
0119             ::boost::throw_exception(
0120                 std::out_of_range("bimap<>: invalid key")
0121             );
0122         }
0123         return iter->info;
0124     }
0125 };
0126
0127
0128 } // namespace views
0129
0130 /*===========================================================================*/
0131 #define BOOST_BIMAP_MAP_VIEW_EXTRA_TYPEDEF(MAP_VIEW,SIDE,TYPENAME)            \
0132 typedef BOOST_DEDUCED_TYPENAME MAP_VIEW::TYPENAME                             \
0133     BOOST_PP_CAT(SIDE,BOOST_PP_CAT(_,TYPENAME));
0134 /*===========================================================================*/
0135
0136 /*===========================================================================*/
0137 #define BOOST_BIMAP_MAP_VIEW_EXTRA_TYPEDEFS_BODY(MAP_VIEW,SIDE)               \
0138     BOOST_BIMAP_MAP_VIEW_EXTRA_TYPEDEF(MAP_VIEW,SIDE,local_iterator)          \
0139     BOOST_BIMAP_MAP_VIEW_EXTRA_TYPEDEF(MAP_VIEW,SIDE,const_local_iterator)    \
0140     BOOST_BIMAP_MAP_VIEW_EXTRA_TYPEDEF(MAP_VIEW,SIDE,range_type)              \
0141     BOOST_BIMAP_MAP_VIEW_EXTRA_TYPEDEF(MAP_VIEW,SIDE,const_range_type)        \
0142     BOOST_BIMAP_MAP_VIEW_EXTRA_TYPEDEF(MAP_VIEW,SIDE,hasher)                  \
0143     BOOST_BIMAP_MAP_VIEW_EXTRA_TYPEDEF(MAP_VIEW,SIDE,key_equal)
0144 /*===========================================================================*/
0145
0146 namespace detail {
0147
0148 template< class Tag, class BimapType >
0149 struct left_map_view_extra_typedefs< ::boost::bimaps::views::unordered_map_view<Tag,BimapType> >
0150 {
0151     private: typedef ::boost::bimaps::views::unordered_map_view<Tag,BimapType> map_view_;
0152     public : BOOST_BIMAP_MAP_VIEW_EXTRA_TYPEDEFS_BODY(map_view_,left)
0153 };
0154
0155 template< class Tag, class BimapType >
0156 struct right_map_view_extra_typedefs< ::boost::bimaps::views::unordered_map_view<Tag,BimapType> >
0157 {
0158     private: typedef ::boost::bimaps::views::unordered_map_view<Tag,BimapType> map_view_;
0159     public : BOOST_BIMAP_MAP_VIEW_EXTRA_TYPEDEFS_BODY(map_view_,right)
0160 };
0161
0162 } // namespace detail
0163
0164 /*===========================================================================*/
0165 #undef BOOST_BIMAP_MAP_VIEW_EXTRA_TYPEDEF
0166 #undef BOOST_BIMAP_MAP_VIEW_EXTRA_TYPEDEFS_BODY
0167 /*===========================================================================*/
0168
0169 } // namespace bimaps
0170 } // namespace boost
0171
0172 #endif // BOOST_BIMAP_VIEWS_UNOREDERED_MAP_VIEW_HPP
0173
0174