Mercurial > octave-nkf
diff src/DLD-FUNCTIONS/fft.cc @ 12160:b64b82721062
Make documentation static by removing docstrings depending on #ifdef variables
author | Rik <octave@nomad.inbox5.com> |
---|---|
date | Tue, 25 Jan 2011 13:07:57 -0800 |
parents | 12df7854fa7c |
children | 72c96de7a403 |
line wrap: on
line diff
--- a/src/DLD-FUNCTIONS/fft.cc Tue Jan 25 10:47:01 2011 +0100 +++ b/src/DLD-FUNCTIONS/fft.cc Tue Jan 25 13:07:57 2011 -0800 @@ -203,9 +203,10 @@ @deftypefn {Loadable Function} {} fft (@var{x})\n\ @deftypefnx {Loadable Function} {} fft (@var{x}, @var{n})\n\ @deftypefnx {Loadable Function} {} fft (@var{x}, @var{n}, @var{dim})\n\ -Compute the FFT of @var{x} using subroutines from\n" -FFTSRC -". The FFT is calculated along the first non-singleton dimension of the\n\ +Compute the discrete Fourier transform of @var{A} using\n\ +a Fast Fourier Transform (FFT) algorithm.\n\ +\n\ +The FFT is calculated along the first non-singleton dimension of the\n\ array. Thus if @var{x} is a matrix, @code{fft (@var{x})} computes the\n\ FFT for each column of @var{x}.\n\ \n\ @@ -231,9 +232,10 @@ @deftypefn {Loadable Function} {} ifft (@var{x})\n\ @deftypefnx {Loadable Function} {} ifft (@var{x}, @var{n})\n\ @deftypefnx {Loadable Function} {} ifft (@var{x}, @var{n}, @var{dim})\n\ -Compute the inverse FFT of @var{x} using subroutines from\n" -FFTSRC -". The inverse FFT is calculated along the first non-singleton dimension\n\ +Compute the inverse discrete Fourier transform of @var{A}\n\ +using a Fast Fourier Transform (FFT) algorithm.\n\ +\n\ +The inverse FFT is calculated along the first non-singleton dimension\n\ of the array. Thus if @var{x} is a matrix, @code{fft (@var{x})} computes\n\ the inverse FFT for each column of @var{x}.\n\ \n\