|
6228
|
1 /* |
|
|
2 |
|
|
3 Copyright (C) 2006 David Bateman |
|
|
4 |
|
|
5 This file is part of Octave. |
|
|
6 |
|
|
7 Octave is free software; you can redistribute it and/or modify it |
|
|
8 under the terms of the GNU General Public License as published by the |
|
|
9 Free Software Foundation; either version 2, or (at your option) any |
|
|
10 later version. |
|
|
11 |
|
|
12 Octave is distributed in the hope that it will be useful, but WITHOUT |
|
|
13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
|
|
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
|
|
15 for more details. |
|
|
16 |
|
|
17 You should have received a copy of the GNU General Public License |
|
|
18 along with Octave; see the file COPYING. If not, write to the Free |
|
|
19 Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA |
|
|
20 02110-1301, USA. |
|
|
21 |
|
|
22 */ |
|
|
23 |
|
|
24 #ifdef HAVE_CONFIG_H |
|
|
25 #include <config.h> |
|
|
26 #endif |
|
|
27 |
|
|
28 #include <algorithm> |
|
|
29 #include "ov.h" |
|
|
30 #include "defun-dld.h" |
|
|
31 #include "error.h" |
|
|
32 |
|
|
33 #if defined (HAVE_FFTW3) |
|
|
34 #include "oct-fftw.h" |
|
|
35 #endif |
|
|
36 |
|
|
37 DEFUN_DLD (fftw, args, , |
|
|
38 "-*- texinfo -*-\n\ |
|
|
39 @deftypefn {Loadable Function} {@var{method} =} fftw ('planner')\n\ |
|
|
40 @deftypefnx {Loadable Function} {} fftw ('planner', @var{method})\n\ |
|
|
41 @deftypefnx {Loadable Function} {@var{wisdom} =} fftw ('dwisdom')\n\ |
|
|
42 @deftypefnx {Loadable Function} {@var{wisdom} =} fftw ('dwisdom', @var{wisdom})\n\ |
|
|
43 \n\ |
|
|
44 Manage FFTW wisdom data. Wisdom data can be used to significantly\n\ |
|
7001
|
45 accelerate the calculation of the FFTs but implies an initial cost\n\ |
|
6228
|
46 in its calculation. The wisdom used by Octave can be imported directly,\n\ |
|
|
47 usually from a file /etc/fftw/wisdom, or @dfn{fftw} can be used\n\ |
|
|
48 to import wisdom. For example\n\ |
|
|
49 \n\ |
|
|
50 @example\n\ |
|
|
51 @var{wisdom} = fftw ('dwisdom')\n\ |
|
|
52 @end example\n\ |
|
|
53 \n\ |
|
|
54 will save the existing wisdom used by Octave to the string @var{wisdom}.\n\ |
|
|
55 This string can then be saved in the usual manner. This existing wisdom\n\ |
|
|
56 can be reimported as follows\n\ |
|
|
57 \n\ |
|
|
58 @example\n\ |
|
|
59 fftw ('dwisdom', @var{wisdom})\n\ |
|
|
60 @end example \n\ |
|
|
61 \n\ |
|
|
62 If @var{wisdom} is an empty matrix, then the wisdom used is cleared.\n\ |
|
|
63 \n\ |
|
|
64 During the calculation of fourier transforms further wisdom is generated.\n\ |
|
|
65 The fashion in which this wisdom is generated is equally controlled by\n\ |
|
|
66 the @dfn{fftw} function. There are five different manners in which the\n\ |
|
|
67 wisdom can be treated, these being\n\ |
|
|
68 \n\ |
|
|
69 @table @asis\n\ |
|
|
70 @item 'estimate'\n\ |
|
|
71 This specifies that no run-time measurement of the optimal means of\n\ |
|
|
72 calculating a particular is performed, and a simple heuristic is used\n\ |
|
|
73 to pick a (probably sub-optimal) plan. The advantage of this method is\n\ |
|
|
74 that there is little or no overhead in the generation of the plan, which\n\ |
|
|
75 is appropriate for a fourier transform that will be calculated once.\n\ |
|
|
76 \n\ |
|
|
77 @item 'measure'\n\ |
|
|
78 In this case a range of algorithms to perform the transform is considered\n\ |
|
|
79 and the best is selected based on their execution time.\n\ |
|
|
80 \n\ |
|
|
81 @item 'patient'\n\ |
|
|
82 This is like 'measure', but a wider range of algorithms is considered.\n\ |
|
|
83 \n\ |
|
7001
|
84 @item 'exhaustive'\n\ |
|
|
85 This is like 'measure', but all possible algorithms that may be used to\n\ |
|
6228
|
86 treat the transform are considered.\n\ |
|
|
87 \n\ |
|
|
88 @item 'hybrid'\n\ |
|
|
89 As run-time measurement of the algorithm can be expensive, this is a\n\ |
|
7001
|
90 compromise where 'measure' is used for transforms up to the size of 8192\n\ |
|
6228
|
91 and beyond that the 'estimate' method is used.\n\ |
|
|
92 @end table\n\ |
|
|
93 \n\ |
|
|
94 The default method is 'estimate', and the method currently being used can\n\ |
|
|
95 be probed with\n\ |
|
|
96 \n\ |
|
|
97 @example\n\ |
|
|
98 @var{method} = fftw ('planner')\n\ |
|
|
99 @end example\n\ |
|
|
100 \n\ |
|
|
101 and the method used can be set using\n\ |
|
|
102 \n\ |
|
|
103 @example\n\ |
|
|
104 fftw ('planner', @var{method})\n\ |
|
|
105 @end example\n\ |
|
|
106 \n\ |
|
|
107 Note that calculated wisdom will be lost when restarting Octave. However,\n\ |
|
|
108 the wisdom data can be reloaded if it is saved to a file as described\n\ |
|
|
109 above. Also, any system-wide wisdom file that has been found will\n\ |
|
|
110 also be used. Saved wisdom files should not be used on different\n\ |
|
|
111 platforms since they will not be efficient and the point of calculating\n\ |
|
|
112 the wisdom is lost.\n\ |
|
|
113 @seealso{fft, ifft, fft2, ifft2, fftn, ifftn}\n\ |
|
|
114 @end deftypefn") |
|
|
115 { |
|
|
116 octave_value retval; |
|
|
117 |
|
|
118 int nargin = args.length(); |
|
|
119 |
|
|
120 if (nargin < 1 || nargin > 2) |
|
|
121 { |
|
|
122 print_usage (); |
|
|
123 return retval; |
|
|
124 } |
|
|
125 |
|
|
126 #if defined (HAVE_FFTW3) |
|
|
127 if (args(0).is_string ()) |
|
|
128 { |
|
|
129 std::string arg0 = args(0).string_value (); |
|
|
130 |
|
|
131 if (!error_state) |
|
|
132 { |
|
|
133 // Use STL function to convert to lower case |
|
|
134 std::transform (arg0.begin (), arg0.end (), arg0.begin (), tolower); |
|
|
135 |
|
|
136 if (nargin == 2) |
|
|
137 { |
|
|
138 std::string arg1 = args(1).string_value (); |
|
|
139 if (!error_state) |
|
|
140 { |
|
|
141 if (arg0 == "planner") |
|
|
142 { |
|
|
143 std::transform (arg1.begin (), arg1.end (), |
|
|
144 arg1.begin (), tolower); |
|
6484
|
145 octave_fftw_planner::FftwMethod meth |
|
|
146 = octave_fftw_planner::UNKNOWN; |
|
6228
|
147 |
|
|
148 if (arg1 == "estimate") |
|
|
149 meth = fftw_planner.method |
|
|
150 (octave_fftw_planner::ESTIMATE); |
|
|
151 else if (arg1 == "measure") |
|
|
152 meth = fftw_planner.method |
|
|
153 (octave_fftw_planner::MEASURE); |
|
|
154 else if (arg1 == "patient") |
|
|
155 meth = fftw_planner.method |
|
|
156 (octave_fftw_planner::PATIENT); |
|
|
157 else if (arg1 == "exhaustive") |
|
|
158 meth = fftw_planner.method |
|
|
159 (octave_fftw_planner::EXHAUSTIVE); |
|
|
160 else if (arg1 == "hybrid") |
|
|
161 meth = fftw_planner.method |
|
|
162 (octave_fftw_planner::HYBRID); |
|
|
163 else |
|
|
164 error ("unrecognized planner method"); |
|
|
165 |
|
|
166 if (!error_state) |
|
|
167 { |
|
|
168 if (meth == octave_fftw_planner::MEASURE) |
|
|
169 retval = octave_value ("measure"); |
|
|
170 else if (meth == octave_fftw_planner::PATIENT) |
|
|
171 retval = octave_value ("patient"); |
|
|
172 else if (meth == octave_fftw_planner::EXHAUSTIVE) |
|
|
173 retval = octave_value ("exhaustive"); |
|
|
174 else if (meth == octave_fftw_planner::HYBRID) |
|
|
175 retval = octave_value ("hybrid"); |
|
|
176 else |
|
|
177 retval = octave_value ("estimate"); |
|
|
178 } |
|
|
179 } |
|
|
180 else if (arg0 == "dwisdom") |
|
|
181 { |
|
|
182 char *str = fftw_export_wisdom_to_string (); |
|
|
183 |
|
|
184 if (arg1.length() < 1) |
|
|
185 fftw_forget_wisdom (); |
|
|
186 else if (! fftw_import_wisdom_from_string (arg1.c_str())) |
|
|
187 error ("could not import supplied wisdom"); |
|
|
188 |
|
|
189 if (!error_state) |
|
|
190 retval = octave_value (std::string (str)); |
|
|
191 |
|
|
192 free (str); |
|
|
193 } |
|
|
194 else if (arg0 == "swisdom") |
|
|
195 error ("single precision wisdom is not supported"); |
|
|
196 else |
|
|
197 error ("unrecognized argument"); |
|
|
198 } |
|
|
199 } |
|
|
200 else |
|
|
201 { |
|
|
202 if (arg0 == "planner") |
|
|
203 { |
|
|
204 octave_fftw_planner::FftwMethod meth = |
|
|
205 fftw_planner.method (); |
|
|
206 |
|
|
207 if (meth == octave_fftw_planner::MEASURE) |
|
|
208 retval = octave_value ("measure"); |
|
|
209 else if (meth == octave_fftw_planner::PATIENT) |
|
|
210 retval = octave_value ("patient"); |
|
|
211 else if (meth == octave_fftw_planner::EXHAUSTIVE) |
|
|
212 retval = octave_value ("exhaustive"); |
|
|
213 else if (meth == octave_fftw_planner::HYBRID) |
|
|
214 retval = octave_value ("hybrid"); |
|
|
215 else |
|
|
216 retval = octave_value ("estimate"); |
|
|
217 } |
|
|
218 else if (arg0 == "dwisdom") |
|
|
219 { |
|
|
220 char *str = fftw_export_wisdom_to_string (); |
|
|
221 retval = octave_value (std::string (str)); |
|
|
222 free (str); |
|
|
223 } |
|
|
224 else if (arg0 == "swisdom") |
|
|
225 error ("single precision wisdom is not supported"); |
|
|
226 else |
|
|
227 error ("unrecognized argument"); |
|
|
228 } |
|
|
229 } |
|
|
230 } |
|
|
231 #else |
|
|
232 |
|
|
233 warning ("fftw: this copy of Octave was not configured to use FFTW3"); |
|
|
234 |
|
|
235 #endif |
|
|
236 |
|
|
237 return retval; |
|
|
238 } |
|
|
239 |
