Added special methods to usm_ndarray implemented to raise NotImplementedError

Author: oleksandr-pavlyk

dpctl/tensor/_usmarray.pxd

@@ -36,6 +36,7 @@ cdef api class usm_ndarray [object PyUSMArrayObject, type PyUSMArrayType]:
     cdef int typenum_
     cdef int flags_
     cdef object base_
+    cdef object array_namespace_
     # make usm_ndarray weak-referenceable
     cdef object __weakref__
 

dpctl/tensor/_usmarray.pyx

@@ -55,7 +55,8 @@ cdef class usm_ndarray:
     usm_ndarray(
         shape, dtype="|f8", strides=None, buffer='device',
         offset=0, order='C',
-        buffer_ctor_kwargs=dict()
+        buffer_ctor_kwargs=dict(),
+        array_namespace=None
     )
 
     See :class:`dpctl.memory.MemoryUSMShared` for allowed
@@ -76,6 +77,7 @@ cdef class usm_ndarray:
         Initializes member fields
         """
         self.base_ = None
+        self.array_namespace_ = None
         self.nd_ = -1
         self.data_ = <char *>0
         self.shape_ = <Py_ssize_t *>0
@@ -106,13 +108,16 @@ cdef class usm_ndarray:
             order=('C' if (self.flags_ & USM_ARRAY_C_CONTIGUOUS) else 'F')
         )
         res.flags_ = self.flags_
+        res.array_namespace_ = self.array_namespace_
         if (res.data_ != self.data_):
             raise InternalUSMArrayError(
                 "Data pointers of cloned and original objects are different.")
         return res
 
     def __cinit__(self, shape, dtype="|f8", strides=None, buffer='device',
-                  Py_ssize_t offset=0, order='C', buffer_ctor_kwargs=dict()):
+                  Py_ssize_t offset=0, order='C',
+                  buffer_ctor_kwargs=dict(),
+                  array_namespace=None):
         """
         strides and offset must be given in units of array elements.
         buffer can be strings ('device'|'shared'|'host' to allocate new memory)
@@ -208,6 +213,7 @@ cdef class usm_ndarray:
         self.typenum_ = typenum
         self.flags_ = contig_flag
         self.nd_ = nd
+        self.array_namespace_ = array_namespace
 
     def __dealloc__(self):
         self._cleanup()
@@ -489,8 +495,53 @@ cdef class usm_ndarray:
             offset=_meta[2]
         )
         res.flags_ |= (self.flags_ & USM_ARRAY_WRITEABLE)
+        res.array_namespace_ = self.array_namespace_
         return res
 
+    def to_device(self, target_device):
+        """
+        Transfer array to target device
+        """
+        d = Device.create_device(target_device)
+        if (d.sycl_device == self.sycl_device):
+            return self
+        elif (d.sycl_context == self.sycl_context):
+            res = usm_ndarray(
+                self.shape,
+                self.dtype,
+                buffer=self.usm_data,
+                strides=self.strides,
+                offset=self.get_offset()
+            )
+            res.flags_ = self.flags
+            return res
+        else:
+            nbytes = self.usm_data.nbytes
+            new_buffer = type(self.usm_data)(
+                nbytes, queue=d.sycl_queue
+            )
+            new_buffer.copy_from_device(self.usm_data)
+            res = usm_ndarray(
+                self.shape,
+                self.dtype,
+                buffer=new_buffer,
+                strides=self.strides,
+                offset=self.get_offset()
+            )
+            res.flags_ = self.flags
+            return res
+
+    def _set_namespace(self, mod):
+        """ Sets array namespace to given module `mod`. """
+        self.array_namespace_ = mod
+
+    def __array_namespace__(self, api_version=None):
+        """
+        Returns array namespace, member functions of which
+        implement data API.
+        """
+        return self.array_namespace_
+
     def __bool__(self):
         if self.size == 1:
             mem_view = dpmem.as_usm_memory(self)
@@ -539,38 +590,89 @@ cdef class usm_ndarray:
 
         raise IndexError("only integer arrays are valid indices")
 
-    def to_device(self, target_device):
-        """
-        Transfer array to target device
-        """
-        d = Device.create_device(target_device)
-        if (d.sycl_device == self.sycl_device):
-            return self
-        elif (d.sycl_context == self.sycl_context):
-            res = usm_ndarray(
-                self.shape,
-                self.dtype,
-                buffer=self.usm_data,
-                strides=self.strides,
-                offset=self.get_offset()
-            )
-            res.flags_ = self.flags
-            return res
+    def __abs__(self):
+        return NotImplemented
+
+    def __add__(self, other):
+        return NotImplemented
+
+    def __and__(self, other):
+        return NotImplemented
+
+    def __dlpack__(self, stream=None):
+        return NotImplemented
+
+    def __dlpack_device__(self):
+        return NotImplemented
+
+    def __eq__(self, other):
+        return NotImplemented
+
+    def __floordiv__(self, other):
+        return NotImplemented
+
+    def __ge__(self, other):
+        return NotImplemented
+
+    def __gt__(self, other):
+        return NotImplemented
+
+    def __invert__(self):
+        return NotImplemented
+
+    def __le__(self, other):
+        return NotImplemented
+
+    def __len__(self):
+        if (self.nd_):
+            return self.shape[0]
         else:
-            nbytes = self.usm_data.nbytes
-            new_buffer = type(self.usm_data)(
-                nbytes, queue=d.sycl_queue
-            )
-            new_buffer.copy_from_device(self.usm_data)
-            res = usm_ndarray(
-                self.shape,
-                self.dtype,
-                buffer=new_buffer,
-                strides=self.strides,
-                offset=self.get_offset()
-            )
-            res.flags_ = self.flags
-            return res
+            raise TypeError("len() of unsized object")
+
+    def __lshift__(self, other):
+        return NotImplemented
+
+    def __lt__(self, other):
+        return NotImplemented
+
+    def __matmul__(self, other):
+        return NotImplemented
+
+    def __mod__(self, other):
+        return NotImplemented
+
+    def __mult__(self, other):
+        return NotImplemented
+
+    def __ne__(self, other):
+        return NotImplemented
+
+    def __neg__(self):
+        return NotImplemented
+
+    def __or__(self, other):
+        return NotImplemented
+
+    def __pos__(self):
+        return NotImplemented
+
+    def __pow__(self, other, mod):
+        return NotImplemented
+
+    def __rshift__(self, other):
+        return NotImplemented
+
+    def __setitem__(self, key, val):
+        raise NotImplementedError
+
+    def __sub__(self, other):
+        return NotImplemented
+
+    def __truediv__(self, other):
+        return NotImplemented
+
+    def __xor__(self, other):
+        return NotImplemented
 
 
 cdef usm_ndarray _real_view(usm_ndarray ary):