Namespaces
Variants

std:: exchange

From cppreference.net
C++
Utilities library
ヘッダーで定義 <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 の元の値を返します。

目次

翻訳の説明： - 「Contents」を「目次」に翻訳しました - C++関連の専門用語（Parameters, Return value, Exceptions, Possible implementation, Notes, Example, See also）は原文のまま保持しました - HTMLタグ、属性、クラス名、IDなどは一切変更していません - 数値やリンク構造も完全に保持しています - 技術文書としての正確性と専門性を維持しています

パラメータ

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 // C++20以降
T exchange(T& obj, U&& new_value)
    noexcept( // 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 は、 move constructors および、 special cleanup を必要としないメンバーに対する move assignment operators の実装時に使用できます： 

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); // nをムーブし、other.nにゼロを残す
        // 注: 自己ムーブ代入の場合、nは変更されない
        // また注意: nが特別なクリーンアップを必要とする不透明なリソースハンドルの場合、リソースはリークする
        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_; }
    // flags_をnewfで置き換え、古い値を返す
    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;
    // 第2テンプレートパラメータにデフォルト値があるため、
    // 波括弧初期化リストを第2引数として使用可能
    // 以下の式は 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)();
    // テンプレートパラメータのデフォルト値により、通常の関数を
    // 第2引数として使用することも可能
    // 以下の式は 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, ...

関連項目

2つのオブジェクトの値を交換する
(関数テンプレート)
(C++11) (C++11)
アトミックオブジェクトの値を非アトミック引数でアトミックに置き換え、アトミックオブジェクトの古い値を返す
(関数テンプレート)