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

 

C++

Поддержка компилятором

Автономные и размещённые реализации

Язык

Стандартная библиотека

Заголовки стандартной библиотеки

Требования к именованию

Макросы тестирования функциональности (C++20)

Поддержка языка

Библиотека концептов (C++20)

Библиотека метапрограммирования (C++11)

Библиотека диагностики

Библиотека общих утилит

Библиотека строк

Библиотека контейнеров

Библиотека итераторов

Библиотека диапазонов (C++20)

Библиотека алгоритмов

Библиотека численных данных

Библиотека ввода/вывода

Библиотека локализаций

Регулярные выражения (C++11)

Атомарные операции (C++11)

Библиотека поддержки конкуренции (C++11)

Библиотека файловой системы (C++17)

Технические спецификации

Указатель символов

Внешние библиотеки

 

Библиотека утилит

Языковая поддержка Поддержка типов (базовые типы, RTTI) Макросы тестирования функциональности библиотеки (C++20)     Управление динамической памятью Программные утилиты Поддержка сопрограмм (C++20) Вариативные функции is_constant_evaluated (C++20) is_within_lifetime (C++26) 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)

Общие утилиты Дата и время Функциональные объекты Библиотека форматирования (C++20) bitset hash (C++11) Операторы отношения (устарело в 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 ranges::swap (C++20) exchange (C++14) declval (C++11) to_underlying (C++23) forward (C++11) forward_like (C++23) move (C++11) move_if_noexcept (C++11) as_const (C++17) Общие лексические типы 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) expected (C++23) Элементарные преобразования строк to_chars (C++17) from_chars (C++17) chars_format (C++17) to_chars_result (C++17) from_chars_result (C++17)

 

std::hash

hash::hash

hash::operator()

 

Специализации std::hash должны определять operator(), который:

• Принимает один аргумент key типа Key.
• Возвращает значение типа std::size_t, представляющее хеш-значение key.
• Для двух одинаковых параметров 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 <cstdint>
#include <functional>
#include <iostream>
#include <string>

struct Employee
{
    std::string name;
    std::uint64_t ID;
};

namespace std {
template <>
class hash<Employee>
{
public:
    std::uint64_t operator()(const Employee& employee) const
    {
        // вычисляет хэш сотрудника, используя вариант
        // хеш-функции Фаулера-Нолла-Во
        constexpr std::uint64_t prime { 0x100000001B3 };
        std::uint64_t result { 0xcbf29ce484222325 };

        for (std::uint64_t i{}, ie = employee.name.size(); i != ie; ++i)
            result = (result * prime) ^ 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';
}

Вывод:

12615575401975788567