summaryrefslogtreecommitdiff
path: root/numpy/fft/__init__.py
diff options
context:
space:
mode:
Diffstat (limited to 'numpy/fft/__init__.py')
-rw-r--r--numpy/fft/__init__.py34
1 files changed, 34 insertions, 0 deletions
diff --git a/numpy/fft/__init__.py b/numpy/fft/__init__.py
index 324e39f4d..1171a6026 100644
--- a/numpy/fft/__init__.py
+++ b/numpy/fft/__init__.py
@@ -1,3 +1,37 @@
+"""
+Discrete Fast Fourier Transform (FFT)
+=====================================
+
+========= =========================================================
+Standard FFTs
+===================================================================
+fft Discrete Fourier transform.
+ifft Inverse discrete Fourier transform.
+fft2 Discrete Fourier transform in two dimensions.
+ifft2 Inverse discrete Fourier transform in two dimensions.
+fftn Discrete Fourier transform in N-dimensions.
+ifftn Inverse discrete Fourier transform in N dimensions.
+========= =========================================================
+
+========= ==========================================================
+Real FFTs
+====================================================================
+rfft Real discrete Fourier transform.
+irfft Inverse real discrete Fourier transform.
+rfft2 Real discrete Fourier transform in two dimensions.
+irfft2 Inverse real discrete Fourier transform in two dimensions.
+rfftn Real discrete Fourier transform in N dimensions.
+irfftn Inverse real discrete Fourier transform in N dimensions.
+========= ==========================================================
+
+========= =========================================================
+Hermite FFTs
+===================================================================
+hfft Hermite discrete Fourier transform.
+ihfft Inverse hermite discrete Fourier transform.
+========= =========================================================
+
+"""
# To get sub-modules
from info import __doc__