std::tuple<Types...>::swap

 

C++

Compiler support

Freestanding and hosted

Language

Standard library headers

Named requirements

Feature test macros (C++20)

Language support library

Concepts library (C++20)

Metaprogramming library (C++11)

Diagnostics library

General utilities library

Strings library

Containers library

Iterators library

Ranges library (C++20)

Algorithms library

Numerics library

Localizations library

Input/output library

Filesystem library (C++17)

Regular expressions library (C++11)

Concurrency support library (C++11)

Technical specifications

Symbols index

External libraries

 

Utilities library

Language support Type support (basic types, RTTI) Library feature-test macros (C++20) Dynamic memory management Program utilities Coroutine support (C++20) Variadic functions is_constant_evaluated (C++20) launder (C++17) initializer_list (C++11) source_location (C++20) Three-way comparison (C++20) three_way_comparablethree_way_comparable_with (C++20)(C++20) strong_ordering (C++20) weak_ordering (C++20) partial_ordering (C++20) common_comparison_category (C++20) compare_three_way_result (C++20) compare_three_way (C++20) strong_order (C++20) weak_order (C++20) partial_order (C++20) compare_strong_order_fallback (C++20) compare_weak_order_fallback (C++20) compare_partial_order_fallback (C++20)    is_eqis_neqis_ltis_lteqis_gtis_gteq (C++20)(C++20)(C++20)(C++20)(C++20)(C++20)

General utilities Date and time Function objects Formatting library (C++20) bitset hash (C++11) Relational operators (deprecated in C++20) rel_ops::operator!=rel_ops::operator> rel_ops::operator<=rel_ops::operator>= Integer comparison functions cmp_equalcmp_lesscmp_less_than (C++20)(C++20)(C++20)    cmp_not_equalcmp_greatercmp_greater_than (C++20)(C++20)(C++20) in_range (C++20) Swap and type operations swap ranges::swap (C++20) exchange (C++14) declval (C++11) to_underlying (C++23) forward (C++11) forward_like (C++23) move (C++11) move_if_noexcept (C++11) as_const (C++17) Common vocabulary types pair tuple (C++11) optional (C++17) any (C++17) variant (C++17) tuple_size (C++11) tuple_element (C++11) apply (C++17) make_from_tuple (C++17) expected (C++23) Elementary string conversions to_chars (C++17) from_chars (C++17) chars_format (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>=operator<=> (until C++20)(until C++20)(until C++20)(until C++20)(until C++20)(C++20)

std::swap

get

Deduction guides(C++17)

Helper classes

tuple_size

tuple_element

uses_allocator

basic_common_reference (C++23)

common_type (C++23)

ignore

 

Defined in header <tuple>
	(1)
void swap( tuple& other ) noexcept(/* see below */);			(since C++11) (until C++20)
constexpr void swap( tuple& other ) noexcept(/* see below */);			(since C++20)
constexpr void swap( const tuple& other ) noexcept(/* see below */) const;		(2)	(since C++23)

Calls swap (which might be std::swap, or might be found via ADL) for each element in *this and its corresponding element in other.

If any selected swap function call is ill-formed, or does not swap the corresponding elements of both tuples, the behavior is undefined.	(until C++23)
If any selected swap function call does not swap the corresponding elements of both tuples, the behavior is undefined. 1) The program is ill-formed if (std::is_swappable_v<Types> && ...) is not true. 2) The program is ill-formed if (std::is_swappable_v<const Types> && ...) is not true.	(since C++23)

Parameters

other

-

tuple of values to swap

Return value

(none)

Exceptions

noexcept specification:   noexcept(     noexcept(swap(std::declval<T0&>>(), std::declval<T0&>())) &&     noexcept(swap(std::declval<T1&>>(), std::declval<T1&>())) &&     noexcept(swap(std::declval<T2&>>(), std::declval<T2&>())) &&     ... ) In the expression above, the identifier swap is looked up in the same manner as the one used by the C++17 std::is_nothrow_swappable trait.	(until C++17)
1) noexcept specification:   noexcept((std::is_nothrow_swappable_v<Types> && ...)) 2) noexcept specification:   noexcept((std::is_nothrow_swappable_v<const Types> && ...))	(since C++17)

Example

Run this code

#include <iostream>
#include <string>
#include <tuple>
 
int main()
{
    std::tuple<int, std::string, float>
                      p1{42, "ABCD", 2.71},
                      p2;
    p2 = std::make_tuple(10, "1234", 3.14);
 
    auto print_p1_p2 = [&](auto rem) {
        std::cout << rem
                  << "p1 = {" << std::get<0>(p1)
                  << ", "     << std::get<1>(p1)
                  << ", "     << std::get<2>(p1) << "}, "
                  << "p2 = {" << std::get<0>(p2)
                  << ", "     << std::get<1>(p2)
                  << ", "     << std::get<2>(p2) << "}\n";
    };
 
    print_p1_p2("Before p1.swap(p2): ");
    p1.swap(p2);
    print_p1_p2("After  p1.swap(p2): ");
    swap(p1, p2);
    print_p1_p2("After swap(p1, p2): ");
}

Output:

Before p1.swap(p2): p1 = {42, ABCD, 2.71}, p2 = {10, 1234, 3.14}
After  p1.swap(p2): p1 = {10, 1234, 3.14}, p2 = {42, ABCD, 2.71}
After swap(p1, p2): p1 = {42, ABCD, 2.71}, p2 = {10, 1234, 3.14}

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 2456	C++11	the noexcept specification is ill-formed	made to work

See also

std::swap(std::tuple) (C++11)	specializes the std::swap algorithm (function template)
swap (C++11)	swaps the contents (public member function of std::pair<T1,T2>)