std::tuple_size

Определён в заголовочном файле `<array>`
Определён в заголовочном файле `<tuple>`
Определён в заголовочном файле `<utility>`
Определён в заголовочном файле `<ranges>`		(начиная с C++20)
Определён в заголовочном файле `<complex>`		(начиная с C++26)
template< class T > struct tuple_size; // not defined	(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-квалифицированных типов по умолчанию повторно используют value соответствующих версий без cv-квалификаторов.

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` (специализация шаблона класса)
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

[static]

для стандартной специализации — количество элементов в кортежеподобном типе 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]; };

// 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` путём конкатенации любого количества кортежей (шаблон функции)

© cppreference.com
Licensed under the Creative Commons Attribution-ShareAlike Unported License v3.0.
https://en.cppreference.com/cpp/utility/tuple_size