std::tuple

 

C++

编译器支持

自立实现与有宿主实现

语言

标准库

标准库标头

具名要求

功能特性测试宏 (C++20)

语言支持库

概念库 (C++20)

元编程库 (C++11)

诊断库

通用工具库

字符串库

容器库

迭代器库

范围库 (C++20)

算法库

数值库

本地化库

输入/输出库

文件系统库 (C++17)

正则表达式库 (C++11)

并发支持库 (C++11)

技术规范

符号索引

外部库

 

工具库

语言支持 类型支持（基本类型、 RTTI） 库功能特性测试宏 (C++20) 动态内存管理 程序工具 协程支持 (C++20) 变参数函数 is_constant_evaluated (C++20) is_within_lifetime (C++26) initializer_list (C++11) source_location (C++20) 三路比较 (C++20) three_way_comparablethree_way_comparable_with (C++20)(C++20) strong_ordering (C++20) weak_ordering (C++20) partial_ordering (C++20) common_comparison_category (C++20) compare_three_way_result (C++20) compare_three_way (C++20) strong_order (C++20) weak_order (C++20) partial_order (C++20) compare_strong_order_fallback (C++20) compare_weak_order_fallback (C++20) compare_partial_order_fallback (C++20) is_eqis_neqis_ltis_lteqis_gtis_gteq (C++20)(C++20)(C++20)(C++20)(C++20)(C++20)

通用工具 日期和时间 函数对象 格式化库 (C++20) bitset hash (C++11) 关系运算符 (C++20 中弃用) rel_ops::operator!=rel_ops::operator> rel_ops::operator<=rel_ops::operator>= 整数比较函数 cmp_equalcmp_lesscmp_less_than (C++20)(C++20)(C++20) cmp_not_equalcmp_greatercmp_greater_than (C++20)(C++20)(C++20) in_range (C++20) swap 与类型运算 swap ranges::swap (C++20) exchange (C++14) declval (C++11) to_underlying (C++23) forward (C++11) forward_like (C++23) move (C++11) move_if_noexcept (C++11) as_const (C++17) 常用词汇类型 pair tuple (C++11) optional (C++17) any (C++17) variant (C++17) tuple_size (C++11) tuple_element (C++11) apply (C++17) make_from_tuple (C++17) expected (C++23) 初等字符串转换 to_chars (C++17) from_chars (C++17) chars_format (C++17) to_chars_result (C++17) from_chars_result (C++17)

 

std::tuple

成员函数

tuple::tuple

tuple::operator=

tuple::swap

非成员函数

make_tuple

tie

forward_as_tuple

tuple_cat

operator==operator!=operator<operator<=operator>operator>=operator<=> (C++20 前)(C++20 前)(C++20 前)(C++20 前)(C++20 前)(C++20)

std::swap

get

推导指引(C++17)

辅助概念

tuple-like (C++23)

辅助类

tuple_size

tuple_element

uses_allocator

basic_common_reference (C++23)

common_type (C++23)

ignore

 

在标头 <tuple> 定义
template< class... Types > class tuple;		(C++11 起)

类模板 std::tuple 是固定大小的异类值汇集。它是 std::pair 的泛用形式。

如果 std::is_trivially_destructible<Ti>::value 对 Types 中的每个 Ti 都是 true，那么 tuple 的析构函数平凡。

模板形参

Types...

-

tuple 所存储的元素的类型。支持空列表。

成员函数

(构造函数)	构造新的 tuple (公开成员函数)
operator=	赋值一个 tuple 的内容给另一个 (公开成员函数)
swap	交换两个 tuple 的内容 (公开成员函数)

非成员函数

make_tuple (C++11)	创建一个 tuple 对象，其类型根据各实参类型定义 (函数模板)
tie (C++11)	创建左值引用的 tuple，或将 tuple 解包为独立对象 (函数模板)
forward_as_tuple (C++11)	创建转发引用的 tuple (函数模板)
tuple_cat (C++11)	通过连接任意数量的元组来创建一个tuple (函数模板)
std::get(std::tuple) (C++11)	元组式访问指定的元素 (函数模板)
operator==operator!=operator<operator<=operator>operator>=operator<=> (C++20 中移除)(C++20 中移除)(C++20 中移除)(C++20 中移除)(C++20 中移除)(C++20)	按字典顺序比较 tuple 中的值 (函数模板)
std::swap(std::tuple) (C++11)	特化 std::swap 算法 (函数模板)

辅助概念

tuple-likepair-like (C++23)

指定类型实现了元组协议 （std::get，std::tuple_element，std::tuple_size） (仅用于阐述的概念*)

辅助类

std::tuple_size<std::tuple> (C++11)	在编译时获得 tuple 的大小 (类模板特化)
std::tuple_element<std::tuple> (C++11)	获得指定元素的类型 (类模板特化)
std::uses_allocator<std::tuple> (C++11)	特化 std::uses_allocator 类型特征 (类模板特化)
std::basic_common_reference<std::tuple> (C++23)	确定二个 tuple 的共同引用类型 (类模板特化)
std::common_type<std::tuple> (C++23)	确定二个 tuple 的共同类型 (类模板特化)
ignore (C++11)	用 tie 解包 tuple 时用来跳过元素的占位符 (常量)

注解

N4387（作为对 C++11 的缺陷报告应用）前，函数不能用复制列表初始化返回 tuple：

std::tuple<int, int> foo_tuple() 
{
  return {1, -1};  // N4387 前错误
  return std::tuple<int, int>{1, -1};  // 始终有效
  return std::make_tuple(1, -1); // 始终有效
}

示例

运行此代码

#include <iostream>
#include <stdexcept>
#include <string>
#include <tuple>
 
std::tuple<double, char, std::string> get_student(int id)
{
    switch (id)
    {
        case 0: return {3.8, 'A', "Lisa Simpson"};
        case 1: return {2.9, 'C', "Milhouse Van Houten"};
        case 2: return {1.7, 'D', "Ralph Wiggum"};
        case 3: return {0.6, 'F', "Bart Simpson"};
    }
 
    throw std::invalid_argument("id");
}
 
int main()
{
    const auto student0 = get_student(0);
    std::cout << "ID：0，"
              << "GPA：" << std::get<0>(student0) << "，"
              << "等级：" << std::get<1>(student0) << "，"
              << "姓名：" << std::get<2>(student0) << '\n';
 
    const auto student1 = get_student(1);
    std::cout << "ID：1，"
              << "GPA：" << std::get<double>(student1) << "，"
              << "等级：" << std::get<char>(student1) << "，"
              << "姓名：" << std::get<std::string>(student1) << '\n';
 
    double gpa2;
    char grade2;
    std::string name2;
    std::tie(gpa2, grade2, name2) = get_student(2);
    std::cout << "ID：2，"
              << "GPA：" << gpa2 << "，"
              << "等级：" << grade2 << "，"
              << "姓名：" << name2 << '\n';
 
    // C++17 结构化绑定：
    const auto [gpa3, grade3, name3] = get_student(3);
    std::cout << "ID：3，"
              << "GPA：" << gpa3 << "，"
              << "等级：" << grade3 << "，"
              << "姓名：" << name3 << '\n';
}

输出：

ID：0，GPA：3.8，等级：A，姓名：Lisa Simpson
ID：1，GPA：2.9，等级：C，姓名：Milhouse Van Houten
ID：2，GPA：1.7，等级：D，姓名：Ralph Wiggum
ID：3，GPA：0.6，等级：F，姓名：Bart Simpson

缺陷报告

下列更改行为的缺陷报告追溯地应用于以前出版的 C++ 标准。

缺陷报告	应用于	出版时的行为	正确行为
LWG 2796	C++11	tuple 的析构函数的平凡性未指明	已指明

引用

• C++23 标准（ISO/IEC 14882:2023）：

• 22.4 Tuples [tuple]

• C++20 标准（ISO/IEC 14882:2020）：

• 20.5 Tuples [tuple]

• C++17 标准（ISO/IEC 14882:2017）：

• 23.5 Tuples [tuple]

• C++14 标准（ISO/IEC 14882:2014）：

• 20.4 Tuples [tuple]

• C++11 标准（ISO/IEC 14882:2011）：

• 20.4 Tuples [tuple]

参阅

pair	实现二元组，即一对值 (类模板)