std::swap(std::array)

 

C++

Compiler support

Freestanding and hosted

Language

Standard library

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)

Execution support library (C++26)

Technical specifications

Symbols index

External libraries

 

Containers library

Sequence

array (C++11)

vector

vector<bool>

inplace_vector (C++26)

deque

forward_list (C++11)

list

Associative

set

multiset

map

multimap

Unordered associative

unordered_set (C++11)

unordered_multiset (C++11)

unordered_map (C++11)

unordered_multimap (C++11)

Adaptors

stack

queue

priority_queue

flat_set (C++23)

flat_multiset (C++23)

flat_map (C++23)

flat_multimap (C++23)

Views

span (C++20)

mdspan (C++23)

Tables

Iterator invalidation

Member function table

Non-member function table

 

std::array

Member types
Member functions
Element access array::at array::operator[]    array::front array::back array::data Operations array::fill array::swap	Iterators array::beginarray::cbegin array::endarray::cend array::rbeginarray::crbegin    array::rendarray::crend	Capacity array::empty array::size array::max_size
Non-member functions
operator==operator<=> (C++20) get(std::array) swap(std::array) to_array (C++20)	operator|=operator<operator>operator<=operator>= (until C++20)(until C++20)(until C++20)(until C++20)(until C++20)
Helper classes
tuple_size<std::array>
tuple_element<std::array>
Deduction guides (C++17)

 

Defined in header <array>
template< class T, std::size_t N > void swap( std::array<T, N>& lhs,            std::array<T, N>& rhs );		(since C++11) (until C++17)
template< class T, std::size_t N > void swap( std::array<T, N>& lhs,            std::array<T, N>& rhs )                noexcept(/* see below */);		(since C++17) (constexpr since C++20)

Specializes the std::swap algorithm for std::array. Swaps the contents of lhs and rhs. Calls lhs.swap(rhs).

This overload participates in overload resolution only if N == 0 or std::is_swappable_v<T> is true.

(since C++17)

Parameters

lhs, rhs

-

containers whose contents to swap

Return value

(none)

Complexity

Linear in size of the containers.

Exceptions

noexcept specification:   noexcept(noexcept(lhs.swap(rhs)))

(since C++17)

Example

Run this code

#include <algorithm>
#include <iostream>
#include <array>
 
int main()
{
    std::array<int, 3> alice{1, 2, 3};
    std::array<int, 3> bob{7, 8, 9};
 
    auto print = [](const int& n) { std::cout << ' ' << n; };
 
    // Print state before swap
    std::cout << "Alice:";
    std::for_each(alice.begin(), alice.end(), print);
    std::cout << "\nBobby:";
    std::for_each(bob.begin(), bob.end(), print);
    std::cout << '\n';
 
    std::cout << "-- SWAP\n";
    std::swap(alice, bob);
 
    // Print state after swap
    std::cout << "Alice:";
    std::for_each(alice.begin(), alice.end(), print);
    std::cout << "\nBobby:";
    std::for_each(bob.begin(), bob.end(), print);
    std::cout << '\n';
}

Output:

Alice: 1 2 3
Bobby: 7 8 9
-- SWAP
Alice: 7 8 9
Bobby: 1 2 3

See also

swap	swaps the contents (public member function)