Mercurial > octave-libgccjit

comparison src/DLD-FUNCTIONS/fft.cc @ 9064:7c02ec148a3c

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Check grammar on all .cc files Same check as previously done on .m files Attempt to enforce some conformity in documentation text for rules such as two spaces after a period, commas around latin abbreviations, etc.
author Rik <rdrider0-list@yahoo.com>
date Sat, 28 Mar 2009 13:57:22 -0700
parents eb63fbe60fab
children bd8e388043c4
comparison
equal deleted inserted replaced
9063:a6cf0ad87eee 9064:7c02ec148a3c
201 DEFUN_DLD (fft, args, , 201 DEFUN_DLD (fft, args, ,
202 "-*- texinfo -*-\n\ 202 "-*- texinfo -*-\n\
203 @deftypefn {Loadable Function} {} fft (@var{a}, @var{n}, @var{dim})\n\ 203 @deftypefn {Loadable Function} {} fft (@var{a}, @var{n}, @var{dim})\n\
204 Compute the FFT of @var{a} using subroutines from\n" 204 Compute the FFT of @var{a} using subroutines from\n"
205 FFTSRC 205 FFTSRC
206 ". The FFT is calculated along the first non-singleton dimension of the\n\ 206 ". The FFT is calculated along the first non-singleton dimension of the\n\
207 array. Thus if @var{a} is a matrix, @code{fft (@var{a})} computes the\n\ 207 array. Thus if @var{a} is a matrix, @code{fft (@var{a})} computes the\n\
208 FFT for each column of @var{a}.\n\ 208 FFT for each column of @var{a}.\n\
209 \n\ 209 \n\
210 If called with two arguments, @var{n} is expected to be an integer\n\ 210 If called with two arguments, @var{n} is expected to be an integer\n\
211 specifying the number of elements of @var{a} to use, or an empty\n\ 211 specifying the number of elements of @var{a} to use, or an empty\n\
212 matrix to specify that its value should be ignored. If @var{n} is\n\ 212 matrix to specify that its value should be ignored. If @var{n} is\n\
213 larger than the dimension along which the FFT is calculated, then\n\ 213 larger than the dimension along which the FFT is calculated, then\n\
214 @var{a} is resized and padded with zeros. Otherwise, if @var{n} is\n\ 214 @var{a} is resized and padded with zeros. Otherwise, if @var{n} is\n\
215 smaller than the dimension along which the FFT is calculated, then\n\ 215 smaller than the dimension along which the FFT is calculated, then\n\
216 @var{a} is truncated.\n\ 216 @var{a} is truncated.\n\
217 \n\ 217 \n\
218 If called with three arguments, @var{dim} is an integer specifying the\n\ 218 If called with three arguments, @var{dim} is an integer specifying the\n\
219 dimension of the matrix along which the FFT is performed\n\ 219 dimension of the matrix along which the FFT is performed\n\
227 DEFUN_DLD (ifft, args, , 227 DEFUN_DLD (ifft, args, ,
228 "-*- texinfo -*-\n\ 228 "-*- texinfo -*-\n\
229 @deftypefn {Loadable Function} {} ifft (@var{a}, @var{n}, @var{dim})\n\ 229 @deftypefn {Loadable Function} {} ifft (@var{a}, @var{n}, @var{dim})\n\
230 Compute the inverse FFT of @var{a} using subroutines from\n" 230 Compute the inverse FFT of @var{a} using subroutines from\n"
231 FFTSRC 231 FFTSRC
232 ". The inverse FFT is calculated along the first non-singleton dimension\n\ 232 ". The inverse FFT is calculated along the first non-singleton dimension\n\
233 of the array. Thus if @var{a} is a matrix, @code{fft (@var{a})} computes\n\ 233 of the array. Thus if @var{a} is a matrix, @code{fft (@var{a})} computes\n\
234 the inverse FFT for each column of @var{a}.\n\ 234 the inverse FFT for each column of @var{a}.\n\
235 \n\ 235 \n\
236 If called with two arguments, @var{n} is expected to be an integer\n\ 236 If called with two arguments, @var{n} is expected to be an integer\n\
237 specifying the number of elements of @var{a} to use, or an empty\n\ 237 specifying the number of elements of @var{a} to use, or an empty\n\
238 matrix to specify that its value should be ignored. If @var{n} is\n\ 238 matrix to specify that its value should be ignored. If @var{n} is\n\
239 larger than the dimension along which the inverse FFT is calculated, then\n\ 239 larger than the dimension along which the inverse FFT is calculated, then\n\
240 @var{a} is resized and padded with zeros. Otherwise, if@var{n} is\n\ 240 @var{a} is resized and padded with zeros. Otherwise, if@var{n} is\n\
241 smaller than the dimension along which the inverse FFT is calculated,\n\ 241 smaller than the dimension along which the inverse FFT is calculated,\n\
242 then @var{a} is truncated.\n\ 242 then @var{a} is truncated.\n\
243 \n\ 243 \n\
244 If called with three arguments, @var{dim} is an integer specifying the\n\ 244 If called with three arguments, @var{dim} is an integer specifying the\n\
245 dimension of the matrix along which the inverse FFT is performed\n\ 245 dimension of the matrix along which the inverse FFT is performed\n\