Skip to content

Commit

Permalink
DOC: add notes on precision to fft routines
Browse files Browse the repository at this point in the history
  • Loading branch information
grlee77 committed Jan 3, 2017
1 parent 82e06ce commit 343d34d
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions scipy/fftpack/basic.py
Original file line number Diff line number Diff line change
Expand Up @@ -236,6 +236,11 @@ def fft(x, n=None, axis=-1, overwrite_x=False):
negative-frequency terms. For `n` even and `x` real, ``A[n/2]`` will
always be real.
Both single and double precision routines are implemented. Half precision
inputs will be converted to single precision. Non floating-point inputs
will be converted to double precision. Long-double precision inputs are
not supported.
This function is most efficient when `n` is a power of two, and least
efficient when `n` is prime.
Expand Down Expand Up @@ -317,6 +322,11 @@ def ifft(x, n=None, axis=-1, overwrite_x=False):
Notes
-----
Both single and double precision routines are implemented. Half precision
inputs will be converted to single precision. Non floating-point inputs
will be converted to double precision. Long-double precision inputs are
not supported.
This function is most efficient when `n` is a power of two, and least
efficient when `n` is prime.
Expand Down Expand Up @@ -396,6 +406,11 @@ def rfft(x, n=None, axis=-1, overwrite_x=False):
-----
Within numerical accuracy, ``y == rfft(irfft(y))``.
Both single and double precision routines are implemented. Half precision
inputs will be converted to single precision. Non floating-point inputs
will be converted to double precision. Long-double precision inputs are
not supported.
Examples
--------
>>> from scipy.fftpack import fft, rfft
Expand Down Expand Up @@ -590,6 +605,13 @@ def fftn(x, shape=None, axes=None, overwrite_x=False):
--------
ifftn
Notes
-----
Both single and double precision routines are implemented. Half precision
inputs will be converted to single precision. Non floating-point inputs
will be converted to double precision. Long-double precision inputs are
not supported.
Examples
--------
>>> from scipy.fftpack import fftn, ifftn
Expand Down

0 comments on commit 343d34d

Please sign in to comment.