std::tuple_size

 

C++

编译器支持

自由（freestanding）与宿主（hosted）

语言

标准库

标准库头文件

具名要求

特性测试宏 (C++20)

语言支持库

概念库 (C++20)

诊断库

内存管理库

元编程库 (C++11)

通用工具库

容器库

迭代器库

范围库 (C++20)

算法库

字符串库

文本处理库

数值库

日期和时间库

输入/输出库

文件系统库 (C++17)

并发支持库 (C++11)

执行控制库 (C++26)

技术规范

符号索引

外部库

 

工具库

语言支持 类型支持（基本类型、RTTI） 库特性测试宏 (C++20) 程序工具 变参函数 initializer_list (C++11) is_constant_evaluated (C++20) is_within_lifetime (C++26) source_location (C++20) 协程支持 (C++20) 契约支持 (C++26) 三路比较 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_ltis_lteq (C++20)(C++20)(C++20)   is_neqis_gtis_gteq (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 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)

 

定义于头文件 <array>
定义于头文件 <tuple>
在头文件 <utility> 中定义
定义于头文件 <ranges>		(C++20 起)
定义于头文件 <complex>		(C++26 起)
template< class T > struct tuple_size; // 未定义	(1)	(C++11 起)
template< class T > struct tuple_size< const T >     : std::integral_constant<std::size_t, std::tuple_size<T>::value> {};	(2)	(C++11 起)
template< class T > struct tuple_size< volatile T >     : std::integral_constant<std::size_t, std::tuple_size<T>::value> {};	(3)	(C++11 起) (C++20 中已弃用)
template< class T > struct tuple_size< const volatile T >     : std::integral_constant<std::size_t, std::tuple_size<T>::value> {};	(4)	(C++11 起) (C++20 中已弃用)

在编译时以常量表达式的形式提供对类元组（tuple-like）类型中元素数量的访问。

1) 主模板未定义。需要显式（完整）或部分特化以使类型成为类元组。

2-4) cv 限定类型的特化默认重用对应 cv 非限定版本的 value。

std::tuple_size 与核心语言交互：它可以在类元组情况下提供结构化绑定支持。 (2-4) 是 SFINAE 友好的：如果 std::tuple_size<T>::value 在被视为未求值操作数时格式错误，它们将不提供成员 value。访问检查的执行方式如同在与 tuple_size 和 T 无关的上下文中进行。只考虑表达式的直接上下文的有效性。这允许 #include <utility>   struct X { int a, b; }; const auto [x, y] = X(); // structured binding declaration first attempts // tuple_size<const X> which attempts to use tuple_size<X>::value, // then soft error encountered, binds to public data members

(C++17 起)

特化

标准库为标准库类型提供以下特化

std::tuple_size<std::tuple> (C++11)	获取 tuple 的大小 一个 tuple (类模板特化)
std::tuple_size<std::pair> (C++11)	获取 pair 的大小 (类模板特化)
std::tuple_size<std::array> (C++11)	获得 array 的大小 (类模板特化)
std::tuple_size<std::ranges::subrange> (C++20)	获取 std::ranges::subrange 的大小 (类模板特化)
std::tuple_size<std::complex> (C++26)	获取 std::complex 的大小 (类模板特化)

所有 std::tuple_size 的特化都满足 一元类型特性 (UnaryTypeTrait)，其基本特性为 std::integral_constant<std::size_t, N>，其中 N 为某个值。

用户可以为程序定义类型特化 std::tuple_size 以使它们成为类元组。程序定义的特化必须满足上述要求。

通常只需要为 cv 非限定类型定制特化。

辅助变量模板

定义于头文件 <tuple>
template< class T > constexpr std::size_t tuple_size_v = tuple_size<T>::value;		(C++17 起)

继承自 std::integral_constant

成员常量

value [静态]

对于标准特化，类元组类型 T 中的元素数量 (public static 成员常量)

成员函数

operator std::size_t	将对象转换为 std::size_t，返回 value (公开成员函数)
operator() (C++14)	返回 value (公开成员函数)

成员类型

类型	定义
value_type	std::size_t
类型	std::integral_constant<std::size_t, value>

示例

运行此代码

#include <array>
#include <cstddef>
#include <ranges>
#include <tuple>
#include <utility>
 
template<class T, std::size_t Size> struct Arr { T data[Size]; };
 
// Program-defined specialization of std::tuple_size:
template<class T, std::size_t Size> struct std::tuple_size<Arr<T, Size>>
    : public integral_constant<std::size_t, Size> {};
 
int main()
{
    using tuple1 = std::tuple<int, char, double>;
    static_assert(3 == std::tuple_size_v<tuple1>); // uses using template (C++17)
 
    using array3x4 = std::array<std::array<int, 3>, 4>;
    static_assert(4 == std::tuple_size<array3x4>{}); // uses operator std::size_t
 
    using pair = std::pair<tuple1, array3x4>;
    static_assert(2 == std::tuple_size<pair>()); // uses operator()
 
    using sub = std::ranges::subrange<char*, char*>;
    static_assert(2 == std::tuple_size<sub>::value);
 
    using Arr5 = Arr<int, 5>;
    static_assert(5 == std::tuple_size_v<Arr5>);
}

缺陷报告

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

缺陷报告	应用于	发布时的行为	正确的行为
LWG 2212	C++11	某些头文件中不需要 cv 类型的特化，导致歧义	需要

参见

结构化绑定 (C++17)	将指定的名称绑定到初始化器的子对象或元组元素
tuple_element (C++11)	获取类元组类型的元素类型 (类模板)
tuple_cat (C++11)	通过连接任意数量的 tuple 创建一个 tuple (函数模板)