std::visit
Определено в заголовке <variant> | ||
|---|---|---|
template< class Visitor, class... Variants > constexpr /* see below */ visit( Visitor&& vis, Variants&&... vars ); | (1) | (с C++17) |
template< class R, class Visitor, class... Variants > constexpr R visit( Visitor&& vis, Variants&&... vars ); | (2) | (с C++20) |
template< class... Ts > auto&& as-variant( std::variant<Ts...>& var ); | (3) | (только для примера*) |
template< class... Ts > auto&& as-variant( const std::variant<Ts...>& var ); | (4) | (только для примера*) |
template< class... Ts > auto&& as-variant( std::variant<Ts...>&& var ); | (5) | (только для примера*) |
template< class... Ts > auto&& as-variant( const std::variant<Ts...>&& var ); | (6) | (только для примера*) |
Применяет посетителя vis (функцию, которая может быть вызвана с любым сочетанием типов из вариантов) к вариантам vars.
Дано VariantBases как decltype(as-variant(std::forward<Variants>(vars))... (набор типов sizeof...(Variants)):
vis как если бы посредством INVOKE(std::forward<Visitor>(vis),, где
std::get<indices>(std::forward<VariantBases>(vars))...)indices равно as-variant(vars).index()....
vis как если бы посредством INVOKE<R>(std::forward<Visitor>(vis),, где
std::get<indices>(std::forward<VariantBases>(vars))...)indices равно as-variant(vars).index()....
Эти перегрузки участвуют в разрешении перегрузки только в том случае, если каждый тип в VariantBases является допустимым типом. Если выражение, обозначаемое INVOKE или INVOKE<R>(с C++20) является недопустимым, или результаты INVOKE или INVOKE<R>(с C++20) имеют разные типы или категории значений для различных indices, программа некорректна.
as-variant (только для примера) принимают значение, тип которого может быть выведен для std::variant<Ts...> (т.е. либо std::variant<Ts...> , либо тип, производный от std::variant<Ts...>), и возвращают значение std::variant с той же квалификацией const и категорией значения.var.std::move(var).Параметры
| vis | - | функция Callable, которая принимает каждый возможный альтернативный тип из каждого варианта |
| vars | - | список вариантов для передачи посетителю |
Значение результата
R является (возможно, с квалификацией cv) void; в противном случае результат операции INVOKE<R>.Исключения
Выбрасывает std::bad_variant_access , если as-variant(vars_i).valueless_by_exception() является true для любого варианта vars_i в vars.
Сложность
Когда количество вариантов равно нулю или одному, вызов объекта вызываемого объекта выполняется за постоянное время, т. е. не зависит от количества типов, которые могут быть сохранены в варианте.
Если количество вариантов больше одного, вызов вызываемого объекта не имеет требований к сложности.
Примечания
Пусть n равно (1 * ... * std::variant_size_v<std::remove_reference_t<VariantBases>>), реализации обычно генерируют таблицу, эквивалентную (возможно, многомерному) массиву указателей на функции n для каждой специализации std::visit, что аналогично реализации виртуальных функций.
Реализации также могут сгенерировать оператор switch с ветвями n для std::visit (например, реализация MSVC STL использует оператор switch, когда n не превышает 256).
В типичных реализациях временная сложность вызова vis может считаться равной сложности доступа к элементу в (возможно, многомерном) массиве или выполнению оператора switch.
| Макрос проверки наличия функции | Значение | Стандарт | Функция |
|---|---|---|---|
__cpp_lib_variant | 202102L |
(C++17) (DR) |
std::visit для классов, производных от std::variant |
Пример
#include <iomanip>
#include <iostream>
#include <string>
#include <type_traits>
#include <variant>
#include <vector>
// the variant to visit
using var_t = std::variant<int, long, double, std::string>;
// helper constant for the visitor #3
template<class>
inline constexpr bool always_false_v = false;
// 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<var_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
var_t w = std::visit([](auto&& arg) -> var_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(always_false_v<T>, "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 | определены |
См. также
| производит обмен с другим вариантом (публичный член-функция) |
© cppreference.com
Licensed under the Creative Commons Attribution-ShareAlike Unported License v3.0.
https://en.cppreference.com/w/cpp/utility/variant/visit