|
4776
|
1 /* |
|
|
2 |
|
|
3 Copyright (C) 2004 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 |
|
5307
|
19 Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA |
|
|
20 02110-1301, USA. |
|
4776
|
21 |
|
|
22 */ |
|
|
23 |
|
|
24 #ifdef HAVE_CONFIG_H |
|
|
25 #include <config.h> |
|
|
26 #endif |
|
|
27 |
|
|
28 #if defined (HAVE_FFTW3) |
|
|
29 #include <fftw3.h> |
|
|
30 #endif |
|
|
31 |
|
5765
|
32 #include <sstream> |
|
|
33 |
|
4776
|
34 #include "defaults.h" |
|
|
35 #include "defun-dld.h" |
|
|
36 #include "error.h" |
|
|
37 #include "file-ops.h" |
|
|
38 #include "gripes.h" |
|
|
39 #include "lo-mappers.h" |
|
5832
|
40 #include "load-path.h" |
|
4776
|
41 #include "oct-env.h" |
|
|
42 #include "oct-obj.h" |
|
|
43 #include "sighandlers.h" |
|
|
44 #include "utils.h" |
|
|
45 |
|
|
46 DEFUN_DLD (fftw_wisdom, args, , |
|
|
47 "-*- texinfo -*-\n\ |
|
|
48 @deftypefn {Loadable Function} {} fftw_wisdom (@var{file}, @var{ow})\n\ |
|
|
49 @deftypefnx {Loadable Function} {} fftw_wisdom (@var{n})\n\ |
|
|
50 \n\ |
|
|
51 This function is used to manipulate the FFTW wisdom data. It can\n\ |
|
|
52 be used to load previously stored wisdom from a file, create wisdom\n\ |
|
|
53 needed by Octave and to save the current wisdom to a file. Wisdom\n\ |
|
|
54 data can be used to significantly accelerate the calculation of the FFTs,\n\ |
|
|
55 but is only profitable if the same FFT is called many times due to the\n\ |
|
|
56 overhead in calculating the wisdom data.\n\ |
|
|
57 \n\ |
|
|
58 Called with a single string argument, @code{fftw_wisdom (@var{file})}\n\ |
|
|
59 will load the wisdom data found in @var{file}. If @var{file} does\n\ |
|
|
60 not exist, then the current wisdom used by FFTW is saved to this\n\ |
|
|
61 file. If the flag @var{ow} is non-zero, then even if @var{file}\n\ |
|
|
62 exists, it will be overwritten.\n\ |
|
|
63 \n\ |
|
|
64 It is assumed that each row of @var{n} represents the size of a FFT for\n\ |
|
|
65 which it is desired to pre-calculate the wisdom needed to accelerate it.\n\ |
|
|
66 Any value of the matrix that is less than 1, is assumed to indicate an\n\ |
|
|
67 absent dimension. That is\n\ |
|
|
68 \n\ |
|
|
69 @example\n\ |
|
|
70 fftw_wisdom ([102, 0, 0; 103, 103, 0; 102, 103, 105]);\n\ |
|
|
71 a = fft (rand (1,102));\n\ |
|
|
72 b = fft (rand (103,103));\n\ |
|
|
73 c = fftn (rand ([102, 103, 105]));\n\ |
|
|
74 @end example\n\ |
|
|
75 \n\ |
|
|
76 calculates the wisdom necessary to accelerate the 103, 102x102 and\n\ |
|
|
77 the 102x103x105 FFTs. Note that calculated wisdom will be lost when\n\ |
|
5448
|
78 restarting Octave. However, if it is saved as discussed above, it\n\ |
|
4776
|
79 can be reloaded. Also, any system-wide wisdom file that has been found\n\ |
|
|
80 will also be used. Saved wisdom files should not be used on different\n\ |
|
|
81 platforms since they will not be efficient and the point of calculating\n\ |
|
|
82 the wisdom is lost.\n\ |
|
|
83 \n\ |
|
|
84 Note that the program @code{fftw-wisdom} supplied with FFTW can equally\n\ |
|
|
85 be used to create a file containing wisdom that can be imported into\n\ |
|
|
86 Octave.\n\ |
|
5642
|
87 @seealso{fft, ifft, fft2, ifft2, fftn, ifftn}\n\ |
|
|
88 @end deftypefn") |
|
4776
|
89 { |
|
|
90 octave_value retval; |
|
|
91 |
|
|
92 int nargin = args.length(); |
|
|
93 |
|
|
94 if (nargin < 1 || nargin > 2) |
|
|
95 { |
|
5823
|
96 print_usage (); |
|
4776
|
97 return retval; |
|
|
98 } |
|
|
99 |
|
4792
|
100 #if defined (HAVE_FFTW3) |
|
|
101 |
|
4776
|
102 if (args(0).is_string ()) |
|
|
103 { |
|
|
104 bool overwrite = false; |
|
|
105 |
|
|
106 if (nargin != 1) |
|
|
107 { |
|
|
108 double dval = args (1).double_value (); |
|
5275
|
109 if (NINTbig (dval) != 0) |
|
4776
|
110 overwrite = true; |
|
|
111 } |
|
|
112 |
|
5722
|
113 std::string str = args(0).string_value (); |
|
4776
|
114 std::string wisdom = octave_env::make_absolute |
|
5832
|
115 (load_path::find_file (str), octave_env::getcwd ()); |
|
4776
|
116 |
|
5775
|
117 // FIXME -- should probably protect FILE* resources with |
|
4787
|
118 // auto_ptr or similar... |
|
|
119 |
|
4776
|
120 if (wisdom.empty () || overwrite) |
|
|
121 { |
|
5722
|
122 if (str.empty ()) |
|
|
123 error ("fftw_wisdom: can not save to file"); |
|
|
124 else |
|
|
125 { |
|
|
126 FILE *ofile = fopen (str.c_str (), "wb"); |
|
|
127 if (! ofile) |
|
|
128 error ("fftw_wisdom: can not save to file %s", str.c_str()); |
|
|
129 else |
|
|
130 { |
|
|
131 fftw_export_wisdom_to_file (ofile); |
|
|
132 fclose (ofile); |
|
|
133 } |
|
|
134 } |
|
4776
|
135 } |
|
|
136 else |
|
|
137 { |
|
|
138 FILE *ifile = fopen (wisdom.c_str (), "r"); |
|
|
139 if (! fftw_import_wisdom_from_file (ifile)) |
|
|
140 error ("fftw_wisdom: can not import wisdom from file"); |
|
|
141 fclose (ifile); |
|
|
142 } |
|
|
143 |
|
|
144 } |
|
|
145 else |
|
|
146 { |
|
|
147 Matrix m = args (0).matrix_value (); |
|
|
148 |
|
|
149 if (error_state) |
|
|
150 { |
|
|
151 error ("fftw_wisdom: argument must be a matrix or a string"); |
|
|
152 return retval; |
|
|
153 } |
|
|
154 |
|
|
155 std::string name = file_ops::tempnam ("", "oct-"); |
|
|
156 |
|
|
157 if (name.empty ()) |
|
|
158 { |
|
|
159 error ("fftw_wisdom: can not open temporary file"); |
|
|
160 return retval; |
|
|
161 } |
|
|
162 |
|
5765
|
163 std::ostringstream cmd_buf; |
|
5794
|
164 cmd_buf << Vfftw_wisdom_program << " -n -o \"" << name << "\""; |
|
4776
|
165 |
|
5275
|
166 for (octave_idx_type k = 0; k < m.rows (); k++) |
|
4776
|
167 { |
|
|
168 bool first = true; |
|
|
169 |
|
|
170 cmd_buf << " "; |
|
|
171 |
|
|
172 // Note reversal of dimensions for column major storage in FFTW |
|
5275
|
173 for (octave_idx_type j = m.columns()-1; j >= 0; j--) |
|
|
174 if (NINTbig(m(k,j)) > 0) |
|
4776
|
175 { |
|
|
176 if (first) |
|
|
177 first = false; |
|
|
178 else |
|
|
179 cmd_buf << "x"; |
|
5275
|
180 cmd_buf << NINTbig(m(k,j)) ; |
|
4776
|
181 } |
|
|
182 } |
|
|
183 |
|
|
184 volatile octave_interrupt_handler old_interrupt_handler |
|
|
185 = octave_ignore_interrupts (); |
|
|
186 |
|
5765
|
187 std::string cmd_buf_str = cmd_buf.str (); |
|
4776
|
188 |
|
5765
|
189 int status = system (cmd_buf_str.c_str ()); |
|
4776
|
190 |
|
|
191 octave_set_interrupt_handler (old_interrupt_handler); |
|
|
192 |
|
|
193 if (WIFEXITED (status)) |
|
|
194 { |
|
|
195 FILE *ifile = fopen (name.c_str (), "r"); |
|
|
196 if (! fftw_import_wisdom_from_file (ifile)) |
|
|
197 error ("fftw_wisdom: can not import wisdom from temporary file"); |
|
|
198 fclose (ifile); |
|
|
199 } |
|
|
200 else |
|
5794
|
201 error ("fftw_wisdom: error running %s", Vfftw_wisdom_program.c_str ()); |
|
4776
|
202 } |
|
|
203 |
|
|
204 #else |
|
|
205 |
|
4787
|
206 warning ("fftw_wisdom: this copy of Octave was not configured to use FFTW3"); |
|
4776
|
207 |
|
|
208 #endif |
|
|
209 |
|
|
210 return retval; |
|
|
211 } |
