Merge pull request #389 from IntelPython/equals_changes_and_misc

Equals changes and misc

Author: oleksandr-pavlyk

dpctl/_sycl_context.pxd

@@ -42,5 +42,5 @@ cdef public class SyclContext(_SyclContext) [object PySyclContextObject, type Py
     cdef int _init_context_from_one_device(self, SyclDevice device, int props)
     cdef int _init_context_from_devices(self, object devices, int props)
     cdef int _init_context_from_capsule(self, object caps)
-    cpdef bool equals (self, SyclContext ctxt)
+    cdef bool equals (self, SyclContext ctxt)
     cdef DPCTLSyclContextRef get_context_ref (self)

dpctl/_sycl_context.pyx

@@ -301,7 +301,7 @@ cdef class SyclContext(_SyclContext):
                 "Unrecognized error code ({}) encountered.".format(ret)
             )
 
-    cpdef bool equals(self, SyclContext ctxt):
+    cdef bool equals(self, SyclContext ctxt):
         """
         Returns true if the :class:`dpctl.SyclContext` argument has the
         same underlying ``DPCTLSyclContextRef`` object as this
@@ -314,6 +314,22 @@ cdef class SyclContext(_SyclContext):
         """
         return DPCTLContext_AreEq(self._ctxt_ref, ctxt.get_context_ref())
 
+    def __eq__(self, other):
+        """
+        Returns True if the :class:`dpctl.SyclContext` argument has the
+        same underlying ``DPCTLSyclContextRef`` object as this
+        :class:`dpctl.SyclContext` instance.
+
+        Returns:
+            :obj:`bool`: ``True`` if the two :class:`dpctl.SyclContext` objects
+            point to the same ``DPCTLSyclContextRef`` object, otherwise
+            ``False``.
+        """
+        if isinstance(other, SyclContext):
+            return self.equals(<SyclContext> other)
+        else:
+            return False
+
     cdef DPCTLSyclContextRef get_context_ref(self):
         return self._ctxt_ref
 

dpctl/_sycl_device.pxd

@@ -49,4 +49,4 @@ cdef public class SyclDevice(_SyclDevice) [object PySyclDeviceObject, type PySyc
     cdef list create_sub_devices_equally(self, size_t count)
     cdef list create_sub_devices_by_counts(self, object counts)
     cdef list create_sub_devices_by_affinity(self, _partition_affinity_domain_type domain)
-    cpdef cpp_bool equals(self, SyclDevice q)
+    cdef cpp_bool equals(self, SyclDevice q)

dpctl/_sycl_device.pyx

@@ -774,7 +774,7 @@ cdef class SyclDevice(_SyclDevice):
             return None
         return SyclDevice._create(pDRef)
 
-    cpdef cpp_bool equals(self, SyclDevice other):
+    cdef cpp_bool equals(self, SyclDevice other):
         """ Returns true if the SyclDevice argument has the same _device_ref
             as this SyclDevice.
         """

dpctl/_sycl_queue.pxd

@@ -66,7 +66,7 @@ cdef public class SyclQueue (_SyclQueue) [object PySyclQueueObject, type PySyclQ
     cdef  SyclQueue _create_from_context_and_device(
         SyclContext ctx, SyclDevice dev
     )
-    cpdef cpp_bool equals(self, SyclQueue q)
+    cdef cpp_bool equals(self, SyclQueue q)
     cpdef SyclContext get_sycl_context(self)
     cpdef SyclDevice get_sycl_device(self)
     cdef  DPCTLSyclQueueRef get_queue_ref(self)

dpctl/_sycl_queue.pyx

@@ -319,16 +319,14 @@ cdef class SyclQueue(_SyclQueue):
                 raise SyclQueueCreationError(
                     "SYCL Context could not be created from '{}'.".format(arg)
                 )
-            elif status == -4:
+            elif status == -4 or status == -6:
                 if len_args == 2:
                     arg = args
                 raise SyclQueueCreationError(
                     "SYCL Queue failed to be created from '{}'.".format(arg)
                 )
             elif status == -5:
                 raise TypeError("Input capsule {} contains a null pointer or could not be renamed".format(arg))
-            elif status == -6:
-                raise "SYCL Queue failed to be created from '{}'.".format(arg)
 
     cdef int _init_queue_from__SyclQueue(self, _SyclQueue other):
         """ Copy data container _SyclQueue fields over.
@@ -601,12 +599,27 @@ cdef class SyclQueue(_SyclQueue):
 
         return ret
 
-    cpdef cpp_bool equals(self, SyclQueue q):
-        """ Returns true if the SyclQueue argument has the same _queue_ref
+    cdef cpp_bool equals(self, SyclQueue q):
+        """ Returns true if the SyclQueue argument `q` has the same _queue_ref
             as this SyclQueue.
         """
         return DPCTLQueue_AreEq(self._queue_ref, q.get_queue_ref())
 
+    def __eq__(self, other):
+        """
+        Returns True if two :class:`dpctl.SyclQueue` compared arguments have
+        the same underlying ``DPCTLSyclQueueRef`` object.
+
+        Returns:
+            :obj:`bool`: ``True`` if the two :class:`dpctl.SyclQueue` objects
+            point to the same ``DPCTLSyclQueueRef`` object, otherwise
+            ``False``.
+        """
+        if isinstance(other, SyclQueue):
+            return self.equals(<SyclQueue> other)
+        else:
+            return False
+
     def get_sycl_backend (self):
         """ Returns the Sycl backend associated with the queue.
         """

dpctl/tests/test_sycl_context.py

@@ -349,7 +349,7 @@ def test_context_not_equals():
         ctx_cpu = dpctl.SyclContext("cpu")
     except ValueError:
         pytest.skip()
-    assert not ctx_cpu.equals(ctx_gpu)
+    assert ctx_cpu != ctx_gpu
 
 
 def test_context_equals():
@@ -358,7 +358,7 @@ def test_context_equals():
         ctx0 = dpctl.SyclContext("gpu")
     except ValueError:
         pytest.skip()
-    assert ctx0.equals(ctx1)
+    assert ctx0 == ctx1
 
 
 def test_context_can_be_used_in_queue(valid_filter):

dpctl/tests/test_sycl_queue.py

@@ -349,7 +349,7 @@ def test_context_not_equals():
     except dpctl.SyclQueueCreationError:
         pytest.skip()
     ctx_cpu = cpuQ.get_sycl_context()
-    assert not ctx_cpu.equals(ctx_gpu)
+    assert ctx_cpu != ctx_gpu
 
 
 def test_context_equals():
@@ -360,4 +360,4 @@ def test_context_equals():
         pytest.skip()
     ctx0 = gpuQ0.get_sycl_context()
     ctx1 = gpuQ1.get_sycl_context()
-    assert ctx0.equals(ctx1)
+    assert ctx0 == ctx1