std::swap(std::stack)

Defined in header `<stack>`
template< class T, class Container > void swap( std::stack<T, Container>& lhs, std::stack<T, Container>& rhs );		(since C++11) (until C++17)
template< class T, class Container > void swap( std::stack<T, Container>& lhs, std::stack<T, Container>& rhs ) noexcept(/* see below */);		(since C++17)

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

This overload participates in overload resolution only if std::is_swappable_v<Container> is true.

(since C++17)

Parameters

lhs, rhs

-

containers whose contents to swap

Return value

(none)

Complexity

Same as swapping the underlying container.

Exceptions

noexcept specification:

noexcept(noexcept(lhs.swap(rhs)))

(since C++17)

Notes

Although the overloads of std::swap for container adaptors are introduced in C++11, container adaptors can already be swapped by std::swap in C++98. Such calls to std::swap usually have linear time complexity, but better complexity may be provided.

Example

Run this code

#include <algorithm>
#include <iostream>
#include <stack>
 
int main()
{
    std::stack<int> alice;
    std::stack<int> bob;
 
    auto print = [](const auto & title, const auto &cont)
    {
        std::cout << title << " size=" << cont.size();
        std::cout << " top=" << cont.top() << '\n';
    };
 
    for (int i = 1; i < 4; ++i)
        alice.push(i);
    for (int i = 7; i < 11; ++i)
        bob.push(i);
 
    // Print state before swap
    print("alice:", alice);
    print("bob  :", bob);
 
    std::cout << "-- SWAP\n";
    std::swap(alice, bob);
 
    // Print state after swap
    print("alice:", alice);
    print("bob  :", bob);
}

Output:

alice: size=3 top=3
bob  : size=4 top=10
-- SWAP
alice: size=4 top=10
bob  : size=3 top=3

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)
Technical specifications
Symbols index
External libraries

Sequence
array (C++11)
vector
vector<bool>
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)
Iterator invalidation
Member function table
Non-member function table

Member functions
stack::stack
stack::~stack
stack::operator=
Element access
stack::top
Capacity
stack::empty
stack::size
Modifiers
stack::push
stack::push_range (C++23)
stack::emplace (C++11)
stack::pop
stack::swap (C++11)
Non-member functions
operator==operator!=operator<operator>operator<=operator>=operator<=> (C++20)
std::swap (C++11)
Helper classes
std::uses_allocator (C++11)
Deduction guides(C++17)