std::exchange

Определено в заголовочном файле `<utility>`
template< class T, class U = T > T exchange( T& obj, U&& new_value );		(начиная с C++14) (constexpr начиная с C++20) (условно noexcept начиная с C++23)

Заменяет значение obj на new_value и возвращает старое значение obj.

Параметры

obj	-	объект, значение которого нужно заменить
new_value	-	значение, присваиваемое `obj`
Требования к типам
-`T` должен удовлетворять требованиям MoveConstructible. Кроме того, должна быть возможна перемещающая операция присваивания объектов типа `U` объектам типа `T`.

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

Старое значение obj.

Исключения

(нет)	(до C++23)
Спецификация `noexcept`: noexcept( std::is_nothrow_move_constructible_v<T> && std::is_nothrow_assignable_v<T&, U> )	(начиная с C++23)

Возможная реализация

template<class T, class U = T>
constexpr // Since C++20
T exchange(T& obj, U&& new_value)
    noexcept( // Since C++23
        std::is_nothrow_move_constructible<T>::value &&
        std::is_nothrow_assignable<T&, U>::value
    )
{
    T old_value = std::move(obj);
    obj = std::forward<U>(new_value);
    return old_value;
}

Примечания

std::exchange можно использовать при реализации перемещающих конструкторов и, для членов, не требующих специальной очистки, операторов перемещающего присваивания:

struct S
{
    int n;

    S(S&& other) noexcept : n{std::exchange(other.n, 0)} {}
  
    S& operator=(S&& other) noexcept
    {
        n = std::exchange(other.n, 0); // Move n, while leaving zero in other.n
        // Note: in case of self-move-assignment, n is unchanged
        // Also note: if n is an opaque resource handle that requires
        //            special cleanup, the resource is leaked.
        return *this;
    }
};

Макрос проверки поддержки возможностей	Значение	Стандарт	Возможность
`__cpp_lib_exchange_function`	`201304L`	(C++14)	`std::exchange`

Пример

#include <iostream>
#include <iterator>
#include <utility>
#include <vector>

class stream
{
public:
    using flags_type = int;

public:
    flags_type flags() const { return flags_; }

    // Replaces flags_ by newf, and returns the old value.
    flags_type flags(flags_type newf) { return std::exchange(flags_, newf); }

private:
    flags_type flags_ = 0;
};

void f() { std::cout << "f()"; }

int main()
{
    stream s;

    std::cout << s.flags() << '\n';
    std::cout << s.flags(12) << '\n';
    std::cout << s.flags() << "\n\n";

    std::vector<int> v;

    // Since the second template parameter has a default value, it is possible
    // to use a braced-init-list as second argument. The expression below
    // is equivalent to std::exchange(v, std::vector<int>{1, 2, 3, 4});

    std::exchange(v, {1, 2, 3, 4});

    std::copy(begin(v), end(v), std::ostream_iterator<int>(std::cout, ", "));

    std::cout << "\n\n";

    void (*fun)();

    // The default value of template parameter also makes possible to use a
    // normal function as second argument. The expression below is equivalent to
    // std::exchange(fun, static_cast<void(*)()>(f))
    std::exchange(fun, f);
    fun();

    std::cout << "\n\nFibonacci sequence: ";
    for (int a{0}, b{1}; a < 100; a = std::exchange(b, a + b))
        std::cout << a << ", ";
    std::cout << "...\n";
}

Вывод:

0
0
12

1, 2, 3, 4,

f()

Fibonacci sequence: 0, 1, 1, 2, 3, 5, 8, 13, 21, 34, 55, 89, ...

См. также

swap	обменивает значения двух объектов (шаблон функции)
atomic_exchangeatomic_exchange_explicit (C++11)(C++11)	атомарно заменяет значение атомарного объекта неатомарным аргументом и возвращает старое значение атомарного объекта (шаблон функции)

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