annotate src/DLD-FUNCTIONS/fftn.cc @ 7007:6304d9ea0a30

[project @ 2007-10-11 16:26:36 by jwe]
author jwe
date Thu, 11 Oct 2007 16:26:37 +0000
parents 0a9d97cf2e13
children 93c65f2a5668
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
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
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
3 Copyright (C) 2004 David Bateman
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
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
9 Free Software Foundation; either version 2, or (at your option) any
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
10 later version.
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
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
18 along with Octave; see the file COPYING. If not, write to the Free
5307
4c8a2e4e0717 [project @ 2005-04-26 19:24:27 by jwe]
jwe
parents: 5275
diff changeset
19 Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
4c8a2e4e0717 [project @ 2005-04-26 19:24:27 by jwe]
jwe
parents: 5275
diff changeset
20 02110-1301, USA.
4773
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
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
24 #ifdef HAVE_CONFIG_H
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
25 #include <config.h>
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
26 #endif
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
27
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
28 #include "lo-mappers.h"
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
29
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
30 #include "defun-dld.h"
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
31 #include "error.h"
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
32 #include "gripes.h"
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
33 #include "oct-obj.h"
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
34 #include "utils.h"
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
35
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
36 // This function should be merged with Fifft.
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
37
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
38 #if defined (HAVE_FFTW3)
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
39 #define FFTSRC "@sc{Fftw}"
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
40 #else
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
41 #define FFTSRC "@sc{Fftpack}"
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
42 #endif
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
43
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
44 static octave_value
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
45 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
46 {
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
47 octave_value retval;
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
48
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
49 int nargin = args.length ();
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
50
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
51 if (nargin < 1 || nargin > 2)
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
52 {
5823
080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe]
jwe
parents: 5642
diff changeset
53 print_usage ();
4773
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
54 return retval;
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
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
57 octave_value arg = args(0);
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
58 dim_vector dims = arg.dims ();
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
59
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
60 for (int i = 0; i < dims.length (); i++)
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
61 if (dims(i) < 0)
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
62 return retval;
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
63
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
64 if (nargin > 1)
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
65 {
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
66 Matrix val = args(1).matrix_value ();
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
67 if (val.rows () > val.columns ())
4849
a3440ff5eb14 [project @ 2004-04-06 15:23:56 by jwe]
jwe
parents: 4787
diff changeset
68 val = val.transpose ();
4773
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
69
4849
a3440ff5eb14 [project @ 2004-04-06 15:23:56 by jwe]
jwe
parents: 4787
diff changeset
70 if (error_state || val.columns () != dims.length () || val.rows () != 1)
4773
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
71 error ("%s: second argument must be a vector of length dim", fcn);
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
72 else
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
73 {
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
74 for (int i = 0; i < dims.length (); i++)
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
75 {
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
76 if (xisnan (val(i,0)))
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
77 error ("%s: NaN is invalid as a dimension", fcn);
5275
23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe]
jwe
parents: 4849
diff changeset
78 else if (NINTbig (val(i,0)) < 0)
4773
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
79 error ("%s: all dimension must be greater than zero", fcn);
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
80 else
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
81 {
5275
23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe]
jwe
parents: 4849
diff changeset
82 dims(i) = NINTbig(val(i,0));
4773
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
83 }
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
84 }
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
85 }
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
86 }
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
87
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
88 if (error_state)
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
89 return retval;
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
90
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
91 if (dims.all_zero ())
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
92 return octave_value (Matrix ());
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
93
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
94 if (arg.is_real_type ())
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
95 {
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
96 NDArray nda = arg.array_value ();
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
97
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
98 if (! error_state)
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
99 {
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
100 nda.resize (dims, 0.0);
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
101 retval = (type != 0 ? nda.ifourierNd () : nda.fourierNd ());
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
102 }
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
103 }
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
104 else if (arg.is_complex_type ())
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
105 {
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
106 ComplexNDArray cnda = arg.complex_array_value ();
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
107
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
108 if (! error_state)
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
109 {
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
110 cnda.resize (dims, 0.0);
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
111 retval = (type != 0 ? cnda.ifourierNd () : cnda.fourierNd ());
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
112 }
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
113 }
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
114 else
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
115 {
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
116 gripe_wrong_type_arg (fcn, arg);
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
117 }
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
118
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
119 return retval;
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
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
122 DEFUN_DLD (fftn, args, ,
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
123 "-*- texinfo -*-\n\
4787
02c748eb2ddc [project @ 2004-02-18 21:20:26 by jwe]
jwe
parents: 4782
diff changeset
124 @deftypefn {Loadable Function} {} fftn (@var{a}, @var{size})\n\
4773
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
125 Compute the N dimensional FFT of @var{a} using subroutines from\n"
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
126 FFTSRC
4787
02c748eb2ddc [project @ 2004-02-18 21:20:26 by jwe]
jwe
parents: 4782
diff changeset
127 ". The optional vector argument @var{size} may be used specify the\n\
02c748eb2ddc [project @ 2004-02-18 21:20:26 by jwe]
jwe
parents: 4782
diff changeset
128 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
129 smaller than the corresponding dimension, then the dimension is\n\
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
130 truncated prior to performing the FFT. Otherwise if an element\n\
4787
02c748eb2ddc [project @ 2004-02-18 21:20:26 by jwe]
jwe
parents: 4782
diff changeset
131 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
132 is resized and padded with zeros.\n\
6971
0a9d97cf2e13 [project @ 2007-10-07 19:44:53 by dbateman]
dbateman
parents: 5823
diff changeset
133 @seealso {ifftn, fft, fft2, fftw}\n\
5642
2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe]
jwe
parents: 5307
diff changeset
134 @end deftypefn")
4773
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
135 {
4782
3dfdf6f36854 [project @ 2004-02-17 16:23:22 by jwe]
jwe
parents: 4773
diff changeset
136 return do_fftn (args, "fftn", 0);
4773
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
137 }
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
138
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
139 DEFUN_DLD (ifftn, args, ,
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
140 "-*- texinfo -*-\n\
4787
02c748eb2ddc [project @ 2004-02-18 21:20:26 by jwe]
jwe
parents: 4782
diff changeset
141 @deftypefn {Loadable Function} {} ifftn (@var{a}, @var{size})\n\
7007
6304d9ea0a30 [project @ 2007-10-11 16:26:36 by jwe]
jwe
parents: 6971
diff changeset
142 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
143 FFTSRC
4787
02c748eb2ddc [project @ 2004-02-18 21:20:26 by jwe]
jwe
parents: 4782
diff changeset
144 ". The optional vector argument @var{size} may be used specify the\n\
02c748eb2ddc [project @ 2004-02-18 21:20:26 by jwe]
jwe
parents: 4782
diff changeset
145 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
146 smaller than the corresponding dimension, then the dimension is\n\
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
147 truncated prior to performing the inverse FFT. Otherwise if an element\n\
4787
02c748eb2ddc [project @ 2004-02-18 21:20:26 by jwe]
jwe
parents: 4782
diff changeset
148 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
149 is resized and padded with zeros.\n\
6971
0a9d97cf2e13 [project @ 2007-10-07 19:44:53 by dbateman]
dbateman
parents: 5823
diff changeset
150 @seealso {fftn, ifft, ifft2, fftw}\n\
5642
2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe]
jwe
parents: 5307
diff changeset
151 @end deftypefn")
4773
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
152 {
4782
3dfdf6f36854 [project @ 2004-02-17 16:23:22 by jwe]
jwe
parents: 4773
diff changeset
153 return do_fftn (args, "ifftn", 1);
4773
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
154 }
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
155
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
156 /*
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
157 ;;; Local Variables: ***
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
158 ;;; mode: C++ ***
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
159 ;;; End: ***
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
160 */