octave: libinterp/corefcn/fftn.cc annotate

annotate libinterp/corefcn/fftn.cc @ 27919:1891570abac8

update Octave Project Developers copyright for the new year In files that have the "Octave Project Developers" copyright notice, update for 2020.

author	John W. Eaton <jwe@octave.org>
date	Mon, 06 Jan 2020 22:29:51 -0500
parents	b442ec6dda5c
children	bd51beb6205e

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
27919 1891570abac8 update Octave Project Developers copyright for the new year John W. Eaton <jwe@octave.org> parents: 27918 diff changeset	3 Copyright (C) 2004-2020 The Octave Project Developers
27918 b442ec6dda5c use centralized file for copyright info for individual contributors John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	4
b442ec6dda5c use centralized file for copyright info for individual contributors John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	5 See the file COPYRIGHT.md in the top-level directory of this distribution
b442ec6dda5c use centralized file for copyright info for individual contributors John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	6 or <https://octave.org/COPYRIGHT.html/>.
b442ec6dda5c use centralized file for copyright info for individual contributors John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	7
4773 ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	8
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	9 This file is part of Octave.
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	10
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 23582 diff changeset	11 Octave is free software: you can redistribute it and/or modify it
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22407 diff changeset	12 under the terms of the GNU General Public License as published by
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 23582 diff changeset	13 the Free Software Foundation, either version 3 of the License, or
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22407 diff changeset	14 (at your option) any later version.
4773 ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	15
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22407 diff changeset	16 Octave is distributed in the hope that it will be useful, but
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22407 diff changeset	17 WITHOUT ANY WARRANTY; without even the implied warranty of
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22407 diff changeset	18 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22407 diff changeset	19 GNU General Public License for more details.
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 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	22 along with Octave; see the file COPYING. If not, see
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 23582 diff changeset	23 <https://www.gnu.org/licenses/>.
4773 ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	24
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	25 */
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	26
21724 aba2e6293dd8 use "#if ..." consistently instead of "#ifdef" and "#ifndef" John W. Eaton <jwe@octave.org> parents: 21660 diff changeset	27 #if defined (HAVE_CONFIG_H)
21301 40de9f8f23a6 Use '#include "config.h"' rather than <config.h>. Rik <rik@octave.org> parents: 21200 diff changeset	28 # include "config.h"
4773 ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	29 #endif
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	30
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	31 #include "lo-mappers.h"
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	32
15039 e753177cde93 maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory Rik <rik@octave.org> parents: 14138 diff changeset	33 #include "defun.h"
4773 ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	34 #include "error.h"
21100 e39e05d90788 Switch gripe_XXX to either err_XXX or warn_XXX naming scheme. Rik <rik@octave.org> parents: 20940 diff changeset	35 #include "errwarn.h"
20940 48b2ad5ee801 maint: Rename oct-obj.[cc\|h] to ovl.[cc\|h] for clarity. Rik <rik@octave.org> parents: 20918 diff changeset	36 #include "ovl.h"
4773 ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	37 #include "utils.h"
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	38
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	39 // This function should be merged with Fifft.
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	40
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	41 static octave_value
23433 c9fab0bc983e maint: Use convention 'int& x' for naming references. Rik <rik@octave.org> parents: 23220 diff changeset	42 do_fftn (const octave_value_list& args, const char *fcn, int type)
4773 ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	43 {
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	44 int nargin = args.length ();
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 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	47 print_usage ();
4773 ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	48
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	49 octave_value retval;
4773 ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	50 octave_value arg = args(0);
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	51 dim_vector dims = arg.dims ();
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11553 diff changeset	52
21660 53728df3e4c9 maint: for clarity, call ndims() rather than length() on dimension vectors. Rik <rik@octave.org> parents: 21301 diff changeset	53 for (int i = 0; i < dims.ndims (); i++)
4773 ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	54 if (dims(i) < 0)
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	55 return retval;
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	56
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	57 if (nargin > 1)
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	58 {
20704 571508c1ed06 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	59 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	60
4773 ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	61 if (val.rows () > val.columns ())
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	62 val = val.transpose ();
4773 ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	63
21660 53728df3e4c9 maint: for clarity, call ndims() rather than length() on dimension vectors. Rik <rik@octave.org> parents: 21301 diff changeset	64 if (val.columns () != dims.ndims () \|\| val.rows () != 1)
11553 01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	65 error ("%s: SIZE must be a vector of length dim", fcn);
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	66
21660 53728df3e4c9 maint: for clarity, call ndims() rather than length() on dimension vectors. Rik <rik@octave.org> parents: 21301 diff changeset	67 for (int i = 0; i < dims.ndims (); i++)
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	68 {
21782 2aef506f3fec use namespace for lo-mappers.h functions John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	69 if (octave::math::isnan (val(i,0)))
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	70 error ("%s: SIZE has invalid NaN entries", fcn);
21782 2aef506f3fec use namespace for lo-mappers.h functions John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	71 else if (octave::math::nint_big (val(i,0)) < 0)
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	72 error ("%s: all dimensions in SIZE must be greater than zero", fcn);
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	73 else
21782 2aef506f3fec use namespace for lo-mappers.h functions John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	74 dims(i) = octave::math::nint_big(val(i,0));
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	75 }
4773 ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	76 }
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	77
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	78 if (dims.all_zero ())
7924 4976f66d469b miscellaneous cleanup John W. Eaton <jwe@octave.org> parents: 7814 diff changeset	79 {
4976f66d469b miscellaneous cleanup John W. Eaton <jwe@octave.org> parents: 7814 diff changeset	80 if (arg.is_single_type ())
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	81 return octave_value (FloatMatrix ());
7924 4976f66d469b miscellaneous cleanup John W. Eaton <jwe@octave.org> parents: 7814 diff changeset	82 else
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	83 return octave_value (Matrix ());
7924 4976f66d469b miscellaneous cleanup John W. Eaton <jwe@octave.org> parents: 7814 diff changeset	84 }
4773 ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	85
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7017 diff changeset	86 if (arg.is_single_type ())
4773 ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	87 {
23582 0cc2011d800e maint: Deprecate is_real_type and replace with isreal. Rik <rik@octave.org> parents: 23581 diff changeset	88 if (arg.isreal ())
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	89 {
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	90 FloatNDArray nda = arg.float_array_value ();
4773 ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	91
20555 f90c8372b7ba eliminate many more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20172 diff changeset	92 nda.resize (dims, 0.0);
f90c8372b7ba eliminate many more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20172 diff changeset	93 retval = (type != 0 ? nda.ifourierNd () : nda.fourierNd ());
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	94 }
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7017 diff changeset	95 else
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	96 {
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	97 FloatComplexNDArray cnda = arg.float_complex_array_value ();
4773 ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	98
20555 f90c8372b7ba eliminate many more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20172 diff changeset	99 cnda.resize (dims, 0.0);
f90c8372b7ba eliminate many more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20172 diff changeset	100 retval = (type != 0 ? cnda.ifourierNd () : cnda.fourierNd ());
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	101 }
4773 ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	102 }
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	103 else
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	104 {
23582 0cc2011d800e maint: Deprecate is_real_type and replace with isreal. Rik <rik@octave.org> parents: 23581 diff changeset	105 if (arg.isreal ())
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	106 {
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	107 NDArray nda = arg.array_value ();
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7017 diff changeset	108
20555 f90c8372b7ba eliminate many more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20172 diff changeset	109 nda.resize (dims, 0.0);
f90c8372b7ba eliminate many more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20172 diff changeset	110 retval = (type != 0 ? nda.ifourierNd () : nda.fourierNd ());
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	111 }
23581 c3075ae020e1 maint: Deprecate is_complex_type and replace with iscomplex. Rik <rik@octave.org> parents: 23433 diff changeset	112 else if (arg.iscomplex ())
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	113 {
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	114 ComplexNDArray cnda = arg.complex_array_value ();
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7017 diff changeset	115
20555 f90c8372b7ba eliminate many more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20172 diff changeset	116 cnda.resize (dims, 0.0);
f90c8372b7ba eliminate many more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20172 diff changeset	117 retval = (type != 0 ? cnda.ifourierNd () : cnda.fourierNd ());
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	118 }
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7017 diff changeset	119 else
21100 e39e05d90788 Switch gripe_XXX to either err_XXX or warn_XXX naming scheme. Rik <rik@octave.org> parents: 20940 diff changeset	120 err_wrong_type_arg (fcn, arg);
4773 ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	121 }
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	122
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	123 return retval;
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	124 }
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	125
15039 e753177cde93 maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory Rik <rik@octave.org> parents: 14138 diff changeset	126 DEFUN (fftn, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21782 diff changeset	127 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21782 diff changeset	128 @deftypefn {} {} fftn (@var{A})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21782 diff changeset	129 @deftypefnx {} {} fftn (@var{A}, @var{size})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21782 diff changeset	130 Compute the N-dimensional discrete Fourier transform of @var{A} using
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21782 diff changeset	131 a Fast Fourier Transform (FFT) algorithm.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21782 diff changeset	132
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21782 diff changeset	133 The optional vector argument @var{size} may be used specify the dimensions
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21782 diff changeset	134 of the array to be used. If an element of @var{size} is smaller than the
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21782 diff changeset	135 corresponding dimension of @var{A}, then the dimension of @var{A} is
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21782 diff changeset	136 truncated prior to performing the FFT@. Otherwise, if an element of
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21782 diff changeset	137 @var{size} is larger than the corresponding dimension then @var{A} is
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21782 diff changeset	138 resized and padded with zeros.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21782 diff changeset	139 @seealso{ifftn, fft, fft2, fftw}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21782 diff changeset	140 @end deftypefn */)
4773 ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	141 {
4782 3dfdf6f36854 [project @ 2004-02-17 16:23:22 by jwe] jwe parents: 4773 diff changeset	142 return do_fftn (args, "fftn", 0);
4773 ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	143 }
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	144
15039 e753177cde93 maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory Rik <rik@octave.org> parents: 14138 diff changeset	145 DEFUN (ifftn, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21782 diff changeset	146 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21782 diff changeset	147 @deftypefn {} {} ifftn (@var{A})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21782 diff changeset	148 @deftypefnx {} {} ifftn (@var{A}, @var{size})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21782 diff changeset	149 Compute the inverse N-dimensional discrete Fourier transform of @var{A}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21782 diff changeset	150 using a Fast Fourier Transform (FFT) algorithm.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21782 diff changeset	151
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21782 diff changeset	152 The optional vector argument @var{size} may be used specify the dimensions
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21782 diff changeset	153 of the array to be used. If an element of @var{size} is smaller than the
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21782 diff changeset	154 corresponding dimension of @var{A}, then the dimension of @var{A} is
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21782 diff changeset	155 truncated prior to performing the inverse FFT@. Otherwise, if an element of
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21782 diff changeset	156 @var{size} is larger than the corresponding dimension then @var{A} is
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21782 diff changeset	157 resized and padded with zeros.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21782 diff changeset	158 @seealso{fftn, ifft, ifft2, fftw}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21782 diff changeset	159 @end deftypefn */)
4773 ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	160 {
4782 3dfdf6f36854 [project @ 2004-02-17 16:23:22 by jwe] jwe parents: 4773 diff changeset	161 return do_fftn (args, "ifftn", 1);
4773 ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	162 }

Mercurial > octave

annotate libinterp/corefcn/fftn.cc @ 27919:1891570abac8