Boost C++ 库

……世界上最受推崇和设计精良的 C++ 库项目之一。 Herb SutterAndrei Alexandrescu,《C++ 编码规范

PrevUpHomeNext

调用特征

简介
复制构造
示例
基本原理
参考

<boost/call_traits.hpp> 的所有内容都在 namespace boost 中定义。

模板类 call_traits<T> 封装了将某个类型 T 的参数传递到函数或从函数传递出的“最佳”方法,它包含一系列如下表所示的 typedefcall_traits 的目的是确保像 “对引用的引用” 这样的问题永远不会发生,并以尽可能高效的方式传递参数,如 示例 所示。在每种情况下,如果您的现有做法是使用左侧定义的类型,则将其替换为右侧定义的 call_traits 类型。

请注意,对于不支持部分特化或成员模板的编译器,使用 call_traits 不会带来任何好处:在这种情况下,call_traits 定义的类型将始终与现有做法相同。此外,如果编译器只支持成员模板而不支持部分模板特化(例如 Visual C++ 6),则 call_traits 不能与数组类型一起使用,尽管它仍然可以用来解决对引用的引用问题。

表 1.2. call_traits 类型

现有做法

call_traits 等效项

描述

备注

T

(按值返回)

call_traits<T>::value_type

定义表示类型 T 的“值”的类型。

将其用于按值返回的函数,或可能用于类型 T 的存储值。

2

T&

(返回值)

call_traits<T>::reference

定义表示类型 T 的引用的类型。

用于通常返回 T& 的函数。

1

const T&

(返回值)

call_traits<T>::const_reference

定义表示类型 T 的常量引用的类型。

用于通常返回 const T& 的函数。

1

const T&

(函数参数)

call_traits<T>::param_type

定义表示将类型 T 的参数传递给函数的“最佳”方式的类型。

1,3


备注

  1. 如果 T 已经是引用类型,则 call_traits 的定义方式使得不会出现 “对引用的引用”(需要部分特化)。
  2. 如果 T 是数组类型,则 call_traitsvalue_type 定义为“指向类型的常量指针”,而不是“类型的数组”(需要部分特化)。请注意,如果您将 value_type 用作存储值,则这将导致存储“指向数组的常量指针”,而不是数组本身。这可能是好事也可能不是好事,具体取决于您实际需要什么(换句话说,要注意!)。
  3. 如果 T 是小的内置类型或指针,则 param_type 定义为 T const,而不是 T const&。如果函数体中的循环依赖于传递的参数,这可以提高编译器优化循环的能力,否则传递参数的语义保持不变(需要部分特化)。

下表定义了哪些 call_traits 类型始终可以从哪些其他类型复制构造。

表 1.3. 哪些 call_traits 类型始终可以从哪些其他类型复制构造

T

value_type

reference

const_reference

param_type

T

当且仅当 T 可复制构造时

当且仅当 T 可复制构造时

value_type

当且仅当 T 可复制构造时

当且仅当 T 可复制构造时

reference

当且仅当 T 可复制构造时

当且仅当 T 可复制构造时

const_reference

当且仅当 T 可复制构造时

param_type

当且仅当 T 可复制构造时

当且仅当 T 可复制构造时


如果 T 是可赋值类型,则可以进行以下赋值:

表 1.4. 哪些 call_traits 类型可以从哪些其他类型赋值

T

value_type

reference

const_reference

param_type

T

-

-

-

value_type

-

-

-

reference

-

-

-

const_reference

-

-

-

param_type

-

-

-


下表显示了 call_traits 对各种类型的影响。

表 1.5. call_traits 类型的示例

call_traits::value_type

call_traits::reference

call_traits::const_reference

call_traits::param_type

应用于

my_class

my_class

my_class&

const my_class&

my_class const&

所有用户定义类型

int

int

int&

const int&

int const

所有小的内置类型

int*

int*

int*&

int* const &

int* const

所有指针类型

int&

int&

int&

const int&

int&

所有引用类型

const int&

const int&

const int&

const int&

const int&

所有常量引用类型

int[3]

const int*

int(&)[3]

const int(&)[3]

const int* const

所有数组类型

const int[3]

const int*

const int(&)[3]

const int(&)[3]

const int* const

所有常量数组类型


该表假设编译器支持部分特化:如果不支持,则所有类型的行为都与“my_class”条目的行为相同,并且 call_traits 不能与引用或数组类型一起使用。

以下类是一个简单的类,它按值存储某种类型 T(参见 call_traits_test.cpp 文件)。目的是说明如何使用每个可用的 call_traits typedef

template <class T>
struct contained
{
   // define our typedefs first, arrays are stored by value
   // so value_type is not the same as result_type:
   typedef typename boost::call_traits<T>::param_type       param_type;
   typedef typename boost::call_traits<T>::reference        reference;
   typedef typename boost::call_traits<T>::const_reference  const_reference;
   typedef T                                                value_type;
   typedef typename boost::call_traits<T>::value_type       result_type;

   // stored value:
   value_type v_;

   // constructors:
   contained() {}
   contained(param_type p) : v_(p){}
   // return byval:
   result_type value() { return v_; }
   // return by_ref:
   reference get() { return v_; }
   const_reference const_get()const { return v_; }
   // pass value:
   void call(param_type p){}

};

考虑 std::binder1st 的定义。

template <class Operation>
class binder1st :
   public std::unary_function<typename Operation::second_argument_type, typename Operation::result_type>
{
protected:
   Operation op;
   typename Operation::first_argument_type value;
public:
   binder1st(const Operation& x, const typename Operation::first_argument_type& y);
   typename Operation::result_type operator()(const typename Operation::second_argument_type& x) const;
};

现在考虑一下在函子将其第二个参数作为引用传递的相对常见情况下会发生什么,这意味着 Operation::second_argument_type 是引用类型,operator() 现在将最终接收对引用的引用作为参数,而这目前是非法的。这里的解决方案是修改 operator() 以使用 call_traits

typename Operation::result_type operator()(typename call_traits<typename Operation::second_argument_type>::param_type x) const;

如果Operation::second_argument_type是引用类型,则参数将作为引用传递,不会出现“引用到引用”的情况。

如果我们将数组名作为std::make_pair的一个(或两个)参数传递,则模板参数推导会将传递的参数推导为“指向T数组的常量引用”,字符串字面量(实际上是数组字面量)也适用此规则。因此,它不会返回一对指针,而是尝试返回一对数组,由于数组类型不可复制构造,因此代码无法编译。一种解决方案是将参数显式转换为std::make_pair的指针,但是call_traits提供了一种更好的自动解决方案,即使在类型转换可能出错的泛型代码中也能安全地工作。

template <class T1, class T2>
std::pair<
   typename boost::call_traits<T1>::value_type,
   typename boost::call_traits<T2>::value_type>
      make_pair(const T1& t1, const T2& t2)
{
   return std::pair<
      typename boost::call_traits<T1>::value_type,
      typename boost::call_traits<T2>::value_type>(t1, t2);
}

这里,如果推导出的类型是数组,则推导出的参数类型将自动降级为指针,标准绑定器和适配器中也会出现类似的情况:原则上,在任何“包装”类型为推导出的临时变量的函数中都会出现这种情况。请注意,std::make_pair的函数参数不是用call_traits表示的:这样做会阻止模板参数推导的正常运行。

call_traits模板将“优化”小内置类型作为函数参数的传递方式。这主要在参数在循环体中使用时有效。

在下面的示例(参见fill_example.cpp)中,std::fill的版本通过两种方式进行了优化:如果传递的类型是单字节内置类型,则使用std::memset来执行填充,否则使用传统的 C++ 实现,但是使用call_traits“优化”传递的参数。

template <bool opt>
struct filler
{
   template <typename I, typename T>
   static void do_fill(I first, I last, typename boost::call_traits<T>::param_type val)
   {
      while(first != last)
      {
         *first = val;
         ++first;
      }
   }
};

template <>
struct filler<true>
{
   template <typename I, typename T>
   static void do_fill(I first, I last, T val)
   {
      std::memset(first, val, last-first);
   }
};

template <class I, class T>
inline void fill(I first, I last, const T& val)
{
   enum { can_opt = boost::is_pointer<I>::value
                   && boost::is_arithmetic<T>::value
                   && (sizeof(T) == 1) };
   typedef filler<can_opt> filler_t;
   filler_t::template do_fill<I,T>(first, last, val);
}

对于小型内置类型,这之所以“最优”,是因为将值作为T const而不是const T&传递,编译器能够同时确定该值是常量且没有别名。有了这些信息,编译器能够将传递的值缓存到寄存器中、展开循环或使用显式并行指令:如果支持这些操作的话。您能从中获得多少好处取决于您的编译器——我们确实需要一些准确的基准测试软件作为 boost 的一部分来处理这种情况。

请注意,fill 的函数参数不是用call_traits表示的:这样做会阻止模板参数推导的正常运行。fill 充当“瘦包装器”,用于执行模板参数推导,编译器将完全优化对 fill 的调用,将其替换为对filler<>::do_fill的调用,后者确实使用了call_traits

以下说明旨在简要描述call_traits中所做选择的理由。

所有用户定义类型都遵循“现有实践”,无需评论。

小型内置类型(标准称为基本类型)仅在param_type typedef方面与现有实践有所不同。在这种情况下,传递T const与现有实践兼容,但在某些情况下可能会提高性能(参见示例 4)。无论如何,这都应该不会比现有实践更差。

指针与小型内置类型的理由相同。

对于引用类型,其理由遵循示例 2——不允许引用到引用,因此必须定义call_traits成员,以避免这些问题。有一项提案建议修改语言,以便“引用到引用就是一个引用”(问题 #106,由 Bjarne Stroustrup 提交)。call_traits<T>::value_typecall_traits<T>::param_type都提供了与该提案相同的效果,而无需更改语言。换句话说,这是一个变通方法。

对于数组类型,将数组作为参数的函数会将数组类型降级为指针类型:这意味着实际参数的类型与其声明类型不同,这会在依赖于参数声明类型的模板代码中造成无尽的问题。

例如

template <class T>
struct A
{
   void foo(T t);
};

在这种情况下,如果我们实例化A<int[2]>,则传递给成员函数foo的参数的声明类型是int[2],但其实际类型是const int*。如果我们尝试在函数体中使用类型T,则我们的代码很可能无法编译。

template <class T>
void A<T>::foo(T t)
{
   T dup(t); // doesn't compile for case that T is an array.
}

通过使用call_traits,从数组到指针的降级是显式的,并且参数的类型与其声明类型相同。

template <class T>
struct A
{
   void foo(typename call_traits<T>::value_type t);
};

template <class T>
void A<T>::foo(typename call_traits<T>::value_type t)
{
   typename call_traits<T>::value_type dup(t); // OK even if T is an array type.
}

对于value_type(按值返回),同样只能返回指针,而不能返回整个数组的副本,同样call_traits使降级变得显式。value_type成员在必须将数组显式降级为指针时非常有用——示例 3提供了测试用例。

脚注:call_traits的数组特化是最不容易理解的call_traits特化之一。如果给定的语义对您造成了特定问题,或者没有解决特定的与数组相关的问题,那么我很想知道。但是,大多数人可能永远不需要使用这种特化。

参考

namespace boost {
  template<typename T> struct call_traits;

  template<typename T, std::size_t N> struct call_traits<const T[N]>;
  template<typename T> struct call_traits<T &>;
  template<typename T, std::size_t N> struct call_traits<T[N]>;
}

PrevUpHomeNext