Implement DPCTLPlatform_AreEq(PRef1, PRef1), DPCTLPlatform_Hash(PRef)

Added declaration, doxygen docs, implementation and tests.

Author: oleksandr-pavlyk

libsyclinterface/include/dpctl_sycl_platform_interface.h

@@ -39,6 +39,19 @@ DPCTL_C_EXTERN_C_BEGIN
  * @defgroup PlatformInterface Platform class C wrapper
  */
 
+/*!
+ * @brief Checks if two DPCTLSyclPlatformRef objects point to the same
+ * sycl::platform.
+ *
+ * @param    PRef1         First opaque pointer to a ``sycl::platform``.
+ * @param    PRef2         Second opaque pointer to a ``sycl::platform``.
+ * @return   True if the underlying sycl::platform are same, false otherwise.
+ * @ingroup PlatformInterface
+ */
+DPCTL_API
+bool DPCTLPlatform_AreEq(__dpctl_keep const DPCTLSyclPlatformRef PRef1,
+                         __dpctl_keep const DPCTLSyclPlatformRef PRef2);
+
 /*!
  * @brief Returns a copy of the DPCTLSyclPlatformRef object.
  *
@@ -155,4 +168,14 @@ DPCTL_API
 __dpctl_give DPCTLSyclContextRef
 DPCTLPlatform_GetDefaultContext(__dpctl_keep const DPCTLSyclPlatformRef PRef);
 
+/*!
+ * @brief Wrapper over std::hash<sycl::platform>'s operator()
+ *
+ * @param    PRef        The DPCTLSyclPlatformRef pointer.
+ * @return   Hash value of the underlying ``sycl::platform`` instance.
+ * @ingroup PlatformInterface
+ */
+DPCTL_API
+size_t DPCTLPlatform_Hash(__dpctl_keep DPCTLSyclPlatformRef CtxRef);
+
 DPCTL_C_EXTERN_C_END

libsyclinterface/source/dpctl_sycl_platform_interface.cpp

@@ -234,3 +234,27 @@ DPCTLPlatform_GetDefaultContext(__dpctl_keep const DPCTLSyclPlatformRef PRef)
         return nullptr;
     }
 }
+
+bool DPCTLPlatform_AreEq(__dpctl_keep const DPCTLSyclPlatformRef PRef1,
+                         __dpctl_keep const DPCTLSyclPlatformRef PRef2)
+{
+    auto P1 = unwrap<platform>(PRef1);
+    auto P2 = unwrap<platform>(PRef2);
+    if (P1 && P2)
+        return *P1 == *P2;
+    else
+        return false;
+}
+
+size_t DPCTLPlatform_Hash(__dpctl_keep const DPCTLSyclPlatformRef PRef)
+{
+    if (PRef) {
+        auto P = unwrap<platform>(PRef);
+        std::hash<platform> hash_fn;
+        return hash_fn(*P);
+    }
+    else {
+        error_handler("Argument PRef is null.", __FILE__, __func__, __LINE__);
+        return 0;
+    }
+}

libsyclinterface/tests/test_sycl_platform_interface.cpp

@@ -264,6 +264,25 @@ TEST_P(TestDPCTLSyclPlatformInterface, ChkPrintInfoNullArg)
     EXPECT_NO_FATAL_FAILURE(DPCTLPlatformMgr_PrintInfo(Null_PRef, 0));
 }
 
+TEST_P(TestDPCTLSyclPlatformInterface, ChkAreEq)
+{
+    DPCTLSyclPlatformRef PRef_Copy = nullptr;
+
+    EXPECT_NO_FATAL_FAILURE(PRef_Copy = DPCTLPlatform_Copy(PRef));
+
+    ASSERT_TRUE(DPCTLPlatform_AreEq(PRef, PRef_Copy));
+    EXPECT_TRUE(DPCTLPlatform_Hash(PRef) == DPCTLPlatform_Hash(PRef_Copy));
+
+    EXPECT_NO_FATAL_FAILURE(DPCTLPlatform_Delete(PRef_Copy));
+}
+
+TEST_P(TestDPCTLSyclPlatformInterface, ChkAreEqNullArg)
+{
+    DPCTLSyclPlatformRef Null_PRef = nullptr;
+    ASSERT_FALSE(DPCTLPlatform_AreEq(PRef, Null_PRef));
+    ASSERT_TRUE(DPCTLPlatform_Hash(Null_PRef) == 0);
+}
+
 TEST_F(TestDPCTLSyclDefaultPlatform, ChkGetName)
 {
     check_platform_name(PRef);