Mercurial > octave-nkf

comparison src/DLD-FUNCTIONS/fftn.cc @ 12160:b64b82721062

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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
comparison
equal deleted inserted replaced
12159:1f56327759e5 12160:b64b82721062
151 151
152 DEFUN_DLD (fftn, args, , 152 DEFUN_DLD (fftn, args, ,
153 "-*- texinfo -*-\n\ 153 "-*- texinfo -*-\n\
154 @deftypefn {Loadable Function} {} fftn (@var{A})\n\ 154 @deftypefn {Loadable Function} {} fftn (@var{A})\n\
155 @deftypefnx {Loadable Function} {} fftn (@var{A}, @var{size})\n\ 155 @deftypefnx {Loadable Function} {} fftn (@var{A}, @var{size})\n\
156 Compute the N-dimensional FFT of @var{A} using subroutines from\n" 156 Compute the N-dimensional discrete Fourier transform of @var{A} using\n\
157 FFTSRC 157 a Fast Fourier Transform (FFT) algorithm.\n\
158 ". The optional vector argument @var{size} may be used specify the\n\ 158 \n\
159 The optional vector argument @var{size} may be used specify the\n\
159 dimensions of the array to be used. If an element of @var{size} is\n\ 160 dimensions of the array to be used. If an element of @var{size} is\n\
160 smaller than the corresponding dimension, then the dimension is\n\ 161 smaller than the corresponding dimension of @var{A}, then the dimension of\n\
161 truncated prior to performing the FFT@. Otherwise if an element\n\ 162 @var{A} is truncated prior to performing the FFT@. Otherwise, if an element\n\
162 of @var{size} is larger than the corresponding dimension @var{A}\n\ 163 of @var{size} is larger than the corresponding dimension then @var{A}\n\
163 is resized and padded with zeros.\n\ 164 is resized and padded with zeros.\n\
164 @seealso{ifftn, fft, fft2, fftw}\n\ 165 @seealso{ifftn, fft, fft2, fftw}\n\
165 @end deftypefn") 166 @end deftypefn")
166 { 167 {
167 return do_fftn (args, "fftn", 0); 168 return do_fftn (args, "fftn", 0);
169 170
170 DEFUN_DLD (ifftn, args, , 171 DEFUN_DLD (ifftn, args, ,
171 "-*- texinfo -*-\n\ 172 "-*- texinfo -*-\n\
172 @deftypefn {Loadable Function} {} ifftn (@var{A})\n\ 173 @deftypefn {Loadable Function} {} ifftn (@var{A})\n\
173 @deftypefnx {Loadable Function} {} ifftn (@var{A}, @var{size})\n\ 174 @deftypefnx {Loadable Function} {} ifftn (@var{A}, @var{size})\n\
174 Compute the inverse N-dimensional FFT of @var{A} using subroutines from\n" 175 Compute the inverse N-dimensional discrete Fourier transform of @var{A}\n\
175 FFTSRC 176 using a Fast Fourier Transform (FFT) algorithm.\n\
176 ". The optional vector argument @var{size} may be used specify the\n\ 177 \n\
178 The optional vector argument @var{size} may be used specify the\n\
177 dimensions of the array to be used. If an element of @var{size} is\n\ 179 dimensions of the array to be used. If an element of @var{size} is\n\
178 smaller than the corresponding dimension, then the dimension is\n\ 180 smaller than the corresponding dimension of @var{A}, then the dimension of\n\
179 truncated prior to performing the inverse FFT@. Otherwise if an element\n\ 181 @var{A} is truncated prior to performing the inverse FFT@. Otherwise, if an\n\
180 of @var{size} is larger than the corresponding dimension @var{A}\n\ 182 element of @var{size} is larger than the corresponding dimension then @var{A}\n\
181 is resized and padded with zeros.\n\ 183 is resized and padded with zeros.\n\
182 @seealso{fftn, ifft, ifft2, fftw}\n\ 184 @seealso{fftn, ifft, ifft2, fftw}\n\
183 @end deftypefn") 185 @end deftypefn")
184 { 186 {
185 return do_fftn (args, "ifftn", 1); 187 return do_fftn (args, "ifftn", 1);