std::swap

 

C++

Language

Standard library headers

Concepts

Utilities library

Strings library

Containers library

Algorithms library

Iterators library

Numerics library

Input/output library

Localizations library

Regular expressions library (C++11)

Atomic operations library (C++11)

Thread support library (C++11)

 

Algorithm library

Functions
Non-modifying sequence operations
all_of any_of none_of (C++11) (C++11) (C++11) for_each count count_if mismatch equal	find find_if find_if_not (C++11) find_end find_first_of adjacent_find search search_n
Modifying sequence operations
copy copy_if (C++11) copy_n (C++11) copy_backward move (C++11) move_backward (C++11) fill fill_n transform generate generate_n remove remove_if remove_copy remove_copy_if	replace replace_if replace_copy replace_copy_if swap swap_ranges iter_swap reverse reverse_copy rotate rotate_copy random_shuffle shuffle   (C++11) unique unique_copy
Partitioning operations
is_partitioned (C++11) partition partition_copy (C++11)	stable_partition partition_point (C++11)
Sorting operations (on sorted ranges)
is_sorted (C++11) is_sorted_until (C++11) sort	partial_sort partial_sort_copy stable_sort nth_element
Binary search operations (on sorted ranges)
lower_bound upper_bound	binary_search equal_range
Set operations (on sorted ranges)
merge inplace_merge includes	set_difference set_intersection set_symmetric_difference set_union
Heap operations
is_heap is_heap_until (C++11) make_heap	push_heap pop_heap sort_heap
Minimum/maximum operations
max max_element min min_element minmax (C++11) minmax_element (C++11)	lexicographical_compare is_permutation (C++11) next_permutation prev_permutation
Numeric operations
iota (C++11) accumulate inner_product	adjacent_difference partial_sum
C library
qsort	bsearch

 

Defined in header <algorithm> Defined in header <utility>		(until C++11) (since C++11)
template< class T > void swap( T& a, T& b );	(1)
template< class T2, size_t N > void swap( T2 (&a)[N], T2 (&b)[N]);	(2)	(since C++11)

Exchanges the given values.

1) Swaps the values a and b.

2) Swaps the arrays a and b. In effect calls std::swap_ranges(a, a+N, b).

Parameters

a, b	-	the values to be swapped
Type requirements
- T must meet the requirements of MoveAssignable and MoveConstructible.
- T2 must meet the requirements of Swappable.

Return value

(none)

Exceptions

1)

noexcept specification:  (since C++11)

noexcept(noexcept(     std::is_nothrow_move_constructible<T>::value &&     std::is_nothrow_move_assignable<T>::value ))

2)

noexcept specification:  (since C++11)

noexcept(noexcept(swap(*a, *b)))

Complexity

1) Constant

2) Linear in N

Specializations

Both custom specializations and overloads of the std::swap algorithm are allowed, but the overloads are generally preferred since specializations of a function template aren't allowed for template classes. Library functions always use the user-provided overloads when swapping, if they are found by argument-dependent lookup (as per Swappable concept).

The following overloads are already provided by the standard library:

std::swap(std::pair) (C++11)	specializes the std::swap algorithm (function template)
std::swap(std::tuple) (C++11)	specializes the std::swap algorithm (function template)
std::swap(std::shared_ptr) (C++11)	specializes the std::swap algorithm (function template)
std::swap(std::weak_ptr) (C++11)	specializes the std::swap algorithm (function template)
std::swap(std::unique_ptr) (C++11)	specializes the std::swap algorithm (function template)
std::swap(std::function) (C++11)	specializes the std::swap algorithm (function template)
std::swap(std::basic_string)	specializes the std::swap algorithm (function template)
std::swap(std::array)	specializes the std::swap algorithm (function template)
std::swap(std::deque)	specializes the std::swap algorithm (function template)
std::swap(std::forward_list)	specializes the std::swap algorithm (function template)
std::swap(std::list)	specializes the std::swap algorithm (function template)
std::swap(std::vector)	specializes the std::swap algorithm (function template)
std::swap(std::map)	specializes the std::swap algorithm (function template)
std::swap(std::multimap)	specializes the std::swap algorithm (function template)
std::swap(std::set)	specializes the std::swap algorithm (function template)
std::swap(std::multiset)	specializes the std::swap algorithm (function template)
std::swap(std::unordered_map)	specializes the std::swap algorithm (function template)
std::swap(std::unordered_multimap)	specializes the std::swap algorithm (function template)
std::swap(std::unordered_set)	specializes the std::swap algorithm (function template)
std::swap(std::unordered_multiset)	specializes the std::swap algorithm (function template)
std::swap(std::queue)	specializes the std::swap algorithm (function template)
std::swap(std::priority_queue)	specializes the std::swap algorithm (function template)
std::swap(std::stack)	specializes the std::swap algorithm (function template)
std::swap(std::valarray) (C++11)	specializes the Template:cpp/ltf algorithm (function template)
std::swap(std::basic_stringbuf) (C++11)	specializes the Template:cpp/ltf algorithm (function template)
std::swap(std::basic_istringstream) (C++11)	specializes the Template:cpp/ltf algorithm (function template)
std::swap(std::basic_ostringstream) (C++11)	specializes the Template:cpp/ltf algorithm (function template)
std::swap(std::basic_stringstream) (C++11)	specializes the Template:cpp/ltf algorithm (function template)
std::swap(std::basic_filebuf) (C++11)	specializes the Template:cpp/ltf algorithm (function template)
std::swap(std::basic_ifstream) (C++11)	specializes the std::swap algorithm (function template)
std::swap(std::basic_ofstream) (C++11)	specializes the std::swap algorithm (function template)
std::swap(std::basic_fstream) (C++11)	specializes the std::swap algorithm (function template)
std::swap(std::basic_regex) (C++11)	specializes the Template:cpp/ltf algorithm (function template)
std::swap(std::match_results) (C++11)	specializes the Template:cpp/ltf algorithm (function template)
std::swap(std::thread) (C++11)	specializes the std::swap algorithm (function template)
std::swap(std::unique_lock) (C++11)	specializes the Template:cpp/ltf algorithm (function template)
std::swap(std::promise) (C++11)	specializes the Template:cpp/ltf algorithm (function template)
std::swap(std::packaged_task) (C++11)	specializes the Template:cpp/ltf algorithm (function template)

Example

run this code

#include <algorithm>
#include <iostream>
 
int main()
{
   int a = 5, b = 3;
 
   // before
   std::cout << a << ' ' << b << '\n';
 
   std::swap(a,b);
 
   // after
   std::cout << a << ' ' << b << '\n';
}

Output:

5 3
3 5

See also

iter_swap	swaps the elements pointed to by two iterators (function template)
swap_ranges	swaps two ranges of elements (function template)