C++11 tuple

本文根据众多互联网博客内容整理后形成，引用内容的版权归原始作者所有，仅限于学习研究使用，不得用于任何商业用途。

在标准库中，tuple（一个N元组：N-tuple）被定义为N个值的有序序列。在这里，N可以是从0到文件中所定义的最大值中的任何一个常数。你可以认为tuple是一个未命名的结构体，该结构体包含了特定的tuple元素类型的数据成员。特别需要指出的是，tuple中元素是被紧密地存储的（位于连续的内存区域），而不是链式结构。

可以显式地声明tuple的元素类型，也可以通过make_tuple()来推断出元素类型。另外，可以使用get()来通过索引（和C++的数组索引一样，从0而不是从1开始）来访问tuple中的元素。

tuple t2(“Kylling”,123);

// t的类型被推断为tuple
auto t = make_tuple(string(“Herring”),10, 1.23);    
// 获取元组中的分量
string s = get<0>(t);
int x = get<1>(t);
double d = get<2>(t);

有时候，我们需要一个编译时异构元素列表（a heterogeneous list of elements at compile time），但又不想定义一个有名字的结构来保存。这种情况下，我们就可以使用tuple（直接地或间接地）. 例如，我们在std::function and std::bind中使用tuple来保存参数。

最常用的tuple是2-tuple(二元组)，也就是一个pair。但是标准库已经定义了pair：std::pair (20.3.3 Pairs)。 我们可以使用pair来初始化一个tuple，然而反之则不可。

另外，需要为tuple中的元素类型定义比较操作（==, !=, < , <=, >, 和 >=）.

tuple元组定义了一个有固定数目元素的容器,其中的每个元素类型都可以不相同,这与其他容器有着本质的区别.是对pair的泛化。

首先来介绍元组的创建和元组元素的访问。通过make_tuple()创建元组，通过get<>()来访问元组的元素。通过下面这段程序来认识这两个函数的用法：

#include 
#include 
#include 

int main()
{
    auto t1 = std::make_tuple(10, "Test", 3.14);
    std::cout << "The value of t1 is "
              << "(" << std::get<0>(t1) << ", " << std::get<1>(t1)
              << ", " << std::get<2>(t1) << ")\n";

    int n = 1;
    auto t2 = std::make_tuple(std::ref(n), n);//ref表示引用
    n = 7;

    std::cout << "The value of t2 is "
              << "(" << std::get<0>(t2) << ", " << std::get<1>(t2) << ")\n";
}

运行结果为：

The value of t1 is (10, Test, 3.14)
The value of t2 is (7, 1)

接下来介绍tie()函数。 tie()函数可以将变量连接到一个给定的tuple上，生成一个元素类型全是引用的tuple,相当于make_tuple(ref(a),ref(b),…)。可以通过tie()函数的使用方便的对tuple进行“解包”操作。看下面的代码：

#include 
#include 
int main ()
{
  int myint;
  char mychar;
  float myfloat;

  std::tuple mytuple;
  mytuple = std::make_tuple (10, 2.6, 'a');          // packing values into tuple

  //std::tie (myint, std::ignore, mychar) = mytuple;   // unpacking tuple into variables  【1】
  std::tie (myint,myfloat, mychar) = mytuple;

  std::cout << "myint contains: " << myint << std::endl;
  std::cout << "mychar contains: " << mychar << std::endl;
  std::cout << "myfloat contains: "<< myfloat <(mytuple) = 100;//修改tuple的值

  std::cout <<"After assignment myint contains: "<< std::get<0>(mytuple) << std::endl;

  return 0;
}

运行结果：

myint contains: 10
mychar contains: a
myfloat contains: 2.6
After assignment myint contains: 100
注：正如【1】处我们可以使用std::ignore,从而不用关联tuple中的第二个元素.

最后介绍一个tuple_cat()函数，通过该函数可以将多个tuple连接起来形成一个tuple（注：在VC11中只能连接两个tuple并不是真正的多个tuple）。

#include 
#include 
#include 
#include 

int main ()
{
  std::tuple mytuple (3.14,"pi");
  std::pair mypair (10,'a');

  auto myauto = std::tuple_cat ( mytuple, mypair );

  std::cout << "myauto contains: " << std::endl;
  std::cout << std::get<0>(myauto) << std::endl;
  std::cout << std::get<1>(myauto) << std::endl;
  std::cout << std::get<2>(myauto) << std::endl;
  std::cout << std::get<3>(myauto) << std::endl;
 
  return 0;
}

运行结果：

myauto contains:
3.14
pi
10
a

这次要讲的内容是：c++11中的tuple（元组）。tuple看似简单，其实它是简约而不简单，可以说它是c++11中一个既简单又复杂的东东，关于它简单的一面是它很容易使用，复杂的一面是它内部隐藏了太多细节，要揭开它神秘的面纱时又比较困难。

tuple是一个固定大小的不同类型值的集合，是泛化的std::pair。和c#中的tuple类似，但是比c#中的tuple强大得多。我们也可以把他当做一个通用的结构体来用，不需要创建结构体又获取结构体的特征，在某些情况下可以取代结构体使程序更简洁，直观。

基本用法

构造一个tuple

tupletp = make_tuple(sendPack,nSendSize); //构造一个tuple

这个tuple等价于一个结构体

struct A
{
  char* p;
  int len;
};

用tupletp就可以不用创建这个结构体了，而作用是一样的，是不是更简洁直观了。还有一种方法也可以创建元组，用std::tie，它会创建一个元组的左值引用。

auto tp = return std::tie(1, "aa", 2);
//tp的类型实际是：
std::tuple

再看看如何获取它的值：

const char* data = std::get<0>(); //获取第一个值
int len = std::get<1>(); //获取第二个值

还有一种方法也可以获取元组的值，通过std::tie解包tuple

int x,y;
string a;
std::tie(x,a,y) = tp;

通过tie解包后，tp中三个值会自动赋值给三个变量。

解包时，我们如果只想解某个位置的值时，可以用std::ignore占位符来表示不解某个位置的值。比如我们只想解第三个值时：

  std::tie(std::ignore,std::ignore,y) = tp; //只解第三个值了

还有一个创建右值的引用元组方法：forward_as_tuple。

std::mapm;
m.emplace(std::piecewise_construct,
std::forward_as_tuple(10),
std::forward_as_tuple(20, 'a'));

它实际上创建了一个类似于std::tuple类型的tuple。

我们还可以通过tuple_cat连接多个tupe

int main()
{
  std::tuple t1(10, "Test", 3.14);
  int n = 7;
  auto t2 = std::tuple_cat(t1, std::make_pair("Foo", "bar"), t1, std::tie(n));
  n = 10;
  print(t2);
}

输出结果：

  (10, Test, 3.14, Foo, bar, 10, Test, 3.14, 10)

到这里tuple的用法介绍完了，是不是很简单，也很容易使用，相信你使用它之后就离不开它了。我前面说过tuple是简约而不简单。它有很多高级的用法。它和模板元关系密切,要介绍它的高级用法的时候，读者需要一定的模板元基础，如果你只是把它当一个泛型的pair去使用时，这部分可以不看，如果你想用它高级用法的时候就往下看。让我们要慢慢揭开tuple神秘的面纱。

tuple的高级用法

获取tuple中某个位置元素的类型

---

通过std::tuple_element获取元素类型。

template
void Fun(Tuple& tp)
{  
  std::tuple_element<0,Tuple>::type first = std::get<0> (mytuple);
  std::tuple_element<1,Tuple>::type second = std::get<1> (mytuple);
}

获取tuple中元素的个数：

tuple t;
int size = std::tuple_size::value;

遍历tuple中的每个元素

---

因为tuple的参数是变长的，也没有for_each函数，如果我们想遍历tuple中的每个元素，需要自己写代码实现。比如我要打印tuple中的每个元素。

template
struct TuplePrinter { 
  static void print(const Tuple& t) 
  { 
    TuplePrinter::print(t); 
    std::cout << ", " << std::get(t); 
  }
};

template
struct TuplePrinter{ 
  static void print(const Tuple& t) 
  { 
    std::cout << std::get<0>(t); 
  }
};

template
void PrintTuple(const std::tuple& t)
{ 
  std::cout << "(";
  TuplePrinter::print(t); 
  std::cout << ")\n";
}

根据tuple元素值获取其对应的索引位置

---

namespace detail{ 

  template 
  struct find_index { 
    static int call(std::tuple const& t, T&& val) 
    { 
      return (std::get(t) == val) ? I - 1 : 
        find_index::call(t, std::forward(val)); 
    } 
  }; 

  template 
  struct find_index<0, T, Args...>
  { 
    static int call(std::tuple const& t, T&& val) 
    { 
      return (std::get<0>(t) == val) ? 0 : -1; 
    } 
  };

}
template
int find_index(std::tuple const& t, T&& val)
{ 
  return detail::find_index<0, sizeof...(Args) - 1, T, Args...>:: 
    call(t, std::forward(val));
}

int main()
{ 
  std::tuple a(2, 3, 1, 4); 
  std::cout << find_index(a, 1) << std::endl; // Prints 2 
  std::cout << find_index(a, 2) << std::endl; // Prints 0 
  std::cout << find_index(a, 5) << std::endl; // Prints -1 (not found)
}

展开tuple，并将tuple元素作为函数的参数。这样就可以根据需要对tuple元素进行处理了

---

#include 
#include 
#include 

template
struct Apply {
  template
  static inline auto apply(F && f, T && t, A &&... a)
    -> decltype
    (
       Apply::apply
      (
        ::std::forward(f), 
        ::std::forward(t),
        ::std::get(::std::forward(t)), 
        ::std::forward(a)...
      )
    )
{
    return Apply::apply
    (
      ::std::forward(f), 
      ::std::forward(t),
      ::std::get(::std::forward(t)), 
      ::std::forward(a)...
    );
  }
};

template<>
struct Apply<0> {
  template
  static inline auto apply(F && f, T &&, A &&... a)
    -> decltype
    (
      ::std::forward(f) 
      (::std::forward(a)...)
    )
  {
    return ::std::forward(f)(::std::forward (a)...);
  }
};

template
inline auto apply(F && f, T && t)
  -> decltype
  (
    Apply< ::std::tuple_size::type>::value>::apply
    (
      ::std::forward(f), 
      ::std::forward(t)
    )
  )
{
  return Apply< ::std::tuple_size::type>::value>::apply
  (
    ::std::forward(f), 
    ::std::forward(t)
  );
}

void one(int i, double d)
{
  std::cout << "function one(" << i << ", " << d << ");\n";
}

int two(int i)
{
  std::cout << "function two(" << i << ");\n";
  return i;
}

//测试代码
int main()
{
  std::tuple tup(23, 4.5);
  apply(one, tup);
  int d = apply(two, std::make_tuple(2));

  return 0;
}

看到这里，想必大家对tuple有了一个全面的认识了吧，怎么样，它是简约而不简单吧。对模板元不熟悉的童鞋可以不看tuple高级用法部分，不要为看不懂而捉急，没事的，高级部分一般用不到，知道基本用法就够用了。

tuple和vector比较：
vector只能容纳同一种类型的数据，tuple可以容纳任意类型的数据；

vector和variant比较：
二者都可以容纳不同类型的数据，但是variant的类型个数是固定的，而tuple的类型个数不是固定的，是变长的，更为强大。

参考资料
【c++11FAQ】标准库中的元组（std::tuple）
C++11 tuple——KingsLanding
C++11改进我们的程序之简化我们的程序（七）tuple
介绍C++11标准的变长参数模板
泛化之美--C++11可变模版参数的妙用