Namespaces
Variants
Views
Actions

std::tuple_element<std::tuple>

From cppreference.com
< cpp‎ | utility‎ | tuple
Revision as of 14:43, 3 October 2024 by Space Mission (Talk | contribs)

 
 
Utilities library
General utilities
Relational operators (deprecated in C++20)
 
 
Defined in header <tuple>
template< std::size_t I, class... Types >
struct tuple_element< I, std::tuple<Types...> >;
(since C++11)

Provides compile-time indexed access to the types of the elements of the tuple.

Contents

Member types

Type Definition
type the type of Ith element of the tuple, where I is in [0sizeof...(Types))

Possible implementation

template<std::size_t I, class T>
struct tuple_element;
 
#ifndef __cpp_pack_indexing
// recursive case
template<std::size_t I, class Head, class... Tail>
struct tuple_element<I, std::tuple<Head, Tail...>>
    : std::tuple_element<I - 1, std::tuple<Tail...>>
{ };
 
// base case
template<class Head, class... Tail>
struct tuple_element<0, std::tuple<Head, Tail...>>
{
    using type = Head;
};
 
#else
// C++26 implementation using pack indexing
template<std::size_t I, class... Ts>
struct tuple_element<I, std::tuple<Ts...>>
{
    using type = Ts...[I];
};
#endif

Example

#include <cstddef>
#include <iostream>
#include <string>
#include <tuple>
#include <typeinfo>
#include <type_traits>
#include <utility>
 
namespace details
{
    template<class TupleLike, std::size_t I>
    void printTypeAtIndex()
    {
        std::cout << "  The type at index " << I << " is: ";
        using SelectedType = std::tuple_element_t<I, TupleLike>;
        using RemovedRefType = std::remove_reference_t<SelectedType>;
        std::cout << typeid(std::remove_cvref_t<SelectedType>).name();
        if constexpr (std::is_const_v<RemovedRefType>)
           std::cout << " const"; 
        if constexpr (std::is_volatile_v<RemovedRefType>)
           std::cout << " volatile";
        if constexpr (std::is_lvalue_reference_v<SelectedType>)
           std::cout << "&";
        if constexpr (std::is_rvalue_reference_v<SelectedType>)
           std::cout << "&&";
        std::cout << '\n';
    }
}
 
template<typename TupleLike, std::size_t I = 0>
void printTypes()
{
    if constexpr (I == 0)
        std::cout << typeid(TupleLike).name() << '\n';
 
    if constexpr (I < std::tuple_size_v<TupleLike>)
    {
        details::printTypeAtIndex<TupleLike, I>();
        printTypes<TupleLike, I + 1>();
    }
}
 
struct MyStruct {};
 
using MyTuple = std::tuple<int, long&, const char&, bool&&,
                           std::string, volatile MyStruct>;
 
using MyPair = std::pair<char, bool&&>;
 
static_assert
(
    std::is_same_v<std::tuple_element_t<0, MyPair>, char> &&
    std::is_same_v<std::tuple_element_t<1, MyPair>, bool&&>
);
 
int main()
{
    printTypes<MyTuple>();
    printTypes<MyPair>();
}

Possible output:

# GCC/Clang output:
St5tupleIJiRlRKcObNSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEEV8MyStructEE
  The type at index 0 is: i
  The type at index 1 is: l&
  The type at index 2 is: c const&
  The type at index 3 is: b&&
  The type at index 4 is: NSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEE
  The type at index 5 is: 8MyStruct volatile
St4pairIcObE
  The type at index 0 is: c
  The type at index 1 is: b&&
 
 
# MSVC output:
class std::tuple<int,long & __ptr64,char const & __ptr64,bool && __ptr64,⮠
class std::basic_string<char,struct std::char_traits<char>,class std::allocator<char> >,⮠
struct MyStruct volatile >
  The type at index 0 is: int
  The type at index 1 is: long&
  The type at index 2 is: char const&
  The type at index 3 is: bool&&
  The type at index 4 is: class std::basic_string<char,struct std::char_traits<char>,⮠
class std::allocator<char> >
  The type at index 5 is: struct MyStruct volatile
struct std::pair<char,bool && __ptr64>
  The type at index 0 is: char
  The type at index 1 is: bool&&

See also

Structured binding (C++17) binds the specified names to sub-objects or tuple elements of the initializer[edit]
obtains the element types of a tuple-like type
(class template) [edit]