std::unordered_map<Key,T,Hash,KeyEqual,Allocator>::unordered_map

See More

 

C++

编译器支持

自立实现与有宿主实现

语言

标准库

标准库标头

具名要求

功能特性测试宏 (C++20)

语言支持库

概念库 (C++20)

诊断库

内存管理库

元编程库 (C++11)

通用工具库

容器库

迭代器库

范围库 (C++20)

算法库

字符串库

文本处理库

数值库

日期和时间库

输入/输出库

文件系统库 (C++17)

并发支持库 (C++11)

执行控制库 (C++26)

技术规范

符号索引

外部库

 

容器库

序列

array (C++11)

vector

vector<bool>

inplace_vector (C++26)

hive (C++26)

deque

forward_list (C++11)

list

关联容器

set

multiset

map

multimap

无序关联容器

unordered_set (C++11)

unordered_multiset (C++11)

unordered_map (C++11)

unordered_multimap (C++11)

容器适配器

stack

queue

priority_queue

flat_set (C++23)

flat_multiset (C++23)

flat_map (C++23)

flat_multimap (C++23)

视图

span (C++20)

mdspan (C++23)

表格

迭代器失效

成员函数表格

非成员函数表格

 

std::unordered_map

成员类型
成员函数
unordered_map::unordered_map unordered_map::~unordered_map unordered_map::operator= unordered_map::get_allocator 迭代器 unordered_map::beginunordered_map::cbegin unordered_map::endunordered_map::cend 容量 unordered_map::size unordered_map::max_size unordered_map::empty 修改器 unordered_map::clear unordered_map::erase unordered_map::swap unordered_map::extract (C++17) unordered_map::merge (C++17) unordered_map::insert unordered_map::insert_range (C++23) unordered_map::insert_or_assign (C++17)   unordered_map::emplace unordered_map::emplace_hint unordered_map::try_emplace (C++17)	查找 unordered_map::at unordered_map::operator[] unordered_map::count unordered_map::find unordered_map::contains (C++20) unordered_map::equal_range 桶接口 unordered_map::begin(size_type)unordered_map::cbegin(size_type) unordered_map::end(size_type)unordered_map::cend(size_type) unordered_map::bucket_count unordered_map::max_bucket_count unordered_map::bucket_size unordered_map::bucket 散列策略 unordered_map::load_factor unordered_map::max_load_factor unordered_map::rehash unordered_map::reserve 观察器 unordered_map::hash_function unordered_map::key_eq
非成员函数
operator==operator!= (C++20 前)	std::swap(std::unordered_map) erase_if(std::unordered_map) (C++20)
推导指引(C++17)

 

<tbody> </tbody> <tbody class="t-dcl-rev t-dcl-rev-num "> </tbody><tbody> </tbody>

	(1)
unordered_map() : unordered_map(size_type(/* 未指定 */)) {}			(C++11 起) (C++20 前)
unordered_map();			(C++20 起)
explicit unordered_map( size_type bucket_count, {{#pad:|22}} const Hash& hash = Hash(), {{#pad:|22}} const key_equal& equal = key_equal(), {{#pad:|22}} const Allocator& alloc = Allocator() );		(2)	(C++11 起)
unordered_map( size_type bucket_count, {{#pad:|13}} const Allocator& alloc ) : unordered_map(bucket_count, Hash(), key_equal(), alloc) {}		(3)	(C++14 起)
unordered_map( size_type bucket_count, {{#pad:|13}} const Hash& hash, {{#pad:|13}} const Allocator& alloc ) : unordered_map(bucket_count, hash, key_equal(), alloc) {}		(4)	(C++14 起)
explicit unordered_map( const Allocator& alloc );		(5)	(C++11 起)
template< class InputIt > unordered_map( InputIt first, InputIt last, {{#pad:|13}} size_type bucket_count = /* 未指定 */, {{#pad:|13}} const Hash& hash = Hash(), {{#pad:|13}} const key_equal& equal = key_equal(), {{#pad:|13}} const Allocator& alloc = Allocator() );		(6)	(C++11 起)
template< class InputIt > unordered_map( InputIt first, InputIt last, {{#pad:|13}} size_type bucket_count, {{#pad:|13}} const Allocator& alloc ) : unordered_map(first, last, {{#pad:|16}}bucket_count, Hash(), key_equal(), alloc) {}		(7)	(C++14 起)
template< class InputIt > unordered_map( InputIt first, InputIt last, {{#pad:|13}} size_type bucket_count, {{#pad:|13}} const Hash& hash, {{#pad:|13}} const Allocator& alloc ) : unordered_map(first, last, {{#pad:|16}}bucket_count, hash, key_equal(), alloc) {}		(8)	(C++14 起)
unordered_map( const unordered_map& other );		(9)	(C++11 起)
unordered_map( const unordered_map& other, const Allocator& alloc );		(10)	(C++11 起)
unordered_map( unordered_map&& other );		(11)	(C++11 起)
unordered_map( unordered_map&& other, const Allocator& alloc );		(12)	(C++11 起)
unordered_map( std::initializer_list<value_type> init, {{#pad:|13}} size_type bucket_count = /* 未指定 */, {{#pad:|13}} const Hash& hash = Hash(), {{#pad:|13}} const key_equal& equal = key_equal(), {{#pad:|13}} const Allocator& alloc = Allocator() );		(13)	(C++11 起)
unordered_map( std::initializer_list<value_type> init, {{#pad:|13}} size_type bucket_count, {{#pad:|13}} const Allocator& alloc ) : unordered_map(init, bucket_count, {{#pad:|16}}Hash(), key_equal(), alloc) {}		(14)	(C++14 起)
unordered_map( std::initializer_list<value_type> init, {{#pad:|13}} size_type bucket_count, {{#pad:|13}} const Hash& hash, {{#pad:|13}} const Allocator& alloc ) : unordered_map(init, bucket_count, {{#pad:|16}}hash, key_equal(), alloc) {}		(15)	(C++14 起)
template< container-compatible-range<value_type> R > unordered_map( std::from_range_t, R&& rg, {{#pad:|13}} size_type bucket_count = /* 见说明 */, {{#pad:|13}} const Hash& hash = Hash(), {{#pad:|13}} const key_equal& equal = key_equal(), {{#pad:|13}} const Allocator& alloc = Allocator() );		(16)	(C++23 起)
template< container-compatible-range<value_type> R > unordered_map( std::from_range_t, R&& rg, {{#pad:|13}} size_type bucket_count, {{#pad:|13}} const Allocator& alloc ) : unordered_map(std::from_range, std::forward<R>(rg), {{#pad:|16}}bucket_count, Hash(), key_equal(), alloc) {}		(17)	(C++23 起)
template< container-compatible-range<value_type> R > unordered_map( std::from_range_t, R&& rg, {{#pad:|13}} size_type bucket_count, {{#pad:|13}} const Hash& hash, {{#pad:|13}} const Alloc& alloc ) : unordered_map(std::from_range, std::forward<R>(rg), {{#pad:|16}}bucket_count, hash, key_equal(), alloc) {}		(18)	(C++23 起)

从各种数据源构造新容器。可选的以用户提供的 bucket_count 为用于创建的最小桶数，以 hash 为散列函数，以 equal 为比较键的函数，并以 alloc 为分配器。

1-5) 构造空容器。设置 max_load_factor() 为 1.0。对于默认构造函数，桶数是未指明的。

6-8) 构造具有范围 [first, last) 的内容的容器。设置 max_load_factor() 为 1.0。如果范围中的多个元素的键比较相等，那么未指定哪个元素会被插入（参考待决的 LWG2844）。

9,10) 复制构造函数。构造拥有 other 内容副本的容器，一同复制加载因子、谓词和散列函数。如果没有提供 alloc，那么就会通过调用 std::allocator_traits<allocator_type>::select_on_container_copy_construction(other.get_allocator()) 获得分配器。

在用于类模板实参推导时，仅从首个实参推导模板形参 Allocator。

(C++23 起)

11,12) 移动构造函数。用移动语义构造拥有 other 的内容的容器。如果没有提供 alloc，那么就会通过从属于 other 的分配器进行移动构造来获得分配器。

在用于类模板实参推导时，仅从首个实参推导模板形参 Allocator。

(C++23 起)

13-15) 初始化器列表构造函数。构造拥有 init 的内容的容器，同 unordered_map(init.begin(), init.end())。

16-18) 构造拥有 rg 的内容的容器。如果范围中的多个元素的键比较相等，那么未指定哪个元素会被插入（参考待决的 LWG2844）。

参数

alloc	-	用于此容器所有内存分配器的分配器
bucket_count	-	初始化时用的最小桶数。若不指定，则使用未指明的默认值
hash	-	要用的散列函数
equal	-	用于进行此容器所有的键比较的比较函数
first, last	-	要复制的源元素范围的迭代器对
rg	-	容器兼容范围，即其元素可以转换为 value_type 的 input_range
other	-	用作源以初始化容器元素的另一容器
init	-	用以初始化容器元素的 initializer_list
类型要求
- InputIt 必须满足老式输入迭代器 (LegacyInputIterator) 。

复杂度

1-5) 常数。

6-8) 平均情况是线性（即 O(N)，其中 N 为 std::distance(first, last)），最坏情况是平方，即 O(N²)。

9,10) 与 other 的大小成线性。

11,12) 常数。给定 alloc 且 alloc != other.get_allocator() 时是线性。

13-15) 平均情况是 O(N)（N 是 std::size(init)），最坏情况是 O(N²)。

16-18) 平均情况是 O(N)（N 是 ranges::distance(rg)），最坏情况是 O(N²)。

异常

对 Allocator::allocate 的调用可能会抛出。

注解

在容器移动构造（重载 (4)）后，指向 other 的引用及迭代器（除了尾迭代器）保持合法，但将指代现于 *this 中的元素。当前标准由 [container.requirements.general]/12 中的总括陈述作出此保证，而 LWG 问题 2321 正在考虑更严格的保证。

尽管在 C++23 前未正式要求，一些实现已经在较早的模式中将 Allocator 放入非推导语境。

功能特性测试宏	值	标准	功能特性
__cpp_lib_containers_ranges	202202L	(C++23)	按范围构造和插入; 重载 (16-18)

示例

运行此代码

#include <bitset>
#include <string>
#include <unordered_map>
#include <utility>
#include <vector>

struct Key
{
    std::string first;
    std::string second;
};

struct KeyHash
{
    std::size_t operator()(const Key& k) const
    {
        return std::hash<std::string>()(k.first) ^
            (std::hash<std::string>()(k.second) << 1);
    }
};

struct KeyEqual
{
    bool operator()(const Key& lhs, const Key& rhs) const
    {
        return lhs.first == rhs.first && lhs.second == rhs.second;
    }
};

struct Foo
{
    Foo(int val_) : val(val_) {}
    int val;
    bool operator==(const Foo &rhs) const { return val == rhs.val; }
};

template<>
struct std::hash<Foo>
{
    std::size_t operator()(const Foo &f) const
    {
        return std::hash<int>{}(f.val);
    }
};

int main()
{
    // 默认构造函数：空映射
    std::unordered_map<std::string, std::string> m1;
    
    // 列表构造函数
    std::unordered_map<int, std::string> m2 =
    {
        {1, "foo"},
        {3, "bar"},
        {2, "baz"}
    };
    
    // 复制构造函数
    std::unordered_map<int, std::string> m3 = m2;
    
    // 移动构造函数
    std::unordered_map<int, std::string> m4 = std::move(m2);
    
    // 范围构造函数
    std::vector<std::pair<std::bitset<8>, int>> v = {{0x12, 1}, {0x01,-1}};
    std::unordered_map<std::bitset<8>, double> m5(v.begin(), v.end());
    
    // 带自定义 Key 类型的构造函数的选项 1
    // 定义 KeyHash 与 KeyEqual 结构体并在模板中使用它们
    std::unordered_map<Key, std::string, KeyHash, KeyEqual> m6 =
    {
        {{"John", "Doe"}, "example"},
        {{"Mary", "Sue"}, "another"}
    };
    
    // 带自定义 Key 类型的构造函数的选项 2
    // 为 class/struct 定义 const == 运算符并于 std 命名空间特化 std::hash 结构体
    std::unordered_map<Foo, std::string> m7 =
    {
        {Foo(1), "One"}, {2, "Two"}, {3, "Three"}
    };
    
    // 选项 3：用 lambda
    // 注意必须将初始桶数传递给构造函数
    struct Goo { int val; };
    auto hash = [](const Goo &g){ return std::hash<int>{}(g.val); };
    auto comp = [](const Goo &l, const Goo &r){ return l.val == r.val; };
    std::unordered_map<Goo, double, decltype(hash), decltype(comp)> m8(10, hash, comp);
}

缺陷报告

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

缺陷报告	应用于	出版时的行为	正确行为
LWG 2193	C++11	默认构造函数是 explicit 的	使之为非 explicit 的
LWG 2230	C++11	未指定重载 (13) 的语义	指定语义

参阅

operator=

将值赋给容器 (公开成员函数)