octave: libinterp/corefcn/fft2.cc annotate

annotate libinterp/corefcn/fft2.cc @ 20802:8bb38ba1bad6

eliminate return statements after calls to print_usage * __contourc__.cc, __dispatch__.cc, __dsearchn__.cc, __ichol__.cc, __lin_interpn__.cc, __qp__.cc, balance.cc, betainc.cc, bsxfun.cc, colloc.cc, daspk.cc, dasrt.cc, dassl.cc, defaults.cc, det.cc, dlmread.cc, dot.cc, eig.cc, ellipj.cc, fft.cc, fft2.cc, fftn.cc, filter.cc, find.cc, gcd.cc, givens.cc, hex2num.cc, inv.cc, lookup.cc, lu.cc, max.cc, mgorth.cc, ordschur.cc, pinv.cc, profiler.cc, quad.cc, qz.cc, rcond.cc, schur.cc, str2double.cc: Eliminate return statements after calls to print_usage.

author	John W. Eaton <jwe@octave.org>
date	Fri, 04 Dec 2015 12:03:44 -0500
parents	f90c8372b7ba
children	1142cf6abc0d

rev	line source
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	1 /*
295f037b4b3e [project @ 1997-05-05 05:32:33 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) 1997-2015 David Bateman
11523 fd0a3ac60b0e update copyright notices John W. Eaton <jwe@octave.org> parents: 10155 diff changeset	4 Copyright (C) 1996-1997 John W. Eaton
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	5
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	6 This file is part of Octave.
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	7
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	8 Octave is free software; you can redistribute it and/or modify it
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	9 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: 7001 diff changeset	10 Free Software Foundation; either version 3 of the License, or (at your
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 7001 diff changeset	11 option) any later version.
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	12
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	13 Octave is distributed in the hope that it will be useful, but WITHOUT
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	14 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	15 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	16 for more details.
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	17
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	18 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: 7001 diff changeset	19 along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 7001 diff changeset	20 <http://www.gnu.org/licenses/>.
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	21
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	22 */
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	23
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	24 #ifdef HAVE_CONFIG_H
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	25 #include <config.h>
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	26 #endif
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	27
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	28 #include "lo-mappers.h"
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	29
15039 e753177cde93 maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory Rik <rik@octave.org> parents: 14501 diff changeset	30 #include "defun.h"
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	31 #include "error.h"
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	32 #include "gripes.h"
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	33 #include "oct-obj.h"
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	34 #include "utils.h"
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	35
4773 ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: 4233 diff changeset	36 // This function should be merged with Fifft.
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	37
9523 0ce82753dd72 more configure changes for libraries John W. Eaton <jwe@octave.org> parents: 9072 diff changeset	38 #if defined (HAVE_FFTW)
9072 bd8e388043c4 Cleanup documentation for signal.texi, image.texi, audio.texi Rik <rdrider0-list@yahoo.com> parents: 8920 diff changeset	39 #define FFTSRC "@sc{fftw}"
4773 ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: 4233 diff changeset	40 #else
9072 bd8e388043c4 Cleanup documentation for signal.texi, image.texi, audio.texi Rik <rdrider0-list@yahoo.com> parents: 8920 diff changeset	41 #define FFTSRC "@sc{fftpack}"
4773 ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: 4233 diff changeset	42 #endif
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: 4233 diff changeset	43
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: 4233 diff changeset	44 static octave_value
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: 4233 diff changeset	45 do_fft2 (const octave_value_list &args, const char *fcn, int type)
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	46 {
4233 ccfdb55c8156 [project @ 2002-12-20 22:43:54 by jwe] jwe parents: 3367 diff changeset	47 octave_value retval;
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	48
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	49 int nargin = args.length ();
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	50
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	51 if (nargin < 1 \|\| nargin > 3)
20802 8bb38ba1bad6 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	52 print_usage ();
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	53
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	54 octave_value arg = args(0);
4773 ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: 4233 diff changeset	55 dim_vector dims = arg.dims ();
5275 23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe] jwe parents: 4782 diff changeset	56 octave_idx_type n_rows = -1;
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11553 diff changeset	57
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	58 if (nargin > 1)
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	59 {
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	60 double dval = args(1).double_value ();
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	61 if (xisnan (dval))
11553 01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	62 error ("%s: number of rows (N) cannot be NaN", fcn);
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	63 else
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9890 diff changeset	64 {
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9890 diff changeset	65 n_rows = NINTbig (dval);
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9890 diff changeset	66 if (n_rows < 0)
11553 01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	67 error ("%s: number of rows (N) must be greater than zero", fcn);
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9890 diff changeset	68 }
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	69 }
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	70
5275 23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe] jwe parents: 4782 diff changeset	71 octave_idx_type n_cols = -1;
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	72 if (nargin > 2)
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	73 {
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	74 double dval = args(2).double_value ();
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	75 if (xisnan (dval))
11553 01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	76 error ("%s: number of columns (M) cannot be NaN", fcn);
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	77 else
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9890 diff changeset	78 {
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9890 diff changeset	79 n_cols = NINTbig (dval);
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9890 diff changeset	80 if (n_cols < 0)
11553 01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	81 error ("%s: number of columns (M) must be greater than zero", fcn);
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9890 diff changeset	82 }
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	83 }
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	84
4773 ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: 4233 diff changeset	85 for (int i = 0; i < dims.length (); i++)
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: 4233 diff changeset	86 if (dims(i) < 0)
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	87 return retval;
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	88
4773 ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: 4233 diff changeset	89 if (n_rows < 0)
20218 b2100e1659ac maint: Use cuddled parentheses when indexing dimension_vectors. Rik <rik@octave.org> parents: 20172 diff changeset	90 n_rows = dims(0);
4773 ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: 4233 diff changeset	91 else
20218 b2100e1659ac maint: Use cuddled parentheses when indexing dimension_vectors. Rik <rik@octave.org> parents: 20172 diff changeset	92 dims(0) = n_rows;
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	93
4773 ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: 4233 diff changeset	94 if (n_cols < 0)
20218 b2100e1659ac maint: Use cuddled parentheses when indexing dimension_vectors. Rik <rik@octave.org> parents: 20172 diff changeset	95 n_cols = dims(1);
4773 ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: 4233 diff changeset	96 else
20218 b2100e1659ac maint: Use cuddled parentheses when indexing dimension_vectors. Rik <rik@octave.org> parents: 20172 diff changeset	97 dims(1) = n_cols;
4773 ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: 4233 diff changeset	98
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: 4233 diff changeset	99 if (dims.all_zero () \|\| n_rows == 0 \|\| n_cols == 0)
7924 4976f66d469b miscellaneous cleanup John W. Eaton <jwe@octave.org> parents: 7814 diff changeset	100 {
4976f66d469b miscellaneous cleanup John W. Eaton <jwe@octave.org> parents: 7814 diff changeset	101 if (arg.is_single_type ())
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9890 diff changeset	102 return octave_value (FloatMatrix ());
7924 4976f66d469b miscellaneous cleanup John W. Eaton <jwe@octave.org> parents: 7814 diff changeset	103 else
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9890 diff changeset	104 return octave_value (Matrix ());
7924 4976f66d469b miscellaneous cleanup John W. Eaton <jwe@octave.org> parents: 7814 diff changeset	105 }
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	106
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7017 diff changeset	107 if (arg.is_single_type ())
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	108 {
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7017 diff changeset	109 if (arg.is_real_type ())
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9890 diff changeset	110 {
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9890 diff changeset	111 FloatNDArray nda = arg.float_array_value ();
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	112
20555 f90c8372b7ba eliminate many more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20218 diff changeset	113 nda.resize (dims, 0.0);
f90c8372b7ba eliminate many more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20218 diff changeset	114 retval = (type != 0 ? nda.ifourier2d () : nda.fourier2d ());
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9890 diff changeset	115 }
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7017 diff changeset	116 else
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9890 diff changeset	117 {
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9890 diff changeset	118 FloatComplexNDArray cnda = arg.float_complex_array_value ();
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	119
20555 f90c8372b7ba eliminate many more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20218 diff changeset	120 cnda.resize (dims, 0.0);
f90c8372b7ba eliminate many more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20218 diff changeset	121 retval = (type != 0 ? cnda.ifourier2d () : cnda.fourier2d ());
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9890 diff changeset	122 }
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	123 }
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	124 else
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	125 {
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7017 diff changeset	126 if (arg.is_real_type ())
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9890 diff changeset	127 {
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9890 diff changeset	128 NDArray nda = arg.array_value ();
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7017 diff changeset	129
20555 f90c8372b7ba eliminate many more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20218 diff changeset	130 nda.resize (dims, 0.0);
f90c8372b7ba eliminate many more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20218 diff changeset	131 retval = (type != 0 ? nda.ifourier2d () : nda.fourier2d ());
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9890 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: 9890 diff changeset	134 {
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9890 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
20555 f90c8372b7ba eliminate many more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20218 diff changeset	137 cnda.resize (dims, 0.0);
f90c8372b7ba eliminate many more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20218 diff changeset	138 retval = (type != 0 ? cnda.ifourier2d () : cnda.fourier2d ());
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9890 diff changeset	139 }
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7017 diff changeset	140 else
20555 f90c8372b7ba eliminate many more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20218 diff changeset	141 gripe_wrong_type_arg (fcn, arg);
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	142 }
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	143
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	144 return retval;
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	145 }
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	146
15039 e753177cde93 maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory Rik <rik@octave.org> parents: 14501 diff changeset	147 DEFUN (fft2, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	148 "-- texinfo --\n\
15039 e753177cde93 maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory Rik <rik@octave.org> parents: 14501 diff changeset	149 @deftypefn {Built-in Function} {} fft2 (@var{A})\n\
e753177cde93 maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory Rik <rik@octave.org> parents: 14501 diff changeset	150 @deftypefnx {Built-in Function} {} fft2 (@var{A}, @var{m}, @var{n})\n\
12160 b64b82721062 Make documentation static by removing docstrings depending on #ifdef variables Rik <octave@nomad.inbox5.com> parents: 11586 diff changeset	151 Compute the two-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	152 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	153 \n\
20172 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	154 The optional arguments @var{m} and @var{n} may be used specify the number of\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	155 rows and columns of @var{A} to use. If either of these is larger than the\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	156 size of @var{A}, @var{A} is resized and padded with zeros.\n\
4773 ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: 4233 diff changeset	157 \n\
11553 01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	158 If @var{A} is a multi-dimensional matrix, each two-dimensional sub-matrix\n\
12160 b64b82721062 Make documentation static by removing docstrings depending on #ifdef variables Rik <octave@nomad.inbox5.com> parents: 11586 diff changeset	159 of @var{A} is treated separately.\n\
20172 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	160 @seealso{ifft2, fft, fftn, fftw}\n\
5642 2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe] jwe parents: 5307 diff changeset	161 @end deftypefn")
4773 ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: 4233 diff changeset	162 {
4782 3dfdf6f36854 [project @ 2004-02-17 16:23:22 by jwe] jwe parents: 4773 diff changeset	163 return do_fft2 (args, "fft2", 0);
4773 ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: 4233 diff changeset	164 }
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: 4233 diff changeset	165
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: 4233 diff changeset	166
15039 e753177cde93 maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory Rik <rik@octave.org> parents: 14501 diff changeset	167 DEFUN (ifft2, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	168 "-- texinfo --\n\
15039 e753177cde93 maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory Rik <rik@octave.org> parents: 14501 diff changeset	169 @deftypefn {Built-in Function} {} ifft2 (@var{A})\n\
e753177cde93 maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory Rik <rik@octave.org> parents: 14501 diff changeset	170 @deftypefnx {Built-in Function} {} ifft2 (@var{A}, @var{m}, @var{n})\n\
12160 b64b82721062 Make documentation static by removing docstrings depending on #ifdef variables Rik <octave@nomad.inbox5.com> parents: 11586 diff changeset	171 Compute the inverse two-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	172 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	173 \n\
20172 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	174 The optional arguments @var{m} and @var{n} may be used specify the number of\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	175 rows and columns of @var{A} to use. If either of these is larger than the\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	176 size of @var{A}, @var{A} is resized and padded with zeros.\n\
4773 ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: 4233 diff changeset	177 \n\
11553 01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	178 If @var{A} is a multi-dimensional matrix, each two-dimensional sub-matrix\n\
01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	179 of @var{A} is treated separately\n\
20172 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	180 @seealso{fft2, ifft, ifftn, fftw}\n\
5642 2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe] jwe parents: 5307 diff changeset	181 @end deftypefn")
4773 ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: 4233 diff changeset	182 {
4782 3dfdf6f36854 [project @ 2004-02-17 16:23:22 by jwe] jwe parents: 4773 diff changeset	183 return do_fft2 (args, "ifft2", 1);
4773 ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: 4233 diff changeset	184 }
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: 4233 diff changeset	185
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	186 /*
14501 60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	187 %% Author: David Billinghurst (David.Billinghurst@riotinto.com.au)
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	188 %% Comalco Research and Technology
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	189 %% 02 May 2000
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	190 %!test
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	191 %! M = 16;
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	192 %! N = 8;
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	193 %!
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	194 %! m = 5;
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	195 %! n = 3;
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	196 %!
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	197 %! x = 2pi(0:1:M-1)/M;
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	198 %! y = 2pi(0:1:N-1)/N;
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	199 %! sx = cos (m*x);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	200 %! sy = sin (n*y);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	201 %! s = kron (sx',sy);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	202 %! S = fft2 (s);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	203 %! answer = kron (fft (sx)', fft (sy));
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	204 %! assert (S, answer, 4MN*eps);
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7789 diff changeset	205
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7789 diff changeset	206 %% Author: David Billinghurst (David.Billinghurst@riotinto.com.au)
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7789 diff changeset	207 %% Comalco Research and Technology
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7789 diff changeset	208 %% 02 May 2000
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7789 diff changeset	209 %!test
14501 60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	210 %! M = 12;
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	211 %! N = 7;
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11553 diff changeset	212 %!
14501 60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	213 %! m = 3;
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	214 %! n = 2;
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11553 diff changeset	215 %!
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7789 diff changeset	216 %! x = 2pi(0:1:M-1)/M;
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7789 diff changeset	217 %! y = 2pi(0:1:N-1)/N;
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11553 diff changeset	218 %!
14501 60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	219 %! sx = cos (m*x);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	220 %! sy = cos (n*y);
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11553 diff changeset	221 %!
14501 60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	222 %! S = kron (fft (sx)', fft (sy));
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	223 %! answer = kron (sx', sy);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	224 %! s = ifft2 (S);
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11553 diff changeset	225 %!
14501 60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	226 %! assert (s, answer, 30*eps);
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7789 diff changeset	227
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7789 diff changeset	228
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7789 diff changeset	229 %% Author: David Billinghurst (David.Billinghurst@riotinto.com.au)
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7789 diff changeset	230 %% Comalco Research and Technology
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7789 diff changeset	231 %% 02 May 2000
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7789 diff changeset	232 %!test
14501 60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	233 %! M = 16;
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	234 %! N = 8;
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11553 diff changeset	235 %!
14501 60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	236 %! m = 5;
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	237 %! n = 3;
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11553 diff changeset	238 %!
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7789 diff changeset	239 %! x = 2pi(0:1:M-1)/M;
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7789 diff changeset	240 %! y = 2pi(0:1:N-1)/N;
14501 60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	241 %! sx = single (cos (m*x));
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	242 %! sy = single (sin (n*y));
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	243 %! s = kron (sx', sy);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	244 %! S = fft2 (s);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	245 %! answer = kron (fft (sx)', fft (sy));
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	246 %! assert (S, answer, 4MN*eps ("single"));
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7789 diff changeset	247
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7789 diff changeset	248 %% Author: David Billinghurst (David.Billinghurst@riotinto.com.au)
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7789 diff changeset	249 %% Comalco Research and Technology
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7789 diff changeset	250 %% 02 May 2000
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7789 diff changeset	251 %!test
14501 60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	252 %! M = 12;
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	253 %! N = 7;
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11553 diff changeset	254 %!
14501 60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	255 %! m = 3;
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	256 %! n = 2;
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11553 diff changeset	257 %!
14501 60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	258 %! x = single (2pi(0:1:M-1)/M);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	259 %! y = single (2pi(0:1:N-1)/N);
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11553 diff changeset	260 %!
14501 60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	261 %! sx = cos (m*x);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	262 %! sy = cos (n*y);
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11553 diff changeset	263 %!
14501 60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	264 %! S = kron (fft (sx)', fft (sy));
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	265 %! answer = kron (sx', sy);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	266 %! s = ifft2 (S);
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11553 diff changeset	267 %!
14501 60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	268 %! assert (s, answer, 30*eps ("single"));
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7789 diff changeset	269 */

Mercurial > octave

annotate libinterp/corefcn/fft2.cc @ 20802:8bb38ba1bad6