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

annotate src/DLD-FUNCTIONS/fft.cc @ 9064:7c02ec148a3c

Check grammar on all .cc files Same check as previously done on .m files Attempt to enforce some conformity in documentation text for rules such as two spaces after a period, commas around latin abbreviations, etc.

author	Rik <rdrider0-list@yahoo.com>
date	Sat, 28 Mar 2009 13:57:22 -0700
parents	eb63fbe60fab
children	bd8e388043c4

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
8920 eb63fbe60fab update copyright notices John W. Eaton <jwe@octave.org> parents: 7924 diff changeset	3 Copyright (C) 1997, 1999, 2002, 2004, 2005, 2006, 2007, 2008 David Bateman
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	4 Copyright (C) 1996, 1997 John W. Eaton
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
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	30 #include "defun-dld.h"
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 #if defined (HAVE_FFTW3)
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: 4233 diff changeset	37 #define FFTSRC "@sc{Fftw}"
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: 4233 diff changeset	38 #else
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: 4233 diff changeset	39 #define FFTSRC "@sc{Fftpack}"
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: 4233 diff changeset	40 #endif
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	41
4773 ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: 4233 diff changeset	42 static octave_value
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: 4233 diff changeset	43 do_fft (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	44 {
4233 ccfdb55c8156 [project @ 2002-12-20 22:43:54 by jwe] jwe parents: 3367 diff changeset	45 octave_value retval;
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	46
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	47 int nargin = args.length ();
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	48
4773 ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: 4233 diff changeset	49 if (nargin < 1 \|\| nargin > 3)
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	50 {
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5642 diff changeset	51 print_usage ();
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	52 return retval;
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
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	55 octave_value arg = args(0);
4773 ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: 4233 diff changeset	56 dim_vector dims = arg.dims ();
5275 23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe] jwe parents: 4869 diff changeset	57 octave_idx_type n_points = -1;
4773 ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: 4233 diff changeset	58 int dim = -1;
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: 4233 diff changeset	59
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: 4233 diff changeset	60 if (nargin > 1)
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: 4233 diff changeset	61 {
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: 4233 diff changeset	62 if (! args(1).is_empty ())
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: 4233 diff changeset	63 {
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: 4233 diff changeset	64 double dval = args(1).double_value ();
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: 4233 diff changeset	65 if (xisnan (dval))
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: 4233 diff changeset	66 error ("%s: NaN is invalid as the N_POINTS", fcn);
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: 4233 diff changeset	67 else
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: 4233 diff changeset	68 {
5275 23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe] jwe parents: 4869 diff changeset	69 n_points = NINTbig (dval);
4773 ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: 4233 diff changeset	70 if (n_points < 0)
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: 4233 diff changeset	71 error ("%s: number of points must be greater than zero", fcn);
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: 4233 diff changeset	72 }
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: 4233 diff changeset	73 }
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: 4233 diff changeset	74 }
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	75
4773 ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: 4233 diff changeset	76 if (error_state)
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: 4233 diff changeset	77 return retval;
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: 4233 diff changeset	78
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: 4233 diff changeset	79 if (nargin > 2)
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	80 {
4773 ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: 4233 diff changeset	81 double dval = args(2).double_value ();
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	82 if (xisnan (dval))
4773 ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: 4233 diff changeset	83 error ("%s: NaN is invalid as the N_POINTS", fcn);
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: 4233 diff changeset	84 else if (dval < 1 \|\| dval > dims.length ())
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: 4233 diff changeset	85 error ("%s: invalid dimension along which to perform fft", fcn);
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	86 else
5275 23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe] jwe parents: 4869 diff changeset	87 // to be safe, cast it back to int since dim is an int
4773 ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: 4233 diff changeset	88 dim = NINT (dval) - 1;
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	89 }
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	90
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	91 if (error_state)
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	92 return retval;
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	93
5275 23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe] jwe parents: 4869 diff changeset	94 for (octave_idx_type i = 0; i < dims.length (); i++)
4773 ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: 4233 diff changeset	95 if (dims(i) < 0)
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	96 return retval;
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	97
4773 ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: 4233 diff changeset	98 if (dim < 0)
4869 b92d59213e63 [project @ 2004-04-21 17:03:02 by jwe] jwe parents: 4782 diff changeset	99 {
5275 23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe] jwe parents: 4869 diff changeset	100 for (octave_idx_type i = 0; i < dims.length (); i++)
6620 bf4bdc21dc8d [project @ 2007-05-14 17:35:46 by jwe] jwe parents: 5823 diff changeset	101 if (dims(i) > 1)
4869 b92d59213e63 [project @ 2004-04-21 17:03:02 by jwe] jwe parents: 4782 diff changeset	102 {
b92d59213e63 [project @ 2004-04-21 17:03:02 by jwe] jwe parents: 4782 diff changeset	103 dim = i;
b92d59213e63 [project @ 2004-04-21 17:03:02 by jwe] jwe parents: 4782 diff changeset	104 break;
b92d59213e63 [project @ 2004-04-21 17:03:02 by jwe] jwe parents: 4782 diff changeset	105 }
b92d59213e63 [project @ 2004-04-21 17:03:02 by jwe] jwe parents: 4782 diff changeset	106
b92d59213e63 [project @ 2004-04-21 17:03:02 by jwe] jwe parents: 4782 diff changeset	107 // And if the first argument is scalar?
b92d59213e63 [project @ 2004-04-21 17:03:02 by jwe] jwe parents: 4782 diff changeset	108 if (dim < 0)
b92d59213e63 [project @ 2004-04-21 17:03:02 by jwe] jwe parents: 4782 diff changeset	109 dim = 1;
b92d59213e63 [project @ 2004-04-21 17:03:02 by jwe] jwe parents: 4782 diff changeset	110 }
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	111
4773 ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: 4233 diff changeset	112 if (n_points < 0)
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: 4233 diff changeset	113 n_points = dims (dim);
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: 4233 diff changeset	114 else
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: 4233 diff changeset	115 dims (dim) = n_points;
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: 4233 diff changeset	116
6620 bf4bdc21dc8d [project @ 2007-05-14 17:35:46 by jwe] jwe parents: 5823 diff changeset	117 if (dims.any_zero () \|\| n_points == 0)
7924 4976f66d469b miscellaneous cleanup John W. Eaton <jwe@octave.org> parents: 7814 diff changeset	118 {
4976f66d469b miscellaneous cleanup John W. Eaton <jwe@octave.org> parents: 7814 diff changeset	119 if (arg.is_single_type ())
4976f66d469b miscellaneous cleanup John W. Eaton <jwe@octave.org> parents: 7814 diff changeset	120 return octave_value (FloatNDArray (dims));
4976f66d469b miscellaneous cleanup John W. Eaton <jwe@octave.org> parents: 7814 diff changeset	121 else
4976f66d469b miscellaneous cleanup John W. Eaton <jwe@octave.org> parents: 7814 diff changeset	122 return octave_value (NDArray (dims));
4976f66d469b miscellaneous cleanup John W. Eaton <jwe@octave.org> parents: 7814 diff changeset	123 }
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	124
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7562 diff changeset	125 if (arg.is_single_type ())
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	126 {
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7562 diff changeset	127 if (arg.is_real_type ())
82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7562 diff changeset	128 {
82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7562 diff changeset	129 FloatNDArray nda = arg.float_array_value ();
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	130
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7562 diff changeset	131 if (! error_state)
82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7562 diff changeset	132 {
82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7562 diff changeset	133 nda.resize (dims, 0.0);
82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7562 diff changeset	134 retval = (type != 0 ? nda.ifourier (dim) : nda.fourier (dim));
82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7562 diff changeset	135 }
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	136 }
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7562 diff changeset	137 else
82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7562 diff changeset	138 {
82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7562 diff changeset	139 FloatComplexNDArray cnda = arg.float_complex_array_value ();
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	140
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7562 diff changeset	141 if (! error_state)
82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7562 diff changeset	142 {
82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7562 diff changeset	143 cnda.resize (dims, 0.0);
82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7562 diff changeset	144 retval = (type != 0 ? cnda.ifourier (dim) : cnda.fourier (dim));
82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7562 diff changeset	145 }
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	146 }
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	147 }
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	148 else
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	149 {
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7562 diff changeset	150 if (arg.is_real_type ())
82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7562 diff changeset	151 {
82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7562 diff changeset	152 NDArray nda = arg.array_value ();
82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7562 diff changeset	153
82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7562 diff changeset	154 if (! error_state)
82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7562 diff changeset	155 {
82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7562 diff changeset	156 nda.resize (dims, 0.0);
82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7562 diff changeset	157 retval = (type != 0 ? nda.ifourier (dim) : nda.fourier (dim));
82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7562 diff changeset	158 }
82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7562 diff changeset	159 }
82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7562 diff changeset	160 else if (arg.is_complex_type ())
82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7562 diff changeset	161 {
82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7562 diff changeset	162 ComplexNDArray cnda = arg.complex_array_value ();
82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7562 diff changeset	163
82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7562 diff changeset	164 if (! error_state)
82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7562 diff changeset	165 {
82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7562 diff changeset	166 cnda.resize (dims, 0.0);
82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7562 diff changeset	167 retval = (type != 0 ? cnda.ifourier (dim) : cnda.fourier (dim));
82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7562 diff changeset	168 }
82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7562 diff changeset	169 }
82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7562 diff changeset	170 else
82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7562 diff changeset	171 {
82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7562 diff changeset	172 gripe_wrong_type_arg (fcn, arg);
82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7562 diff changeset	173 }
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	174 }
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	175
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	176 return retval;
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	177 }
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	178
6620 bf4bdc21dc8d [project @ 2007-05-14 17:35:46 by jwe] jwe parents: 5823 diff changeset	179 /*
bf4bdc21dc8d [project @ 2007-05-14 17:35:46 by jwe] jwe parents: 5823 diff changeset	180
bf4bdc21dc8d [project @ 2007-05-14 17:35:46 by jwe] jwe parents: 5823 diff changeset	181 %!error(fft())
bf4bdc21dc8d [project @ 2007-05-14 17:35:46 by jwe] jwe parents: 5823 diff changeset	182 %!assert(fft([]), [])
6621 80a8e2019d39 [project @ 2007-05-14 17:58:00 by jwe] jwe parents: 6620 diff changeset	183 %!assert(fft(zeros(10,0)), zeros(10,0))
80a8e2019d39 [project @ 2007-05-14 17:58:00 by jwe] jwe parents: 6620 diff changeset	184 %!assert(fft(zeros(0,10)), zeros(0,10))
6620 bf4bdc21dc8d [project @ 2007-05-14 17:35:46 by jwe] jwe parents: 5823 diff changeset	185 %!assert(fft(0), 0)
bf4bdc21dc8d [project @ 2007-05-14 17:35:46 by jwe] jwe parents: 5823 diff changeset	186 %!assert(fft(1), 1)
bf4bdc21dc8d [project @ 2007-05-14 17:35:46 by jwe] jwe parents: 5823 diff changeset	187 %!assert(fft(ones(2,2)), [2,2; 0,0])
bf4bdc21dc8d [project @ 2007-05-14 17:35:46 by jwe] jwe parents: 5823 diff changeset	188 %!assert(fft(eye(2,2)), [1,1; 1,-1])
bf4bdc21dc8d [project @ 2007-05-14 17:35:46 by jwe] jwe parents: 5823 diff changeset	189
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7789 diff changeset	190 %!assert(fft(single([])), single([]))
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7789 diff changeset	191 %!assert(fft(zeros(10,0,'single')), zeros(10,0,'single'))
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7789 diff changeset	192 %!assert(fft(zeros(0,10,'single')), zeros(0,10,'single'))
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7789 diff changeset	193 %!assert(fft(single(0)), single(0))
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7789 diff changeset	194 %!assert(fft(single(1)), single(1))
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7789 diff changeset	195 %!assert(fft(ones(2,2,'single')), single([2,2; 0,0]))
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7789 diff changeset	196 %!assert(fft(eye(2,2,'single')), single([1,1; 1,-1]))
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7789 diff changeset	197
6620 bf4bdc21dc8d [project @ 2007-05-14 17:35:46 by jwe] jwe parents: 5823 diff changeset	198 */
bf4bdc21dc8d [project @ 2007-05-14 17:35:46 by jwe] jwe parents: 5823 diff changeset	199
4773 ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: 4233 diff changeset	200
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: 4233 diff changeset	201 DEFUN_DLD (fft, args, ,
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: 4233 diff changeset	202 "-- texinfo --\n\
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: 4233 diff changeset	203 @deftypefn {Loadable Function} {} fft (@var{a}, @var{n}, @var{dim})\n\
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: 4233 diff changeset	204 Compute the FFT of @var{a} using subroutines from\n"
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: 4233 diff changeset	205 FFTSRC
9064 7c02ec148a3c Check grammar on all .cc files Rik <rdrider0-list@yahoo.com> parents: 8920 diff changeset	206 ". The FFT is calculated along the first non-singleton dimension of the\n\
7c02ec148a3c Check grammar on all .cc files Rik <rdrider0-list@yahoo.com> parents: 8920 diff changeset	207 array. Thus if @var{a} is a matrix, @code{fft (@var{a})} computes the\n\
4773 ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: 4233 diff changeset	208 FFT for each column of @var{a}.\n\
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: 4233 diff changeset	209 \n\
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: 4233 diff changeset	210 If called with two arguments, @var{n} is expected to be an integer\n\
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: 4233 diff changeset	211 specifying the number of elements of @var{a} to use, or an empty\n\
9064 7c02ec148a3c Check grammar on all .cc files Rik <rdrider0-list@yahoo.com> parents: 8920 diff changeset	212 matrix to specify that its value should be ignored. If @var{n} is\n\
4773 ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: 4233 diff changeset	213 larger than the dimension along which the FFT is calculated, then\n\
9064 7c02ec148a3c Check grammar on all .cc files Rik <rdrider0-list@yahoo.com> parents: 8920 diff changeset	214 @var{a} is resized and padded with zeros. Otherwise, if @var{n} is\n\
4773 ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: 4233 diff changeset	215 smaller than the dimension along which the FFT is calculated, then\n\
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: 4233 diff changeset	216 @var{a} is truncated.\n\
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: 4233 diff changeset	217 \n\
5448 ebe5d7d15522 [project @ 2005-09-14 18:55:04 by jwe] jwe parents: 5307 diff changeset	218 If called with three arguments, @var{dim} is an integer specifying the\n\
4773 ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: 4233 diff changeset	219 dimension of the matrix along which the FFT is performed\n\
6971 0a9d97cf2e13 [project @ 2007-10-07 19:44:53 by dbateman] dbateman parents: 6622 diff changeset	220 @seealso{ifft, fft2, fftn, fftw}\n\
5642 2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe] jwe parents: 5448 diff changeset	221 @end deftypefn")
4773 ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: 4233 diff changeset	222 {
4782 3dfdf6f36854 [project @ 2004-02-17 16:23:22 by jwe] jwe parents: 4773 diff changeset	223 return do_fft (args, "fft", 0);
4773 ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: 4233 diff changeset	224 }
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: 4233 diff changeset	225
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: 4233 diff changeset	226
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: 4233 diff changeset	227 DEFUN_DLD (ifft, args, ,
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: 4233 diff changeset	228 "-- texinfo --\n\
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: 4233 diff changeset	229 @deftypefn {Loadable Function} {} ifft (@var{a}, @var{n}, @var{dim})\n\
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: 4233 diff changeset	230 Compute the inverse FFT of @var{a} using subroutines from\n"
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: 4233 diff changeset	231 FFTSRC
9064 7c02ec148a3c Check grammar on all .cc files Rik <rdrider0-list@yahoo.com> parents: 8920 diff changeset	232 ". The inverse FFT is calculated along the first non-singleton dimension\n\
7c02ec148a3c Check grammar on all .cc files Rik <rdrider0-list@yahoo.com> parents: 8920 diff changeset	233 of the array. Thus if @var{a} is a matrix, @code{fft (@var{a})} computes\n\
4773 ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: 4233 diff changeset	234 the inverse FFT for each column of @var{a}.\n\
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: 4233 diff changeset	235 \n\
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: 4233 diff changeset	236 If called with two arguments, @var{n} is expected to be an integer\n\
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: 4233 diff changeset	237 specifying the number of elements of @var{a} to use, or an empty\n\
9064 7c02ec148a3c Check grammar on all .cc files Rik <rdrider0-list@yahoo.com> parents: 8920 diff changeset	238 matrix to specify that its value should be ignored. If @var{n} is\n\
4773 ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: 4233 diff changeset	239 larger than the dimension along which the inverse FFT is calculated, then\n\
9064 7c02ec148a3c Check grammar on all .cc files Rik <rdrider0-list@yahoo.com> parents: 8920 diff changeset	240 @var{a} is resized and padded with zeros. Otherwise, if@var{n} is\n\
4773 ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: 4233 diff changeset	241 smaller than the dimension along which the inverse FFT is calculated,\n\
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: 4233 diff changeset	242 then @var{a} is truncated.\n\
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: 4233 diff changeset	243 \n\
7001 8b0cfeb06365 [project @ 2007-10-10 18:02:59 by jwe] jwe parents: 6971 diff changeset	244 If called with three arguments, @var{dim} is an integer specifying the\n\
4773 ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: 4233 diff changeset	245 dimension of the matrix along which the inverse FFT is performed\n\
6971 0a9d97cf2e13 [project @ 2007-10-07 19:44:53 by dbateman] dbateman parents: 6622 diff changeset	246 @seealso{fft, ifft2, ifftn, fftw}\n\
5642 2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe] jwe parents: 5448 diff changeset	247 @end deftypefn")
4773 ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: 4233 diff changeset	248 {
4782 3dfdf6f36854 [project @ 2004-02-17 16:23:22 by jwe] jwe parents: 4773 diff changeset	249 return do_fft (args, "ifft", 1);
4773 ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: 4233 diff changeset	250 }
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe] jwe parents: 4233 diff changeset	251
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	252 /*
7562 c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	253
c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	254 %% Author: David Billinghurst (David.Billinghurst@riotinto.com.au)
c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	255 %% Comalco Research and Technology
c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	256 %% 02 May 2000
c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	257 %!test
c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	258 %! N=64;
c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	259 %! n=4;
c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	260 %! t = 2pi(0:1:N-1)/N;
c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	261 %! s = cos(n*t);
c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	262 %! S = fft(s);
c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	263 %!
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7789 diff changeset	264 %! answer = zeros (size(t));
7562 c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	265 %! answer(n+1) = N/2;
c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	266 %! answer(N-n+1) = N/2;
c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	267 %!
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7789 diff changeset	268 %! assert(S, answer, 4Neps);
7562 c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	269
c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	270 %% Author: David Billinghurst (David.Billinghurst@riotinto.com.au)
c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	271 %% Comalco Research and Technology
c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	272 %% 02 May 2000
c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	273 %!test
c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	274 %! N=64;
c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	275 %! n=7;
c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	276 %! t = 2pi(0:1:N-1)/N;
c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	277 %! s = cos(n*t);
c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	278 %!
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7789 diff changeset	279 %! S = zeros (size(t));
7562 c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	280 %! S(n+1) = N/2;
c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	281 %! S(N-n+1) = N/2;
c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	282 %!
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7789 diff changeset	283 %! assert(ifft(S), s, 4Neps);
7562 c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	284
c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	285 %% Author: David Billinghurst (David.Billinghurst@riotinto.com.au)
c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	286 %% Comalco Research and Technology
c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	287 %% 02 May 2000
c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	288 %!test
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7789 diff changeset	289 %! N=64;
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7789 diff changeset	290 %! n=4;
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7789 diff changeset	291 %! t = single (2pi(0:1:N-1)/N);
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7789 diff changeset	292 %! s = cos(n*t);
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7789 diff changeset	293 %! S = fft(s);
7562 c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	294 %!
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7789 diff changeset	295 %! answer = zeros (size(t),'single');
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7789 diff changeset	296 %! answer(n+1) = N/2;
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7789 diff changeset	297 %! answer(N-n+1) = N/2;
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7789 diff changeset	298 %!
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7789 diff changeset	299 %! assert(S, answer, 4Neps('single'));
7562 c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	300
c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	301 %% Author: David Billinghurst (David.Billinghurst@riotinto.com.au)
c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	302 %% Comalco Research and Technology
c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	303 %% 02 May 2000
c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	304 %!test
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7789 diff changeset	305 %! N=64;
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7789 diff changeset	306 %! n=7;
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7789 diff changeset	307 %! t = 2pi(0:1:N-1)/N;
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7789 diff changeset	308 %! s = cos(n*t);
7562 c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	309 %!
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7789 diff changeset	310 %! S = zeros (size(t),'single');
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7789 diff changeset	311 %! S(n+1) = N/2;
87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7789 diff changeset	312 %! S(N-n+1) = N/2;
7562 c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	313 %!
7814 87865ed7405f Second set of single precision test code and fix of resulting bugs David Bateman <dbateman@free.fr> parents: 7789 diff changeset	314 %! assert(ifft(S), s, 4Neps('single'));
7562 c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	315
c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	316 */
c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	317
c827f5673321 move tests to individual source files John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	318 /*
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	319 ;;; Local Variables: ***
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	320 ;;; mode: C++ ***
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	321 ;;; End: ***
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	322 */

Mercurial > octave-nkf

annotate src/DLD-FUNCTIONS/fft.cc @ 9064:7c02ec148a3c