std::tuple_size

来自cppreference.com
< cpp‎ | utility
 
C++
 
工具库
通用工具
关系运算符 (C++20 弃用)
整数比较函数
(C++20)(C++20)(C++20)  
(C++20)
交换与类型运算
(C++20)
(C++14)
(C++11)
(C++23)
(C++11)
(C++23)
(C++11)
(C++11)
(C++17)
常用词汇类型
(C++11)
(C++17)
(C++17)
(C++17)
tuple_size
(C++11)
(C++11)
(C++17)
(C++17)
(C++23)


 
在标头 <tuple> 定义
在标头 <utility> 定义
在标头 <array> 定义
在标头 <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 弃用)

提供对元组式类型中元素个数的访问，作为编译时常量表达式。

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(); // 结构化绑定声明首先尝试 tuple_size<const X>，这会尝试使用
                         // tuple_size<X>::value，然后遇到软错误，绑定到公开数据成员
 (C++17 起)

目录

[编辑] 特化

标准库为标准库类型提供下列特化：

(C++11)
 获得 tuple 的大小
(类模板特化) [编辑]
(C++11)
 获得 pair 的大小
(类模板特化) [编辑]
(C++11)
 获得 array 的大小
(类模板特化) [编辑]
(C++20)
 获得 std::ranges::subrange 的大小
(类模板特化) [编辑]
(C++26)
 获取 std::complex 的大小
(类模板特化) [编辑]

std::tuple_size 的所有特化都满足基特征对于某个 N 为 std::integral_constant<std::size_t, N> 的一元类型特征 (UnaryTypeTrait) 。

用户可以对程序定义类型特化 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 的元素个数
(公开静态成员常量)

成员函数

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

成员类型

类型 定义
value_type std::size_t
type 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]; };
 
// 程序定义的 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>); // 使用变量模板 (C++17)
 
    using array3x4 = std::array<std::array<int, 3>, 4>;
    static_assert(4 == std::tuple_size<array3x4>{}); // 使用 operator std::size_t
 
    using pair = std::pair<tuple1, array3x4>;
    static_assert(2 == std::tuple_size<pair>()); // 使用 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) 绑定指定的名字到初始化式的子对象或元组元素[编辑]
(C++11)
 获得元组式类型的元素类型
(类模板) [编辑]
(C++11)
 通过连接任意数量的元组来创建一个tuple
(函数模板) [编辑]
来自“https://zh.cppreference.com/mwiki/index.php?title=cpp/utility/tuple_size&oldid=94507”