Mercurial > octave
diff libinterp/corefcn/fft.cc @ 24575:93714122ed59 stable
doc: Fixes for signal, image, audio, and OOP chapters (bug #52844).
* oop.txi: Remove duplicate word "can".
* package.txi: Change @example code to find current_installation_directory so
that it would actually run. Rewrite BuildRequires item.
* plot.txi: Re-phrase language about when Contour group objects are created.
* fft.cc (Ffft, Fifft): Use the same variable name 'x' in docstring as in
@deftypefn. Add period to final sentence of docstring.
* fft2.cc (Ffft2): Add period to final sentence of docstring.
* lin2mu.m: Add output variable 'y' to @deftypefn.
* mu2lin.m: Add output variable 'y' to @deftypefn. Space out mathematical
expression for better readibility.
* ind2gray.m: Use the same variable name 'map' in docstring as in @deftypefn.
* rgb2ind.m: Add period to final sentence of docstring.
* periodogram.m: Use ':' operator rather than '..' to indicate range.
author | Rik <rik@octave.org> |
---|---|
date | Tue, 09 Jan 2018 21:10:38 -0800 |
parents | 3ac9f9ecfae5 |
children | e6b22e378389 |
line wrap: on
line diff
--- a/libinterp/corefcn/fft.cc Mon Jan 08 12:24:33 2018 -0800 +++ b/libinterp/corefcn/fft.cc Tue Jan 09 21:10:38 2018 -0800 @@ -186,7 +186,7 @@ @deftypefn {} {} fft (@var{x}) @deftypefnx {} {} fft (@var{x}, @var{n}) @deftypefnx {} {} fft (@var{x}, @var{n}, @var{dim}) -Compute the discrete Fourier transform of @var{A} using +Compute the discrete Fourier transform of @var{x} using a Fast Fourier Transform (FFT) algorithm. The FFT is calculated along the first non-singleton dimension of the @@ -202,7 +202,7 @@ @var{x} is truncated. If called with three arguments, @var{dim} is an integer specifying the -dimension of the matrix along which the FFT is performed +dimension of the matrix along which the FFT is performed. @seealso{ifft, fft2, fftn, fftw} @end deftypefn */) { @@ -215,7 +215,7 @@ @deftypefn {} {} ifft (@var{x}) @deftypefnx {} {} ifft (@var{x}, @var{n}) @deftypefnx {} {} ifft (@var{x}, @var{n}, @var{dim}) -Compute the inverse discrete Fourier transform of @var{A} +Compute the inverse discrete Fourier transform of @var{x} using a Fast Fourier Transform (FFT) algorithm. The inverse FFT is calculated along the first non-singleton dimension @@ -231,7 +231,7 @@ then @var{x} is truncated. If called with three arguments, @var{dim} is an integer specifying the -dimension of the matrix along which the inverse FFT is performed +dimension of the matrix along which the inverse FFT is performed. @seealso{fft, ifft2, ifftn, fftw} @end deftypefn */) {