Spec-Zone.ru › C++

std::visit

Определено в заголовочном файле <variant>
template< class Visitor, class... Variants >
constexpr /* see below */ visit( Visitor&& v, Variants&&... values );
(1) (начиная с C++17)
template< class R, class Visitor, class... Variants >
constexpr R visit( Visitor&& v, Variants&&... values );
(2) (начиная с C++20)
Вспомогательные шаблоны
template< class... Ts >
auto&& /*as-variant*/( std::variant<Ts...>& value );
(3) (только для иллюстрации*)
template< class... Ts >
auto&& /*as-variant*/( const std::variant<Ts...>& value );
(4) (только для иллюстрации*)
template< class... Ts >
auto&& /*as-variant*/( std::variant<Ts...>&& value );
(5) (только для иллюстрации*)
template< class... Ts >
auto&& /*as-variant*/( const std::variant<Ts...>&& value );
(6) (только для иллюстрации*)

Применяет посетитель v (Callable, который можно вызвать с любой комбинацией типов из variant) к вариантам values.

Пусть VariantBases — это decltype(as-variant(std::forward<Variants>(values))... (пак из sizeof...(Variants) типов):

1) Вызывает v, как если бы это было

INVOKE(std::forward<Visitor>(v),
      std::get<indices>(std::forward<VariantBases>(values))...)
, где indices — это as-variant(values).index()....

2) Вызывает v, как если бы это было

INVOKE<R>(std::forward<Visitor>(v),
         std::get<indices>(std::forward<VariantBases>(values))...)
, где indices — это as-variant(values).index()....

Эти перегрузки участвуют в разрешении перегрузки, только если каждый тип в VariantBases является допустимым типом. Если выражение, обозначенное INVOKE или INVOKE<R>(начиная с C++20), некорректно либо результаты INVOKE или INVOKE<R>(начиная с C++20) имеют разные типы или категории значений для разных indices, программа некорректна.

3-6) Функции-шаблоны as-variant, приведённые только для иллюстрации, принимают значение, тип которого можно вывести для std::variant<Ts...> (то есть либо std::variant<Ts...>, либо тип, производный от std::variant<Ts...>), и возвращают значение std::variant с теми же квалификаторами const и категорией значения.
3,4) Возвращает value.
5,6) Возвращает std::move(value).

Параметры

v - Callable, принимающий все возможные альтернативы из каждого варианта в Variants
values - список вариантов, передаваемых посетителю

Возвращаемое значение

1) Результат операции INVOKE. Возвращаемый тип — это тип, полученный при применении decltype к результату.
2) Ничего, если R имеет тип (возможно, cv-квалифицированный) void; в противном случае — результат операции INVOKE<R>.
3-6) Значение типа std::variant, преобразованное из value.

Исключения

Выбрасывает std::bad_variant_access, если as-variant(value_i).valueless_by_exception() имеет значение true для какого-либо варианта value_i в values.

Сложность

Если число вариантов равно нулю или единице, вызов вызываемого объекта выполняется за постоянное время, то есть время выполнения не зависит от количества типов, которые могут храниться в варианте.

Если число вариантов больше единицы, требования к сложности вызова вызываемого объекта не предъявляются.

Примечания

Пусть n — это (1 * ... * std::variant_size_v<std::remove_reference_t<VariantBases>>); реализации обычно генерируют таблицу, эквивалентную (возможно, многомерному) массиву указателей на функции n для каждой специализации std::visit, что похоже на реализацию виртуальных функций.

Реализации также могут генерировать оператор switch с n ветвями для std::visit (например, реализация MSVC STL использует оператор switch, если n не превышает 256).

В типичных реализациях временную сложность вызова v можно считать равной сложности доступа к элементу (возможно, многомерного) массива или выполнения оператора switch.

Макрос проверки поддержки возможности Значение Стандарт Возможность
__cpp_lib_variant 202102L (C++23)
(DR17)
std::visit для классов, производных от std::variant

Пример

#include <iomanip>
#include <iostream>
#include <string>
#include <type_traits>
#include <variant>
#include <vector>

// the variant to visit
using value_t = std::variant<int, long, double, std::string>;

// helper type for the visitor #4
template<class... Ts>
struct overloaded : Ts... { using Ts::operator()...; };
// explicit deduction guide (not needed as of C++20)
template<class... Ts>
overloaded(Ts...) -> overloaded<Ts...>;

int main()
{
    std::vector<value_t> vec = {10, 15l, 1.5, "hello"};

    for (auto& v: vec)
    {
        // 1. void visitor, only called for side-effects (here, for I/O)
        std::visit([](auto&& arg){ std::cout << arg; }, v);

        // 2. value-returning visitor, demonstrates the idiom of returning another variant
        value_t w = std::visit([](auto&& arg) -> value_t { return arg + arg; }, v);

        // 3. type-matching visitor: a lambda that handles each type differently
        std::cout << ". After doubling, variant holds ";
        std::visit([](auto&& arg)
        {
            using T = std::decay_t<decltype(arg)>;
            if constexpr (std::is_same_v<T, int>)
                std::cout << "int with value " << arg << '\n';
            else if constexpr (std::is_same_v<T, long>)
                std::cout << "long with value " << arg << '\n';
            else if constexpr (std::is_same_v<T, double>)
                std::cout << "double with value " << arg << '\n';
            else if constexpr (std::is_same_v<T, std::string>)
                std::cout << "std::string with value " << std::quoted(arg) << '\n';
            else
                static_assert(false, "non-exhaustive visitor!");
        }, w);
    }

    for (auto& v: vec)
    {
        // 4. another type-matching visitor: a class with 3 overloaded operator()'s
        // Note: The `(auto arg)` template operator() will bind to `int` and `long`
        //       in this case, but in its absence the `(double arg)` operator()
        //       *will also* bind to `int` and `long` because both are implicitly
        //       convertible to double. When using this form, care has to be taken
        //       that implicit conversions are handled correctly.
        std::visit(overloaded{
            [](auto arg) { std::cout << arg << ' '; },
            [](double arg) { std::cout << std::fixed << arg << ' '; },
            [](const std::string& arg) { std::cout << std::quoted(arg) << ' '; }
        }, v);
    }
}

Вывод:

10. After doubling, variant holds int with value 20
15. After doubling, variant holds long with value 30
1.5. After doubling, variant holds double with value 3
hello. After doubling, variant holds std::string with value "hellohello"
10 15 1.500000 "hello"

Отчёты об ошибках

Следующие отчёты об ошибках, изменяющие поведение, были применены задним числом к ранее опубликованным стандартам C++.

DR Применяется к Опубликованное поведение Корректное поведение
LWG 2970 C++17 тип возвращаемого значения перегрузки (1) не сохранял
категорию значения результата операции INVOKE
сохраняет
LWG 3052
(P2162R2)
C++17 эффекты не были специфицированы, если какой-либо тип
в Variants не является std::variant
специфицированы

См. также

visit
(C++26)
вызывает предоставленный функциональный объект с аргументом, хранящимся в variant
(открытая функция-член)
swap
меняет местами с другим variant
(открытая функция-член)

© cppreference.com
Licensed under the Creative Commons Attribution-ShareAlike Unported License v3.0.
https://en.cppreference.com/cpp/utility/variant/visit2

Spec-Zone.ru

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