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

 

C++

編譯器支援

自由（freestanding）與宿主（hosted）

語言

標準庫

標準庫標頭檔案

具名要求

特性測試宏 (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>= (until C++20)(until C++20)(until C++20)(until C++20)(until C++20)

推導指引 (C++17)

 

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) 必須是良好形式且具有明確定義的行為，否則行為未定義。

僅當限定 ID 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]; };
 
// The container must use std::less<> (or other transparent Comparator) to
// access overloads (3,4). This includes standard overloads, such as
// comparison between std::string and 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
    // Transparent comparison demo.
    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[]	訪問或插入指定元素 (public member function)
find	查詢具有特定鍵的元素 (public member function)