octave-nkf: src/DLD-FUNCTIONS/fftn.cc annotate

annotate src/DLD-FUNCTIONS/fftn.cc @ 11553:01f703952eff

Improve docstrings for functions in DLD-FUNCTIONS directory. Use same variable names in error() strings and in documentation.

author	Rik <octave@nomad.inbox5.com>
date	Sun, 16 Jan 2011 22:13:23 -0800
parents	fd0a3ac60b0e
children	12df7854fa7c

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
11523 fd0a3ac60b0e update copyright notices John W. Eaton <jwe@octave.org> parents: 10840 diff changeset	3 Copyright (C) 2004-2011 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
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	29 #include "defun-dld.h"
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)
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	51 {
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5642 diff changeset	52 print_usage ();
4773 ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	53 return retval;
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	54 }
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	55
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	56 octave_value arg = args(0);
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	57 dim_vector dims = arg.dims ();
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	58
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	59 for (int i = 0; i < dims.length (); i++)
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	60 if (dims(i) < 0)
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	61 return retval;
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	62
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	63 if (nargin > 1)
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	64 {
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	65 Matrix val = args(1).matrix_value ();
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	66 if (val.rows () > val.columns ())
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	67 val = val.transpose ();
4773 ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	68
4849 a3440ff5eb14 [project @ 2004-04-06 15:23:56 by jwe] jwe parents: 4787 diff changeset	69 if (error_state \|\| 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	70 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	71 else
10154 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 for (int i = 0; i < dims.length (); i++)
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	74 {
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	75 if (xisnan (val(i,0)))
11553 01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	76 error ("%s: SIZE has invalid NaN entries", fcn);
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	77 else if (NINTbig (val(i,0)) < 0)
11553 01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	78 error ("%s: all dimensions in SIZE must be greater than zero", fcn);
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	79 else
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	80 {
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	81 dims(i) = NINTbig(val(i,0));
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 }
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	84 }
4773 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
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	87 if (error_state)
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	88 return retval;
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	89
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	90 if (dims.all_zero ())
7924 4976f66d469b miscellaneous cleanup John W. Eaton <jwe@octave.org> parents: 7814 diff changeset	91 {
4976f66d469b miscellaneous cleanup John W. Eaton <jwe@octave.org> parents: 7814 diff changeset	92 if (arg.is_single_type ())
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	93 return octave_value (FloatMatrix ());
7924 4976f66d469b miscellaneous cleanup John W. Eaton <jwe@octave.org> parents: 7814 diff changeset	94 else
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	95 return octave_value (Matrix ());
7924 4976f66d469b miscellaneous cleanup John W. Eaton <jwe@octave.org> parents: 7814 diff changeset	96 }
4773 ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	97
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7017 diff changeset	98 if (arg.is_single_type ())
4773 ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	99 {
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7017 diff changeset	100 if (arg.is_real_type ())
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	101 {
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	102 FloatNDArray nda = arg.float_array_value ();
4773 ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	103
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	104 if (! error_state)
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	105 {
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	106 nda.resize (dims, 0.0);
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	107 retval = (type != 0 ? nda.ifourierNd () : nda.fourierNd ());
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	108 }
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	109 }
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7017 diff changeset	110 else
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	111 {
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	112 FloatComplexNDArray cnda = arg.float_complex_array_value ();
4773 ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	113
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	114 if (! error_state)
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	115 {
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	116 cnda.resize (dims, 0.0);
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	117 retval = (type != 0 ? cnda.ifourierNd () : cnda.fourierNd ());
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	118 }
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	119 }
4773 ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	120 }
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	121 else
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	122 {
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7017 diff changeset	123 if (arg.is_real_type ())
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	124 {
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	125 NDArray nda = arg.array_value ();
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7017 diff changeset	126
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	127 if (! error_state)
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	128 {
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	129 nda.resize (dims, 0.0);
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	130 retval = (type != 0 ? nda.ifourierNd () : nda.fourierNd ());
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	131 }
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	132 }
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7017 diff changeset	133 else if (arg.is_complex_type ())
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	134 {
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	135 ComplexNDArray cnda = arg.complex_array_value ();
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7017 diff changeset	136
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	137 if (! error_state)
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	138 {
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	139 cnda.resize (dims, 0.0);
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	140 retval = (type != 0 ? cnda.ifourierNd () : cnda.fourierNd ());
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	141 }
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	142 }
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7017 diff changeset	143 else
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	144 {
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	145 gripe_wrong_type_arg (fcn, arg);
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	146 }
4773 ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	147 }
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	148
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	149 return retval;
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	150 }
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 DEFUN_DLD (fftn, args, ,
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	153 "-- texinfo --\n\
11553 01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	154 @deftypefn {Loadable Function} {} fftn (@var{A})\n\
01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	155 @deftypefnx {Loadable Function} {} fftn (@var{A}, @var{size})\n\
01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	156 Compute the N-dimensional FFT of @var{A} using subroutines from\n"
4773 ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	157 FFTSRC
9072 bd8e388043c4 Cleanup documentation for signal.texi, image.texi, audio.texi Rik <rdrider0-list@yahoo.com> parents: 9064 diff changeset	158 ". The optional vector argument @var{size} may be used specify the\n\
9064 7c02ec148a3c Check grammar on all .cc files Rik <rdrider0-list@yahoo.com> parents: 8920 diff changeset	159 dimensions of the array to be used. If an element of @var{size} is\n\
4773 ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	160 smaller than the corresponding dimension, then the dimension is\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10155 diff changeset	161 truncated prior to performing the FFT@. Otherwise if an element\n\
11553 01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	162 of @var{size} is larger than the corresponding dimension @var{A}\n\
4773 ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	163 is 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	164 @seealso{ifftn, fft, fft2, fftw}\n\
5642 2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe] jwe parents: 5307 diff changeset	165 @end deftypefn")
4773 ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	166 {
4782 3dfdf6f36854 [project @ 2004-02-17 16:23:22 by jwe] jwe parents: 4773 diff changeset	167 return do_fftn (args, "fftn", 0);
4773 ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	168 }
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	169
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	170 DEFUN_DLD (ifftn, args, ,
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	171 "-- texinfo --\n\
11553 01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	172 @deftypefn {Loadable Function} {} ifftn (@var{A})\n\
01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	173 @deftypefnx {Loadable Function} {} ifftn (@var{A}, @var{size})\n\
01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	174 Compute the inverse N-dimensional FFT of @var{A} using subroutines from\n"
4773 ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	175 FFTSRC
9072 bd8e388043c4 Cleanup documentation for signal.texi, image.texi, audio.texi Rik <rdrider0-list@yahoo.com> parents: 9064 diff changeset	176 ". The optional vector argument @var{size} may be used specify the\n\
9064 7c02ec148a3c Check grammar on all .cc files Rik <rdrider0-list@yahoo.com> parents: 8920 diff changeset	177 dimensions of the array to be used. If an element of @var{size} is\n\
4773 ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	178 smaller than the corresponding dimension, then the dimension is\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10155 diff changeset	179 truncated prior to performing the inverse FFT@. Otherwise if an element\n\
11553 01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	180 of @var{size} is larger than the corresponding dimension @var{A}\n\
4773 ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	181 is 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	182 @seealso{fftn, ifft, ifft2, fftw}\n\
5642 2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe] jwe parents: 5307 diff changeset	183 @end deftypefn")
4773 ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	184 {
4782 3dfdf6f36854 [project @ 2004-02-17 16:23:22 by jwe] jwe parents: 4773 diff changeset	185 return do_fftn (args, "ifftn", 1);
4773 ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: diff changeset	186 }

Mercurial > octave-nkf

annotate src/DLD-FUNCTIONS/fftn.cc @ 11553:01f703952eff