std::hash

 

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)

汎用ユーティリティ 日付と時間 関数オブジェクト 書式化ライブラリ(C++20) bitset hash (C++11) integer_sequence (C++14) 関係演算子 (C++20で非推奨) rel_ops::operator!=rel_ops::operator>rel_ops::operator<=rel_ops::operator>= 整数比較関数 cmp_equalcmp_not_equalcmp_lesscmp_greatercmp_less_thancmp_greater_than (C++20)(C++20)(C++20)(C++20)(C++20)(C++20) in_range (C++20) スワップと型操作 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) 一般的な語彙の型 pair tuple (C++11) apply (C++17) make_from_tuple (C++17) optional (C++17) any (C++17) variant (C++17) 初等文字列変換 to_chars (C++17) from_chars (C++17) chars_format (C++17)

 

std::hash

hash::hash

hash::operator()

 

ヘッダ <functional> で定義
template<class Key > struct hash;		(C++11以上)

このテンプレートの各々の特殊化は有効 (「汚染されていない」) または無効 (「汚染されている」) のいずれかです。 有効な std::hash<Key> の特殊化がライブラリによってもユーザによっても提供されていないすべての Key 型について、その特殊化は存在しており、無効化されています。 無効な特殊化は Hash を満たさず、 std::is_default_constructible_v、 std::is_copy_constructible_v、 std::is_move_constructible_v、 std::is_copy_assignable_v、 std::is_move_assignable_v はすべて false です。 別の言い方をすると、存在はしていますが、使うことはできません。

(C++17以上)

hash テンプレートの有効な特殊化(C++17以上)はハッシュ関数を実装する関数オブジェクトを定義します。 この関数オブジェクトのインスタンスは Hash を満たします。 特に、この型は以下のような operator()const を定義します。

1. Key 型の引数を1つ取ります。

2. 引数のハッシュ値を表す std::size_t 型の値を返します。

3. 呼ばれた時に例外を投げることはありません。

4. 2つの等しい値 k1 および k2 に対して、 std::hash<Key>()(k1)== std::hash<Key>()(k2) です。

5. 2つの等しくない異なる値 k1 および k2 に対して、 std::hash<Key>()(k1)== std::hash<Key>()(k2) である確率が非常に小さい、具体的には 1.0/std::numeric_limits<std::size_t>::max() に近いことが期待されます。

標準ライブラリによって提供される hash の明示的および部分的なすべての特殊化は DefaultConstructible、 CopyAssignable、 Swappable、 Destructible を満たします。 ユーザが提供する hash の特殊化もこれらの要件を満たさなければなりません。

非順序連想コンテナ std::unordered_set、 std::unordered_multiset、 std::unordered_map、 std::unordered_multimap はデフォルトのハッシュ関数として std::hash テンプレートの特殊化を使用します。

ノート

実際のハッシュ関数は処理系依存であり、上で規定されている以外のいかなる品質基準も満たすことは要求されません。 例えば、整数をそれ自身に対応付ける自明な (恒等な) ハッシュ関数を使っている処理系もあります。 別の言い方をすると、これらのハッシュ関数は非順序連想コンテナで使えるようには設計されていますが、例えば、暗号学的なハッシュとしては使用できません。

ハッシュ関数は、単一のプログラム実行中でしか、同じ入力に対して同じ結果を返すことが要求されません。 これにより、衝突サービス拒否攻撃を防ぐソルト付きのハッシュを使うことができます。

(C++14以上)

C の文字列に対する特殊化はありません。 std::hash<constchar*> はポインタの値 (メモリアドレス) のハッシュを返し、文字配列の内容は考慮しません。

メンバ型 メンバ型 定義 argument_type(C++17で非推奨) Key result_type(C++17で非推奨) std::size_t

(C++20未満)

メンバ関数

コンストラクタ	ハッシュ関数オブジェクトを構築します (パブリックメンバ関数)
operator()	引数のハッシュを計算します (パブリックメンバ関数)

基本型に対する標準の特殊化

ヘッダ <functional> で定義
template<>struct hash<bool>; template<>struct hash<char>; template<>struct hash<signedchar>; template<>struct hash<unsignedchar>; template<>struct hash<char8_t>; template<>struct hash<char16_t>; template<>struct hash<char32_t>; template<>struct hash<wchar_t>; template<>struct hash<short>; template<>struct hash<unsignedshort>; template<>struct hash<int>; template<>struct hash<unsignedint>; template<>struct hash<long>; template<>struct hash<longlong>; template<>struct hash<unsignedlong>; template<>struct hash<unsignedlonglong>; template<>struct hash<float>; template<>struct hash<double>; template<>struct hash<longdouble>; template<class T >struct hash<T*>;

上記に加え、すべての (スコープ付きおよびスコープなしの) 列挙型に対する特殊化も標準ライブラリによって提供されます。 これらは std::hash<std::underlying_type<Enum>::type> として実装されるかもしれません (が、要求されているわけではありません)。	(C++14以上)
テンプレート std::hash を宣言する標準ライブラリの各々のヘッダは std::nullptr_t、すべての cv 修飾された算術型 (あらゆる拡張整数型を含む)、すべての列挙型およびすべてのポインタ型に対する std::hash の有効な特殊化を提供します。 このテンプレートの標準ライブラリによるすべての特殊化のすべてのメンバ関数は noexcept です。 ただし std::hash<std::optional>、 std::hash<std::variant>、 std::hash<std::unique_ptr> は除きます。	(C++17以上)

ライブラリ型に対する標準の特殊化

std::hash<std::string>std::hash<std::u8string>std::hash<std::u16string>std::hash<std::u32string>std::hash<std::wstring>std::hash<std::pmr::string>std::hash<std::pmr::u8string>std::hash<std::pmr::u16string>std::hash<std::pmr::u32string>std::hash<std::pmr::wstring> (C++11)(C++20)(C++11)(C++11)(C++11)(C++20)(C++20)(C++20)(C++20)(C++20)	文字列に対するハッシュサポート (クラステンプレートの特殊化)
std::hash<std::error_code> (C++11)	std::error_code に対するハッシュサポート (クラステンプレートの特殊化)
std::hash<std::bitset> (C++11)	std::bitset に対するハッシュサポート (クラステンプレートの特殊化)
std::hash<std::unique_ptr> (C++11)	std::unique_ptr に対するハッシュサポート (クラステンプレートの特殊化)
std::hash<std::shared_ptr> (C++11)	std::shared_ptr に対するハッシュサポート (クラステンプレートの特殊化)
std::hash<std::type_index> (C++11)	std::type_index に対するハッシュサポート (クラステンプレートの特殊化)
std::hash<std::vector<bool>> (C++11)	std::vector<bool> に対するハッシュサポート (クラステンプレートの特殊化)
std::hash<std::thread::id> (C++11)	std::thread::id に対するハッシュサポート (クラステンプレートの特殊化)
std::hash<std::optional> (C++17)	std::hash アルゴリズムの特殊化 (クラステンプレートの特殊化)
std::hash<std::variant> (C++17)	std::hash アルゴリズムの特殊化 (クラステンプレートの特殊化)
std::hash<std::string_view>std::hash<std::wstring_view>std::hash<std::u8string_view>std::hash<std::u16string_view>std::hash<std::u32string_view> (C++17)(C++17)(C++20)(C++17)(C++17)	文字列ビューに対するハッシュサポート (クラステンプレートの特殊化)
std::hash<std::error_condition> (C++17)	std::error_condition に対するハッシュサポート (クラステンプレートの特殊化)

ノート: std::pair および標準のコンテナ型に対する追加の特殊化やハッシュを合成するユーティリティ関数が boost.hash で利用可能です。

例

Run this code

#include <iostream>#include <iomanip>#include <functional>#include <string>#include <unordered_set>   struct S {std::string first_name;std::string last_name;};bool operator==(const S& lhs, const S& rhs){return lhs.first_name== rhs.first_name&& lhs.last_name== rhs.last_name;}   // カスタムハッシュ関数は独立した関数オブジェクトにできます。struct MyHash {std::size_t operator()(S const& s)constnoexcept{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);// または boost::hash_combine を使用します。}};   // std::hash のカスタム特殊化は std 名前空間に注入できます。namespace std {template<>struct hash<S>{std::size_t operator()(S const& s)constnoexcept{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);// または 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)<<") = "<< str_hash <<'\n';   S obj ={"Hubert", "Farnsworth"};// スタンドアロンの関数オブジェクトを使用。std::cout<<"hash("<<std::quoted(obj.first_name)<<','<<std::quoted(obj.last_name)<<") = "<< MyHash{}(obj)<<" (using MyHash)\n or "<< std::hash<S>{}(obj)<<" (using injected std::hash<S> specialization)\n";   // カスタムハッシュにより非順序コンテナでカスタム型が使用できるようになります。// この例では上の注入された std::hash<S> の特殊化を使用します。// 代わりに MyHash を使う場合は、それを第2テンプレート引数として渡してください。std::unordered_set<S> names ={obj, {"Bender", "Rodriguez"}, {"Turanga", "Leela"}};for(auto& s: names)std::cout<<std::quoted(s.first_name)<<' '<<std::quoted(s.last_name)<<'\n';}

出力例:

hash("Meet the new boss...") = 1861821886482076440 hash("Hubert","Farnsworth") = 17622465712001802105 (using MyHash) or 17622465712001802105 (using injected std::hash<S> specialization) "Turanga" "Leela" "Bender" "Rodriguez" "Hubert" "Farnsworth"