1. 简介
std::enable_if
是在C++ 11中引入的模板结构体,在头文件<type_traits>
中定义。
template < bool B, class T = void >
struct enable_if ;
如果条件B是为true
, std::enable_if
将拥有一个公共成员 typedef type
, 等价于T
; 否则,没有成员 typedef
。
此元函数是在 C++20 的概念之前利用SFINAE(Substitution Failure Is Not An Error)的便捷方式,特别是用于根据类型特征有条件地从候选集中删除函数,允许基于这些不同类型特征的单独函数重载或特化。
std::enable_if
可以以多种形式使用,包括:
- 作为返回类型(不适用于构造函数和析构函数)
- 作为附加函数参数(不适用于运算符重载)
- 作为类模板或函数模板参数
添加特化行为的enable_if
是未定义的。
2. 使用说明
前文的说明稍显抽象,来看看具体使用说明更加利于理解其功能。可以使用std::enable_if
对函数模板进行条件限制。当某个条件为真时,std::enable_if
可以使函数模板“启用”,否则“禁用”函数模板。这个功能可以使得函数模板更加通用、可靠和安全。
下面是对于该用法的示例:
#include <type_traits>
#include <iostream>
template <typename T>
typename std::enable_if<std::is_integral<T>::value, T>::type
foo(T x)
{
std::cout << "foo int";
return x * 2;
}
template <typename T>
typename std::enable_if<std::is_floating_point<T>::value, T>::type
foo(T x)
{
std::cout << "foo float";
return x / 2.0;
}
在这个示例中,我们定义了两个函数模板foo
,它们根据不同的类型来返回不同的结果。第一个foo
函数只能接受整型参数,并返回这个整数的两倍。第二个foo
函数只能接受浮点型参数,并返回这个浮点数的一半。
这个实现使用了std::enable_if
对函数模板进行条件限制。我们使用std::is_integral
和std::is_floating_point
来检查T
是否是整型或浮点型,如果是则启用对应的函数模板,否则就被禁用。我们使用typename std::enable_if<...>::type
来指定函数的返回类型,这是因为在禁用状态下,函数不应该返回任何值。
std::enable_if
还可以用于函数参数列表中,这样就可以根据不同的条件来选择不同的函数参数列表。
template <typename T>
void bar(T x, typename std::enable_if<std::is_integral<T>::value>::type* = nullptr)
{
std::cout << "bar int";
// 处理整型参数的函数实现
}
template <typename T>
void bar(T x, typename std::enable_if<std::is_floating_point<T>::value>::type* = nullptr)
{
std::cout << "bar float";
// 处理浮点型参数的函数实现
}
在这个示例中,我们定义了两个函数模板bar
,它们根据不同的类型来采用不同的函数参数列表。第一个bar
函数只能接受整型参数,并处理整型参数的函数实现。第二个bar
函数只能接受浮点型参数,并处理浮点型参数的函数实现。
这个实现也使用了std::enable_if
对函数模板进行条件限制。我们使用std::is_integral
和std::is_floating_point
来检查T
是否是整型或浮点型,如果是则启用对应的函数模板,否则就被禁用。我们使用typename std::enable_if<...>::type* = nullptr
来指定函数参数列表,这样就可以根据不同的条件来选择不同的函数参数列表。需要注意的是,我们使用了一个默认参数nullptr
,这是因为在禁用状态下,函数不应该使用这个参数。
基于以上模板函数,我们运行下列代码片段:
foo(2);
foo(2.1);
bar(2);
bar(2.1);
程序的打印将会是下面这样的:
foo int
foo float
bar int
bar float
除了在函数模板中使用std::enable_if
进行条件限制之外,还可以在类模板中使用。在类模板中使用std::enable_if
可以控制类模板的实例化,从而使得只有满足某些条件的类型才能实例化这个类模板。
下面是一个使用std::enable_if
的类模板示例:
#include <type_traits>
#include <iostream>
template <typename T, typename Enable = void>
class MyClass
{
// 默认实现,适用于所有类型
public:
MyClass<T>() { std::cout << "default"; }
};
template <typename T>
class MyClass<T, typename std::enable_if<std::is_integral<T>::value>::type>
{
// 整型类型的特化实现
public:
MyClass<T>() { std::cout << "int"; }
};
template <typename T>
class MyClass<T, typename std::enable_if<std::is_floating_point<T>::value>::type>
{
// 浮点型类型的特化实现
public:
MyClass<T>() { std::cout << "float"; }
};
在这个示例中,我们定义了一个类模板MyClass
,并使用std::enable_if
对它进行条件限制。默认情况下,MyClass
可以适用于任何类型,因为我们没有对第二个模板参数进行任何限制。但是,我们可以通过对第二个模板参数使用std::enable_if
,来控制MyClass
的实例化。
具体来说,我们定义了两个特化版本的MyClass
:一个适用于整型类型,一个适用于浮点型类型。当T
是整型类型时,第二个模板参数的值是typename std::enable_if<std::is_integral<T>::value>::type
,因此只有当T
是整型类型时,这个特化版本才会被实例化。同样的,当T
是浮点型类型时,第二个模板参数的值是typename std::enable_if<std::is_floating_point<T>::value>::type
,因此只有当T
是浮点型类型时,这个特化版本才会被实例化。
需要注意的是,当使用std::enable_if
对类模板进行条件限制时,需要将第二个模板参数命名为Enable
(或其他有意义的名称),并且在类模板的定义中使用typename Enable::type
来引用第二个模板参数。这是因为std::enable_if
返回的是一个类型,而不是一个值。
基于以上类的定义,我们运行下列代码片段:
MyClass<std::string> class3;
MyClass<int> class1;
MyClass<float> class2;
程序的打印将会是下面这样:
default
int
float