octave-nkf: src/DLD-FUNCTIONS/fftw.cc annotate

annotate src/DLD-FUNCTIONS/fftw.cc @ 14138:72c96de7a403 stable

maint: update copyright notices for 2012

author	John W. Eaton <jwe@octave.org>
date	Mon, 02 Jan 2012 14:25:41 -0500
parents	f96b9b9f141b
children	97883071e8e4 f63a4f23bfe7

rev	line source
6228 aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	1 /*
aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	2
14138 72c96de7a403 maint: update copyright notices for 2012 John W. Eaton <jwe@octave.org> parents: 12642 diff changeset	3 Copyright (C) 2006-2012 David Bateman
6228 aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	4
aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	5 This file is part of Octave.
aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	6
aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	7 Octave is free software; you can redistribute it and/or modify it
aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman 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: 7001 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: 7001 diff changeset	10 option) any later version.
6228 aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	11
aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	12 Octave is distributed in the hope that it will be useful, but WITHOUT
aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	15 for more details.
aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	16
aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman 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: 7001 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: 7001 diff changeset	19 <http://www.gnu.org/licenses/>.
6228 aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	20
aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	21 */
aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	22
aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	23 #ifdef HAVE_CONFIG_H
aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	24 #include <config.h>
aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	25 #endif
aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	26
aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	27 #include <algorithm>
9523 0ce82753dd72 more configure changes for libraries John W. Eaton <jwe@octave.org> parents: 9516 diff changeset	28
0ce82753dd72 more configure changes for libraries John W. Eaton <jwe@octave.org> parents: 9516 diff changeset	29 #include "oct-fftw.h"
0ce82753dd72 more configure changes for libraries John W. Eaton <jwe@octave.org> parents: 9516 diff changeset	30
6228 aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	31 #include "defun-dld.h"
aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	32 #include "error.h"
9523 0ce82753dd72 more configure changes for libraries John W. Eaton <jwe@octave.org> parents: 9516 diff changeset	33 #include "ov.h"
6228 aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	34
aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	35 DEFUN_DLD (fftw, args, ,
aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	36 "-- texinfo --\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10154 diff changeset	37 @deftypefn {Loadable Function} {@var{method} =} fftw ('planner')\n\
6228 aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	38 @deftypefnx {Loadable Function} {} fftw ('planner', @var{method})\n\
aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	39 @deftypefnx {Loadable Function} {@var{wisdom} =} fftw ('dwisdom')\n\
11553 01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	40 @deftypefnx {Loadable Function} {} fftw ('dwisdom', @var{wisdom})\n\
6228 aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	41 \n\
9072 bd8e388043c4 Cleanup documentation for signal.texi, image.texi, audio.texi Rik <rdrider0-list@yahoo.com> parents: 9064 diff changeset	42 Manage @sc{fftw} wisdom data. Wisdom data can be used to significantly\n\
11553 01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	43 accelerate the calculation of the FFTs, but implies an initial cost\n\
9072 bd8e388043c4 Cleanup documentation for signal.texi, image.texi, audio.texi Rik <rdrider0-list@yahoo.com> parents: 9064 diff changeset	44 in its calculation. When the @sc{fftw} libraries are initialized, they read\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10154 diff changeset	45 a system wide wisdom file (typically in @file{/etc/fftw/wisdom}), allowing\n\
10846 a4f482e66b65 Grammarcheck more of the documentation. Rik <octave@nomad.inbox5.com> parents: 10840 diff changeset	46 wisdom to be shared between applications other than Octave. Alternatively,\n\
a4f482e66b65 Grammarcheck more of the documentation. Rik <octave@nomad.inbox5.com> parents: 10840 diff changeset	47 the @code{fftw} function can be used to import wisdom. For example,\n\
6228 aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	48 \n\
aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	49 @example\n\
aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	50 @var{wisdom} = fftw ('dwisdom')\n\
aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	51 @end example\n\
aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	52 \n\
10846 a4f482e66b65 Grammarcheck more of the documentation. Rik <octave@nomad.inbox5.com> parents: 10840 diff changeset	53 @noindent\n\
6228 aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	54 will save the existing wisdom used by Octave to the string @var{wisdom}.\n\
8115 37c1bdb9805c Clarify fftw documentation David Bateman <dbateman@free.fr> parents: 7789 diff changeset	55 This string can then be saved to a file and restored using the @code{save}\n\
10846 a4f482e66b65 Grammarcheck more of the documentation. Rik <octave@nomad.inbox5.com> parents: 10840 diff changeset	56 and @code{load} commands respectively. This existing wisdom can be\n\
a4f482e66b65 Grammarcheck more of the documentation. Rik <octave@nomad.inbox5.com> parents: 10840 diff changeset	57 reimported as follows\n\
6228 aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	58 \n\
aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	59 @example\n\
aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	60 fftw ('dwisdom', @var{wisdom})\n\
12642 f96b9b9f141b doc: Periodic grammarcheck and spellcheck of documentation. Rik <octave@nomad.inbox5.com> parents: 11586 diff changeset	61 @end example\n\
6228 aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	62 \n\
aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	63 If @var{wisdom} is an empty matrix, then the wisdom used is cleared.\n\
aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	64 \n\
9072 bd8e388043c4 Cleanup documentation for signal.texi, image.texi, audio.texi Rik <rdrider0-list@yahoo.com> parents: 9064 diff changeset	65 During the calculation of Fourier transforms further wisdom is generated.\n\
11553 01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	66 The fashion in which this wisdom is generated is also controlled by\n\
9064 7c02ec148a3c Check grammar on all .cc files Rik <rdrider0-list@yahoo.com> parents: 8920 diff changeset	67 the @code{fftw} function. There are five different manners in which the\n\
11553 01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	68 wisdom can be treated:\n\
6228 aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	69 \n\
aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	70 @table @asis\n\
aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	71 @item 'estimate'\n\
11553 01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	72 Specifies that no run-time measurement of the optimal means of\n\
6228 aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	73 calculating a particular is performed, and a simple heuristic is used\n\
9064 7c02ec148a3c Check grammar on all .cc files Rik <rdrider0-list@yahoo.com> parents: 8920 diff changeset	74 to pick a (probably sub-optimal) plan. The advantage of this method is\n\
6228 aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	75 that there is little or no overhead in the generation of the plan, which\n\
9072 bd8e388043c4 Cleanup documentation for signal.texi, image.texi, audio.texi Rik <rdrider0-list@yahoo.com> parents: 9064 diff changeset	76 is appropriate for a Fourier transform that will be calculated once.\n\
6228 aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	77 \n\
aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	78 @item 'measure'\n\
aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	79 In this case a range of algorithms to perform the transform is considered\n\
aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	80 and the best is selected based on their execution time.\n\
aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	81 \n\
aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	82 @item 'patient'\n\
11553 01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	83 Similar to 'measure', but a wider range of algorithms is considered.\n\
6228 aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	84 \n\
7001 8b0cfeb06365 [project @ 2007-10-10 18:02:59 by jwe] jwe parents: 6484 diff changeset	85 @item 'exhaustive'\n\
11553 01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	86 Like 'measure', but all possible algorithms that may be used to\n\
6228 aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	87 treat the transform are considered.\n\
aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	88 \n\
aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	89 @item 'hybrid'\n\
aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	90 As run-time measurement of the algorithm can be expensive, this is a\n\
7001 8b0cfeb06365 [project @ 2007-10-10 18:02:59 by jwe] jwe parents: 6484 diff changeset	91 compromise where 'measure' is used for transforms up to the size of 8192\n\
6228 aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	92 and beyond that the 'estimate' method is used.\n\
aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	93 @end table\n\
aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	94 \n\
11553 01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	95 The default method is 'estimate'. The current method can\n\
01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	96 be queried with\n\
6228 aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	97 \n\
aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	98 @example\n\
aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	99 @var{method} = fftw ('planner')\n\
aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	100 @end example\n\
aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	101 \n\
10846 a4f482e66b65 Grammarcheck more of the documentation. Rik <octave@nomad.inbox5.com> parents: 10840 diff changeset	102 @noindent\n\
11553 01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	103 or set by using\n\
6228 aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	104 \n\
aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	105 @example\n\
aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	106 fftw ('planner', @var{method})\n\
aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	107 @end example\n\
aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	108 \n\
9064 7c02ec148a3c Check grammar on all .cc files Rik <rdrider0-list@yahoo.com> parents: 8920 diff changeset	109 Note that calculated wisdom will be lost when restarting Octave. However,\n\
6228 aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	110 the wisdom data can be reloaded if it is saved to a file as described\n\
9064 7c02ec148a3c Check grammar on all .cc files Rik <rdrider0-list@yahoo.com> parents: 8920 diff changeset	111 above. Saved wisdom files should not be used on different platforms since\n\
8115 37c1bdb9805c Clarify fftw documentation David Bateman <dbateman@free.fr> parents: 7789 diff changeset	112 they will not be efficient and the point of calculating the wisdom is lost.\n\
6228 aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	113 @seealso{fft, ifft, fft2, ifft2, fftn, ifftn}\n\
aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	114 @end deftypefn")
aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	115 {
aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	116 octave_value retval;
aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	117
aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	118 int nargin = args.length();
aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	119
aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	120 if (nargin < 1 \|\| nargin > 2)
aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	121 {
aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	122 print_usage ();
aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	123 return retval;
aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	124 }
aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	125
9523 0ce82753dd72 more configure changes for libraries John W. Eaton <jwe@octave.org> parents: 9516 diff changeset	126 #if defined (HAVE_FFTW)
6228 aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	127 if (args(0).is_string ())
aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	128 {
aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	129 std::string arg0 = args(0).string_value ();
aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	130
aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	131 if (!error_state)
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	132 {
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	133 // Use STL function to convert to lower case
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	134 std::transform (arg0.begin (), arg0.end (), arg0.begin (), tolower);
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11553 diff changeset	135
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	136 if (nargin == 2)
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	137 {
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	138 std::string arg1 = args(1).string_value ();
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	139 if (!error_state)
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	140 {
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	141 if (arg0 == "planner")
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	142 {
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11553 diff changeset	143 std::transform (arg1.begin (), arg1.end (),
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	144 arg1.begin (), tolower);
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	145 octave_fftw_planner::FftwMethod meth
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	146 = octave_fftw_planner::UNKNOWN;
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	147 octave_float_fftw_planner::FftwMethod methf
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	148 = octave_float_fftw_planner::UNKNOWN;
6228 aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	149
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	150 if (arg1 == "estimate")
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	151 {
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	152 meth = octave_fftw_planner::ESTIMATE;
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	153 methf = octave_float_fftw_planner::ESTIMATE;
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	154 }
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	155 else if (arg1 == "measure")
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	156 {
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	157 meth = octave_fftw_planner::MEASURE;
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	158 methf = octave_float_fftw_planner::MEASURE;
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	159 }
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	160 else if (arg1 == "patient")
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	161 {
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	162 meth = octave_fftw_planner::PATIENT;
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	163 methf = octave_float_fftw_planner::PATIENT;
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	164 }
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	165 else if (arg1 == "exhaustive")
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	166 {
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	167 meth = octave_fftw_planner::EXHAUSTIVE;
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	168 methf = octave_float_fftw_planner::EXHAUSTIVE;
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	169 }
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	170 else if (arg1 == "hybrid")
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	171 {
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	172 meth = octave_fftw_planner::HYBRID;
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	173 methf = octave_float_fftw_planner::HYBRID;
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	174 }
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	175 else
11553 01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	176 error ("unrecognized planner METHOD");
6228 aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	177
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	178 if (!error_state)
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	179 {
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	180 meth = octave_fftw_planner::method (meth);
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	181 octave_float_fftw_planner::method (methf);
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7017 diff changeset	182
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	183 if (meth == octave_fftw_planner::MEASURE)
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	184 retval = octave_value ("measure");
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	185 else if (meth == octave_fftw_planner::PATIENT)
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	186 retval = octave_value ("patient");
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	187 else if (meth == octave_fftw_planner::EXHAUSTIVE)
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	188 retval = octave_value ("exhaustive");
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	189 else if (meth == octave_fftw_planner::HYBRID)
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	190 retval = octave_value ("hybrid");
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	191 else
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	192 retval = octave_value ("estimate");
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	193 }
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	194 }
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	195 else if (arg0 == "dwisdom")
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	196 {
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	197 char *str = fftw_export_wisdom_to_string ();
6228 aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	198
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	199 if (arg1.length() < 1)
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	200 fftw_forget_wisdom ();
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	201 else if (! fftw_import_wisdom_from_string (arg1.c_str()))
11553 01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	202 error ("could not import supplied WISDOM");
6228 aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	203
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	204 if (!error_state)
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	205 retval = octave_value (std::string (str));
6228 aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	206
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	207 free (str);
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	208 }
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	209 else if (arg0 == "swisdom")
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	210 {
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	211 char *str = fftwf_export_wisdom_to_string ();
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7017 diff changeset	212
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	213 if (arg1.length() < 1)
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	214 fftwf_forget_wisdom ();
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	215 else if (! fftwf_import_wisdom_from_string (arg1.c_str()))
11553 01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	216 error ("could not import supplied WISDOM");
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7017 diff changeset	217
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	218 if (!error_state)
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	219 retval = octave_value (std::string (str));
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7017 diff changeset	220
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	221 free (str);
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	222 }
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	223 else
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	224 error ("unrecognized argument");
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	225 }
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	226 }
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	227 else
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	228 {
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	229 if (arg0 == "planner")
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	230 {
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11553 diff changeset	231 octave_fftw_planner::FftwMethod meth =
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	232 octave_fftw_planner::method ();
6228 aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	233
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	234 if (meth == octave_fftw_planner::MEASURE)
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	235 retval = octave_value ("measure");
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	236 else if (meth == octave_fftw_planner::PATIENT)
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	237 retval = octave_value ("patient");
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	238 else if (meth == octave_fftw_planner::EXHAUSTIVE)
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	239 retval = octave_value ("exhaustive");
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	240 else if (meth == octave_fftw_planner::HYBRID)
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	241 retval = octave_value ("hybrid");
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	242 else
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	243 retval = octave_value ("estimate");
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	244 }
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	245 else if (arg0 == "dwisdom")
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	246 {
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	247 char *str = fftw_export_wisdom_to_string ();
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	248 retval = octave_value (std::string (str));
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	249 free (str);
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	250 }
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	251 else if (arg0 == "swisdom")
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	252 {
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	253 char *str = fftwf_export_wisdom_to_string ();
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	254 retval = octave_value (std::string (str));
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	255 free (str);
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	256 }
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	257 else
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	258 error ("unrecognized argument");
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	259 }
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	260 }
6228 aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	261 }
aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	262 #else
aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	263
9523 0ce82753dd72 more configure changes for libraries John W. Eaton <jwe@octave.org> parents: 9516 diff changeset	264 warning ("fftw: this copy of Octave was not configured to use the FFTW3 planner");
6228 aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	265
aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	266 #endif
aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	267
aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	268 return retval;
aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	269 }

Mercurial > octave-nkf

annotate src/DLD-FUNCTIONS/fftw.cc @ 14138:72c96de7a403 stable