名前空間
変種
操作

std::unordered_map の推論ガイド

From cppreference.com

[テンプレートを編集]
 
C++
コンパイラサポート
フリースタンディングとホスト
言語
標準ライブラリ
標準ライブラリヘッダー
名前付き要件
機能テストマクロ (C++20)
言語サポートライブラリ
コンセプトライブラリ (C++20)
診断ライブラリ
メモリ管理ライブラリ
メタプログラミングライブラリ (C++11)
汎用ユーティリティライブラリ
コンテナライブラリ
イテレータライブラリ
Rangesライブラリ (C++20)
アルゴリズムライブラリ
文字列ライブラリ
テキスト処理ライブラリ
数値ライブラリ
日付と時刻ライブラリ
入出力ライブラリ
ファイルシステムライブラリ (C++17)
並行サポートライブラリ (C++11)
実行制御ライブラリ (C++26)
Technical specifications (技術仕様)
シンボルインデックス
外部ライブラリ
 
コンテナライブラリ
 
std::unordered_map
メンバ型
メンバ関数
非メンバ関数
(C++20まで)
推論補助(C++17)
 
ヘッダ <unordered_map> で定義
template< class InputIt,

          class Hash = std::hash<iter_key_t<InputIt>>,
          class Pred = std::equal_to<iter_key_t<InputIt>>,
          class Alloc = std::allocator<iter_to_alloc_t<InputIt>> >
unordered_map( InputIt, InputIt,
               typename /*下記参照*/::size_type = /*下記参照*/,
               Hash = Hash(), Pred = Pred(), Alloc = Alloc() )
    -> unordered_map<iter_key_t<InputIt>, iter_val_t<InputIt>,

                     Hash, Pred, Alloc>;
 (1) (C++17以降)
template< class Key, class T, class Hash = std::hash<Key>,

          class Pred = std::equal_to<Key>,
          class Alloc = std::allocator<std::pair<const Key, T>> >
unordered_map( std::initializer_list<std::pair<Key, T>>,
               typename /*下記参照*/::size_type = /*下記参照*/,
               Hash = Hash(), Pred = Pred(), Alloc = Alloc() )

    -> unordered_map<Key, T, Hash, Pred, Alloc>;
 (2) (C++17以降)
template< class InputIt, class Alloc >

unordered_map( InputIt, InputIt, typename /*下記参照*/::size_type, Alloc )
    -> unordered_map<iter_key_t<InputIt>, iter_val_t<InputIt>,
                     std::hash<iter_key_t<InputIt>>,

                     std::equal_to<iter_key_t<InputIt>>, Alloc>;
 (3) (C++17以降)
template< class InputIt, class Alloc >

unordered_map( InputIt, InputIt, Alloc )
    -> unordered_map<iter_key_t<InputIt>, iter_val_t<InputIt>,
                     std::hash<iter_key_t<InputIt>>,

                     std::equal_to<iter_key_t<InputIt>>, Alloc>;
 (4) (C++17以降)
template< class InputIt, class Hash, class Alloc >

unordered_map( InputIt, InputIt, typename /*下記参照*/::size_type, Hash, Alloc )
    -> unordered_map<iter_key_t<InputIt>, iter_val_t<InputIt>, Hash,

                     std::equal_to<iter_key_t<InputIt>>, Alloc>;
 (5) (C++17以降)
template< class Key, class T, typename Alloc >

unordered_map( std::initializer_list<std::pair<Key, T>>,
               typename /*下記参照*/::size_type, Alloc )

    -> unordered_map<Key, T, std::hash<Key>, std::equal_to<Key>, Alloc>;
 (6) (C++17以降)
template< class Key, class T, typename Alloc >

unordered_map( std::initializer_list<std::pair<Key, T>>, Alloc )

    -> unordered_map<Key, T, std::hash<Key>, std::equal_to<Key>, Alloc>;
 (7) (C++17以降)
template< class Key, class T, class Hash, class Alloc >

unordered_map( std::initializer_list<std::pair<Key, T>>,
               typename /*下記参照*/::size_type, Hash, Alloc )

    -> unordered_map<Key, T, Hash, std::equal_to<Key>, Alloc>;
 (8) (C++17以降)
template< ranges::input_range R,

          class Hash = std::hash<range_key_t<R>>,
          class Pred = std::equal_to<range_key_t<R>>,
          class Alloc = std::allocator<range_to_alloc_t<R>> >
unordered_map( std::from_range_t, R&&,
               typename /* 説明を参照 */::size_type = /* 説明を参照 */,
               Hash = Hash(), Pred = Pred(), Alloc = Alloc() )
    -> unordered_map<range_key_t<R>, range_mapped_t<R>,

                     Hash, Pred, Alloc>;
 (9) (C++23から)
template< ranges::input_range R, class Alloc >

unordered_map( std::from_range_t, R&&,
               typename /* 説明を参照 */::size_type, Alloc )
    -> unordered_map<range_key_t<R>, range_mapped_t<R>,
                     std::hash<range_key_t<R>>,

                     std::equal_to<range_key_t<R>>, Alloc>;
 (10) (C++23から)
template< ranges::input_range R, class Alloc >

unordered_map( std::from_range_t, R&&, Alloc )
    -> unordered_map<range_key_t<R>, range_mapped_t<R>,
                     std::hash<range_key_t<R>>,

                     std::equal_to<range_key_t<R>>, Alloc>;
 (11) (C++23から)
template< ranges::input_range R, class Hash, class Alloc >

unordered_map( std::from_range_t, R&&, typename /* 説明を参照 */::size_type,
               Hash, Alloc )
    -> unordered_map<range_key_t<R>, range_mapped_t<R>, Hash,

                     std::equal_to<range_key_t<R>>, Alloc>;
 (12) (C++23から)
Exposition-only helper type aliases
template< class InputIter >

using iter_val_t =

    typename std::iterator_traits<InputIter>::value_type;
 (説明用*)
template< class InputIter >

using iter_key_t =

    std::remove_const_t< std::tuple_element_t<0, iter_val_t<InputIter>>>;
 (説明用*)
template< class InputIter >

using iter_mapped_t =

    std::tuple_element_t<1, iter_val_t<InputIter>>;
 (説明用*)
template< class InputIter >

using iter_to_alloc_t =
    std::pair<std::add_const_t<tuple_element_t<0, iter_val_t<InputIter>>>,

              std::tuple_element_t<1, iter_val_t<InputIter>>>;
 (説明用*)
template< ranges::input_range Range >

using range_key_t =

    std::remove_const_t<typename ranges::range_value_t<Range>::first_type>;
 (C++23から)
(説明用*)
template< ranges::input_range Range >

using range_mapped_t =

    typename ranges::range_value_t<Range>::second_type;
 (C++23から)
(説明用*)
template< ranges::input_range Range >

using range_to_alloc_t =
    std::pair<std::add_const_t<typename ranges::range_value_t<Range>::first_type>,

              typename ranges::range_value_t<Range>::second_type>;
 (C++23から)
(説明用*)
1-8) これらの推論ガイドは、unordered_map がイテレータ範囲（オーバーロード (1,3-5)）および std::initializer_list（オーバーロード (2,6-8)）から推論できるように提供されています。
9-12) これらの推論ガイドは、unordered_map が std::from_range_t タグおよび input_range から推論できるように提供されています。

これらのオーバーロードは、InputIt が LegacyInputIterator を満たし、Alloc が Allocator を満たし、Hash と Pred のどちらも Allocator を満たさず、Hash が整数型でない場合にのみオーバーロード解決に参加します。

注意: ライブラリが型を LegacyInputIterator として満たさないと判断する程度は未規定ですが、最低限、整数型は入力イテレータとして適格ではありません。同様に、型が Allocator を満たさないと判断する程度は未規定ですが、最低限、メンバ型 Alloc::value_type が存在し、式 std::declval<Alloc&>().allocate(std::size_t{}) が評価されないオペランドとして適切であることが必要です。

これらのガイドにおける size_type パラメータ型は、推論ガイドによって推論される型の size_type メンバ型を参照します。

[編集] 注釈

機能テストマクロ 値 規格 機能
__cpp_lib_containers_ranges 202202L (C++23) 範囲対応の構築と挿入。オーバーロード (9-12)

[編集] 例

このコードを実行
#include <unordered_map>
 
int main()
{
    // std::unordered_map m1 = {{"foo", 1}, {"bar", 2}};
        // Error: braced-init-list has no type cannot
        // deduce pair<Key, T> from {"foo", 1} or {"bar", 2}
 
    std::unordered_map m1 = {std::pair{"foo", 2}, {"bar", 3}}; // guide #2
    std::unordered_map m2(m1.begin(), m1.end()); // guide #1
}

[編集] 不具合報告

以下の動作変更を伴う欠陥報告が、以前に公開されたC++標準に遡って適用されました。

DR 適用対象 公開された動作 正しい動作
LWG 3025 C++17 initializer-listガイドは std::pair<const Key, T> を受け取ります std::pair<Key, T> を使用してください
"https://ja.cppreference.dev/mwiki/index.php?title=cpp/container/unordered_map/deduction_guides&oldid=135907" から取得
English 日本語 中文(简体) 中文(繁體)