std::get(std::tuple)

 

C++

Language

Standard Library Headers

Freestanding and hosted implementations

Named requirements

Language support library

Concepts library (C++20)

Diagnostics library

Utilities library

Strings library

Containers library

Iterators library

Ranges library (C++20)

Algorithms library

Numerics library

Input/output library

Localizations library

Regular expressions library (C++11)

Atomic operations library (C++11)

Thread support library (C++11)

Filesystem library (C++17)

Technical Specifications

 

Utilities library

Type support (basic types, RTTI, type traits)
Dynamic memory management
Error handling
Program utilities
Variadic functions
Library feature-test macros
Date and time
Function objects
initializer_list (C++11)
bitset
hash (C++11)
integer_sequence (C++14)
Relational operators (deprecated in C++20)
rel_ops::operator!=rel_ops::operator>rel_ops::operator<=rel_ops::operator>=
Comparisons (C++20)
strong_order weak_order partial_order strong_equal weak_equal	strong_ordering weak_ordering partial_ordering strong_equality weak_equality	is_eqis_neqis_ltis_lteqis_gtis_gteq
common_comparison_category
Common vocabulary types
pair tuple (C++11) apply (C++17) make_from_tuple (C++17)	optional (C++17) any (C++17) variant (C++17)
Swap, forward and move
swap
exchange (C++14)
forward (C++11)
move (C++11)
move_if_noexcept (C++11)
Elementary string conversions
to_chars (C++17)
from_chars (C++17)
chars_format (C++17)
Type operations
declval (C++11)
as_const (C++17)
launder (C++17)

 

std::tuple

Member functions

tuple::tuple

tuple::operator=

tuple::swap

Non-member functions

make_tuple

tie

forward_as_tuple

tuple_cat

operator==operator!=operator<operator<=operator>operator>=

std::swap

get

Deduction guides(C++17)

Helper classes

tuple_size

tuple_element

uses_allocator

ignore

 

template< std::size_t I, class... Types > typename std::tuple_element<I, tuple<Types...> >::type&     get( tuple<Types...>& t ) noexcept;	(1)	(since C++11) (constexpr since C++14)
template< std::size_t I, class... Types > typename std::tuple_element<I, tuple<Types...> >::type&&     get( tuple<Types...>&& t ) noexcept;	(2)	(since C++11) (constexpr since C++14)
template< std::size_t I, class... Types > typename std::tuple_element<I, tuple<Types...> >::type const&     get( const tuple<Types...>& t ) noexcept;	(3)	(since C++11) (constexpr since C++14)
template< std::size_t I, class... Types > typename std::tuple_element<I, tuple<Types...> >::type const&&     get( const tuple<Types...>&& t ) noexcept;	(4)	(since C++11) (constexpr since C++14)
template< class T, class... Types > constexpr T& get(tuple<Types...>& t) noexcept;	(5)	(since C++14)
template< class T, class... Types > constexpr T&& get(tuple<Types...>&& t) noexcept;	(6)	(since C++14)
template< class T, class... Types > constexpr const T& get(const tuple<Types...>& t) noexcept;	(7)	(since C++14)
template< class T, class... Types > constexpr const T&& get(const tuple<Types...>&& t) noexcept;	(8)	(since C++14)

1-4) Extracts the Ith element from the tuple. I must be an integer value in [0, sizeof...(Types)).

5-8) Extracts the element of the tuple t whose type is T. Fails to compile unless the tuple has exactly one element of that type.

Parameters

t

-

tuple whose contents to extract

Return value

A reference to the selected element of t.

Defect reports

The following behavior-changing defect reports were applied retroactively to previously published C++ standards.

DR	Applied to	Behavior as published	Correct behavior
LWG 2485	C++11	there are no overloads for const tuple&&	the overloads are added

Example

Run this code

#include <iostream>
#include <string>
#include <tuple>
 
int main()
{
    auto t = std::make_tuple(1, "Foo", 3.14);
    // index-based access
    std::cout << "(" << std::get<0>(t) << ", " << std::get<1>(t)
              << ", " << std::get<2>(t) << ")\n";
    // type-based access
    std::cout << "(" << std::get<int>(t) << ", " << std::get<const char*>(t)
              << ", " << std::get<double>(t) << ")\n";
    // Note: std::tie and structured binding may also be used to decompose a tuple
}

Output:

(1, Foo, 3.14)
(1, Foo, 3.14)

See also

std::get(std::array)	accesses an element of an array (function template)
std::get(std::pair) (C++11)	accesses an element of a pair (function template)
std::get(std::variant) (C++17)	reads the value of the variant given the index or the type (if the type is unique), throws on error (function template)