Spec-Zone.ru › C++

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

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) std::out_of_range, если контейнер не содержит элемент с указанным key.
3,4) std::out_of_range, если контейнер не содержит указанный элемент, то есть если find(x) == end() равно true.

Сложность

Логарифмическая относительно размера контейнера.

Примечания

Макрос проверки поддержки возможности Значение Стандарт Возможность
__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[]
доступ к указанному элементу или его вставка
(открытая функция-член)
find
ищет элемент с указанным ключом
(открытая функция-член)

© cppreference.com
Licensed under the Creative Commons Attribution-ShareAlike Unported License v3.0.
https://en.cppreference.com/cpp/container/map/at

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API