Mercurial > octave
annotate libinterp/corefcn/fft.cc @ 31210:9ad55d2e1bbf stable
Make sure we don't pass short 8.3 path to latex on Windows (bug #62779).
* latex-text-renderer.cc (latex_renderer::write_tex_file): On Windows, use
canonicalized path of temporary directory.
author | Pantxo Diribarne <pantxo.diribarne@gmail.com> |
---|---|
date | Sun, 28 Aug 2022 22:44:49 +0200 |
parents | 796f54d4ddbf |
children | 32d2b6604a9f |
rev | line source |
---|---|
27923
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
1 //////////////////////////////////////////////////////////////////////// |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
2 // |
30564
796f54d4ddbf
update Octave Project Developers copyright for the new year
John W. Eaton <jwe@octave.org>
parents:
29961
diff
changeset
|
3 // Copyright (C) 1996-2022 The Octave Project Developers |
27923
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
4 // |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
5 // See the file COPYRIGHT.md in the top-level directory of this |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
6 // distribution or <https://octave.org/copyright/>. |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
7 // |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
8 // This file is part of Octave. |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
9 // |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
10 // Octave is free software: you can redistribute it and/or modify it |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
11 // under the terms of the GNU General Public License as published by |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
12 // the Free Software Foundation, either version 3 of the License, or |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
13 // (at your option) any later version. |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
14 // |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
15 // Octave is distributed in the hope that it will be useful, but |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
16 // WITHOUT ANY WARRANTY; without even the implied warranty of |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
17 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
18 // GNU General Public License for more details. |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
19 // |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
20 // You should have received a copy of the GNU General Public License |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
21 // along with Octave; see the file COPYING. If not, see |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
22 // <https://www.gnu.org/licenses/>. |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
23 // |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
24 //////////////////////////////////////////////////////////////////////// |
2928 | 25 |
21724
aba2e6293dd8
use "#if ..." consistently instead of "#ifdef" and "#ifndef"
John W. Eaton <jwe@octave.org>
parents:
21660
diff
changeset
|
26 #if defined (HAVE_CONFIG_H) |
21301
40de9f8f23a6
Use '#include "config.h"' rather than <config.h>.
Rik <rik@octave.org>
parents:
21200
diff
changeset
|
27 # include "config.h" |
2928 | 28 #endif |
29 | |
30 #include "lo-mappers.h" | |
31 | |
15039
e753177cde93
maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory
Rik <rik@octave.org>
parents:
14854
diff
changeset
|
32 #include "defun.h" |
2928 | 33 #include "error.h" |
21100
e39e05d90788
Switch gripe_XXX to either err_XXX or warn_XXX naming scheme.
Rik <rik@octave.org>
parents:
20940
diff
changeset
|
34 #include "errwarn.h" |
20940
48b2ad5ee801
maint: Rename oct-obj.[cc|h] to ovl.[cc|h] for clarity.
Rik <rik@octave.org>
parents:
20918
diff
changeset
|
35 #include "ovl.h" |
2928 | 36 #include "utils.h" |
37 | |
29958
32c3a5805893
move DEFUN and DEFMETHOD functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
29688
diff
changeset
|
38 OCTAVE_NAMESPACE_BEGIN |
32c3a5805893
move DEFUN and DEFMETHOD functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
29688
diff
changeset
|
39 |
4773 | 40 static octave_value |
23433
c9fab0bc983e
maint: Use convention 'int& x' for naming references.
Rik <rik@octave.org>
parents:
23220
diff
changeset
|
41 do_fft (const octave_value_list& args, const char *fcn, int type) |
2928 | 42 { |
43 int nargin = args.length (); | |
44 | |
4773 | 45 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
|
46 print_usage (); |
2928 | 47 |
20918
6f0bd96f93c0
maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
48 octave_value retval; |
2928 | 49 octave_value arg = args(0); |
22662
655157b34a9f
Fix segfault when calling fft on last dimension (bug #49026).
Rik <rik@octave.org>
parents:
22407
diff
changeset
|
50 octave_idx_type n_points = -1; |
4773 | 51 dim_vector dims = arg.dims (); |
22662
655157b34a9f
Fix segfault when calling fft on last dimension (bug #49026).
Rik <rik@octave.org>
parents:
22407
diff
changeset
|
52 int ndims = dims.ndims (); |
4773 | 53 int dim = -1; |
11586
12df7854fa7c
strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents:
11553
diff
changeset
|
54 |
4773 | 55 if (nargin > 1) |
56 { | |
23577
80c42f4cca13
maint: Deprecate is_empty and replace with isempty.
Rik <rik@octave.org>
parents:
23433
diff
changeset
|
57 if (! args(1).isempty ()) |
10154
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9523
diff
changeset
|
58 { |
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9523
diff
changeset
|
59 double dval = args(1).double_value (); |
29961
7d6709900da7
eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more
John W. Eaton <jwe@octave.org>
parents:
29958
diff
changeset
|
60 if (math::isnan (dval)) |
11553
01f703952eff
Improve docstrings for functions in DLD-FUNCTIONS directory.
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
61 error ("%s: number of points (N) cannot be NaN", fcn); |
20918
6f0bd96f93c0
maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
62 |
29961
7d6709900da7
eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more
John W. Eaton <jwe@octave.org>
parents:
29958
diff
changeset
|
63 n_points = math::nint_big (dval); |
20918
6f0bd96f93c0
maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
64 if (n_points < 0) |
6f0bd96f93c0
maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
65 error ("%s: number of points (N) must be greater than zero", fcn); |
10154
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9523
diff
changeset
|
66 } |
4773 | 67 } |
2928 | 68 |
4773 | 69 if (nargin > 2) |
2928 | 70 { |
4773 | 71 double dval = args(2).double_value (); |
29961
7d6709900da7
eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more
John W. Eaton <jwe@octave.org>
parents:
29958
diff
changeset
|
72 if (math::isnan (dval)) |
11553
01f703952eff
Improve docstrings for functions in DLD-FUNCTIONS directory.
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
73 error ("%s: DIM cannot be NaN", fcn); |
22662
655157b34a9f
Fix segfault when calling fft on last dimension (bug #49026).
Rik <rik@octave.org>
parents:
22407
diff
changeset
|
74 else if (dval < 1 || dval > ndims) |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
75 error ("%s: DIM must be a valid dimension along which to perform FFT", |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
76 fcn); |
2928 | 77 else |
10154
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9523
diff
changeset
|
78 // to be safe, cast it back to int since dim is an int |
29961
7d6709900da7
eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more
John W. Eaton <jwe@octave.org>
parents:
29958
diff
changeset
|
79 dim = math::nint (dval) - 1; |
2928 | 80 } |
81 | |
22662
655157b34a9f
Fix segfault when calling fft on last dimension (bug #49026).
Rik <rik@octave.org>
parents:
22407
diff
changeset
|
82 // FIXME: This seems strange and unnecessary (10/21/16). |
655157b34a9f
Fix segfault when calling fft on last dimension (bug #49026).
Rik <rik@octave.org>
parents:
22407
diff
changeset
|
83 // How would you ever arrive at an octave_value object without correct dims? |
655157b34a9f
Fix segfault when calling fft on last dimension (bug #49026).
Rik <rik@octave.org>
parents:
22407
diff
changeset
|
84 // We certainly don't make this check every other place in Octave. |
655157b34a9f
Fix segfault when calling fft on last dimension (bug #49026).
Rik <rik@octave.org>
parents:
22407
diff
changeset
|
85 for (octave_idx_type i = 0; i < ndims; i++) |
4773 | 86 if (dims(i) < 0) |
2928 | 87 return retval; |
88 | |
4773 | 89 if (dim < 0) |
4869 | 90 { |
22662
655157b34a9f
Fix segfault when calling fft on last dimension (bug #49026).
Rik <rik@octave.org>
parents:
22407
diff
changeset
|
91 dim = dims.first_non_singleton (); |
4869 | 92 |
93 // And if the first argument is scalar? | |
22662
655157b34a9f
Fix segfault when calling fft on last dimension (bug #49026).
Rik <rik@octave.org>
parents:
22407
diff
changeset
|
94 if (dim == ndims) |
10154
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9523
diff
changeset
|
95 dim = 1; |
4869 | 96 } |
2928 | 97 |
4773 | 98 if (n_points < 0) |
20218
b2100e1659ac
maint: Use cuddled parentheses when indexing dimension_vectors.
Rik <rik@octave.org>
parents:
19697
diff
changeset
|
99 n_points = dims(dim); |
4773 | 100 else |
20218
b2100e1659ac
maint: Use cuddled parentheses when indexing dimension_vectors.
Rik <rik@octave.org>
parents:
19697
diff
changeset
|
101 dims(dim) = n_points; |
4773 | 102 |
22662
655157b34a9f
Fix segfault when calling fft on last dimension (bug #49026).
Rik <rik@octave.org>
parents:
22407
diff
changeset
|
103 if (n_points == 0 || dims.any_zero ()) |
7924 | 104 { |
105 if (arg.is_single_type ()) | |
10154
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9523
diff
changeset
|
106 return octave_value (FloatNDArray (dims)); |
7924 | 107 else |
10154
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9523
diff
changeset
|
108 return octave_value (NDArray (dims)); |
7924 | 109 } |
2928 | 110 |
22662
655157b34a9f
Fix segfault when calling fft on last dimension (bug #49026).
Rik <rik@octave.org>
parents:
22407
diff
changeset
|
111 if (n_points == 1) |
655157b34a9f
Fix segfault when calling fft on last dimension (bug #49026).
Rik <rik@octave.org>
parents:
22407
diff
changeset
|
112 { |
655157b34a9f
Fix segfault when calling fft on last dimension (bug #49026).
Rik <rik@octave.org>
parents:
22407
diff
changeset
|
113 octave_value_list idx (ndims); |
655157b34a9f
Fix segfault when calling fft on last dimension (bug #49026).
Rik <rik@octave.org>
parents:
22407
diff
changeset
|
114 for (octave_idx_type i = 0; i < ndims; i++) |
29961
7d6709900da7
eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more
John W. Eaton <jwe@octave.org>
parents:
29958
diff
changeset
|
115 idx(i) = idx_vector::colon; |
7d6709900da7
eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more
John W. Eaton <jwe@octave.org>
parents:
29958
diff
changeset
|
116 idx(dim) = idx_vector (0); |
22662
655157b34a9f
Fix segfault when calling fft on last dimension (bug #49026).
Rik <rik@octave.org>
parents:
22407
diff
changeset
|
117 |
28631
70cdf8de553d
move non-member octave_value operator functions to octave namespace
John W. Eaton <jwe@octave.org>
parents:
27923
diff
changeset
|
118 return arg.index_op (idx); |
22662
655157b34a9f
Fix segfault when calling fft on last dimension (bug #49026).
Rik <rik@octave.org>
parents:
22407
diff
changeset
|
119 } |
655157b34a9f
Fix segfault when calling fft on last dimension (bug #49026).
Rik <rik@octave.org>
parents:
22407
diff
changeset
|
120 |
7789
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7562
diff
changeset
|
121 if (arg.is_single_type ()) |
2928 | 122 { |
23582
0cc2011d800e
maint: Deprecate is_real_type and replace with isreal.
Rik <rik@octave.org>
parents:
23581
diff
changeset
|
123 if (arg.isreal ()) |
10154
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9523
diff
changeset
|
124 { |
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9523
diff
changeset
|
125 FloatNDArray nda = arg.float_array_value (); |
2928 | 126 |
20555
f90c8372b7ba
eliminate many more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20218
diff
changeset
|
127 nda.resize (dims, 0.0); |
f90c8372b7ba
eliminate many more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20218
diff
changeset
|
128 retval = (type != 0 ? nda.ifourier (dim) : nda.fourier (dim)); |
10154
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9523
diff
changeset
|
129 } |
7789
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7562
diff
changeset
|
130 else |
10154
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9523
diff
changeset
|
131 { |
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9523
diff
changeset
|
132 FloatComplexNDArray cnda = arg.float_complex_array_value (); |
2928 | 133 |
20555
f90c8372b7ba
eliminate many more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20218
diff
changeset
|
134 cnda.resize (dims, 0.0); |
f90c8372b7ba
eliminate many more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20218
diff
changeset
|
135 retval = (type != 0 ? cnda.ifourier (dim) : cnda.fourier (dim)); |
10154
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9523
diff
changeset
|
136 } |
2928 | 137 } |
138 else | |
139 { | |
23582
0cc2011d800e
maint: Deprecate is_real_type and replace with isreal.
Rik <rik@octave.org>
parents:
23581
diff
changeset
|
140 if (arg.isreal ()) |
10154
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9523
diff
changeset
|
141 { |
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9523
diff
changeset
|
142 NDArray nda = arg.array_value (); |
7789
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7562
diff
changeset
|
143 |
20555
f90c8372b7ba
eliminate many more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20218
diff
changeset
|
144 nda.resize (dims, 0.0); |
f90c8372b7ba
eliminate many more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20218
diff
changeset
|
145 retval = (type != 0 ? nda.ifourier (dim) : nda.fourier (dim)); |
10154
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9523
diff
changeset
|
146 } |
23581
c3075ae020e1
maint: Deprecate is_complex_type and replace with iscomplex.
Rik <rik@octave.org>
parents:
23577
diff
changeset
|
147 else if (arg.iscomplex ()) |
10154
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9523
diff
changeset
|
148 { |
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9523
diff
changeset
|
149 ComplexNDArray cnda = arg.complex_array_value (); |
7789
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7562
diff
changeset
|
150 |
20555
f90c8372b7ba
eliminate many more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20218
diff
changeset
|
151 cnda.resize (dims, 0.0); |
f90c8372b7ba
eliminate many more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20218
diff
changeset
|
152 retval = (type != 0 ? cnda.ifourier (dim) : cnda.fourier (dim)); |
10154
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9523
diff
changeset
|
153 } |
7789
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7562
diff
changeset
|
154 else |
21100
e39e05d90788
Switch gripe_XXX to either err_XXX or warn_XXX naming scheme.
Rik <rik@octave.org>
parents:
20940
diff
changeset
|
155 err_wrong_type_arg (fcn, arg); |
2928 | 156 } |
157 | |
158 return retval; | |
159 } | |
160 | |
6620 | 161 /* |
25586 | 162 %!testif HAVE_FFTW |
163 %! assert (fft ([]), []) | |
164 %!testif HAVE_FFTW | |
165 %! assert (fft (zeros (10,0)), zeros (10,0)) | |
166 %!testif HAVE_FFTW | |
167 %! assert (fft (zeros (0,10)), zeros (0,10)) | |
168 %!testif HAVE_FFTW | |
169 %! assert (fft (0), 0) | |
170 %!testif HAVE_FFTW | |
171 %! assert (fft (1), 1) | |
172 %!testif HAVE_FFTW | |
173 %! assert (fft (ones (2,2)), [2,2; 0,0]) | |
174 %!testif HAVE_FFTW | |
175 %! assert (fft (eye (2,2)), [1,1; 1,-1]) | |
6620 | 176 |
25586 | 177 %!testif HAVE_FFTW |
178 %! assert (fft (single ([])), single ([])) | |
179 %!testif HAVE_FFTW | |
180 %! assert (fft (zeros (10,0,"single")), zeros (10,0,"single")) | |
181 %!testif HAVE_FFTW | |
182 %! assert (fft (zeros (0,10,"single")), zeros (0,10,"single")) | |
183 %!testif HAVE_FFTW | |
184 %! assert (fft (single (0)), single (0)) | |
185 %!testif HAVE_FFTW | |
186 %! assert (fft (single (1)), single (1)) | |
187 %!testif HAVE_FFTW | |
188 %! assert (fft (ones (2,2,"single")), single ([2,2; 0,0])) | |
189 %!testif HAVE_FFTW | |
190 %! assert (fft (eye (2,2,"single")), single ([1,1; 1,-1])) | |
6620 | 191 |
28930
2883b3d08b7e
maint: Remove unnecessary parentheses bracketing %!error BIST tests.
Rik <rik@octave.org>
parents:
28631
diff
changeset
|
192 %!error fft () |
6620 | 193 */ |
194 | |
4773 | 195 |
15039
e753177cde93
maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory
Rik <rik@octave.org>
parents:
14854
diff
changeset
|
196 DEFUN (fft, args, , |
21966
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21782
diff
changeset
|
197 doc: /* -*- texinfo -*- |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21782
diff
changeset
|
198 @deftypefn {} {} fft (@var{x}) |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21782
diff
changeset
|
199 @deftypefnx {} {} fft (@var{x}, @var{n}) |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21782
diff
changeset
|
200 @deftypefnx {} {} fft (@var{x}, @var{n}, @var{dim}) |
24575
93714122ed59
doc: Fixes for signal, image, audio, and OOP chapters (bug #52844).
Rik <rik@octave.org>
parents:
23219
diff
changeset
|
201 Compute the discrete Fourier transform of @var{x} using |
21966
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21782
diff
changeset
|
202 a Fast Fourier Transform (FFT) algorithm. |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21782
diff
changeset
|
203 |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21782
diff
changeset
|
204 The FFT is calculated along the first non-singleton dimension of the |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21782
diff
changeset
|
205 array. Thus if @var{x} is a matrix, @code{fft (@var{x})} computes the |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21782
diff
changeset
|
206 FFT for each column of @var{x}. |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21782
diff
changeset
|
207 |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21782
diff
changeset
|
208 If called with two arguments, @var{n} is expected to be an integer |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21782
diff
changeset
|
209 specifying the number of elements of @var{x} to use, or an empty |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21782
diff
changeset
|
210 matrix to specify that its value should be ignored. If @var{n} is |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21782
diff
changeset
|
211 larger than the dimension along which the FFT is calculated, then |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21782
diff
changeset
|
212 @var{x} is resized and padded with zeros. Otherwise, if @var{n} is |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21782
diff
changeset
|
213 smaller than the dimension along which the FFT is calculated, then |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21782
diff
changeset
|
214 @var{x} is truncated. |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21782
diff
changeset
|
215 |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21782
diff
changeset
|
216 If called with three arguments, @var{dim} is an integer specifying the |
24575
93714122ed59
doc: Fixes for signal, image, audio, and OOP chapters (bug #52844).
Rik <rik@octave.org>
parents:
23219
diff
changeset
|
217 dimension of the matrix along which the FFT is performed. |
21966
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21782
diff
changeset
|
218 @seealso{ifft, fft2, fftn, fftw} |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21782
diff
changeset
|
219 @end deftypefn */) |
4773 | 220 { |
4782 | 221 return do_fft (args, "fft", 0); |
4773 | 222 } |
223 | |
224 | |
15039
e753177cde93
maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory
Rik <rik@octave.org>
parents:
14854
diff
changeset
|
225 DEFUN (ifft, args, , |
21966
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21782
diff
changeset
|
226 doc: /* -*- texinfo -*- |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21782
diff
changeset
|
227 @deftypefn {} {} ifft (@var{x}) |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21782
diff
changeset
|
228 @deftypefnx {} {} ifft (@var{x}, @var{n}) |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21782
diff
changeset
|
229 @deftypefnx {} {} ifft (@var{x}, @var{n}, @var{dim}) |
24575
93714122ed59
doc: Fixes for signal, image, audio, and OOP chapters (bug #52844).
Rik <rik@octave.org>
parents:
23219
diff
changeset
|
230 Compute the inverse discrete Fourier transform of @var{x} |
21966
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21782
diff
changeset
|
231 using a Fast Fourier Transform (FFT) algorithm. |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21782
diff
changeset
|
232 |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21782
diff
changeset
|
233 The inverse FFT is calculated along the first non-singleton dimension |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21782
diff
changeset
|
234 of the array. Thus if @var{x} is a matrix, @code{fft (@var{x})} computes |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21782
diff
changeset
|
235 the inverse FFT for each column of @var{x}. |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21782
diff
changeset
|
236 |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21782
diff
changeset
|
237 If called with two arguments, @var{n} is expected to be an integer |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21782
diff
changeset
|
238 specifying the number of elements of @var{x} to use, or an empty |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21782
diff
changeset
|
239 matrix to specify that its value should be ignored. If @var{n} is |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21782
diff
changeset
|
240 larger than the dimension along which the inverse FFT is calculated, then |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21782
diff
changeset
|
241 @var{x} is resized and padded with zeros. Otherwise, if @var{n} is |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21782
diff
changeset
|
242 smaller than the dimension along which the inverse FFT is calculated, |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21782
diff
changeset
|
243 then @var{x} is truncated. |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21782
diff
changeset
|
244 |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21782
diff
changeset
|
245 If called with three arguments, @var{dim} is an integer specifying the |
24575
93714122ed59
doc: Fixes for signal, image, audio, and OOP chapters (bug #52844).
Rik <rik@octave.org>
parents:
23219
diff
changeset
|
246 dimension of the matrix along which the inverse FFT is performed. |
21966
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21782
diff
changeset
|
247 @seealso{fft, ifft2, ifftn, fftw} |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21782
diff
changeset
|
248 @end deftypefn */) |
4773 | 249 { |
4782 | 250 return do_fft (args, "ifft", 1); |
4773 | 251 } |
252 | |
2928 | 253 /* |
22662
655157b34a9f
Fix segfault when calling fft on last dimension (bug #49026).
Rik <rik@octave.org>
parents:
22407
diff
changeset
|
254 ## Author: David Billinghurst (David.Billinghurst@riotinto.com.au) |
655157b34a9f
Fix segfault when calling fft on last dimension (bug #49026).
Rik <rik@octave.org>
parents:
22407
diff
changeset
|
255 ## Comalco Research and Technology |
655157b34a9f
Fix segfault when calling fft on last dimension (bug #49026).
Rik <rik@octave.org>
parents:
22407
diff
changeset
|
256 ## 02 May 2000 |
25586 | 257 %!testif HAVE_FFTW |
14501
60e5cf354d80
Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
258 %! N = 64; |
60e5cf354d80
Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
259 %! n = 4; |
60e5cf354d80
Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
260 %! t = 2*pi*(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
|
261 %! s = cos (n*t); |
60e5cf354d80
Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
262 %! S = fft (s); |
60e5cf354d80
Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
263 %! |
60e5cf354d80
Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
264 %! answer = zeros (size (t)); |
60e5cf354d80
Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
265 %! answer(n+1) = N/2; |
60e5cf354d80
Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
266 %! answer(N-n+1) = N/2; |
60e5cf354d80
Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
267 %! |
60e5cf354d80
Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
268 %! assert (S, answer, 4*N*eps); |
7562
c827f5673321
move tests to individual source files
John W. Eaton <jwe@octave.org>
parents:
7017
diff
changeset
|
269 |
22662
655157b34a9f
Fix segfault when calling fft on last dimension (bug #49026).
Rik <rik@octave.org>
parents:
22407
diff
changeset
|
270 ## Author: David Billinghurst (David.Billinghurst@riotinto.com.au) |
655157b34a9f
Fix segfault when calling fft on last dimension (bug #49026).
Rik <rik@octave.org>
parents:
22407
diff
changeset
|
271 ## Comalco Research and Technology |
655157b34a9f
Fix segfault when calling fft on last dimension (bug #49026).
Rik <rik@octave.org>
parents:
22407
diff
changeset
|
272 ## 02 May 2000 |
25586 | 273 %!testif HAVE_FFTW |
14501
60e5cf354d80
Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
274 %! N = 64; |
60e5cf354d80
Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
275 %! n = 7; |
7562
c827f5673321
move tests to individual source files
John W. Eaton <jwe@octave.org>
parents:
7017
diff
changeset
|
276 %! t = 2*pi*(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
|
277 %! s = cos (n*t); |
11586
12df7854fa7c
strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents:
11553
diff
changeset
|
278 %! |
14854
5ae9f0f77635
maint: Use Octave coding conventions for coddling parenthis is DLD-FUNCTIONS directory
Rik <octave@nomad.inbox5.com>
parents:
14501
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; |
11586
12df7854fa7c
strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents:
11553
diff
changeset
|
282 %! |
14501
60e5cf354d80
Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
283 %! assert (ifft (S), s, 4*N*eps); |
7562
c827f5673321
move tests to individual source files
John W. Eaton <jwe@octave.org>
parents:
7017
diff
changeset
|
284 |
22662
655157b34a9f
Fix segfault when calling fft on last dimension (bug #49026).
Rik <rik@octave.org>
parents:
22407
diff
changeset
|
285 ## Author: David Billinghurst (David.Billinghurst@riotinto.com.au) |
655157b34a9f
Fix segfault when calling fft on last dimension (bug #49026).
Rik <rik@octave.org>
parents:
22407
diff
changeset
|
286 ## Comalco Research and Technology |
655157b34a9f
Fix segfault when calling fft on last dimension (bug #49026).
Rik <rik@octave.org>
parents:
22407
diff
changeset
|
287 ## 02 May 2000 |
25586 | 288 %!testif HAVE_FFTW |
14501
60e5cf354d80
Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
289 %! N = 64; |
60e5cf354d80
Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
290 %! n = 4; |
7814
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 (2*pi*(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
|
292 %! s = cos (n*t); |
60e5cf354d80
Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
293 %! S = fft (s); |
11586
12df7854fa7c
strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents:
11553
diff
changeset
|
294 %! |
14501
60e5cf354d80
Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
295 %! answer = zeros (size (t), "single"); |
7814
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; |
11586
12df7854fa7c
strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents:
11553
diff
changeset
|
298 %! |
14501
60e5cf354d80
Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
299 %! assert (S, answer, 4*N*eps ("single")); |
7562
c827f5673321
move tests to individual source files
John W. Eaton <jwe@octave.org>
parents:
7017
diff
changeset
|
300 |
22662
655157b34a9f
Fix segfault when calling fft on last dimension (bug #49026).
Rik <rik@octave.org>
parents:
22407
diff
changeset
|
301 ## Author: David Billinghurst (David.Billinghurst@riotinto.com.au) |
655157b34a9f
Fix segfault when calling fft on last dimension (bug #49026).
Rik <rik@octave.org>
parents:
22407
diff
changeset
|
302 ## Comalco Research and Technology |
655157b34a9f
Fix segfault when calling fft on last dimension (bug #49026).
Rik <rik@octave.org>
parents:
22407
diff
changeset
|
303 ## 02 May 2000 |
25586 | 304 %!testif HAVE_FFTW |
14501
60e5cf354d80
Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
305 %! N = 64; |
60e5cf354d80
Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
306 %! n = 7; |
7814
87865ed7405f
Second set of single precision test code and fix of resulting bugs
David Bateman <dbateman@free.fr>
parents:
7789
diff
changeset
|
307 %! t = 2*pi*(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
|
308 %! s = cos (n*t); |
11586
12df7854fa7c
strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents:
11553
diff
changeset
|
309 %! |
14501
60e5cf354d80
Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
310 %! S = zeros (size (t), "single"); |
7814
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; |
11586
12df7854fa7c
strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents:
11553
diff
changeset
|
313 %! |
14501
60e5cf354d80
Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
314 %! assert (ifft (S), s, 4*N*eps ("single")); |
7562
c827f5673321
move tests to individual source files
John W. Eaton <jwe@octave.org>
parents:
7017
diff
changeset
|
315 */ |
29958
32c3a5805893
move DEFUN and DEFMETHOD functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
29688
diff
changeset
|
316 |
32c3a5805893
move DEFUN and DEFMETHOD functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
29688
diff
changeset
|
317 OCTAVE_NAMESPACE_END |