Added auto-loading of interfaces

In scipy fft return NotImplemented for complex256 and double128 inputs.

Author: oleksandr-pavlyk

mkl_fft/__init__.py

@@ -28,6 +28,7 @@
                       rfft_numpy, irfft_numpy, rfftn_numpy, irfftn_numpy)
 
 from ._version import __version__
+import mkl_fft.interfaces
 
 __all__ = ['fft', 'ifft', 'fft2', 'ifft2', 'fftn', 'ifftn', 'rfft', 'irfft',
-           'rfft_numpy', 'irfft_numpy', 'rfftn_numpy', 'irfftn_numpy']
+           'rfft_numpy', 'irfft_numpy', 'rfftn_numpy', 'irfftn_numpy', 'interfaces']

mkl_fft/_scipy_fft_backend.py

@@ -162,7 +162,10 @@ def __exit__(self, *args):
 
 
 def fft(a, n=None, axis=-1, norm=None, overwrite_x=False, workers=None):
-    x = _float_utils.__upcast_float16_array(a)
+    try:
+        x = _float_utils.__upcast_float16_array(a)
+    except ValueError:
+        return NotImplemented
     with Workers(workers):
         output = _pydfti.fft(x, n=n, axis=axis, overwrite_x=overwrite_x)
     if _unitary(norm):
@@ -171,7 +174,10 @@ def fft(a, n=None, axis=-1, norm=None, overwrite_x=False, workers=None):
 
 
 def ifft(a, n=None, axis=-1, norm=None, overwrite_x=False, workers=None):
-    x = _float_utils.__upcast_float16_array(a)
+    try:
+        x = _float_utils.__upcast_float16_array(a)
+    except ValueError:
+        return NotImplemented
     with Workers(workers):
         output = _pydfti.ifft(x, n=n, axis=axis, overwrite_x=overwrite_x)
     if _unitary(norm):
@@ -180,7 +186,10 @@ def ifft(a, n=None, axis=-1, norm=None, overwrite_x=False, workers=None):
 
 
 def fft2(a, s=None, axes=(-2,-1), norm=None, overwrite_x=False, workers=None):
-    x = _float_utils.__upcast_float16_array(a)
+    try:
+        x = _float_utils.__upcast_float16_array(a)
+    except ValueError:
+        return NotImplemented
     with Workers(workers):
         output = _pydfti.fftn(x, shape=s, axes=axes, overwrite_x=overwrite_x)
     if _unitary(norm):
@@ -192,7 +201,10 @@ def fft2(a, s=None, axes=(-2,-1), norm=None, overwrite_x=False, workers=None):
 
 
 def ifft2(a, s=None, axes=(-2,-1), norm=None, overwrite_x=False, workers=None):
-    x = _float_utils.__upcast_float16_array(a)
+    try:
+        x = _float_utils.__upcast_float16_array(a)
+    except ValueError:
+        return NotImplemented
     with Workers(workers):
         output = _pydfti.ifftn(x, shape=s, axes=axes, overwrite_x=overwrite_x)
     if _unitary(norm):
@@ -205,7 +217,10 @@ def ifft2(a, s=None, axes=(-2,-1), norm=None, overwrite_x=False, workers=None):
 
 
 def fftn(a, s=None, axes=None, norm=None, overwrite_x=False, workers=None):
-    x = _float_utils.__upcast_float16_array(a)
+    try:
+        x = _float_utils.__upcast_float16_array(a)
+    except ValueError:
+        return NotImplemented
     with Workers(workers):
         output = _pydfti.fftn(x, shape=s, axes=axes, overwrite_x=overwrite_x)
     if _unitary(norm):
@@ -218,7 +233,10 @@ def fftn(a, s=None, axes=None, norm=None, overwrite_x=False, workers=None):
 
 
 def ifftn(a, s=None, axes=None, norm=None, overwrite_x=False, workers=None):
-    x = _float_utils.__upcast_float16_array(a)
+    try:
+        x = _float_utils.__upcast_float16_array(a)
+    except ValueError:
+        return NotImplemented
     with Workers(workers):
         output = _pydfti.ifftn(x, shape=s, axes=axes, overwrite_x=overwrite_x)
     if _unitary(norm):
@@ -231,7 +249,10 @@ def ifftn(a, s=None, axes=None, norm=None, overwrite_x=False, workers=None):
 
 
 def rfft(a, n=None, axis=-1, norm=None, workers=None):
-    x = _float_utils.__upcast_float16_array(a)
+    try:
+        x = _float_utils.__upcast_float16_array(a)
+    except ValueError:
+        return NotImplemented
     unitary = _unitary(norm)
     x = _float_utils.__downcast_float128_array(x)
     if unitary and n is None:
@@ -245,8 +266,10 @@ def rfft(a, n=None, axis=-1, norm=None, workers=None):
 
 
 def irfft(a, n=None, axis=-1, norm=None, workers=None):
-    x = _float_utils.__upcast_float16_array(a)
-    x = _float_utils.__downcast_float128_array(x)
+    try:
+        x = _float_utils.__upcast_float16_array(a)
+    except ValueError:
+        return NotImplemented
     with Workers(workers):
         output = _pydfti.irfft_numpy(x, n=n, axis=axis)
     if _unitary(norm):
@@ -255,21 +278,27 @@ def irfft(a, n=None, axis=-1, norm=None, workers=None):
 
 
 def rfft2(a, s=None, axes=(-2, -1), norm=None, workers=None):
-    x = _float_utils.__upcast_float16_array(a)
-    x = _float_utils.__downcast_float128_array(a)
+    try:
+        x = _float_utils.__upcast_float16_array(a)
+    except ValueError:
+        return NotImplemented
     return rfftn(x, s, axes, norm, workers)
 
 
 def irfft2(a, s=None, axes=(-2, -1), norm=None, workers=None):
-    x = _float_utils.__upcast_float16_array(a)
-    x = _float_utils.__downcast_float128_array(x)
+    try:
+        x = _float_utils.__upcast_float16_array(a)
+    except ValueError:
+        return NotImplemented
     return irfftn(x, s, axes, norm, workers)
 
 
 def rfftn(a, s=None, axes=None, norm=None, workers=None):
     unitary = _unitary(norm)
-    x = _float_utils.__upcast_float16_array(a)
-    x = _float_utils.__downcast_float128_array(x)
+    try:
+        x = _float_utils.__upcast_float16_array(a)
+    except ValueError:
+        return NotImplemented
     if unitary:
         x = asarray(x)
         s, axes = _cook_nd_args(x, s, axes)
@@ -282,8 +311,10 @@ def rfftn(a, s=None, axes=None, norm=None, workers=None):
 
 
 def irfftn(a, s=None, axes=None, norm=None, workers=None):
-    x = _float_utils.__upcast_float16_array(a)
-    x = _float_utils.__downcast_float128_array(x)
+    try:
+        x = _float_utils.__upcast_float16_array(a)
+    except ValueError:
+        return NotImplemented
     with Workers(workers):
         output = _pydfti.irfftn_numpy(x, s, axes)
     if _unitary(norm):

mkl_fft/interfaces/__init__.py

@@ -1,2 +1,27 @@
+# Copyright (c) 2017-2023, Intel Corporation
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+#     * Redistributions of source code must retain the above copyright notice,
+#       this list of conditions and the following disclaimer.
+#     * Redistributions in binary form must reproduce the above copyright
+#       notice, this list of conditions and the following disclaimer in the
+#       documentation and/or other materials provided with the distribution.
+#     * Neither the name of Intel Corporation nor the names of its contributors
+#       may be used to endorse or promote products derived from this software
+#       without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
+# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
 from .. import _numpy_fft as numpy_fft
 from .. import _scipy_fft_backend as scipy_fft

mkl_fft/tests/test_fft1d.py

@@ -24,8 +24,6 @@
 # OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
-from __future__ import division, absolute_import, print_function
-
 import numpy as np
 from numpy.testing import (
         TestCase, run_module_suite, assert_, assert_raises, assert_equal,
@@ -127,7 +125,7 @@ def test_vector5(self):
         f1 = mkl_fft.fft(x, overwrite_x=True)
         f2 = mkl_fft.fft(self.xz1[::-2])
         assert_(np.allclose(f1,f2))
-    
+
     def test_vector6(self):
         "fft in place"
         x = self.xz1.copy()
@@ -137,8 +135,8 @@ def test_vector6(self):
         x = self.xz1.copy()
         f1 = mkl_fft.fft(x[::-2], overwrite_x=True)
         assert_( not np.allclose(x, self.xz1) ) # this is also in-place
-        assert_( np.allclose(x[-2::-2], self.xz1[-2::-2]) ) 
-        assert_( np.allclose(x[-1::-2], f1) ) 
+        assert_( np.allclose(x[-2::-2], self.xz1[-2::-2]) )
+        assert_( np.allclose(x[-1::-2], f1) )
 
     def test_vector7(self):
         "fft of real array is the same as fft of its complex cast"

mkl_fft/tests/test_fftnd.py

@@ -24,8 +24,6 @@
 # OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
-from __future__ import division, absolute_import, print_function
-
 import numpy as np
 from numpy.testing import (
         TestCase, run_module_suite, assert_, assert_raises, assert_equal,

mkl_fft/tests/test_interfaces.py

@@ -0,0 +1,36 @@
+#!/usr/bin/env python
+# Copyright (c) 2017-2023, Intel Corporation
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+#     * Redistributions of source code must retain the above copyright notice,
+#       this list of conditions and the following disclaimer.
+#     * Redistributions in binary form must reproduce the above copyright
+#       notice, this list of conditions and the following disclaimer in the
+#       documentation and/or other materials provided with the distribution.
+#     * Neither the name of Intel Corporation nor the names of its contributors
+#       may be used to endorse or promote products derived from this software
+#       without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
+# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+import mkl_fft.interfaces as mfi
+import pytest
+
+
+def test_interfaces_has_numpy():
+    assert hasattr(mfi, 'numpy_fft')
+
+
+def test_interfaces_has_scipy():
+    assert hasattr(mfi, 'scipy_fft')