Spec-Zone.ru › C++

std::swap

Определено в заголовке <algorithm> (до C++11)
Определено в заголовке <utility> (с C++11)
Определено в заголовке <string_view> (с C++17)
(1)
template< class T >
void swap( T& a, T& b );
(до C++11)
template< class T >
void swap( T& a, T& b ) noexcept( /* see below */ );
(с C++11)
(до C++20)
template< class T >
constexpr void swap( T& a, T& b ) noexcept( /* see below */ );
(с C++20)
(2)
template< class T2, std::size_t N >
void swap( T2 (&a)[N], T2 (&b)[N] );
(до C++11)
template< class T2, std::size_t N >
void swap( T2 (&a)[N], T2 (&b)[N] ) noexcept( /* see below */ );
(с C++11)
(до C++20)
template< class T2, std::size_t N >
constexpr void swap( T2 (&a)[N], T2 (&b)[N] ) noexcept( /* see below */ );
(с C++20)

Меняет заданные значения.

1) Меняет местами значения a и b. Эта перегрузка не участвует в разрешении перегрузки, если std::is_move_constructible_v<T> && std::is_move_assignable_v<T> не true.(с C++17)
2) Меняет местами массивы a и b. По сути, вызывает std::swap_ranges(a, a + N, b). Эта перегрузка не участвует в разрешении перегрузки, если std::is_swappable_v<T2> не true.(с C++17)

Параметры

a, b - значения, которые нужно поменять местами
Требования к типу
-T должно удовлетворять требованиям CopyConstructible и CopyAssignable(до C++11)MoveConstructible и MoveAssignable(с C++11)
-T2 должно удовлетворять требованиям Swappable.

Возвращаемое значение

(нет)

Исключения

1)

(нет)

(до C++11)
noexcept спецификация:
noexcept(

std::is_nothrow_move_constructible<T>::value &&
std::is_nothrow_move_assignable<T>::value

)
(с C++11)
2)
noexcept спецификация:
noexcept(noexcept(swap(*a, *b)))
Поиск идентификатора swap в спецификации исключений находит эту шаблонную функцию помимо всего, что найдено обычными правилами поиска, делая спецификацию исключений эквивалентной C++17 std::is_nothrow_swappable.
(с C++11)
(до C++17)
noexcept спецификация:
noexcept(std::is_nothrow_swappable_v<T2>)
(с C++17)

Сложность

1) Постоянная
2) Линейная относительно N

Специализации

std::swap может быть специализирована в пространстве имен std для типов, определённых программой, но такие специализации не обнаруживаются ADL (пространство имен std не является связанным пространством имен для типа, определённого программой).

(до C++20)

Ожидаемый способ сделать тип, определённый программой, переключаемым, — это предоставить внечленённую функцию swap в том же пространстве имён, что и тип: см. Swappable для подробностей.

Следующие перегрузки уже предоставляются стандартной библиотекой:

std::swap(std::pair)
(C++11)
специализирует алгоритм std::swap
(шаблон функции)
std::swap(std::tuple)
(C++11)
специализирует алгоритм std::swap
(шаблон функции)
std::swap(std::shared_ptr)
(C++11)
специализирует алгоритм std::swap
(шаблон функции)
std::swap(std::weak_ptr)
(C++11)
специализирует алгоритм std::swap
(шаблон функции)
std::swap(std::unique_ptr)
(C++11)
специализирует алгоритм std::swap
(шаблон функции)
std::swap(std::function)
(C++11)
специализирует алгоритм std::swap
(шаблон функции)
std::swap(std::basic_string)
специализирует алгоритм std::swap
(шаблон функции)
std::swap(std::array)
(C++11)
специализирует алгоритм std::swap
(шаблон функции)
std::swap(std::deque)
специализирует алгоритм std::swap
(шаблон функции)
std::swap(std::forward_list)
(C++11)
специализирует алгоритм std::swap
(шаблон функции)
std::swap(std::list)
специализирует алгоритм std::swap
(шаблон функции)
std::swap(std::vector)
специализирует алгоритм std::swap
(шаблон функции)
std::swap(std::map)
специализирует алгоритм std::swap
(шаблон функции)
std::swap(std::multimap)
специализирует алгоритм std::swap
(шаблон функции)
std::swap(std::set)
специализирует алгоритм std::swap
(шаблон функции)
std::swap(std::multiset)
специализирует алгоритм std::swap
(шаблон функции)
std::swap(std::unordered_map)
(C++11)
специализирует алгоритм std::swap
(шаблон функции)
std::swap(std::unordered_multimap)
(C++11)
специализирует алгоритм std::swap
(шаблон функции)
std::swap(std::unordered_set)
(C++11)
специализирует алгоритм std::swap
(шаблон функции)
std::swap(std::unordered_multiset)
(C++11)
специализирует алгоритм std::swap
(шаблон функции)
std::swap(std::queue)
(C++11)
специализирует алгоритм std::swap
(шаблон функции)
std::swap(std::priority_queue)
(C++11)
специализирует алгоритм std::swap
(шаблон функции)
std::swap(std::stack)
(C++11)
специализирует алгоритм std::swap
(шаблон функции)
std::swap(std::valarray)
(C++11)
специализирует алгоритм std::swap
(шаблон функции)
std::swap(std::basic_stringbuf)
(C++11)
специализирует алгоритм std::swap
(шаблон функции)
std::swap(std::basic_istringstream)
(C++11)
специализирует алгоритм std::swap
(шаблон функции)
std::swap(std::basic_ostringstream)
(C++11)
специализирует алгоритм std::swap
(шаблон функции)
std::swap(std::basic_stringstream)
(C++11)
специализирует алгоритм std::swap
(шаблон функции)
std::swap(std::basic_filebuf)
(C++11)
специализирует алгоритм std::swap
(шаблон функции)
std::swap(std::basic_ifstream)
(C++11)
специализирует алгоритм std::swap
(шаблон функции)
std::swap(std::basic_ofstream)
(C++11)
специализирует алгоритм std::swap
(шаблон функции)
std::swap(std::basic_fstream)
(C++11)
специализирует алгоритм std::swap
(шаблон функции)
std::swap(std::basic_syncbuf)
(C++20)
специализирует алгоритм std::swap
(шаблон функции)
std::swap(std::basic_spanbuf)
(C++23)
специализирует алгоритм std::swap
(шаблон функции)
std::swap(std::basic_ispanstream)
(C++23)
специализирует алгоритм std::swap
(шаблон функции)
std::swap(std::basic_ospanstream)
(C++23)
специализирует алгоритм std::swap
(шаблон функции)
std::swap(std::basic_spanstream)
(C++23)
специализирует алгоритм std::swap
(шаблон функции)
std::swap(std::basic_regex)
(C++11)
специализирует алгоритм std::swap
(шаблон функции)
std::swap(std::match_results)
(C++11)
специализирует алгоритм std::swap
(шаблон функции)
std::swap(std::thread)
(C++11)
специализирует алгоритм std::swap
(функция)
std::swap(std::unique_lock)
(C++11)
специализация std::swap для unique_lock
(шаблон функции)
std::swap(std::shared_lock)
(C++14)
специализация std::swap для shared_lock
(шаблон функции)
std::swap(std::promise)
(C++11)
специализирует алгоритм std::swap
(шаблон функции)
std::swap(std::packaged_task)
(C++11)
специализирует алгоритм std::swap
(шаблон функции)
std::swap(std::optional)
(C++17)
специализирует алгоритм std::swap
(шаблон функции)
std::swap(std::any)
(C++17)
специализирует алгоритм std::swap
(функция)
std::swap(std::variant)
(C++17)
специализирует алгоритм std::swap
(шаблон функции)
std::swap(std::basic_stacktrace)
(C++23)
специализирует алгоритм std::swap
(шаблон функции)
swap(std::filesystem::path)
(C++17)
меняет местами два пути
(функция)
swap(std::expected)
(C++23)
специализирует алгоритм std::swap
(функция)
swap(std::jthread)
(C++20)
специализирует алгоритм std::swap
(функция)
swap(std::move_only_function)
(C++23)
перегружает алгоритм std::swap
(функция)
swap(std::stop_source)
(C++20)
специализирует алгоритм std::swap
(функция)
swap(std::stop_token)
(C++20)
специализирует алгоритм std::swap
(функция)

Пример

#include <algorithm>
#include <iostream>
 
namespace Ns
{
    class A
    {
        int id {};
 
        friend void swap(A& lhs, A& rhs)
        {
            std::cout << "swap(" << lhs << ", " << rhs << ")\n";
            std::swap(lhs.id, rhs.id);
        }
 
        friend std::ostream& operator<<(std::ostream& os, A const& a)
        {
            return os << "A::id=" << a.id;
        }
 
    public:
        A(int i) : id {i} {}
        A(A const&) = delete;
        A& operator = (A const&) = delete;
    };
}
 
int main()
{
    int a = 5, b = 3;
    std::cout << a << ' ' << b << '\n';
    std::swap(a, b);
    std::cout << a << ' ' << b << '\n';
 
    Ns::A p {6}, q {9};
    std::cout << p << ' ' << q << '\n';
//  std::swap(p, q); // error, type requirements are not satisfied
    swap(p, q);      // OK, ADL finds the appropriate friend `swap`
    std::cout << p << ' ' << q << '\n';
}

Вывод:

5 3
3 5
A::id=6 A::id=9
swap(A::id=6, A::id=9)
A::id=9 A::id=6
END_OF_DOCUMENT_MARKER

Отчёты об ошибках

Следующие отчёты об ошибках, изменяющие поведение, были применены ретроспективно к ранее опубликованным стандартам C++.

DR Применено к Поведение при публикации Корректное поведение
LWG 227 C++98 T не должно было быть CopyConstructible или DefaultConstructible
(объект-временная переменная типа T мог не быть создан)
T также должно
быть CopyConstructible
LWG 809 C++98 массивы нельзя было поменять местами добавлен перегруз (2)
LWG 2554 C++11 перестановка многомерных массивов никогда не
могла быть noexcept из-за проблем со поиском имён
стало работать

См. также

ranges::swap
(C++20)
меняет местами значения двух объектов
(объект-точка кастомизации)
iter_swap
меняет местами элементы, на которые указывают два итератора
(шаблон функции)
swap_ranges
меняет местами два диапазона элементов
(шаблон функции)
exchange
(C++14)
заменяет аргумент новым значением и возвращает его предыдущее значение
(шаблон функции)

© cppreference.com
Licensed under the Creative Commons Attribution-ShareAlike Unported License v3.0.
https://en.cppreference.com/w/cpp/algorithm/swap

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API