octave: libinterp/corefcn/fftn.cc annotate

annotate libinterp/corefcn/fftn.cc @ 20853:1142cf6abc0d

2015 Code Sprint: remove class of function from docstring for all C++ files.

author	Rik <rik@octave.org>
date	Sat, 12 Dec 2015 07:40:03 -0800
parents	8bb38ba1bad6
children	6f0bd96f93c0

rev	line source
4773 ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	1 /*
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	2
19697 4197fc428c7d maint: Update copyright notices for 2015. John W. Eaton <jwe@octave.org> parents: 17787 diff changeset	3 Copyright (C) 2004-2015 David Bateman
4773 ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	4
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	5 This file is part of Octave.
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	6
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	7 Octave is free software; you can redistribute it and/or modify it
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	8 under the terms of the GNU General Public License as published by the
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 7007 diff changeset	9 Free Software Foundation; either version 3 of the License, or (at your
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 7007 diff changeset	10 option) any later version.
4773 ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	11
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	12 Octave is distributed in the hope that it will be useful, but WITHOUT
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	15 for more details.
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	16
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	17 You should have received a copy of the GNU General Public License
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 7007 diff changeset	18 along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 7007 diff changeset	19 <http://www.gnu.org/licenses/>.
4773 ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	20
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	21 */
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	22
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	23 #ifdef HAVE_CONFIG_H
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	24 #include <config.h>
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	25 #endif
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	26
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	27 #include "lo-mappers.h"
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	28
15039 e753177cde93 maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory Rik <rik@octave.org> parents: 14138 diff changeset	29 #include "defun.h"
4773 ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	30 #include "error.h"
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	31 #include "gripes.h"
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	32 #include "oct-obj.h"
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	33 #include "utils.h"
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	34
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	35 // This function should be merged with Fifft.
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	36
9523 0ce82753dd72 more configure changes for libraries John W. Eaton <jwe@octave.org> parents: 9072 diff changeset	37 #if defined (HAVE_FFTW)
9072 bd8e388043c4 Cleanup documentation for signal.texi, image.texi, audio.texi Rik <rdrider0-list@yahoo.com> parents: 9064 diff changeset	38 #define FFTSRC "@sc{fftw}"
4773 ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	39 #else
9072 bd8e388043c4 Cleanup documentation for signal.texi, image.texi, audio.texi Rik <rdrider0-list@yahoo.com> parents: 9064 diff changeset	40 #define FFTSRC "@sc{fftpack}"
4773 ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	41 #endif
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	42
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	43 static octave_value
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	44 do_fftn (const octave_value_list &args, const char *fcn, int type)
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	45 {
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	46 octave_value retval;
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	47
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	48 int nargin = args.length ();
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	49
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	50 if (nargin < 1 \|\| nargin > 2)
20802 8bb38ba1bad6 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20704 diff changeset	51 print_usage ();
4773 ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	52
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	53 octave_value arg = args(0);
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	54 dim_vector dims = arg.dims ();
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11553 diff changeset	55
4773 ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	56 for (int i = 0; i < dims.length (); i++)
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	57 if (dims(i) < 0)
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	58 return retval;
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	59
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	60 if (nargin > 1)
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	61 {
20704 571508c1ed06 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	62 Matrix val = args(1).xmatrix_value ("%s: SIZE must be a vector of length dim", fcn);
571508c1ed06 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	63
4773 ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	64 if (val.rows () > val.columns ())
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	65 val = val.transpose ();
4773 ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	66
20704 571508c1ed06 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	67 if (val.columns () != dims.length () \|\| val.rows () != 1)
11553 01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	68 error ("%s: SIZE must be a vector of length dim", fcn);
4773 ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	69 else
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	70 {
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	71 for (int i = 0; i < dims.length (); i++)
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	72 {
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	73 if (xisnan (val(i,0)))
11553 01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	74 error ("%s: SIZE has invalid NaN entries", fcn);
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	75 else if (NINTbig (val(i,0)) < 0)
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	76 error ("%s: all dimensions in SIZE must be greater than zero",
175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	77 fcn);
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	78 else
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	79 {
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	80 dims(i) = NINTbig(val(i,0));
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	81 }
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	82 }
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	83 }
4773 ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	84 }
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	85
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	86 if (dims.all_zero ())
7924 4976f66d469b miscellaneous cleanup John W. Eaton <jwe@octave.org> parents: 7814 diff changeset	87 {
4976f66d469b miscellaneous cleanup John W. Eaton <jwe@octave.org> parents: 7814 diff changeset	88 if (arg.is_single_type ())
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	89 return octave_value (FloatMatrix ());
7924 4976f66d469b miscellaneous cleanup John W. Eaton <jwe@octave.org> parents: 7814 diff changeset	90 else
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	91 return octave_value (Matrix ());
7924 4976f66d469b miscellaneous cleanup John W. Eaton <jwe@octave.org> parents: 7814 diff changeset	92 }
4773 ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	93
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7017 diff changeset	94 if (arg.is_single_type ())
4773 ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	95 {
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7017 diff changeset	96 if (arg.is_real_type ())
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	97 {
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	98 FloatNDArray nda = arg.float_array_value ();
4773 ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	99
20555 f90c8372b7ba eliminate many more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20172 diff changeset	100 nda.resize (dims, 0.0);
f90c8372b7ba eliminate many more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20172 diff changeset	101 retval = (type != 0 ? nda.ifourierNd () : nda.fourierNd ());
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	102 }
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7017 diff changeset	103 else
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	104 {
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	105 FloatComplexNDArray cnda = arg.float_complex_array_value ();
4773 ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	106
20555 f90c8372b7ba eliminate many more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20172 diff changeset	107 cnda.resize (dims, 0.0);
f90c8372b7ba eliminate many more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20172 diff changeset	108 retval = (type != 0 ? cnda.ifourierNd () : cnda.fourierNd ());
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	109 }
4773 ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	110 }
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	111 else
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	112 {
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7017 diff changeset	113 if (arg.is_real_type ())
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	114 {
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	115 NDArray nda = arg.array_value ();
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7017 diff changeset	116
20555 f90c8372b7ba eliminate many more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20172 diff changeset	117 nda.resize (dims, 0.0);
f90c8372b7ba eliminate many more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20172 diff changeset	118 retval = (type != 0 ? nda.ifourierNd () : nda.fourierNd ());
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	119 }
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7017 diff changeset	120 else if (arg.is_complex_type ())
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	121 {
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	122 ComplexNDArray cnda = arg.complex_array_value ();
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7017 diff changeset	123
20555 f90c8372b7ba eliminate many more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20172 diff changeset	124 cnda.resize (dims, 0.0);
f90c8372b7ba eliminate many more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20172 diff changeset	125 retval = (type != 0 ? cnda.ifourierNd () : cnda.fourierNd ());
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	126 }
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7017 diff changeset	127 else
20555 f90c8372b7ba eliminate many more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20172 diff changeset	128 gripe_wrong_type_arg (fcn, arg);
4773 ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	129 }
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	130
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	131 return retval;
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	132 }
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	133
15039 e753177cde93 maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory Rik <rik@octave.org> parents: 14138 diff changeset	134 DEFUN (fftn, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	135 "-- texinfo --\n\
20853 1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files. Rik <rik@octave.org> parents: 20802 diff changeset	136 @deftypefn {} {} fftn (@var{A})\n\
1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files. Rik <rik@octave.org> parents: 20802 diff changeset	137 @deftypefnx {} {} fftn (@var{A}, @var{size})\n\
12160 b64b82721062 Make documentation static by removing docstrings depending on #ifdef variables Rik <octave@nomad.inbox5.com> parents: 11586 diff changeset	138 Compute the N-dimensional discrete Fourier transform of @var{A} using\n\
b64b82721062 Make documentation static by removing docstrings depending on #ifdef variables Rik <octave@nomad.inbox5.com> parents: 11586 diff changeset	139 a Fast Fourier Transform (FFT) algorithm.\n\
b64b82721062 Make documentation static by removing docstrings depending on #ifdef variables Rik <octave@nomad.inbox5.com> parents: 11586 diff changeset	140 \n\
20172 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	141 The optional vector argument @var{size} may be used specify the dimensions\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	142 of the array to be used. If an element of @var{size} is smaller than the\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	143 corresponding dimension of @var{A}, then the dimension of @var{A} is\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	144 truncated prior to performing the FFT@. Otherwise, if an element of\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	145 @var{size} is larger than the corresponding dimension then @var{A} is\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	146 resized and padded with zeros.\n\
11553 01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	147 @seealso{ifftn, fft, fft2, fftw}\n\
5642 2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe] jwe parents: 5307 diff changeset	148 @end deftypefn")
4773 ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	149 {
4782 3dfdf6f36854 [project @ 2004-02-17 16:23:22 by jwe] jwe parents: 4773 diff changeset	150 return do_fftn (args, "fftn", 0);
4773 ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	151 }
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	152
15039 e753177cde93 maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory Rik <rik@octave.org> parents: 14138 diff changeset	153 DEFUN (ifftn, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	154 "-- texinfo --\n\
20853 1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files. Rik <rik@octave.org> parents: 20802 diff changeset	155 @deftypefn {} {} ifftn (@var{A})\n\
1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files. Rik <rik@octave.org> parents: 20802 diff changeset	156 @deftypefnx {} {} ifftn (@var{A}, @var{size})\n\
12160 b64b82721062 Make documentation static by removing docstrings depending on #ifdef variables Rik <octave@nomad.inbox5.com> parents: 11586 diff changeset	157 Compute the inverse N-dimensional discrete Fourier transform of @var{A}\n\
b64b82721062 Make documentation static by removing docstrings depending on #ifdef variables Rik <octave@nomad.inbox5.com> parents: 11586 diff changeset	158 using a Fast Fourier Transform (FFT) algorithm.\n\
b64b82721062 Make documentation static by removing docstrings depending on #ifdef variables Rik <octave@nomad.inbox5.com> parents: 11586 diff changeset	159 \n\
20172 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	160 The optional vector argument @var{size} may be used specify the dimensions\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	161 of the array to be used. If an element of @var{size} is smaller than the\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	162 corresponding dimension of @var{A}, then the dimension of @var{A} is\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	163 truncated prior to performing the inverse FFT@. Otherwise, if an element of\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	164 @var{size} is larger than the corresponding dimension then @var{A} is\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	165 resized and padded with zeros.\n\
11553 01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	166 @seealso{fftn, ifft, ifft2, fftw}\n\
5642 2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe] jwe parents: 5307 diff changeset	167 @end deftypefn")
4773 ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	168 {
4782 3dfdf6f36854 [project @ 2004-02-17 16:23:22 by jwe] jwe parents: 4773 diff changeset	169 return do_fftn (args, "ifftn", 1);
4773 ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	170 }

Mercurial > octave

annotate libinterp/corefcn/fftn.cc @ 20853:1142cf6abc0d