STL中的map和hash_map

在网上看到有关STL中hash_map的文章，以及一些其他关于STL map和hash_map的资料，总结笔记如下：

    1、STL的map底层是用红黑树实现的，查找时间复杂度是log(n)；

    2、STL的hash_map底层是用hash表存储的，查询时间复杂度是O(1)；

    3、什么时候用map，什么时候用hash_map？

    这个药看具体的应用，不一定常数级别的hash_map一定比log(n)级别的map要好，hash_map的hash函数以及解决地址冲突等都要耗时 间，而且众所周知hash表是以空间换时间的，因而hash_map的内存消耗肯定要大，一般情况下，如果记录非常大，考虑hash_map，查找效率会 高很多，如果要考虑内存消耗，则要谨慎使用hash_map。

  0. 为什么需要hash_map

    用过map吧，map提供一个很常用的功能，那就是提供key-value的存储和查询功能。例如，我要记录一个人名和相应的存储，而且随时增加，要快速查找和修改：

    岳不群-华山派掌门人，人称君子剑

    张三丰-武当掌门人，太极拳创始人

    东方不败-第一高手，葵花宝典

    .......

    这些信息如果保存下来并不复杂，但是找起来比较麻烦。例如我要找“张三丰”的信息，最笨的方法就是取得所有的记录，然后按照名字一个一个比较。如果要速度快，就需要把这些记录按照字母顺序排列，然后按照二分查找。但是增加记录的 时间同时需要保持记录有序，因此需要插入排序。考虑到效率，这就需要用二叉树。如果你使用STL中map容器，你可以非常方便实现这个功能，而不用关心其 他细节。看看map的实现。

2. map<string, string> namemap;
4. //增加。。。
5. namemap["岳不群"]="华山派掌门人，人称君子剑";
6. namemap["张三丰"]="武当掌门人，太极拳创始人";
7. namemap["东方不败"]="第一高手，葵花宝典";
8. ...
10. //查找。。
11. if(namemap.find("岳不群") != namemap.end())
12. {
13.         ...
14. }

    实现起来比较容易，而且效率很高，100万条记录，最多也只要20次的string.compare的比较，就能找到你要找的记录。

    速度永远满足不了现实的需求，如果100万条记录，需要频繁的进行搜索时，20次比较也会成为瓶颈，要是能降到一次或者两次比较是否有可能？而且当记录数到200万的时候也是一次或二次比较，是否有可能？而且还需要和map一样的方便使用。

    答案是肯定的，这时你需要has_map。虽然hash_map目前没有纳入C++标准模板库中，但几乎每个版本的STL都提供了相应的实现。而且应用十分广泛。在正式使用hash_map之前，先看看hash_map的原理。

1、数据结构：hash_map原理

    hash_map基于hash table（哈希表）。哈希表最大的优点是：把数据存储和查询消耗的时间大大降低，几乎可以看成是常数时间；而代价仅仅是消耗比较多的内存。然后在当前可利用内存越来越多的情况下，用空间换时间的做法是值得的。另外，编码比较容易也是它的特点之一。

    其基本原理是：使用一个下标范围比较大的数组来存储元素。可以设计一个函数（哈希函数，也叫散列函数），使得每个元素的关键字都与一个函数值（即数组下标，hash值）相对应，于是用这个数组单元来存储这个元素；也可以简单的理解为，按照关键字为每一个元素“分类”，然后将这个元素存储在相应“类”所对应的地方，称为桶。

    但是，这不能够保证每个元素的关键字与函数值是一一对应的，因此极有可能出现对不不同的元素，却计算出相同的函数值，这样就产生了“冲突”。换句话说，就是把不同的元素分在了相同的“类”中。总的来说，“直接定址”和“解决冲突”是哈希表的两大特点。

    hash_map，首先分配一大片内存，形成许多桶。是利用hash函数，对key进行映射到不同区域进行保存。其插入过程：

    1、得到key；

    2、通过hash函数得到hash值；

    3、得到桶号（一般都为hash值对桶数求模）；

    4、存放key和value在桶内；

    其取值过程是：

    1、得到key；

    2、通过hash函数得到hash值；    

    3、得到桶号；

    4、比较桶的内部元素是否与key相等，若不相等，则没有找到；

    5、取出相等的记录的value；

    hash_map中直接地址用hash函数生成，解决冲突，用比较函数解决。这里可以看出，如果每个桶内部只有一个元素，那么查找的时候只有一次比较。当许多桶没有值时，许多查询就会更快了（指查不到的时候）。

    由此可见，要实现哈希表，和用户相关的是：hash函数和比较函数。这两个参数刚好是我们在使用hash_map时需要指定的参数。

2、hash_map的使用

2.1 一个简单的例子

    不要急着如何把“岳不群”用hash_map表示，先看一个简单的例子：随你给你一个ID号和ID号相应的信息，ID号的范围是1~2³¹。如何快速查找保存。

2. #include <iostream>
3. #include <string>
4. #include <hash_map>
6. using namespace std;
8. int main()
9. {
10.     hash_map<int, string> mp;
11.     mp[9527] = "唐伯虎点秋香";
12.     mp[10000] = "百万富翁的生活";
13.     mp[88888] = "白领的工资底线";
15.     if(mp.find(10000) != mp.end())
16.     {
17.         //....
18.     }
19. }

    这也是比较简单的，和map的使用方法一样。这时你或许会问？hash函数和比较函数呢？不是要指定么？你说对了，但是在你没有指定hash函数和比较函数的时候，你会有一个缺省的函数，看看hash_map的声明，你会更加明白。下面是SGI STL的声明。

2. template <class _Key, class _Tp, class _HashFcn = hash<_Key>,
3. class _EqualKey = equal_to<_Key>,
4. class _Alloc = __STL_DEFAULT_ALLOCATOR(_Tp) >
5. class hash_map
6. {
7.         ...
8. }

    也就是说，在上例中，有以下等同关系。

2. ...
3. hash_map<int, string> mymap;
4. //等同于:
5. hash_map<int, string, hash<int>, equal_to<int> > mymap;

    Alloc这里不需要关注太多的。

2.2 hash_map的hash函数

    hash<int>到底是什么样子？看看源代码：

2. struct hash<int> {
3.         size_t operator()(int __x) const { return __x; }
4. };

    原来是个函数对象。咋SGI STL中，提供了以下hash函数：

2. struct hash<char*>
3. struct hash<const char*>
4. struct hash<char>
5. struct hash<unsigned char>
6. struct hash<signed char>
7. struct hash<short>
8. struct hash<unsigned short>
9. struct hash<int>
10. struct hash<unsigned int>
11. struct hash<long>
12. struct hash<unsigned long>

    也就是说，如果你的可以key是以上类型中的一种，你都可以使用缺省的hash函数。当然你自己也可以定义自己的hash函数。对于自定义变量，例如对于string，就必须自定义hash函数。例如：

2. struct str_hash{
3.         size_t operator()(const string& str) const
4.         {
5.                 unsigned long __h = 0;
6.                 for (size_t i = 0 ; i < str.size() ; i ++)
7.                 __h = 5*__h + str[i];
8.                 return size_t(__h);
9.         }
10. };
11. //如果你希望利用系统定义的字符串hash函数，你可以这样写：
12. struct str_hash{
13.         size_t operator()(const string& str) const
14.         {
15.                 return return __stl_hash_string(str.c_str());
16.         }
17. };

    在声明自己的hash函数时要注意以下几点：

    1、使用struct，然后重载operator();

    2、返回size_t；

    3、参数是你要hash的key的类型；

    4、函数是const类型的；

    如这些比较难记，最简单的方法就是照猫画虎，找一个函数改改就是了。

    现在开始对开头的“岳不群”进行哈希化，直接替换成下面的声明即可。

2. map<string, string> namemap;
3. //改为：
4. hash_map<string, string, str_hash> namemap;

    其他用法都不用管。当然不要忘记了str_hash的声明以及头文件改为hash_map。

    你或许会问：比较函数呢？别急，这里就开始介绍hash_map中的比较函数。

2.3 hash_map的比较函数

    在map中的比较函数，需要提供less函数。如果没有提供，缺省的也是less<key>。在hash_map中，要比较桶内的数据和key是否相等，因此需要的是是否等于的函数equal_to<key>。先看看equal_to的源码：

2. //本代码可以从SGI STL
3. //先看看binary_function 函数声明，其实只是定义一些类型而已。
4. template <class _Arg1, class _Arg2, class _Result>
5. struct binary_function {
6.         typedef _Arg1 first_argument_type;
7.         typedef _Arg2 second_argument_type;
8.         typedef _Result result_type;
9. };
10. //看看equal_to的定义：
11. template <class _Tp>
12. struct equal_to : public binary_function<_Tp,_Tp,bool>
13. {
14.         bool operator()(const _Tp& __x, const _Tp& __y) const { return __x == __y; }
15. };

    如果你使用一个自定义的数据类型，如struct mystruct或者const char*的字符串，如何使用比较函数？使用比较函数，有两种方法。第一种是：重载==操作符，利用equal_to；看看下面的例子：

2. struct mystruct{
3.         int iID;
4.         int len;
5.         bool operator==(const mystruct & my) const{
6.                 return (iID==my.iID) && (len==my.len) ;
7.         }
8. };

    这样，就可以使用equal_to<mystruct>作为比较函数了。另一种方法就是使用函数对象。自定义一个比较函数体：

2. struct compare_str{
3.         bool operator()(const char* p1, const char*p2) const{
4.                 return strcmp(p1,p2)==0;
5.         }
6. };

    有了compare_str，就可以使用hash_map了。

2. typedef hash_map<const char*, string, hash<const char*>, compare_str> StrIntMap;
3. StrIntMap namemap;
4. namemap["岳不群"]="华山派掌门人，人称君子剑";
5. namemap["张三丰"]="武当掌门人，太极拳创始人";
6. namemap["东方不败"]="第一高手，葵花宝典";

2.4 hash_map函数

    hash_map的函数和map的函数差不多。这里主要介绍几个常用函数。

    1、hash_map(size_type n) 如果讲究效率，这个参数是必须要设置的。n 主要用来设置hash_map 容器中hash桶的个数。桶个数越多，hash函数发生冲突的概率就越小，重新申请内存的概率就越小。n越大，效率越高，但是内存消耗也越大。

    2、const_iterator find(const key_type& k) const. 用查找，输入为键值，返回为迭代器。

    3、data_type& operator[](const key_type& k) . 这是我最常用的一个函数。因为其特别方便，可像使用数组一样使用。不过需要注意的是，当你使用[key ]操作符时，如果容器中没有key元素，这就相当于自动增加了一个key元素。因此当你只是想知道容器中是否有key元素时，你可以使用find。如果你 希望插入该元素时，你可以直接使用[]操作符。

    4、insert 函数。在容器中不包含key值时，insert函数和[]操作符的功能差不多。但是当容器中元素越来越多，每个桶中的元素会增加，为了保证效率， hash_map会自动申请更大的内存，以生成更多的桶。因此在insert以后，以前的iterator有可能是不可用的。

    5、erase 函数。在insert的过程中，当每个桶的元素太多时，hash_map可能会自动扩充容器的内存。但在sgi stl中是erase并不自动回收内存。因此你调用erase后，其他元素的iterator还是可用的。

3、相关hash容器

    hash容器除了hash_map外，还有hash_set、hash_multimap、hash_multiset，这些容器使用起来和set、multimap、multiset的区别于hash_map和map的区别一样。

4、其他

    这里列几个问题，应该对你理解和使用hash_map比较有帮助。

4.1 hash_map和map的区别在哪里？

    （1）构造函数  hash_map需要hash函数，等于函数；map只需要比较函数（小于函数）。

    （2）存储结构  hash_map采用hash表存储，map一般采用红黑树实现。因此内存数据结构是不一样的。

4.2 什么时候需要使用hash_map，什么时候需要map？

    总体来说，hash_map 查找速度会比map快，而且查找速度基本和数据数据量大小，属于常数级别;而map的查找速度是log(n)级别。并不一定常数就比log(n)小， hash还有hash函数的耗时，明白了吧，如果你考虑效率，特别是在元素达到一定数量级时，考虑考虑hash_map。但若你对内存使用特别严格，希望 程序尽可能少消耗内存，那么一定要小心，hash_map可能会让你陷入尴尬，特别是当你的hash_map对象特别多时，你就更无法控制了，而且 hash_map的构造速度较慢。

    现在知道如何选择了吗？权衡三个因素: 查找速度, 数据量, 内存使用。

4.3 如何在hash_map中加入自己定义的类型？

    你只需要做两件事情：定于hash函数、定义等于比较函数。下面的代码是一个例子：

2. #include <hash_map>
3. #include <string>
4. #include <iostream>
6. using namespace std;
7. //define the class
8. class ClassA{
9.         public:
10.         ClassA(int a):c_a(a){}
11.         int getvalue()const { return c_a;}
12.         void setvalue(int a){c_a;}
13.         private:
14.         int c_a;
15. };
17. //1 define the hash function
18. struct hash_A{
19.         size_t operator()(const class ClassA & A)const{
20.                 // return hash<int>(classA.getvalue());
21.                 return A.getvalue();
22.         }
23. };
25. //2 define the equal function
26. struct equal_A{
27.         bool operator()(const class ClassA & a1, const class ClassA & a2)const{
28.                 return a1.getvalue() == a2.getvalue();
29.         }
30. };
32. int main()
33. {
34.         hash_map<ClassA, string, hash_A, equal_A> hmap;
35.         ClassA a1(12);
36.         hmap[a1]="I am 12";
37.         ClassA a2(198877);
38.         hmap[a2]="I am 198877";
39.         
40.         cout<<hmap[a1]<<endl;
41.         cout<<hmap[a2]<<endl;
42.         return 0;
43. }

4.4 如何用hash_map替换程序中已有的map容器？

    这个很容易，但需要你有良好的编程风格。建议你尽量使用typedef来定义你的类型：

    typedef map<Key, Value> KeyMap;

    当你希望使用hash_map来替换的时候，只需要修改:

    typedef hash_map<Key, Value> KeyMap;

    其他的基本不变。当然，你需要注意是否有Key类型的hash函数和比较函数。

4.5 为什么hash_map不是标准的？

    具体为什么不 是标准的，我也不清楚，有个解释说在STL加入标准C++之时，hash_map系列当时还没有完全实现，以后应该会成为标准。如果谁知道更合理的解释， 也希望告诉我。但我想表达的是，正是因为hash_map不是标准的，所以许多平台上安装了g++编译器，不一定有hash_map的实现。我就遇到了这 样的例子。因此在使用这些非标准库的时候，一定要事先测试。另外，如果考虑到平台移植，还是少用为佳。