rename functions

Author: Vahid Tavanashad

mkl_fft/_fft_utils.py

@@ -26,19 +26,19 @@
 
 import numpy as np
 
-__all__ = ["_check_norm", "_compute_fwd_scale"]
+__all__ = ["check_norm", "compute_fwd_scale"]
 
 
-def _check_norm(norm):
+def check_norm(norm):
     if norm not in (None, "ortho", "forward", "backward"):
         raise ValueError(
             f"Invalid norm value {norm} should be None, 'ortho', 'forward', "
             "or 'backward'."
         )
 
 
-def _compute_fwd_scale(norm, n, shape):
-    _check_norm(norm)
+def compute_fwd_scale(norm, n, shape):
+    check_norm(norm)
     if norm in (None, "backward"):
         return 1.0
 

mkl_fft/_numpy_fft.py

@@ -76,7 +76,7 @@
 import numpy as np
 
 from . import _pydfti as mkl_fft  # pylint: disable=no-name-in-module
-from ._fft_utils import _check_norm, _compute_fwd_scale
+from ._fft_utils import check_norm, compute_fwd_scale
 from ._float_utils import __downcast_float128_array
 
 
@@ -125,7 +125,7 @@ def _cook_nd_args(a, s=None, axes=None, invreal=False):
 
 
 def _swap_direction(norm):
-    _check_norm(norm)
+    check_norm(norm)
     _swap_direction_map = {
         "backward": "forward",
         None: "forward",
@@ -241,7 +241,7 @@ def fft(a, n=None, axis=-1, norm=None):
     """
 
     x = __downcast_float128_array(a)
-    fsc = _compute_fwd_scale(norm, n, x.shape[axis])
+    fsc = compute_fwd_scale(norm, n, x.shape[axis])
 
     return trycall(mkl_fft.fft, (x,), {"n": n, "axis": axis, "fwd_scale": fsc})
 
@@ -334,7 +334,7 @@ def ifft(a, n=None, axis=-1, norm=None):
     """
 
     x = __downcast_float128_array(a)
-    fsc = _compute_fwd_scale(norm, n, x.shape[axis])
+    fsc = compute_fwd_scale(norm, n, x.shape[axis])
 
     return trycall(mkl_fft.ifft, (x,), {"n": n, "axis": axis, "fwd_scale": fsc})
 
@@ -425,7 +425,7 @@ def rfft(a, n=None, axis=-1, norm=None):
     """
 
     x = __downcast_float128_array(a)
-    fsc = _compute_fwd_scale(norm, n, x.shape[axis])
+    fsc = compute_fwd_scale(norm, n, x.shape[axis])
 
     return trycall(mkl_fft.rfft, (x,), {"n": n, "axis": axis, "fwd_scale": fsc})
 
@@ -518,7 +518,7 @@ def irfft(a, n=None, axis=-1, norm=None):
     """
 
     x = __downcast_float128_array(a)
-    fsc = _compute_fwd_scale(norm, n, 2 * (x.shape[axis] - 1))
+    fsc = compute_fwd_scale(norm, n, 2 * (x.shape[axis] - 1))
 
     return trycall(
         mkl_fft.irfft, (x,), {"n": n, "axis": axis, "fwd_scale": fsc}
@@ -606,7 +606,7 @@ def hfft(a, n=None, axis=-1, norm=None):
     x = __downcast_float128_array(a)
     x = np.array(x, copy=True, dtype=complex)
     np.conjugate(x, out=x)
-    fsc = _compute_fwd_scale(norm, n, 2 * (x.shape[axis] - 1))
+    fsc = compute_fwd_scale(norm, n, 2 * (x.shape[axis] - 1))
 
     return trycall(
         mkl_fft.irfft, (x,), {"n": n, "axis": axis, "fwd_scale": fsc}
@@ -675,7 +675,7 @@ def ihfft(a, n=None, axis=-1, norm=None):
     norm = _swap_direction(norm)
     x = __downcast_float128_array(a)
     x = np.array(x, copy=True, dtype=float)
-    fsc = _compute_fwd_scale(norm, n, x.shape[axis])
+    fsc = compute_fwd_scale(norm, n, x.shape[axis])
 
     output = trycall(
         mkl_fft.rfft, (x,), {"n": n, "axis": axis, "fwd_scale": fsc}
@@ -787,7 +787,7 @@ def fftn(a, s=None, axes=None, norm=None):
 
     x = __downcast_float128_array(a)
     s, axes = _cook_nd_args(x, s, axes)
-    fsc = _compute_fwd_scale(norm, s, x.shape)
+    fsc = compute_fwd_scale(norm, s, x.shape)
 
     return trycall(mkl_fft.fftn, (x,), {"s": s, "axes": axes, "fwd_scale": fsc})
 
@@ -894,7 +894,7 @@ def ifftn(a, s=None, axes=None, norm=None):
 
     x = __downcast_float128_array(a)
     s, axes = _cook_nd_args(x, s, axes)
-    fsc = _compute_fwd_scale(norm, s, x.shape)
+    fsc = compute_fwd_scale(norm, s, x.shape)
 
     return trycall(
         mkl_fft.ifftn, (x,), {"s": s, "axes": axes, "fwd_scale": fsc}
@@ -1182,7 +1182,7 @@ def rfftn(a, s=None, axes=None, norm=None):
 
     x = __downcast_float128_array(a)
     s, axes = _cook_nd_args(x, s, axes)
-    fsc = _compute_fwd_scale(norm, s, x.shape)
+    fsc = compute_fwd_scale(norm, s, x.shape)
 
     return trycall(
         mkl_fft.rfftn, (x,), {"s": s, "axes": axes, "fwd_scale": fsc}
@@ -1326,7 +1326,7 @@ def irfftn(a, s=None, axes=None, norm=None):
 
     x = __downcast_float128_array(a)
     s, axes = _cook_nd_args(x, s, axes, invreal=True)
-    fsc = _compute_fwd_scale(norm, s, x.shape)
+    fsc = compute_fwd_scale(norm, s, x.shape)
 
     return trycall(
         mkl_fft.irfftn, (x,), {"s": s, "axes": axes, "fwd_scale": fsc}

mkl_fft/_pydfti.pyx

@@ -1335,11 +1335,11 @@ def ifftn(x, s=None, axes=None, overwrite_x=False, fwd_scale=1.0):
 
 
 def rfft2(x, s=None, axes=(-2, -1), fwd_scale=1.0):
-    return rfftn(x, s=s, axes=axes, fsc=fwd_scale)
+    return rfftn(x, s=s, axes=axes, fwd_scale=fwd_scale)
 
 
 def irfft2(x, s=None, axes=(-2, -1), fwd_scale=1.0):
-    return irfftn(x, s=s, axes=axes, fsc=fwd_scale)
+    return irfftn(x, s=s, axes=axes, fwd_scale=fwd_scale)
 
 
 def _remove_axis(s, axes, axis_to_remove):

mkl_fft/_scipy_fft.py

@@ -33,7 +33,7 @@
 import numpy as np
 
 from . import _pydfti as mkl_fft  # pylint: disable=no-name-in-module
-from ._fft_utils import _compute_fwd_scale
+from ._fft_utils import compute_fwd_scale
 from ._float_utils import __supported_array_or_not_implemented
 
 __doc__ = """
@@ -235,7 +235,7 @@ def fft(
 ):
     _check_plan(plan)
     x = _validate_input(a)
-    fsc = _compute_fwd_scale(norm, n, x.shape[axis])
+    fsc = compute_fwd_scale(norm, n, x.shape[axis])
 
     with Workers(workers):
         return mkl_fft.fft(
@@ -248,7 +248,7 @@ def ifft(
 ):
     _check_plan(plan)
     x = _validate_input(a)
-    fsc = _compute_fwd_scale(norm, n, x.shape[axis])
+    fsc = compute_fwd_scale(norm, n, x.shape[axis])
 
     with Workers(workers):
         return mkl_fft.ifft(
@@ -303,7 +303,7 @@ def fftn(
 ):
     _check_plan(plan)
     x = _validate_input(a)
-    fsc = _compute_fwd_scale(norm, s, x.shape)
+    fsc = compute_fwd_scale(norm, s, x.shape)
 
     with Workers(workers):
         return mkl_fft.fftn(
@@ -316,7 +316,7 @@ def ifftn(
 ):
     _check_plan(plan)
     x = _validate_input(a)
-    fsc = _compute_fwd_scale(norm, s, x.shape)
+    fsc = compute_fwd_scale(norm, s, x.shape)
 
     with Workers(workers):
         return mkl_fft.ifftn(
@@ -327,7 +327,7 @@ def ifftn(
 def rfft(a, n=None, axis=-1, norm=None, workers=None, plan=None):
     _check_plan(plan)
     x = _validate_input(a)
-    fsc = _compute_fwd_scale(norm, n, x.shape[axis])
+    fsc = compute_fwd_scale(norm, n, x.shape[axis])
 
     with Workers(workers):
         return mkl_fft.rfft(x, n=n, axis=axis, fwd_scale=fsc)
@@ -336,7 +336,7 @@ def rfft(a, n=None, axis=-1, norm=None, workers=None, plan=None):
 def irfft(a, n=None, axis=-1, norm=None, workers=None, plan=None):
     _check_plan(plan)
     x = _validate_input(a)
-    fsc = _compute_fwd_scale(norm, n, 2 * (x.shape[axis] - 1))
+    fsc = compute_fwd_scale(norm, n, 2 * (x.shape[axis] - 1))
 
     with Workers(workers):
         return mkl_fft.irfft(x, n=n, axis=axis, fwd_scale=fsc)
@@ -356,7 +356,7 @@ def rfftn(a, s=None, axes=None, norm=None, workers=None, plan=None):
     _check_plan(plan)
     x = _validate_input(a)
     s, axes = _cook_nd_args(x, s, axes)
-    fsc = _compute_fwd_scale(norm, s, x.shape)
+    fsc = compute_fwd_scale(norm, s, x.shape)
 
     with Workers(workers):
         return mkl_fft.rfftn(x, s, axes, fwd_scale=fsc)
@@ -366,7 +366,7 @@ def irfftn(a, s=None, axes=None, norm=None, workers=None, plan=None):
     _check_plan(plan)
     x = _validate_input(a)
     s, axes = _cook_nd_args(x, s, axes, invreal=True)
-    fsc = _compute_fwd_scale(norm, s, x.shape)
+    fsc = compute_fwd_scale(norm, s, x.shape)
 
     with Workers(workers):
         return mkl_fft.irfftn(x, s, axes, fwd_scale=fsc)