命名空间
变体
操作

std::hash

来自 cppreference.cn
< cpp‎ | 工具
 
C++
 
工具库
通用工具
函数对象
位操作 (C++20)
hash
(C++11)
关系运算符 (C++20 中弃用)
 
std::hash
 
定义于头文件 <bitset>
定义于头文件 <coroutine>
定义于头文件 <chrono>
(C++26 起)
定义于头文件 <filesystem>
定义于头文件 <functional>
定义于头文件 <memory>
定义于头文件 <optional>
定义于头文件 <stacktrace>
定义于头文件 <string>
定义于头文件 <string_view>
定义于头文件 <system_error>
定义于头文件 <text_encoding>
定义于头文件 <thread>
定义于头文件 <typeindex>
定义于头文件 <variant>
在头文件 <vector> 中定义
template< class Key >
struct hash;
 (C++11 起)

无序关联容器 std::unordered_set、std::unordered_multiset、std::unordered_map、std::unordered_multimap 使用模板 std::hash 的特化作为默认哈希函数。

给定类型 Key，std::hash<Key> 的每个特化要么是启用的，要么是禁用的。

  • 如果程序或用户未提供 std::hash<Key>，则它被禁用。
  • 否则，如果满足以下所有条件，则 std::hash<Key> 被启用：
  • 满足以下所有要求：
  • 给定以下值：
  • h，类型为 std::hash<Key> 的对象。
  • k1 和 k2，类型为 Key 的对象。
满足以下所有要求：
  • 如果 k1 == k2 为 true，则 h(k1) == h(k2) 也为 true。
  • 除非 std::hash<Key> 是程序定义的特化，否则 h(k1) 永远不会抛出异常。
  • 否则，std::hash<Key> 被禁用。

禁用的特化不满足 Hash，不满足 FunctionObject，并且以下所有值为 false：

换句话说，它们存在，但无法使用。

目录

嵌套类型

名称 定义
argument_type (C++17 中已弃用) Key
result_type (C++17 中已弃用) std::size_t
(C++20 前)

[编辑] 成员函数

 构造哈希函数对象
(公开成员函数)
计算参数的哈希值
(公开成员函数)

[编辑] 标准库特化

每个声明模板 std::hash 的头文件也为以下类型提供 std::hash 的启用特化：

此外，一些头文件还为库类型提供其他启用的 std::hash 特化（参见下方）。

对于标准库提供的所有 std::hash 特化（除了以下特化），它们的所有成员函数都是 noexcept：

(C++26 起)
 (C++17 起)

[编辑] 库类型的特化

(C++20)
 std::coroutine_handle 的哈希支持
(类模板特化) [编辑]
(C++11)
 std::error_code 的哈希支持
(类模板特化) [编辑]
(C++17)
 std::error_condition 的哈希支持
(类模板特化) [编辑]
(C++23)
 std::stacktrace_entry 的哈希支持
(类模板特化) [编辑]
(C++23)
 std::basic_stacktrace 的哈希支持
(类模板特化) [编辑]
(C++17)
 std::optional 的哈希支持
(类模板特化) [编辑]
(C++17)
 std::variant 的哈希支持
(类模板特化) [编辑]
(C++17)
 std::monostate 的哈希支持
(类模板特化)
(C++11)
 std::bitset 的哈希支持
(类模板特化) [编辑]
(C++11)
 std::unique_ptr 的哈希支持
(类模板特化) [编辑]
(C++11)
 std::shared_ptr 的哈希支持
(类模板特化) [编辑]
(C++11)
 对 std::type_index 的哈希支持
(类模板特化) [编辑]
(C++11)
 字符串的哈希支持
(类模板特化) [编辑]
(C++17)(C++17)(C++20)(C++17)(C++17)
 字符串视图的哈希支持
(类模板特化) [编辑]
(C++26)
 std::text_encoding 的哈希支持
(类模板特化) [编辑]
(C++11)
 std::vector<bool> 的哈希支持
(类模板特化)
(C++17)
 对 std::filesystem::path 的哈希支持
(类模板特化) [编辑]
(C++11)
 std::thread::id 的哈希支持
(类模板特化) [编辑]
(C++26)
 std::chrono::duration 的哈希支持
(类模板特化)
(C++26)
 std::chrono::time_point 的哈希支持
(类模板特化)
(C++26)
 std::chrono::day 的哈希支持
(类模板特化)
(C++26)
 std::chrono::month 的哈希支持
(类模板特化)
(C++26)
 std::chrono::year 的哈希支持
(类模板特化)
(C++26)
 std::chrono::weekday 的哈希支持
(类模板特化)
(C++26)
 std::chrono::weekday_indexed 的哈希支持
(类模板特化)
(C++26)
 std::chrono::weekday_last 的哈希支持
(类模板特化)
(C++26)
 std::chrono::month_day 的哈希支持
(类模板特化)
(C++26)
 std::chrono::month_day_last 的哈希支持
(类模板特化)
(C++26)
 std::chrono::month_weekday 的哈希支持
(类模板特化)
(C++26)
 std::chrono::month_weekday_last 的哈希支持
(类模板特化)
(C++26)
 std::chrono::year_month 的哈希支持
(类模板特化)
(C++26)
 std::chrono::year_month_day 的哈希支持
(类模板特化)
(C++26)
 std::chrono::year_month_day_last 的哈希支持
(类模板特化)
(C++26)
 std::chrono::year_month_weekday 的哈希支持
(类模板特化)
(C++26)
 std::chrono::year_month_weekday_last 的哈希支持
(类模板特化)
(C++26)
 std::chrono::zoned_time 的哈希支持
(类模板特化)
(C++26)
 std::chrono::leap_second 的哈希支持
(类模板特化)

[编辑] 注意

实际的哈希函数是依赖于实现的，并且除了上面指定的之外，不要求满足任何其他质量标准。值得注意的是，一些实现使用平凡的（同一性）哈希函数，将整数映射到自身。换句话说，这些哈希函数旨在与无序关联容器一起使用，但不适用于加密哈希等用途。

哈希函数仅要求在程序的单次执行中对相同输入产生相同的结果；这允许使用加盐哈希来防止碰撞拒绝服务攻击。

没有为 C 字符串提供特化。 std::hash<const char*> 产生指针值（内存地址）的哈希，它不检查任何字符数组的内容。

对于 std::pair 和标准容器类型的附加特化，以及用于组合哈希的实用函数，可在 boost::hash 中找到。

[编辑] 示例

运行此代码
#include <cstddef>
#include <functional>
#include <iomanip>
#include <iostream>
#include <string>
#include <unordered_set>
 
struct S
{
    std::string first_name;
    std::string last_name;
    bool operator==(const S&) const = default; // since C++20
};
 
// Before C++20.
// bool operator==(const S& lhs, const S& rhs)
// {
//     return lhs.first_name == rhs.first_name && lhs.last_name == rhs.last_name;
// }
 
// Custom hash can be a standalone function object.
struct MyHash
{
    std::size_t operator()(const S& s) const noexcept
    {
        std::size_t h1 = std::hash<std::string>{}(s.first_name);
        std::size_t h2 = std::hash<std::string>{}(s.last_name);
        return h1 ^ (h2 << 1); // or use boost::hash_combine
    }
};
 
// Custom specialization of std::hash can be injected in namespace std.
template<>
struct std::hash<S>
{
    std::size_t operator()(const S& s) const noexcept
    {
        std::size_t h1 = std::hash<std::string>{}(s.first_name);
        std::size_t h2 = std::hash<std::string>{}(s.last_name);
        return h1 ^ (h2 << 1); // or use boost::hash_combine
    }
};
 
int main()
{
    std::string str = "Meet the new boss...";
    std::size_t str_hash = std::hash<std::string>{}(str);
    std::cout << "hash(" << std::quoted(str) << ") =\t" << str_hash << '\n';
 
    S obj = {"Hubert", "Farnsworth"};
    // Using the standalone function object.
    std::cout << "hash(" << std::quoted(obj.first_name) << ", "
              << std::quoted(obj.last_name) << ") =\t"
              << MyHash{}(obj) << " (using MyHash) or\n\t\t\t\t"
              << std::hash<S>{}(obj) << " (using injected specialization)\n";
 
    // Custom hash makes it possible to use custom types in unordered containers.
    // The example will use the injected std::hash<S> specialization above,
    // to use MyHash instead, pass it as a second template argument.
    std::unordered_set<S> names = {obj, {"Bender", "Rodriguez"}, {"Turanga", "Leela"}};
    for (auto const& s: names)
        std::cout << std::quoted(s.first_name) << ' '
                  << std::quoted(s.last_name) << '\n';
}

可能的输出

hash("Meet the new boss...") =  10656026664466977650
hash("Hubert", "Farnsworth") =  12922914235676820612 (using MyHash) or
                                12922914235676820612 (using injected specialization)
"Bender" "Rodriguez"
"Turanga" "Leela"
"Hubert" "Farnsworth"

[编辑] 缺陷报告

下列更改行为的缺陷报告追溯地应用于以前出版的 C++ 标准。

缺陷报告 应用于 发布时的行为 正确的行为
LWG 2119 C++11 缺少对扩展整数类型的特化 已提供
LWG 2148 C++11 缺少对枚举的特化 已提供
LWG 2543 C++11 std::hash 可能不是 SFINAE 友好的 变为 SFINAE 友好
LWG 2817 C++11 缺少对 std::nullptr_t 的特化 已提供
取自 "https://cppreference.cn/mwiki/index.php?title=cpp/utility/hash&oldid=179088"