U Hv f@s|ddlmmZddlmZddlmZGdddZdeiZdd Z dd d Z d dZ dddZ ddZ e ddddS)N)_fftlog) _pocketfftc@s eZdZdZdZeddZdS) _ScipyBackenda-The default backend for fft calculations Notes ----- We use the domain ``numpy.scipy`` rather than ``scipy`` because ``uarray`` treats the domain as a hierarchy. This means the user can install a single backend for ``numpy`` and have it implement ``numpy.scipy.fft`` as well. numpy.scipy.fftcCs:tt|jd}|dkr$tt|jd}|dkr0tS|||S)N)getattrr__name__rNotImplemented)methodargskwargsfnr6/tmp/pip-unpacked-wheel-96ln3f52/scipy/fft/_backend.py__ua_function__s z_ScipyBackend.__ua_function__N)r __module__ __qualname____doc__ __ua_domain__ staticmethodrrrrrrsrZscipyc Cs`t|trJz t|}Wn2tk rH}ztd||W5d}~XYnX|jdkr\td|S)z8Maps strings to known backends and validates the backendzUnknown backend {}Nrz,Backend does not implement "numpy.scipy.fft") isinstancestr_named_backendsKeyError ValueErrorformatr)backenderrr_backend_from_arg!s  " rFcCst|}tj||||ddS)a7Sets the global fft backend This utility method replaces the default backend for permanent use. It will be tried in the list of backends automatically, unless the ``only`` flag is set on a backend. This will be the first tried backend outside the :obj:`set_backend` context manager. Parameters ---------- backend : {object, 'scipy'} The backend to use. Can either be a ``str`` containing the name of a known backend {'scipy'} or an object that implements the uarray protocol. coerce : bool Whether to coerce input types when trying this backend. only : bool If ``True``, no more backends will be tried if this fails. Implied by ``coerce=True``. try_last : bool If ``True``, the global backend is tried after registered backends. Raises ------ ValueError: If the backend does not implement ``numpy.scipy.fft``. Notes ----- This will overwrite the previously set global backend, which, by default, is the SciPy implementation. Examples -------- We can set the global fft backend: >>> from scipy.fft import fft, set_global_backend >>> set_global_backend("scipy") # Sets global backend. "scipy" is the default backend. >>> fft([1]) # Calls the global backend array([1.+0.j]) )coerceonlytry_lastN)ruaset_global_backend)rrr r!rrrr#0s(r#cCst|}t|dS)az Register a backend for permanent use. Registered backends have the lowest priority and will be tried after the global backend. Parameters ---------- backend : {object, 'scipy'} The backend to use. Can either be a ``str`` containing the name of a known backend {'scipy'} or an object that implements the uarray protocol. Raises ------ ValueError: If the backend does not implement ``numpy.scipy.fft``. Examples -------- We can register a new fft backend: >>> from scipy.fft import fft, register_backend, set_global_backend >>> class NoopBackend: # Define an invalid Backend ... __ua_domain__ = "numpy.scipy.fft" ... def __ua_function__(self, func, args, kwargs): ... return NotImplemented >>> set_global_backend(NoopBackend()) # Set the invalid backend as global >>> register_backend("scipy") # Register a new backend >>> fft([1]) # The registered backend is called because the global backend returns `NotImplemented` array([1.+0.j]) >>> set_global_backend("scipy") # Restore global backend to default N)rr"register_backendrrrrr$\s"r$cCst|}tj|||dS)aOContext manager to set the backend within a fixed scope. Upon entering the ``with`` statement, the given backend will be added to the list of available backends with the highest priority. Upon exit, the backend is reset to the state before entering the scope. Parameters ---------- backend : {object, 'scipy'} The backend to use. Can either be a ``str`` containing the name of a known backend {'scipy'} or an object that implements the uarray protocol. coerce : bool, optional Whether to allow expensive conversions for the ``x`` parameter. e.g., copying a NumPy array to the GPU for a CuPy backend. Implies ``only``. only : bool, optional If only is ``True`` and this backend returns ``NotImplemented``, then a BackendNotImplemented error will be raised immediately. Ignoring any lower priority backends. Examples -------- >>> import scipy.fft as fft >>> with fft.set_backend('scipy', only=True): ... fft.fft([1]) # Always calls the scipy implementation array([1.+0.j]) )rr )rr" set_backend)rrr rrrr&sr&cCst|}t|S)aContext manager to skip a backend within a fixed scope. Within the context of a ``with`` statement, the given backend will not be called. This covers backends registered both locally and globally. Upon exit, the backend will again be considered. Parameters ---------- backend : {object, 'scipy'} The backend to skip. Can either be a ``str`` containing the name of a known backend {'scipy'} or an object that implements the uarray protocol. Examples -------- >>> import scipy.fft as fft >>> fft.fft([1]) # Calls default SciPy backend array([1.+0.j]) >>> with fft.skip_backend('scipy'): # We explicitly skip the SciPy backend ... fft.fft([1]) # leaving no implementation available Traceback (most recent call last): ... BackendNotImplementedError: No selected backends had an implementation ... )rr" skip_backendr%rrrr'sr'T)r!)FFF)FF)Zscipy._lib.uarrayZ_libZuarrayr"rrrrrr#r$r&r'rrrrs   ,&