std::map<Key,T,Compare,Allocator>::at

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::map

成员函数

map::map map::~map               map::operator= map::get_allocator

元素访问 map::at map::operator[] 迭代器 map::beginmap::cbegin (C++11) map::endmap::cend (C++11) map::rbeginmap::crbegin (C++11)      map::rendmap::crend (C++11) 容量 map::size map::max_size map::empty 观察器 map::key_comp map::value_comp 修改器 map::clear map::insert map::erase map::swap map::extract (C++17) map::merge (C++17) map::insert_range (C++23) map::insert_or_assign (C++17) map::emplace (C++11) map::emplace_hint (C++11) map::try_emplace (C++17) 查找 map::count map::find map::contains (C++20) map::equal_range map::lower_bound map::upper_bound

非成员函数

operator==operator<=> (C++20) std::swap(std::map) erase_if(std::map) (C++20)   operator!=operator<operator>operator<=operator>= (C++20 前)(C++20 前)(C++20 前)(C++20 前)(C++20 前)

推导指引 (C++17)

 

<tbody> </tbody>

T& at( const Key& key );	(1)
const T& at( const Key& key ) const;	(2)
template< class K > T& at( const K& x );	(3)	(C++26 起)
template< class K > const T& at( const K& x ) const;	(4)	(C++26 起)

返回到拥有指定键的元素被映射值的引用。如果没有这种元素，那么就会抛出 std::out_of_range 类型的异常。

1,2) 其键等价于 key。

3,4) 其键比较等价于 x 的值。如同以表达式 this->find(x)->second 获得到被映射值的引用。

表达式 this->find(x) 必须良构且具有确切定义的行为，否则其行为未定义。

这些重载只有在限定标识 Compare::is_transparent 合法并指代类型时才会参与重载决议。它允许调用此函数时无需构造 Key 的实例。

参数

key	-	要找到的元素的键
x	-	可以透明地与键比较的任意类型的值

返回值

到所请求元素的被映射值的引用。

异常

1,2) 在容器没有指定 key 的元素时抛出 std::out_of_range。

3,4) 在容器没有指定的元素，即当 find(x) == end() 为 true 时抛出 std::out_of_range。

复杂度

与容器大小成对数。

注解

功能特性测试宏	值	标准	功能特性
__cpp_lib_associative_heterogeneous_insertion	202311L	(C++26)	有序和无序关联容器中剩余成员函数的异质重载。(3,4)

示例

运行此代码

#include <cassert>
#include <iostream>
#include <map>

struct LightKey { int o; };
struct HeavyKey { int o[1000]; };

// 容器必须使用 std::less<> （或其他透明比较器）以使用重载 (3,4)。
// 其中包括标准的重载，比如 std::string 与 std::string_view 之间的比较。
bool operator<(const HeavyKey& x, const LightKey& y) { return x.o[0] < y.o; }
bool operator<(const LightKey& x, const HeavyKey& y) { return x.o < y.o[0]; }
bool operator<(const HeavyKey& x, const HeavyKey& y) { return x.o[0] < y.o[0]; }

int main()
{
    std::map<int, char> map{{1, 'a'}, {2, 'b'}};
    assert(map.at(1) == 'a');
    assert(map.at(2) == 'b');
    try
    {
        map.at(13);
    }
    catch(const std::out_of_range& ex)
    {
        std::cout << "1) out_of_range::what(): " << ex.what() << '\n';
    }

#ifdef __cpp_lib_associative_heterogeneous_insertion
    // 透明比较的演示。
    std::map<HeavyKey, char, std::less<>> map2{{{1}, 'a'}, {{2}, 'b'}};
    assert(map2.at(LightKey{1}) == 'a');
    assert(map2.at(LightKey{2}) == 'b');
    try
    {
        map2.at(LightKey{13});
    }
    catch(const std::out_of_range& ex)
    {
        std::cout << "2) out_of_range::what(): " << ex.what() << '\n';
    }
#endif
}

可能的输出：

1) out_of_range::what(): map::at:  key not found
2) out_of_range::what(): map::at:  key not found

缺陷报告

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

缺陷报告	应用于	出版时的行为	正确行为
LWG 464	C++98	map 没有这个成员函数	添加该函数
LWG 703	C++98	缺失了复杂度要求	已补充
LWG 2007	C++98	返回值指代请求元素	指代该元素的被映射值

参阅

operator[]	访问或插入指定的元素 (公开成员函数)
find	寻找带有特定键的元素 (公开成员函数)