Mercurial > octave-nkf
view libinterp/corefcn/fftn.cc @ 20207:4f45eaf83908 stable
doc: Update more docstrings to have one sentence summary as first line.
Reviewed libinterp/corefcn directory.
* libinterp/corefcn/__ilu__.cc, libinterp/corefcn/balance.cc,
libinterp/corefcn/besselj.cc, libinterp/corefcn/betainc.cc,
libinterp/corefcn/bitfcns.cc, libinterp/corefcn/bsxfun.cc,
libinterp/corefcn/cellfun.cc, libinterp/corefcn/colloc.cc,
libinterp/corefcn/conv2.cc, libinterp/corefcn/data.cc,
libinterp/corefcn/debug.cc, libinterp/corefcn/defaults.cc,
libinterp/corefcn/det.cc, libinterp/corefcn/dirfns.cc,
libinterp/corefcn/dlmread.cc, libinterp/corefcn/dot.cc,
libinterp/corefcn/eig.cc, libinterp/corefcn/error.cc,
libinterp/corefcn/fft2.cc, libinterp/corefcn/fftn.cc,
libinterp/corefcn/file-io.cc, libinterp/corefcn/filter.cc,
libinterp/corefcn/find.cc, libinterp/corefcn/gammainc.cc,
libinterp/corefcn/gcd.cc, libinterp/corefcn/getgrent.cc,
libinterp/corefcn/getpwent.cc, libinterp/corefcn/getrusage.cc,
libinterp/corefcn/graphics.cc, libinterp/corefcn/help.cc,
libinterp/corefcn/hex2num.cc, libinterp/corefcn/input.cc,
libinterp/corefcn/inv.cc, libinterp/corefcn/kron.cc,
libinterp/corefcn/load-path.cc, libinterp/corefcn/load-save.cc,
libinterp/corefcn/lookup.cc, libinterp/corefcn/ls-oct-ascii.cc,
libinterp/corefcn/lsode.cc, libinterp/corefcn/lu.cc,
libinterp/corefcn/luinc.cc, libinterp/corefcn/mappers.cc,
libinterp/corefcn/matrix_type.cc, libinterp/corefcn/max.cc,
libinterp/corefcn/md5sum.cc, libinterp/corefcn/mgorth.cc,
libinterp/corefcn/nproc.cc, libinterp/corefcn/oct-hist.cc,
libinterp/corefcn/ordschur.cc, libinterp/corefcn/pager.cc,
libinterp/corefcn/pinv.cc, libinterp/corefcn/pr-output.cc,
libinterp/corefcn/pt-jit.cc, libinterp/corefcn/quad.cc,
libinterp/corefcn/quadcc.cc, libinterp/corefcn/qz.cc,
libinterp/corefcn/rand.cc, libinterp/corefcn/rcond.cc,
libinterp/corefcn/regexp.cc, libinterp/corefcn/schur.cc,
libinterp/corefcn/sighandlers.cc, libinterp/corefcn/sparse.cc,
libinterp/corefcn/spparms.cc, libinterp/corefcn/str2double.cc,
libinterp/corefcn/strfind.cc, libinterp/corefcn/strfns.cc,
libinterp/corefcn/sub2ind.cc, libinterp/corefcn/svd.cc,
libinterp/corefcn/symtab.cc, libinterp/corefcn/syscalls.cc,
libinterp/corefcn/sysdep.cc, libinterp/corefcn/time.cc,
libinterp/corefcn/toplev.cc, libinterp/corefcn/tril.cc,
libinterp/corefcn/tsearch.cc, libinterp/corefcn/typecast.cc,
libinterp/corefcn/urlwrite.cc, libinterp/corefcn/utils.cc,
libinterp/corefcn/variables.cc, scripts/polynomial/spline.m:
Update more docstrings to have one sentence summary as first line.
author | Rik <rik@octave.org> |
---|---|
date | Sat, 09 May 2015 17:19:30 -0700 |
parents | 4197fc428c7d |
children | f90c8372b7ba |
line wrap: on
line source
/* Copyright (C) 2004-2015 David Bateman This file is part of Octave. Octave is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. Octave is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with Octave; see the file COPYING. If not, see <http://www.gnu.org/licenses/>. */ #ifdef HAVE_CONFIG_H #include <config.h> #endif #include "lo-mappers.h" #include "defun.h" #include "error.h" #include "gripes.h" #include "oct-obj.h" #include "utils.h" // This function should be merged with Fifft. #if defined (HAVE_FFTW) #define FFTSRC "@sc{fftw}" #else #define FFTSRC "@sc{fftpack}" #endif static octave_value do_fftn (const octave_value_list &args, const char *fcn, int type) { octave_value retval; int nargin = args.length (); if (nargin < 1 || nargin > 2) { print_usage (); return retval; } octave_value arg = args(0); dim_vector dims = arg.dims (); for (int i = 0; i < dims.length (); i++) if (dims(i) < 0) return retval; if (nargin > 1) { Matrix val = args(1).matrix_value (); if (val.rows () > val.columns ()) val = val.transpose (); if (error_state || val.columns () != dims.length () || val.rows () != 1) error ("%s: SIZE must be a vector of length dim", fcn); else { for (int i = 0; i < dims.length (); i++) { if (xisnan (val(i,0))) error ("%s: SIZE has invalid NaN entries", fcn); else if (NINTbig (val(i,0)) < 0) error ("%s: all dimensions in SIZE must be greater than zero", fcn); else { dims(i) = NINTbig(val(i,0)); } } } } if (error_state) return retval; if (dims.all_zero ()) { if (arg.is_single_type ()) return octave_value (FloatMatrix ()); else return octave_value (Matrix ()); } if (arg.is_single_type ()) { if (arg.is_real_type ()) { FloatNDArray nda = arg.float_array_value (); if (! error_state) { nda.resize (dims, 0.0); retval = (type != 0 ? nda.ifourierNd () : nda.fourierNd ()); } } else { FloatComplexNDArray cnda = arg.float_complex_array_value (); if (! error_state) { cnda.resize (dims, 0.0); retval = (type != 0 ? cnda.ifourierNd () : cnda.fourierNd ()); } } } else { if (arg.is_real_type ()) { NDArray nda = arg.array_value (); if (! error_state) { nda.resize (dims, 0.0); retval = (type != 0 ? nda.ifourierNd () : nda.fourierNd ()); } } else if (arg.is_complex_type ()) { ComplexNDArray cnda = arg.complex_array_value (); if (! error_state) { cnda.resize (dims, 0.0); retval = (type != 0 ? cnda.ifourierNd () : cnda.fourierNd ()); } } else { gripe_wrong_type_arg (fcn, arg); } } return retval; } DEFUN (fftn, args, , "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {} fftn (@var{A})\n\ @deftypefnx {Built-in Function} {} fftn (@var{A}, @var{size})\n\ Compute the N-dimensional discrete Fourier transform of @var{A} using\n\ a Fast Fourier Transform (FFT) algorithm.\n\ \n\ The optional vector argument @var{size} may be used specify the dimensions\n\ of the array to be used. If an element of @var{size} is smaller than the\n\ corresponding dimension of @var{A}, then the dimension of @var{A} is\n\ truncated prior to performing the FFT@. Otherwise, if an element of\n\ @var{size} is larger than the corresponding dimension then @var{A} is\n\ resized and padded with zeros.\n\ @seealso{ifftn, fft, fft2, fftw}\n\ @end deftypefn") { return do_fftn (args, "fftn", 0); } DEFUN (ifftn, args, , "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {} ifftn (@var{A})\n\ @deftypefnx {Built-in Function} {} ifftn (@var{A}, @var{size})\n\ Compute the inverse N-dimensional discrete Fourier transform of @var{A}\n\ using a Fast Fourier Transform (FFT) algorithm.\n\ \n\ The optional vector argument @var{size} may be used specify the dimensions\n\ of the array to be used. If an element of @var{size} is smaller than the\n\ corresponding dimension of @var{A}, then the dimension of @var{A} is\n\ truncated prior to performing the inverse FFT@. Otherwise, if an element of\n\ @var{size} is larger than the corresponding dimension then @var{A} is\n\ resized and padded with zeros.\n\ @seealso{fftn, ifft, ifft2, fftw}\n\ @end deftypefn") { return do_fftn (args, "ifftn", 1); }