C++ SFINAE 原则实战:enable_if 实现编译期类型约束与模板特化全攻略

概述

定位为一个helper模板(助手模板),用于辅助其他模板的设计,表现一种:编译期的分支逻辑(编译期就可以确定走哪条分支)。

什么是 SFINAE原则?

SFINAE: Substitudion Failure Is Not An Error 的缩写, 意思是 “替换失败并不是错误”.

就是说,匹配重载的函数 / 类时如果没有匹配上,编译器并不会报错,相应的, 这个函数 /或类就不会作为候选。这是一个 C++11 的新特性,也是 enable_if 最核心的原理。

SFANAE 是 C++ 语言标准中固有的一部分, 是模板编程中的一个核心特性。 SFINAE 不是可以选择开启或关闭的功能, 而是编译器在处理模板时自然遵循的原则。

SFINAE(Substitution Failure Is Not An Error)的机制确实意味着在模板参数匹配过程中,如果某次替换(Substitution)失败,并不会立即导致编译错误。编译器会继续尝试其他可用的模板特化或重载,寻找一个合适的匹配。只有当所有可能的选项都尝试过,且没有任何一个成功匹配时,才会导致编译失败。

cpp 复制
// STRUCT TEMPLATE enable_if
template <bool _Test, class _Ty = void>   //泛化版本
struct enable_if {}; // no member "type" when !_Test

template <class _Ty> // 只有这个偏特化版本存在,才存在一个名字叫做 type 的类型别名(类型)
struct enable_if<true, _Ty> { // type is _Ty for _Test
	using type = _Ty;
};

应用

控制函数返回值类型

对于模板函数,有时希望根据不同的模板参数返回不同类型的值,进而给函数模板也赋予类型模板特化的性质。

示例如下:

cpp 复制
template <typename _Tp>
typename enable_if<std::is_integral<_Tp>::value,bool>::type is_odd(_Tp i){return i&0x1;}
void test_is_odd(){
    std::cout << std::boolalpha << is_odd(10) << std::endl;
}

限制模板函数的参数类型

在某些场景下,我们需要实现只有特定类型可以调用的模板函数。如下代码所示,通过对返回值使用std::enable_if和在模板参数中使用std::enable_if均实现了只允许整形参数调用函数的功能。

cpp 复制
// enable_if example: two ways of using enable_if
#include <iostream>
#include <type_traits>

// 1. the return type (bool) is only valid if T is an integral type:
template <class T>
typename std::enable_if<std::is_integral<T>::value,bool>::type
is_odd (T i) {return bool(i%2);}

// 2. the second template argument is only valid if T is an integral type:
template < class T,
 class = typename std::enable_if<std::is_integral<T>::value>::type>
bool is_even (T i) {return !bool(i%2);}

int main() {
    short int i = 1;  // code does not compile if type of i is not integral
    std::cout << std::boolalpha;
    std::cout << "i is odd: " << is_odd(i) << std::endl;
    std::cout << "i is even: " << is_even(i) << std::endl;
	return 0;
}

当使用float类型参数调用函数时,程序会报错:

error: no matching function for call to 'is_odd(float&)'

用模版限制函数的参数类型为整形或者字符串类型,除了重载可以考虑用模版函数实现,如下:

cpp 复制
#include <iostream>
#include <type_traits>
#include <string>
 
template<typename T>
std::enable_if_t<std::is_integral<T>::value || std::is_same<std::string, T>::value, void>
judge(T&&) {
    std::cout << "This type is supported." << std::endl;
}

int main() {
    int a = 10;
    std::string b = "Hello, world!";
    double c = 3.14;
 
    judge(a);
    judge(b);
    //judge(c);  // This will cause a compile error.
 
    return 0;
}

模板类型偏特化

在使用模板编程时,可以利用std::enable_if的特性根据模板参数的不同特性进行不同的类型选择。

如下所示,我们可以实现一个检测变量是否为智能指针的实现:

cpp 复制
#include <iostream>
#include <type_traits>
#include <memory>
 
template <typename T>
struct is_smart_pointer_helper : public std::false_type {};
 
template <typename T>
struct is_smart_pointer_helper<std::shared_ptr<T> > : public std::true_type {};
 
template <typename T>
struct is_smart_pointer_helper<std::unique_ptr<T> > : public std::true_type {};
 
template <typename T>
struct is_smart_pointer_helper<std::weak_ptr<T> > : public std::true_type {};
 
template <typename T>
struct is_smart_pointer : public is_smart_pointer_helper<typename std::remove_cv<T>::type> {};
 
template <typename T>
typename std::enable_if<is_smart_pointer<T>::value,void>::type 
    check_smart_pointer(const T& t)
{
  std::cout << "is smart pointer" << std::endl;
}
 
template <typename T>
typename std::enable_if<!is_smart_pointer<T>::value,void>::type 
    check_smart_pointer(const T& t)
{
  std::cout << "not smart pointer" << std::endl;
}
 
int main()
{
    int* p(new int(2));
    std::shared_ptr<int> pp(new int(2));
    std::unique_ptr<int> upp(new int(4));

    check_smart_pointer(p);
    check_smart_pointer(pp);
    check_smart_pointer(upp);

    return 0;
}

程序输出:

not smart pointer is smart pointer is smart pointer