c++ std::variant用法

std::variant

Union类型的问题：

• 无法知道当前使用的类型是什么
• union无法自动调用底层数据成员的析构函数。联合体无法对其内部的数据属性的生命周期的全面支持，因为当外部代码调用Union时在切换类型，它无法做到对当前使用的对象，并自动调用其析构函数。
• C/C++没有原生的工具可以检测Union内部当前的活动类型。
• 不能有non-trivial的成员，比如std::string(从c++ 11起, union原则上可以有non-trivial的成员，但是必须实现特殊的成员函数，比如复制构造函数和析构函数，因为只有通过代码逻辑才能知道哪个成员是可用的。)
• 不能从union中派生类。

在 C++17 之前，为了改进这些问题，提出了std::variant。

• 与C语言中传统的 union 类型相同的是，variant 也是联合(union)类型。即 variant 可以存放多种类型的数据，但任何时刻最多只能存放其中一种类型的数据。
• 与C语言中传统的 union 类型所不同的是，variant 是可辨识的类型安全的联合(union)类型。即 variant 无须借助外力只需要通过查询自身就可辨别实际所存放数据的类型。

std::variant 基础用法

构造函数

std::variant<int, double, std::string> x, y;

x，y是一个可存放 int, double, std::string 这三种类型数据的变体类型的对象

std::in_place_index、std::in_place_type 显式赋值

显式指定当前索引/类型，并使用后续参数进行原地构造

variant<vector<int>, string> v{ std::in_place_index<0>, { 0, 1, 2, 3 } };
variant<vector<int>, string> v{ std::in_place_type<int>, { 0, 1, 2, 3 } };

修改值

赋值和emplace()操作对应于初始化

std::variant<int, int, std::string> var; // sets first int to 0, index()==0
var = "hello"; // sets string, index()==2
var.emplace<1>(42); // sets second int, index()==1

获取当前使用的type 在variant声明中的索引

x = 100.0f;
std::cout << "可变体的活动类型返回的index：" << x.index() << std::endl;

std::monostate

只是一个空类型，被用来和variant一起使用来表示空状态。当variant中的第一个类型没有默认构造函数时，可以将std::monostate作为第一个类型来使用。也就是说，std::monostate可以作为第一种替代类型，使变体类型默认为可构造的。

#include <iostream>
#include <variant>
 
struct NoDefConstr
{
    NoDefConstr(int i)
    {
        std::cout << "NoDefConstr::NoDefConstr(int) called\n";
    }
};
 
int main()
{
    std::variant<std::monostate, NoDefConstr> v2; // OK
    std::cout << "index: " << v2.index() << '\n'; // prints 0
 
    if (v2.index() == 0) 
    {
        std::cout << "has monostate\n";
    }
    if (!v2.index()) 
    {
        std::cout << "has monostate\n";
    }
    if (std::holds_alternative<std::monostate>(v2)) 
    {
        std::cout << "has monostate\n";
    }
    if (std::get_if<0>(&v2)) 
    {
        std::cout << "has monostate\n";
    }
    if (std::get_if<std::monostate>(&v2)) 
    {
        std::cout << "has monostate\n";
    }
 
    return 0;
}

获取std::variant中的值

使用std::get() 或直接std::get()来获取variant中包含的值，std::get(v) 如果变体类型 v 存放的数据类型为 T，那么返回所存放的数据，否则报错

double d = std::get<double>(x);
std::string s = std::get<2>(y);

如果std::variant中当前存储的不是对应Type的值, 则会抛出std::bad_variant_access类型的异常

try
{
    int i = std::get<int>(x);
}
catch (std::bad_variant_access e)
{
    std::cerr << e.what() << std::endl;
}

get_if()

除了会引发异常的std::get<>，也有无异常的 std::get_if() 方法，get_if通常保证std::get在访问可变体时不会抛出bad_variant_access 异常，提供了访问前的类型安全判断。需要自行判断返回的指针类型是否为空。
std::get_if(&v) 如果变体类型 v 存放的数据类型为 T，那么返回所存放数据的指针，否则返回空指针。

int* i = std::get_if<int>(&x);
if (i == nullptr)
{
    std::cout << "wrong type" << std::endl;
}
else
{
    std::cout << "value is " << *i << std::endl;
}

同时具有bool和std::string

如果一个std::variant<>同时有bool和std::string两个备选项，字符串字面量转换为bool比转换为std::string匹配

 #include <iostream>
#include <variant>
 
int main()
{
    std::variant<bool, std::string> v;
    v = "hi"; // OOPS: sets the bool alternative
    std::cout << "index: " << v.index() << '\n';
 
    std::visit([](const auto& val) {std::cout << "value: " << val << '\n'; }, v);
 
    return 0;
}

字符串常量值被解释为通过Boolean值true初始化变量(true是因为指针不是0)

解决方案

v.emplace<1>("hello"); // explicitly assign to second alternative
v.emplace<std::string>("hello"); // explicitly assign to string alternative
v = std::string{"hello"}; // make sure a string is assigned
 
using namespace std::literals; // make sure a string is assigned
v = "hello"s;

std::holds_alternative(v)

查询变体类型 v 是否存放了 T 类型的数据。

#include <iostream>
#include <string>
#include <variant>

using namespace std;

int main()
{
    variant<int, double, string> v; // v == 0
    v = 1;
    bool has_int = holds_alternative<int>(v);
    bool has_double = holds_alternative<double>(v);
    cout << v.index() << has_int << has_double << get<0>(v) << *get_if<0>(&v) << endl; // 01011
    v = 2.0;
    cout << v.index() << (get_if<int>(&v) == nullptr) << get<1>(v) << get<double>(v) << endl; // 1122
    v = "a";
    cout << v.index() << get<2>(v) << get<string>(v) << endl; // 2aa
}