std::tuple_size

Определено в заголовке `<tuple>`
Определено в заголовке `<array>`
Определено в заголовке `<utility>`
Определено в заголовке `<ranges>`		(с C++20)
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 из соответствующих неквалифицированных версий.

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)	получает размер пары (специализация шаблона класса)
std::tuple_size<std::array> (C++11)	получает размер массива (специализация шаблона класса)
std::tuple_size<std::ranges::subrange> (C++20)	получает количество компонентов поддиапазона (специализация шаблона класса)

Все специализации std::tuple_size удовлетворяют UnaryTypeTrait с основной характеристикой std::integral_constant<std::size_t, N> для некоторых N.

Пользователи могут специализировать std::tuple_size для определённых пользователем типов, чтобы сделать их похожими на кортежи. Определённые пользователем специализации должны соответствовать вышеупомянутым требованиям.

Обычно требуется только специализация для неквалифицированных типов.

Вспомогательный шаблон переменной

Определено в заголовке `<tuple>`
template< class T > inline 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]; };
// a 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++.

DR	Применено к	Поведение при публикации	Правильное поведение
LWG 2212	C++11	специализации для типов с cv не требовались в некоторых заголовках, что приводило к неоднозначности	необходимы

См. также

Связывание по структуре (C++17)	связывает указанные имена с подобъектами или элементами кортежа инициализатора
tuple_element (C++11)	получает типы элементов типа, похожего на кортеж (шаблон класса)
tuple_cat (C++11)	создаёт кортеж, конкатенируя любое количество кортежей (шаблон функции)

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