[llvm] [STLExtras] Add a template for detecting whether a type has an equality comparison operator (PR #176429)

Benjamin Stott via llvm-commits llvm-commits at lists.llvm.org
Mon Jan 19 08:05:59 PST 2026


https://github.com/BStott6 updated https://github.com/llvm/llvm-project/pull/176429

>From f1b15dc6e72866ff70ddba8de34609a1ef93ca55 Mon Sep 17 00:00:00 2001
From: BStott <Benjamin.Stott at sony.com>
Date: Fri, 16 Jan 2026 16:50:21 +0000
Subject: [PATCH 1/3] [STLExtras] Add a template for detecting whether a type
 has an equality-comparison operator

---
 llvm/include/llvm/ADT/STLExtras.h    | 11 +++++++++++
 llvm/unittests/ADT/STLExtrasTest.cpp | 22 ++++++++++++++++++++++
 2 files changed, 33 insertions(+)

diff --git a/llvm/include/llvm/ADT/STLExtras.h b/llvm/include/llvm/ADT/STLExtras.h
index 23da931a63de1..fd31430ede911 100644
--- a/llvm/include/llvm/ADT/STLExtras.h
+++ b/llvm/include/llvm/ADT/STLExtras.h
@@ -2682,6 +2682,17 @@ template <typename T> using has_sizeof = decltype(sizeof(T));
 template <typename T>
 constexpr bool is_incomplete_v = !is_detected<detail::has_sizeof, T>::value;
 
+// Detect types with equality comparison operators.
+namespace detail {
+template <typename T>
+using has_equality_comparison =
+    decltype(std::declval<const T &>() == std::declval<const T &>());
+} // namespace detail
+
+/// Detects when type `const T` can be compared for equality with itself.
+template <typename T>
+constexpr bool has_equality_comparison_v =
+    is_detected<detail::has_equality_comparison, T>::value;
 } // end namespace llvm
 
 namespace std {
diff --git a/llvm/unittests/ADT/STLExtrasTest.cpp b/llvm/unittests/ADT/STLExtrasTest.cpp
index fe71945e4a794..02b4eee04d005 100644
--- a/llvm/unittests/ADT/STLExtrasTest.cpp
+++ b/llvm/unittests/ADT/STLExtrasTest.cpp
@@ -1780,6 +1780,28 @@ struct Bar {};
 static_assert(is_incomplete_v<Foo>, "Foo is incomplete");
 static_assert(!is_incomplete_v<Bar>, "Bar is defined");
 
+struct NoEqualityComparison {};
+static_assert(!has_equality_comparison_v<NoEqualityComparison>);
+
+// Mutating equality comparison doesn't count.
+struct MutatingEqualityComparison {
+  bool operator==(MutatingEqualityComparison &Other) { return false; }
+};
+static_assert(!has_equality_comparison_v<MutatingEqualityComparison>);
+
+struct PrivateEqualityComparison {
+private:
+  bool operator==(const PrivateEqualityComparison &Other) const {
+    return false;
+  }
+};
+static_assert(!has_equality_comparison_v<PrivateEqualityComparison>);
+
+struct PublicEqualityComparison {
+  bool operator==(const PublicEqualityComparison &Other) const { return false; }
+};
+static_assert(has_equality_comparison_v<PublicEqualityComparison>);
+
 TEST(STLExtrasTest, Search) {
   // Test finding a subsequence in the middle.
   std::vector<int> Haystack = {1, 2, 3, 4, 5, 6, 7, 8};

>From c8b43a379f767384965d4db88e9249d3a7036db5 Mon Sep 17 00:00:00 2001
From: BStott <Benjamin.Stott at sony.com>
Date: Mon, 19 Jan 2026 11:30:41 +0000
Subject: [PATCH 2/3] Make has_equality_comparison_v take two template
 parameters

---
 llvm/include/llvm/ADT/STLExtras.h    | 10 +++++-----
 llvm/unittests/ADT/STLExtrasTest.cpp |  7 +++++++
 2 files changed, 12 insertions(+), 5 deletions(-)

diff --git a/llvm/include/llvm/ADT/STLExtras.h b/llvm/include/llvm/ADT/STLExtras.h
index fd31430ede911..d9c6b9ac5f1d7 100644
--- a/llvm/include/llvm/ADT/STLExtras.h
+++ b/llvm/include/llvm/ADT/STLExtras.h
@@ -2684,15 +2684,15 @@ constexpr bool is_incomplete_v = !is_detected<detail::has_sizeof, T>::value;
 
 // Detect types with equality comparison operators.
 namespace detail {
-template <typename T>
+template <typename T, typename U>
 using has_equality_comparison =
-    decltype(std::declval<const T &>() == std::declval<const T &>());
+    decltype(std::declval<const T &>() == std::declval<const U &>());
 } // namespace detail
 
-/// Detects when type `const T` can be compared for equality with itself.
-template <typename T>
+/// Detects when type `const T` can be compared for equality with `const U`.
+template <typename T, typename U = T>
 constexpr bool has_equality_comparison_v =
-    is_detected<detail::has_equality_comparison, T>::value;
+    is_detected<detail::has_equality_comparison, T, U>::value;
 } // end namespace llvm
 
 namespace std {
diff --git a/llvm/unittests/ADT/STLExtrasTest.cpp b/llvm/unittests/ADT/STLExtrasTest.cpp
index 02b4eee04d005..e9b0f2c369547 100644
--- a/llvm/unittests/ADT/STLExtrasTest.cpp
+++ b/llvm/unittests/ADT/STLExtrasTest.cpp
@@ -1802,6 +1802,13 @@ struct PublicEqualityComparison {
 };
 static_assert(has_equality_comparison_v<PublicEqualityComparison>);
 
+struct StructA {};
+struct StructB {
+  bool operator==(const StructA &Other) const { return false; }
+};
+static_assert(!has_equality_comparison_v<StructA, StructB>);
+static_assert(has_equality_comparison_v<StructB, StructA>);
+
 TEST(STLExtrasTest, Search) {
   // Test finding a subsequence in the middle.
   std::vector<int> Haystack = {1, 2, 3, 4, 5, 6, 7, 8};

>From b298b01bcde917057d2ef0c7bca685d3ff055ba2 Mon Sep 17 00:00:00 2001
From: BStott <Benjamin.Stott at sony.com>
Date: Mon, 19 Jan 2026 16:05:35 +0000
Subject: [PATCH 3/3] Surround test assertions in a test function

---
 llvm/unittests/ADT/STLExtrasTest.cpp | 58 +++++++++++++++-------------
 1 file changed, 32 insertions(+), 26 deletions(-)

diff --git a/llvm/unittests/ADT/STLExtrasTest.cpp b/llvm/unittests/ADT/STLExtrasTest.cpp
index e9b0f2c369547..a2eb251c98588 100644
--- a/llvm/unittests/ADT/STLExtrasTest.cpp
+++ b/llvm/unittests/ADT/STLExtrasTest.cpp
@@ -1777,37 +1777,43 @@ TEST(STLExtrasTest, ReverseConditionally) {
 struct Foo;
 struct Bar {};
 
-static_assert(is_incomplete_v<Foo>, "Foo is incomplete");
-static_assert(!is_incomplete_v<Bar>, "Bar is defined");
+TEST(STLExtrasTest, HasEqualityComparison) {
+  static_assert(is_incomplete_v<Foo>, "Foo is incomplete");
+  static_assert(!is_incomplete_v<Bar>, "Bar is defined");
 
-struct NoEqualityComparison {};
-static_assert(!has_equality_comparison_v<NoEqualityComparison>);
+  struct NoEqualityComparison {};
+  static_assert(!has_equality_comparison_v<NoEqualityComparison>);
 
-// Mutating equality comparison doesn't count.
-struct MutatingEqualityComparison {
-  bool operator==(MutatingEqualityComparison &Other) { return false; }
-};
-static_assert(!has_equality_comparison_v<MutatingEqualityComparison>);
+  // Mutating equality comparison doesn't count.
+  struct MutatingEqualityComparison {
+    bool operator==(MutatingEqualityComparison &Other) { return false; }
+  };
+  static_assert(!has_equality_comparison_v<MutatingEqualityComparison>);
 
-struct PrivateEqualityComparison {
-private:
-  bool operator==(const PrivateEqualityComparison &Other) const {
-    return false;
-  }
-};
-static_assert(!has_equality_comparison_v<PrivateEqualityComparison>);
+  struct PrivateEqualityComparison {
+  private:
+    bool operator==(const PrivateEqualityComparison &Other) const {
+      return false;
+    }
+  };
+  static_assert(!has_equality_comparison_v<PrivateEqualityComparison>);
 
-struct PublicEqualityComparison {
-  bool operator==(const PublicEqualityComparison &Other) const { return false; }
-};
-static_assert(has_equality_comparison_v<PublicEqualityComparison>);
+  struct PublicEqualityComparison {
+    bool operator==(const PublicEqualityComparison &Other) const {
+      return false;
+    }
+  };
+  static_assert(has_equality_comparison_v<PublicEqualityComparison>);
 
-struct StructA {};
-struct StructB {
-  bool operator==(const StructA &Other) const { return false; }
-};
-static_assert(!has_equality_comparison_v<StructA, StructB>);
-static_assert(has_equality_comparison_v<StructB, StructA>);
+  struct StructA {};
+  struct StructB {
+    bool operator==(const StructA &Other) const { return false; }
+  };
+  static_assert(!has_equality_comparison_v<StructA, StructB>);
+  static_assert(has_equality_comparison_v<StructB, StructA>);
+
+  SUCCEED();
+}
 
 TEST(STLExtrasTest, Search) {
   // Test finding a subsequence in the middle.



More information about the llvm-commits mailing list