std::equality_comparable, std::equality_comparable_with

 

C++

编译器支持

自由（freestanding）与宿主（hosted）

语言

标准库

标准库头文件

具名要求

特性测试宏 (C++20)

语言支持库

概念库 (C++20)

诊断库

内存管理库

元编程库 (C++11)

通用工具库

容器库

迭代器库

范围库 (C++20)

算法库

字符串库

文本处理库

数值库

日期和时间库

输入/输出库

文件系统库 (C++17)

并发支持库 (C++11)

执行控制库 (C++26)

技术规范

符号索引

外部库

 

概念库

核心语言概念 same_as (C++20) derived_from (C++20) convertible_to (C++20) common_reference_with (C++20) common_with (C++20) integral (C++20) signed_integral (C++20) unsigned_integral (C++20) floating_point (C++20) swappableswappable_with (C++20)(C++20) destructible (C++20) constructible_from (C++20) default_initializable (C++20)   move_constructible (C++20) copy_constructible (C++20) assignable_from (C++20)

比较概念 equality_comparableequality_comparable_with (C++20)(C++20) totally_orderedtotally_ordered_with (C++20)(C++20) 对象概念 movable (C++20) copyable (C++20) semiregular (C++20) regular (C++20) 可调用概念 invocableregular_invocable (C++20)(C++20) predicate (C++20) relation (C++20) equivalence_relation (C++20) strict_weak_order (C++20)

仅用于阐释的概念 boolean-testable  (C++20)

 

定义于头文件 <concepts>
template< class T > concept equality_comparable = __WeaklyEqualityComparableWith<T, T>;	(1)	(C++20 起)
template< class T, class U > concept equality_comparable_with =     std::equality_comparable<T> &&     std::equality_comparable<U> &&     __ComparisonCommonTypeWith<T, U> &&     std::equality_comparable<         std::common_reference_t<             const std::remove_reference_t<T>&,             const std::remove_reference_t<U>&>> &&     __WeaklyEqualityComparableWith<T, U>;	(2)	(C++20 起)
辅助概念
template< class T, class U > concept __WeaklyEqualityComparableWith =     requires(const std::remove_reference_t<T>& t,              const std::remove_reference_t<U>& u) {         { t == u } -> boolean-testable;         { t != u } -> boolean-testable;         { u == t } -> boolean-testable;         { u != t } -> boolean-testable;     };	(3)	(仅作说明*)
	(4)
template< class T, class U > concept __ComparisonCommonTypeWith =     std::common_reference_with<         const std::remove_reference_t<T>&,         const std::remove_reference_t<U>&>;			(直至 C++23) (仅作说明*)
template< class T, class U, class C = std::common_reference_t<const T&, const U&> > concept _ComparisonCommonTypeWithImpl =     std::same_as<std::common_reference_t<const T&, const U&>,                  std::common_reference_t<const U&, const T&>> &&     requires {         requires std::convertible_to<const T&, const C&> ||             std::convertible_to<T, const C&>;         requires std::convertible_to<const U&, const C&> ||             std::convertible_to<U, const C&>;     }; template< class T, class U > concept __ComparisonCommonTypeWith =     _ComparisonCommonTypeWithImpl<std::remove_cvref_t<T>, std::remove_cvref_t<U>>;			(C++23 起) (仅作说明*)

1) 概念 std::equality_comparable 指定类型 T 上的比较运算符 == 和 != 反映相等性：当且仅当操作数相等时，== 返回 true。

2) 概念 std::equality_comparable_with 指定（可能是混合的）T 和 U 操作数上的比较运算符 == 和 != 产生与相等性一致的结果。比较混合操作数产生的结果等同于将操作数转换为其共同类型后进行比较。

3) 仅用于解释的概念 __WeaklyEqualityComparableWith 指定类型 T 的对象和类型 U 的对象可以相互（按任意顺序）使用 == 和 != 进行相等性比较，并且比较结果是一致的。

4) 仅用于解释的概念 __ComparisonCommonTypeWith 指定两种类型共享一个共同类型，并且任一类型的 const 左值 或非 const 右值(C++23 起) 可转换为该共同类型。

语义要求

这些概念只有在它们自身满足并且它们所包含的所有概念都满足时才被建模。

在以下段落中，给定表达式 E 和类型 C，CONVERT_TO<C>(E) 定义为

static_cast<C>(std::as_const(E)).	(直至 C++23)
如果这是一个有效表达式，则为 static_cast<const C&>(std::as_const(E))， 否则为 static_cast<const C&>(std::move(E))。	(C++23 起)

1) std::equality_comparable<T> 仅在以下情况下被建模：给定类型 T 的对象 a 和 b，当且仅当 a 和 b 相等时，bool(a == b) 为 true。结合 a == b 是保持相等的要求，这意味着 == 是对称和传递的，并且对于所有至少与一个其他对象相等的对象 a 来说，== 是自反的。

2) std::equality_comparable_with<T, U> 仅在以下情况下被建模：设

• t 和 t2 为分别表示类型 const std::remove_reference_t<T> 和 std::remove_cvref_t<T> 的不同相等对象的左值，
• u 和 u2 为分别表示类型 const std::remove_reference_t<U> 和 std::remove_cvref_t<U> 的不同相等对象的左值，
• C 为 std::common_reference_t<const std::remove_reference_t<T>&, const std::remove_reference_t<U>&>，

以下表达式为真：

• bool(t == u) == bool(CONVERT_TO<C>(t2) == CONVERT_TO<C>(u2)).

3) __WeaklyEqualityComparableWith<T, U> 仅在给定以下对象时被建模：

• t，类型为 const std::remove_reference_t<T> 的左值，以及
• u，类型为 const std::remove_reference_t<U> 的左值，

以下为真：

• t == u、u == t、t != u、u != t 具有相同的域；
• bool(u == t) == bool(t == u);
• bool(t != u) == !bool(t == u)；以及
• bool(u != t) == bool(t != u).

4) __WeaklyEqualityComparableWith<T, U> 仅在以下情况下被建模：

对应的 common_reference_with 概念被建模。	(直至 C++23)
令 C 为 std::common_reference_t<const T&, const U&>， t1 和 t2 为 保持相等的表达式，它们是类型 std::remove_cvref_t<T> 的左值， u1 和 u2 为 保持相等的表达式，它们是类型 std::remove_cvref_t<U> 的左值， 以下条件成立： 当且仅当 t1 等于 t2 时，CONVERT_TO<C>(t1) 等于 CONVERT_TO<C>(t2)；以及 当且仅当 u1 等于 u2 时，CONVERT_TO<C>(u1) 等于 CONVERT_TO<C>(u2)。	(C++23 起)

保持相等

标准库概念的 requires 表达式中声明的表达式必须是保持相等的（除非另有说明）。

隐式表达式变体

使用对于某个常量左值操作数是非修改性表达式的 requires 表达式也需要隐式表达式变体。

参考

• C++23 标准 (ISO/IEC 14882:2024)

• 18.5.4 Concept equality_comparable [concept.equalitycomparable]

• C++20 标准 (ISO/IEC 14882:2020)

• 18.5.3 Concept equality_comparable [concept.equalitycomparable]