std::ranges::swap

 

C++

编译器支持

自由（freestanding）与宿主（hosted）

语言

标准库

标准库头文件

具名要求

特性测试宏 (C++20)

语言支持库

概念库 (C++20)

诊断库

内存管理库

元编程库 (C++11)

通用工具库

容器库

迭代器库

范围库 (C++20)

算法库

字符串库

文本处理库

数值库

日期和时间库

输入/输出库

文件系统库 (C++17)

并发支持库 (C++11)

执行控制库 (C++26)

技术规范

符号索引

外部库

 

工具库

语言支持 类型支持（基本类型、RTTI） 库特性测试宏 (C++20) 程序工具 变参函数 initializer_list (C++11) is_constant_evaluated (C++20) is_within_lifetime (C++26) source_location (C++20) 协程支持 (C++20) 契约支持 (C++26) 三路比较 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_ltis_lteq (C++20)(C++20)(C++20)   is_neqis_gtis_gteq (C++20)(C++20)(C++20)

通用工具 函数对象 位操作 (C++20) bitset hash (C++11) 关系运算符 (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 ranges::swap (C++20) exchange (C++14) declval (C++11) to_underlying (C++23) forward (C++11) forward_like (C++23) move (C++11) move_if_noexcept (C++11) as_const (C++17) 常用词汇类型 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) expected (C++23)

 

定义于头文件 <concepts>
namespace ranges {     inline namespace /* 未指定 */ {         inline constexpr /* 未指定 */ swap = /* 未指定 */;     } }		(C++20 起) (定制点对象)
调用签名 (Call signature)
template< class T, class U > constexpr void ranges::swap( T&& t, U&& u ) noexcept(/* 见下文 */);		(C++20 起)

交换由 t 和 u 引用的值。

ranges::swap(t, u) 在表达式上等价于

1. (void)swap(t, u)，如果 t 或 u 具有类或枚举类型，且该表达式有效，其中重载决议在命名空间 std::ranges 中执行，并添加候选 template<class T> void swap(T&, T&) = delete;。
   • 如果重载决议选中的函数未交换由 t 和 u 引用的值，则程序格式错误；无需诊断。
2. 否则，如果 t 和 u 是相等范围（但可能不同元素类型）的左值数组，且 ranges::swap(*t, *u) 是一个有效表达式，则为 (void)ranges::swap_ranges(t, u)，除了 noexcept((void)ranges::swap_ranges(t, u)) 等于 noexcept(ranges::swap(*t, *u))。
3. 否则，一个交换 t 和 u 所引用值的表达式，如果它们都是相同类型 V 的左值，并且 V 满足 std::move_constructible<V> 和 std::assignable_from<V&, V>。
   • 对该表达式应用 noexcept 运算符的结果等于 std::is_nothrow_move_constructible_v<V> && std::is_nothrow_move_assignable_v<V>。
   • 该表达式是一个常量表达式，如果
     • V 是一个字面类型 (LiteralType)，
     • 以及 t = std::move(u)) 和 u = std::move(t) 都是常量子表达式，并且
     • 以下声明中初始化器的完整表达式是常量子表达式
       • V v1(std::move(t));
       • V v2(std::move(u));
4. 否则，ranges::swap(t, u) 格式错误，当 ranges::swap(t, u) 出现在模板实例化的直接语境中时，可能导致替换失败。

自定义点对象

名称 ranges::swap 表示一个“自定义点对象 (customization point object)”，它是一个 const 函数对象，类型为字面类型的semiregular类。为便于说明，其类型中 cv 不限定的版本表示为 __swap_fn。

__swap_fn 的所有实例都相等。在相同参数上调用类型为 __swap_fn 的不同实例的效果是等价的，无论表示该实例的表达式是左值还是右值，以及是否为 const 限定（但是，volatile 限定的实例不要求可调用）。因此，ranges::swap 可以自由复制，并且其副本可以互换使用。

给定一组类型 Args...，如果 std::declval<Args>()... 满足上述 ranges::swap 参数的要求，则 __swap_fn 遵循

• std::invocable<__swap_fn, Args...>,
• std::invocable<const __swap_fn, Args...>,
• std::invocable<__swap_fn&, Args...>，以及
• std::invocable<const __swap_fn&, Args...>.
  

否则，__swap_fn 的函数调用运算符不参与重载决议。

示例

运行此代码

#include <array>
#include <concepts>
#include <iostream>
#include <ranges>
#include <string_view>
#include <vector>
 
void print(std::string_view name, 
           std::ranges::common_range auto const& p, 
           std::ranges::common_range auto const& q)
{
    std::cout << name << "1{ ";
    for (auto const& i : p)
        std::cout << i << ' ';
    std::cout << "}, " << name << "2{ ";
    for (auto const& i : q)
        std::cout << i << ' ';
    std::cout << "}\n";
}
 
void print(std::string_view name, int p, int q)
{
    std::cout << name << "1 = " << p << ", " << name << "2 = " << q << '\n';
}
 
struct IntLike
{
    int v;
};
 
void swap(IntLike& lhs, int& rhs)
{
    std::swap(lhs.v, rhs);
}
 
void swap(int& lhs, IntLike& rhs)
{
    std::swap(lhs, rhs.v);
}
 
std::ostream& operator<<(std::ostream& out, IntLike i)
{
    return out << i.v;
}
 
int main()
{
    std::vector a1{10, 11, 12}, a2{13, 14};
    std::ranges::swap(a1, a2);
    print("a", a1, a2);
 
    std::array b1{15, 16, 17}, b2{18, 19, 20};
    std::ranges::swap(b1, b2);
    print("b", b1, b2);
 
    // std::array c1{1, 2, 3}; std::array c2{4, 5};
    // std::ranges::swap(c1, c2); // error: no swap found by ADL
 
    int d1[]{21, 22, 23}, d2[]{24, 25, 26};
    std::ranges::swap(d1, d2);
    print("d", d1, d2);
 
    // int e1[]{1, 2, 3}, e2[]{4, 5};
    // std::ranges::swap(e1, e2); // error: extents mismatch
 
    // char f1[]{1, 2, 3};
    // int  f2[]{4, 5, 6};
    // std::ranges::swap(f1, f2); // error: no swap(*f1, *f2) found by ADL
 
    IntLike g1[]{1, 2, 3};
    int     g2[]{4, 5, 6};
    std::ranges::swap(g1, g2); // heterogeneous swap supported
    print("g", g1, g2);
 
    int h1{27}, h2{28};
    std::ranges::swap(h1, h2);
    print("h", h1, h2);
}

输出

a1{ 13 14 }, a2{ 10 11 12 }
b1{ 18 19 20 }, b2{ 15 16 17 }
d1{ 24 25 26 }, d2{ 21 22 23 }
g1{ 4 5 6 }, g2{ 1 2 3 }
h1 = 28, h2 = 27

另见

swappableswappable_with (C++20)	指定类型可以被交换，或者两种类型可以互相交换 (概念)
swap	交换两个对象的值 (函数模板)