annotate src/DLD-FUNCTIONS/fftn.cc @ 7017:a1dbe9d80eee

[project @ 2007-10-12 21:27:11 by jwe]
author jwe
date Fri, 12 Oct 2007 21:27:37 +0000
parents 93c65f2a5668
children 82be108cc558
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
7017
a1dbe9d80eee [project @ 2007-10-12 21:27:11 by jwe]
jwe
parents: 7016
diff changeset
3 Copyright (C) 2004, 2005, 2006, 2007 David Bateman
4773
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
4
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
5 This file is part of Octave.
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
6
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
7 Octave is free software; you can redistribute it and/or modify it
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
8 under the terms of the GNU General Public License as published by the
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 7007
diff changeset
9 Free Software Foundation; either version 3 of the License, or (at your
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 7007
diff changeset
10 option) any later version.
4773
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
11
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
12 Octave is distributed in the hope that it will be useful, but WITHOUT
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
15 for more details.
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
16
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
17 You should have received a copy of the GNU General Public License
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 7007
diff changeset
18 along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 7007
diff changeset
19 <http://www.gnu.org/licenses/>.
4773
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
20
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
21 */
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
22
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
23 #ifdef HAVE_CONFIG_H
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
24 #include <config.h>
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
25 #endif
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
26
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
27 #include "lo-mappers.h"
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
28
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
29 #include "defun-dld.h"
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
30 #include "error.h"
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
31 #include "gripes.h"
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
32 #include "oct-obj.h"
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
33 #include "utils.h"
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
34
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
35 // This function should be merged with Fifft.
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
36
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
37 #if defined (HAVE_FFTW3)
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
38 #define FFTSRC "@sc{Fftw}"
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
39 #else
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
40 #define FFTSRC "@sc{Fftpack}"
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
41 #endif
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
42
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
43 static octave_value
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
44 do_fftn (const octave_value_list &args, const char *fcn, int type)
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
45 {
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
46 octave_value retval;
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
47
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
48 int nargin = args.length ();
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
49
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
50 if (nargin < 1 || nargin > 2)
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
51 {
5823
080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe]
jwe
parents: 5642
diff changeset
52 print_usage ();
4773
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
53 return retval;
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
54 }
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
55
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
56 octave_value arg = args(0);
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
57 dim_vector dims = arg.dims ();
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
58
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
59 for (int i = 0; i < dims.length (); i++)
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
60 if (dims(i) < 0)
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
61 return retval;
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
62
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
63 if (nargin > 1)
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
64 {
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
65 Matrix val = args(1).matrix_value ();
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
66 if (val.rows () > val.columns ())
4849
a3440ff5eb14 [project @ 2004-04-06 15:23:56 by jwe]
jwe
parents: 4787
diff changeset
67 val = val.transpose ();
4773
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
68
4849
a3440ff5eb14 [project @ 2004-04-06 15:23:56 by jwe]
jwe
parents: 4787
diff changeset
69 if (error_state || val.columns () != dims.length () || val.rows () != 1)
4773
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
70 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
71 else
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
72 {
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
73 for (int i = 0; i < dims.length (); i++)
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
74 {
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
75 if (xisnan (val(i,0)))
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
76 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
77 else if (NINTbig (val(i,0)) < 0)
4773
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
78 error ("%s: all dimension must be greater than zero", fcn);
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
79 else
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
80 {
5275
23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe]
jwe
parents: 4849
diff changeset
81 dims(i) = NINTbig(val(i,0));
4773
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
82 }
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 if (error_state)
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
88 return retval;
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
89
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
90 if (dims.all_zero ())
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
91 return octave_value (Matrix ());
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
92
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
93 if (arg.is_real_type ())
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
94 {
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
95 NDArray nda = arg.array_value ();
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
96
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
97 if (! error_state)
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
98 {
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
99 nda.resize (dims, 0.0);
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
100 retval = (type != 0 ? nda.ifourierNd () : nda.fourierNd ());
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
101 }
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
102 }
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
103 else if (arg.is_complex_type ())
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
104 {
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
105 ComplexNDArray cnda = arg.complex_array_value ();
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
106
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
107 if (! error_state)
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
108 {
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
109 cnda.resize (dims, 0.0);
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
110 retval = (type != 0 ? cnda.ifourierNd () : cnda.fourierNd ());
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
111 }
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 else
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
114 {
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
115 gripe_wrong_type_arg (fcn, arg);
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
116 }
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 return retval;
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
119 }
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 DEFUN_DLD (fftn, args, ,
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
122 "-*- texinfo -*-\n\
4787
02c748eb2ddc [project @ 2004-02-18 21:20:26 by jwe]
jwe
parents: 4782
diff changeset
123 @deftypefn {Loadable Function} {} fftn (@var{a}, @var{size})\n\
4773
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
124 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
125 FFTSRC
4787
02c748eb2ddc [project @ 2004-02-18 21:20:26 by jwe]
jwe
parents: 4782
diff changeset
126 ". 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
127 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
128 smaller than the corresponding dimension, then the dimension is\n\
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
129 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
130 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
131 is resized and padded with zeros.\n\
6971
0a9d97cf2e13 [project @ 2007-10-07 19:44:53 by dbateman]
dbateman
parents: 5823
diff changeset
132 @seealso {ifftn, fft, fft2, fftw}\n\
5642
2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe]
jwe
parents: 5307
diff changeset
133 @end deftypefn")
4773
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
134 {
4782
3dfdf6f36854 [project @ 2004-02-17 16:23:22 by jwe]
jwe
parents: 4773
diff changeset
135 return do_fftn (args, "fftn", 0);
4773
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
136 }
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 DEFUN_DLD (ifftn, args, ,
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
139 "-*- texinfo -*-\n\
4787
02c748eb2ddc [project @ 2004-02-18 21:20:26 by jwe]
jwe
parents: 4782
diff changeset
140 @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
141 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
142 FFTSRC
4787
02c748eb2ddc [project @ 2004-02-18 21:20:26 by jwe]
jwe
parents: 4782
diff changeset
143 ". 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
144 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
145 smaller than the corresponding dimension, then the dimension is\n\
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
146 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
147 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
148 is resized and padded with zeros.\n\
6971
0a9d97cf2e13 [project @ 2007-10-07 19:44:53 by dbateman]
dbateman
parents: 5823
diff changeset
149 @seealso {fftn, ifft, ifft2, fftw}\n\
5642
2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe]
jwe
parents: 5307
diff changeset
150 @end deftypefn")
4773
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
151 {
4782
3dfdf6f36854 [project @ 2004-02-17 16:23:22 by jwe]
jwe
parents: 4773
diff changeset
152 return do_fftn (args, "ifftn", 1);
4773
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
153 }
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 ;;; Local Variables: ***
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
157 ;;; mode: C++ ***
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
158 ;;; End: ***
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents:
diff changeset
159 */