std::exchange

 

C++

语言

标准库头文件

自立与有宿主实现

具名要求

语言支持库

概念库 (C++20)

诊断库

工具库

字符串库

容器库

迭代器库

范围库 (C++20)

算法库

数值库

本地化库

输入/输出库

文件系统库 (C++17)

正则表达式库 (C++11)

原子操作库 (C++11)

线程支持库 (C++11)

技术规范

 

工具库

语言支持 类型支持（基本类型、 RTTI 、类型特征）     库功能特性测试宏 (C++20) 动态内存管理 程序工具 错误处理 协程支持 (C++20) 变参数函数 launder (C++17) initializer_list (C++11) source_location (C++20) 三路比较 (C++20) three_way_comparablethree_way_comparable_with (C++20)(C++20) strong_ordering (C++20) weak_ordering (C++20) partial_ordering (C++20) common_comparison_category (C++20) compare_three_way_result (C++20) compare_three_way (C++20) strong_order (C++20) weak_order (C++20) partial_order (C++20) compare_strong_order_fallback (C++20) compare_weak_order_fallback (C++20) compare_partial_order_fallback (C++20) is_eqis_neqis_ltis_lteqis_gtis_gteq (C++20)(C++20)(C++20)(C++20)(C++20)(C++20)

通用工具 日期和时间 函数对象 bitset 格式化库 (C++20) hash (C++11) integer_sequence (C++14) 关系运算符 (C++20 中弃用) rel_ops::operator!=rel_ops::operator> rel_ops::operator<=rel_ops::operator>= 整数比较函数 cmp_equalcmp_lesscmp_less_than (C++20)(C++20)(C++20) cmp_not_equalcmp_greatercmp_greater_than (C++20)(C++20)(C++20) in_range (C++20) swap 与类型运算 swap ranges::swap (C++20) exchange (C++14) declval (C++11) forward (C++11) move (C++11) move_if_noexcept (C++11) as_const (C++17) to_underlying (C++23) 常用词汇类型 pair tuple (C++11) optional (C++17) any (C++17) variant (C++17) tuple_size (C++11) tuple_element (C++11) apply (C++17) make_from_tuple (C++17) 初等字符串转换 to_chars (C++17) from_chars (C++17) chars_format (C++17) 栈踪 stacktrace_entry (C++23) basic_stacktrace (C++23)

 

定义于头文件 <utility>
template< class T, class U = T > T exchange( T& obj, U&& new_value );		(C++14 起) (C++20 前)
template< class T, class U = T > constexpr T exchange( T& obj, U&& new_value );		(C++20 起) (C++23 前)
template< class T, class U = T > constexpr T exchange( T& obj, U&& new_value ) noexcept(/* see below */);		(C++23 起)

以 new_value 替换 obj 的值，并返回 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 // C++20 起 T exchange(T& obj, U&& new_value) noexcept( 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; }

注解

能在实现移动赋值运算符和移动构造函数时使用此函数：

struct S
{
  int n;
 
  S(S&& other) noexcept : n{std::exchange(other.n, 0)}
  {}
 
  S& operator=(S&& other) noexcept 
  {
    if(this != &other)
        n = std::exchange(other.n, 0); // 移动 n ，并于 other.n 留下零
    return *this;
  }
};

示例

运行此代码

#include <iostream>
#include <utility>
#include <vector>
#include <iterator>
 
class stream
{
  public:
 
   using flags_type = int;
 
  public:
 
    flags_type flags() const
    { return flags_; }
 
    /// 以 newf 替换 flags_ 并返回旧值。
    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;
 
   // 因为第二模板形参有默认值，故能以花括号初始化列器表为第二参数。
   // 下方表达式等价于 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)();
 
   // 模板形参的默认值亦使得能以通常函数为第二参数。
   // 下方表达式等价于 std::exchange(fun, static_cast<void(*)()>(f))
   std::exchange(fun,f);
   fun();
}

输出：

0
0
12
 
1, 2, 3, 4, 
 
f()

参阅

swap	交换两个对象的值 (函数模板)
atomic_exchangeatomic_exchange_explicit (C++11)(C++11)	原子地以非原子实参的值替换原子对象的值，并返回该原子对象的旧值 (函数模板)