std::hash<Key>::operator()

 

C++

语言

标准库头文件

自立与有宿主实现

具名要求

语言支持库

概念库 (C++20)

诊断库

工具库

字符串库

容器库

迭代器库

范围库 (C++20)

算法库

数值库

本地化库

输入/输出库

文件系统库 (C++17)

正则表达式库 (C++11)

原子操作库 (C++11)

线程支持库 (C++11)

技术规范

 

工具库

语言支持 类型支持（基本类型、 RTTI 、类型特征）     库功能特性测试宏 (C++20) 动态内存管理 程序工具 错误处理 协程支持 (C++20) 变参数函数 launder (C++17) initializer_list (C++11) source_location (C++20) 三路比较 (C++20) three_way_comparablethree_way_comparable_with (C++20)(C++20) strong_ordering (C++20) weak_ordering (C++20) partial_ordering (C++20) common_comparison_category (C++20) compare_three_way_result (C++20) compare_three_way (C++20) strong_order (C++20) weak_order (C++20) partial_order (C++20) compare_strong_order_fallback (C++20) compare_weak_order_fallback (C++20) compare_partial_order_fallback (C++20) is_eqis_neqis_ltis_lteqis_gtis_gteq (C++20)(C++20)(C++20)(C++20)(C++20)(C++20)

通用工具 日期和时间 函数对象 bitset 格式化库 (C++20) hash (C++11) integer_sequence (C++14) 关系运算符 (C++20 中弃用) rel_ops::operator!=rel_ops::operator> rel_ops::operator<=rel_ops::operator>= 整数比较函数 cmp_equalcmp_lesscmp_less_than (C++20)(C++20)(C++20) cmp_not_equalcmp_greatercmp_greater_than (C++20)(C++20)(C++20) in_range (C++20) swap 与类型运算 swap ranges::swap (C++20) exchange (C++14) declval (C++11) forward (C++11) move (C++11) move_if_noexcept (C++11) as_const (C++17) to_underlying (C++23) 常用词汇类型 pair tuple (C++11) optional (C++17) any (C++17) variant (C++17) tuple_size (C++11) tuple_element (C++11) apply (C++17) make_from_tuple (C++17) 初等字符串转换 to_chars (C++17) from_chars (C++17) chars_format (C++17) 栈踪 stacktrace_entry (C++23) basic_stacktrace (C++23)

 

std::hash

hash::hash

hash::operator()

 

std::hash 的特化应定义满足下列条件的 operator() ：

• 接收单个 key 类型的参数 Key 。
• 返回表示 key 哈希值的 std::size_t 类型值。
• 对于二个相等的参数 k1 与 k2 ， std::hash<Key>()(k1) == std::hash<Key>()(k2) 。
• 对于二个相异而不等的参数 k1 与 k2 ， std::hash<Key>()(k1) == std::hash<Key>()(k2) 的概率应该非常小，接近 1.0/std::numeric_limits<size_t>::max() 。

参数

key

-

要被哈希的对象

返回值

表示哈希值的 std::size_t

异常

哈希函数不应抛异常。

示例

下列代码演示如何为自定义类特化 std::hash 模板。

运行此代码

#include <functional>
#include <iostream>
#include <string>
 
struct Employee {
  std::string name;
  unsigned int ID;
};
 
namespace std {
template <>
class hash<Employee> {
 public:
  size_t operator()(const Employee &employee) const
  {
    // 用 Fowler-Noll-Vo hash 哈希函数的变体计算 employee 的哈希
    size_t result = 2166136261;
 
    for (size_t i = 0, ie = employee.name.size(); i != ie; ++i) {
      result = (result * 16777619) ^ employee.name[i];
    }
 
    return result ^ (employee.ID << 1);
  }
};
}
 
int main()
{
  Employee employee;
  employee.name = "Zaphod Beeblebrox";
  employee.ID = 42;
 
  std::hash<Employee> hash_fn;
  std::cout << hash_fn(employee) << '\n';
}

输出：

177237019