跟我学C++编程中级篇——std::enable_if的使用

一、std::enable_if介绍

对于SFINAE（不清楚的可以翻一下以前的相关文章）开发者来说，std::enable_if是绕不开的一个小话题。在C++11至C++20间，其在模板的元编程中起到了重要的作用。不过在C++20后Cocepts可以实现更清晰更简单的方式。它的定义方式为：

template< bool B, class T = void >
struct enable_if;

从C++14起还提供了一个辅助的类型，用来更简单的元编程中使用：

template< bool B, class T = void >
using enable_if_t = typename enable_if<B,T>::type;

其实非常好理解，这个模板结构体的第一个参数是bool型，第二个默认是个void，就是说，第一个参数决定了是否启用第二个参数。其具体的实现可能为：

template<bool B, class T = void>
struct enable_if {};
 
template<class T>
struct enable_if<true, T> { typedef T type; };

这下就明白了吧。
需要注意的是，它的使用错误的情况：

 
struct T {
    enum { int_t,float_t } m_type;
    template <typename Integer,
              typename = std::enable_if_t<std::is_integral_v<Integer>>
    >
    T(Integer) : m_type(int_t) {}
 
    template <typename Floating,
              typename = std::enable_if_t<std::is_floating_point_v<Floating>>
    >
    T(Floating) : m_type(float_t) {} // 错误：无法被重载
};

正确的应该是：

#include <iostream>

using namespace std;
struct T {
  enum { int_t, float_t } m_type;
  template <typename Integer, std::enable_if_t<std::is_integral_v<Integer>, int> = 0> T(Integer) : m_type(int_t) {}

  template <typename Floating, std::enable_if_t<std::is_floating_point_v<Floating>, int> = 0>
  T(Floating) : m_type(float_t) {} // OK
};
int main() {
  int d = 0;
  float dd = 0.0f;
  T t(d);
  T tt(dd);
  
  return 0;
}

//其编译后为：
#include <iostream>
using namespace std;
struct T
{
  enum 
  {
    int_t, 
    float_t
  };
  
  enum (unnamed) m_type;
  template<typename Integer, std::enable_if_t<std::is_integral_v<Integer>, int>  = 0>
  inline T(Integer)
  : m_type{int_t}
  {
  }
  
  /* First instantiated from: insights.cpp:15 */
  #ifdef INSIGHTS_USE_TEMPLATE
  template<>
  inline T<int, 0>(int)
  : m_type{int_t}
  {
  }
  #endif 
  
  template<typename Floating, std::enable_if_t<std::is_floating_point_v<Floating>, int>  = 0>
  inline T(Floating)
  : m_type{float_t}
  {
  }
  
  /* First instantiated from: insights.cpp:16 */
  #ifdef INSIGHTS_USE_TEMPLATE
  template<>
  inline T<float, 0>(float)
  : m_type{float_t}
  {
  }
  #endif  
  
};


int main()
{
  int d = 0;
  float dd = 0.0F;
  T t = T(d);
  T tt = T(dd);
  return 0;
}

其实很好理解，看编译后的场景就可以看出来，如果没有后面的 =0,模板的显示实例化不会对无默认实参的参数进行推导，这个可以参看一下模板的等价。
另外，参进行接口开发时，需要注意ABI的规范，有些规范对模板的处理是有差异的，具体的要看相关的规范规定。

二、应用场景

std::enable_if的应用主要有三种场景：
1、用来进行模板的偏特化处理
2、用来控制函数的返回值
3、用来控制函数的类型限定（显示实例化形成重载）
具体的例子在后面的实例中给出。
在C++20中，可以使用Concepts来更好的完成相关的功能，下面看一个小例子：

#include <iostream>
#include <concepts>

template<typename T>
concept Integral = std::is_integral<T>::value;

template<Integral  T>
T Add(T x) {
    return x +10;
}
template <typename T, class = typename std::enable_if<std::is_integral<T>::value>::type> 
//template <typename T, class = typename std::enable_if_t<std::is_integral_v<T>>> //c++17
bool limit(T t) {
  std::cout << "cur value t:" << t << std::endl;
  return t > 0;
}
int main() {
    std::cout << Add(6) << std::endl; 
    //std::cout << Add(6.1) << std::endl;  //compile ERROR
    
  //limit(3.0f);
  limit(3);
    return 0;
}

是不是觉得简单很多，也更容易理解。

三、实例

下面就分三种情况通过实例进行分析：

#include <iostream>
#include <memory>
//1、 class partial specialization
template <class T, class Enable = void> class Example {
public:
  Example() { std::cout << "call stand Example instance!" << std::endl; }
};

template <class T> class Example<T, typename std::enable_if<std::is_floating_point<T>::value>::type> {
public:
  Example() { std::cout << "call float Example instance!" << std::endl; }
};

// 2、return type
template <typename T> typename std::enable_if<std::is_integral<T>::value, int>::type GetData(T t) {
  std::cout << "GetData return type is int" << std::endl;
  return t;
}
template <typename T> typename std::enable_if<!std::is_integral<T>::value, int>::type GetData(T t) {
  std::cout << "GetData return type is not int" << std::endl;
  return t;
}

// 3、as an additional function argument (not applicable to operator overloads),
template <typename T, typename std::enable_if<std::is_integral<T>::value, int>::type * = nullptr> void GetPars(T t) {
  std::cout << "GetData parameter type is int" << std::endl;
}

template <typename T, typename std::enable_if<!std::is_integral<T>::value, int>::type = 0> void GetPars(T t) {
  std::cout << "GetData parameter type is not int" << std::endl;
}
void testParameter() {
  int d = 10;
  GetPars(d);
  float f = 10.0f;
  GetPars(f);
}
void testReturn() {
  int d = 3;
  float f = 3.0f;
  d = GetData(d);
  f = GetData(f);
  std::cout << " call GetData int : " << d << "," << typeid(d).name() << std::endl;
  std::cout << " call GetData float : " << f << "," << typeid(f).name() << std::endl;
}

int main() {
  auto ptr_int = std::make_shared<Example<int>>();
  auto ptr_float = std::make_shared<Example<float>>();

  testParameter();
  testReturn();
  return 0;
}

编译出来：

#include <iostream>
#include <memory>
//1、 class partial specialization
template<class T, class Enable = void>
class Example
{
  
  public: 
  inline Example()
  {
    std::operator<<(std::cout, "call stand Example instance!").operator<<(std::endl);
  }
  
};

/* First instantiated from: shared_ptr_base.h:1742 */
#ifdef INSIGHTS_USE_TEMPLATE
template<>
class Example<int, void>
{
  
  public: 
  inline Example()
  {
    std::operator<<(std::cout, "call stand Example instance!").operator<<(std::endl);
  }
  
};

#endif
/* First instantiated from: shared_ptr_base.h:1742 */
#ifdef INSIGHTS_USE_TEMPLATE
template<>
class Example<float, void>
{
  public: 
  inline Example()
  {
    std::operator<<(std::cout, "call float Example instance!").operator<<(std::endl);
  }
};

#endif
template<class T>
class Example<T, typename std::enable_if<std::is_floating_point<T>::value>::type>
{ 
  public: 
  inline Example()
  {
    std::operator<<(std::cout, "call float Example instance!").operator<<(std::endl);
  } 
};

// 2、return type
template<typename T>
typename std::enable_if<std::is_integral<T>::value, int>::type GetData(T t)
{
  std::operator<<(std::cout, "GetData return type is int").operator<<(std::endl);
  return t;
}

/* First instantiated from: insights.cpp:41 */
#ifdef INSIGHTS_USE_TEMPLATE
template<>
typename std::enable_if<std::is_integral<int>::value, int>::type GetData<int>(int t)
{
  std::operator<<(std::cout, "GetData return type is int").operator<<(std::endl);
  return t;
}
#endif

template<typename T>
typename std::enable_if<!std::is_integral<T>::value, int>::type GetData(T t)
{
  std::operator<<(std::cout, "GetData return type is not int").operator<<(std::endl);
  return t;
}

/* First instantiated from: insights.cpp:42 */
#ifdef INSIGHTS_USE_TEMPLATE
template<>
typename std::enable_if<!std::is_integral<float>::value, int>::type GetData<float>(float t)
{
  std::operator<<(std::cout, "GetData return type is not int").operator<<(std::endl);
  return static_cast<int>(t);
}
#endif

// 3、as an additional function argument (not applicable to operator overloads),
//下面的两种形式都可以
template<typename T, typename std::enable_if<std::is_integral<T>::value, int>::type *  = nullptr>
void GetPars(T t)
{
  std::operator<<(std::cout, "GetData parameter type is int").operator<<(std::endl);
}

/* First instantiated from: insights.cpp:34 */
#ifdef INSIGHTS_USE_TEMPLATE
template<>
void GetPars<int, nullptr>(int t)
{
  std::operator<<(std::cout, "GetData parameter type is int").operator<<(std::endl);
}
#endif

template<typename T, typename std::enable_if<!std::is_integral<T>::value, int>::type  = 0>
void GetPars(T t)
{
  std::operator<<(std::cout, "GetData parameter type is not int").operator<<(std::endl);
}

/* First instantiated from: insights.cpp:36 */
#ifdef INSIGHTS_USE_TEMPLATE
template<>
void GetPars<float, 0>(float t)
{
  std::operator<<(std::cout, "GetData parameter type is not int").operator<<(std::endl);
}
#endif

void testParameter()
{
  int d = 10;
  GetPars(d);
  float f = 10.0F;
  GetPars(f);
}

void testReturn()
{
  int d = 3;
  float f = 3.0F;
  d = GetData(d);
  f = static_cast<float>(GetData(f));
  std::operator<<(std::operator<<(std::operator<<(std::cout, " call GetData int : ").operator<<(d), ","), typeid(d).name()).operator<<(std::endl);
  std::operator<<(std::operator<<(std::operator<<(std::cout, " call GetData float : ").operator<<(f), ","), typeid(f).name()).operator<<(std::endl);
}

int main()
{
  std::shared_ptr<Example<int, void> > ptr_int = std::make_shared<Example<int, void> >();
  std::shared_ptr<Example<float, void> > ptr_float = std::make_shared<Example<float, void> >();
  testParameter();
  testReturn();
  return 0;
}

对比分析一下编译前和编译后的结果，基本就能明白std::enable_if的应用方式了。然后再匹配一些相关的元函数或者自己编写的特殊的模板参数的控制，就可以实现一些技巧性的编程。有的时候，不是基础知识没掌握，是掌握后无法灵活的应用到工程里。

四、总结

通过上面的分析和对比，基本对std::enable_if有了一个整体上的了解。还是那句话，要想用得得心应手，就得多写代码，多用。特别是模板甚至是元编程，在实际上用得本来就少，再不怎么动手，即使会用了，慢慢也会生疏，以至于忘记。
各人有各人的方法，不用拘于一种天地。目的只有一个，会活学活用即可。