octave: libinterp/dldfcn/fftw.cc annotate

annotate libinterp/dldfcn/fftw.cc @ 27923:bd51beb6205e

update formatting of copyright notices * Use <https://octave.org/copyright/> instead of <https://octave.org/COPYRIGHT.html/>. * For consistency with other comments in the Octave sources, use C++-style comments for copyright blocks in C and C++ files. * Use delimiters above and below copyright blocks that are appropriate for the language used in the file. * Eliminate extra spacing inside copyright blocks. * lex.ll (looks_like_copyright): Also allow newlines and carriage returns before the word "Copyright". * scripts/mk-doc.pl (gethelp): Also skip empty comment lines. * bp-table.cc, type.m: Adjust tests.

author	John W. Eaton <jwe@octave.org>
date	Wed, 08 Jan 2020 11:59:41 -0500
parents	1891570abac8
children	0a5b15007766

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 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	3 // Copyright (C) 2006-2020 The Octave Project Developers
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 ////////////////////////////////////////////////////////////////////////
6228 aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	25
21724 aba2e6293dd8 use "#if ..." consistently instead of "#ifdef" and "#ifndef" John W. Eaton <jwe@octave.org> parents: 21691 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"
6228 aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	28 #endif
aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	29
aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	30 #include <algorithm>
23024 a6a7b054e4ba Rationalize #includes in libinterp/dldfcn directory. Rik <rik@octave.org> parents: 22755 diff changeset	31 #include <string>
9523 0ce82753dd72 more configure changes for libraries John W. Eaton <jwe@octave.org> parents: 9516 diff changeset	32
21451 763e30285935 eliminate configuration macros from oct-fftw.h (bug #41027) John W. Eaton <jwe@octave.org> parents: 21447 diff changeset	33 #if defined (HAVE_FFTW3_H)
763e30285935 eliminate configuration macros from oct-fftw.h (bug #41027) John W. Eaton <jwe@octave.org> parents: 21447 diff changeset	34 # include <fftw3.h>
763e30285935 eliminate configuration macros from oct-fftw.h (bug #41027) John W. Eaton <jwe@octave.org> parents: 21447 diff changeset	35 #endif
763e30285935 eliminate configuration macros from oct-fftw.h (bug #41027) John W. Eaton <jwe@octave.org> parents: 21447 diff changeset	36
9523 0ce82753dd72 more configure changes for libraries John W. Eaton <jwe@octave.org> parents: 9516 diff changeset	37 #include "oct-fftw.h"
0ce82753dd72 more configure changes for libraries John W. Eaton <jwe@octave.org> parents: 9516 diff changeset	38
6228 aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	39 #include "defun-dld.h"
aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	40 #include "error.h"
23024 a6a7b054e4ba Rationalize #includes in libinterp/dldfcn directory. Rik <rik@octave.org> parents: 22755 diff changeset	41 #include "errwarn.h"
9523 0ce82753dd72 more configure changes for libraries John W. Eaton <jwe@octave.org> parents: 9516 diff changeset	42 #include "ov.h"
6228 aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	43
aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	44 DEFUN_DLD (fftw, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	45 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	46 @deftypefn {} {@var{method} =} fftw ("planner")
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	47 @deftypefnx {} {} fftw ("planner", @var{method})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	48 @deftypefnx {} {@var{wisdom} =} fftw ("dwisdom")
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	49 @deftypefnx {} {} fftw ("dwisdom", @var{wisdom})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	50 @deftypefnx {} {} fftw ("threads", @var{nthreads})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	51 @deftypefnx {} {@var{nthreads} =} fftw ("threads")
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	52
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	53 Manage @sc{fftw} wisdom data.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	54
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	55 Wisdom data can be used to significantly accelerate the calculation of the
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	56 FFTs, but implies an initial cost in its calculation. When the @sc{fftw}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	57 libraries are initialized, they read a system wide wisdom file (typically in
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	58 @file{/etc/fftw/wisdom}), allowing wisdom to be shared between applications
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	59 other than Octave. Alternatively, the @code{fftw} function can be used to
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	60 import wisdom. For example,
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	61
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	62 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	63 @var{wisdom} = fftw ("dwisdom")
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	64 @end example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	65
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	66 @noindent
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	67 will save the existing wisdom used by Octave to the string @var{wisdom}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	68 This string can then be saved to a file and restored using the @code{save}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	69 and @code{load} commands respectively. This existing wisdom can be
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	70 re-imported as follows
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	71
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	72 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	73 fftw ("dwisdom", @var{wisdom})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	74 @end example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	75
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	76 If @var{wisdom} is an empty string, then the wisdom used is cleared.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	77
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	78 During the calculation of Fourier transforms further wisdom is generated.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	79 The fashion in which this wisdom is generated is also controlled by
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	80 the @code{fftw} function. There are five different manners in which the
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	81 wisdom can be treated:
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	82
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	83 @table @asis
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	84 @item @qcode{"estimate"}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	85 Specifies that no run-time measurement of the optimal means of
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	86 calculating a particular is performed, and a simple heuristic is used
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	87 to pick a (probably sub-optimal) plan. The advantage of this method is
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	88 that there is little or no overhead in the generation of the plan, which
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	89 is appropriate for a Fourier transform that will be calculated once.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	90
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	91 @item @qcode{"measure"}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	92 In this case a range of algorithms to perform the transform is considered
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	93 and the best is selected based on their execution time.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	94
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	95 @item @qcode{"patient"}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	96 Similar to @qcode{"measure"}, but a wider range of algorithms is
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	97 considered.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	98
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	99 @item @qcode{"exhaustive"}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	100 Like @qcode{"measure"}, but all possible algorithms that may be used to
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	101 treat the transform are considered.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	102
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	103 @item @qcode{"hybrid"}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	104 As run-time measurement of the algorithm can be expensive, this is a
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	105 compromise where @qcode{"measure"} is used for transforms up to the size
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	106 of 8192 and beyond that the @qcode{"estimate"} method is used.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	107 @end table
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	108
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	109 The default method is @qcode{"estimate"}. The current method can
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	110 be queried with
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	111
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	112 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	113 @var{method} = fftw ("planner")
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	114 @end example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	115
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	116 @noindent
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	117 or set by using
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	118
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	119 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	120 fftw ("planner", @var{method})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	121 @end example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	122
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	123 Note that calculated wisdom will be lost when restarting Octave. However,
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	124 the wisdom data can be reloaded if it is saved to a file as described
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	125 above. Saved wisdom files should not be used on different platforms since
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	126 they will not be efficient and the point of calculating the wisdom is lost.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	127
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	128 The number of threads used for computing the plans and executing the
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	129 transforms can be set with
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	130
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	131 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	132 fftw ("threads", @var{NTHREADS})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	133 @end example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	134
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	135 Note that octave must be compiled with multi-threaded @sc{fftw} support for
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	136 this feature. The number of processors available to the current process is
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	137 used per default.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	138
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	139 @seealso{fft, ifft, fft2, ifft2, fftn, ifftn}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	140 @end deftypefn */)
6228 aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	141 {
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	142 #if defined (HAVE_FFTW)
6228 aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	143
14846 460a3c6d8bf1 maint: Use Octave coding convention for cuddled parenthis in function calls with empty argument lists. Rik <octave@nomad.inbox5.com> parents: 14361 diff changeset	144 int nargin = args.length ();
6228 aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	145
aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	146 if (nargin < 1 \|\| nargin > 2)
20790 c2d9556d51d0 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20711 diff changeset	147 print_usage ();
6228 aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	148
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	149 octave_value retval;
b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	150
20700 68e3a747ca02 rename octave_value value extractors that accept error message args John W. Eaton <jwe@octave.org> parents: 20579 diff changeset	151 std::string arg0 = args(0).xstring_value ("fftw: first argument must be a string");
20579 10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	152
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	153 if (arg0 == "planner")
6228 aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	154 {
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	155 if (nargin == 2) // planner setter
20579 10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	156 {
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	157 // Use STL function to convert to lower case
20711 7b608fadc663 Make error messages more specific about the variable and problem encountered. Rik <rik@octave.org> parents: 20700 diff changeset	158 std::transform (arg0.begin (), arg0.end (), arg0.begin (), tolower);
20579 10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	159
20711 7b608fadc663 Make error messages more specific about the variable and problem encountered. Rik <rik@octave.org> parents: 20700 diff changeset	160 std::string arg1 = args(1).xstring_value ("fftw: METHOD must be a string");
19743 67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	161
20711 7b608fadc663 Make error messages more specific about the variable and problem encountered. Rik <rik@octave.org> parents: 20700 diff changeset	162 std::transform (arg1.begin (), arg1.end (), arg1.begin (), tolower);
23058 5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23024 diff changeset	163 octave::fftw_planner::FftwMethod meth
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23024 diff changeset	164 = octave::fftw_planner::UNKNOWN;
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23024 diff changeset	165 octave::float_fftw_planner::FftwMethod methf
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23024 diff changeset	166 = octave::float_fftw_planner::UNKNOWN;
20579 10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	167
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	168 if (arg1 == "estimate")
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	169 {
23058 5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23024 diff changeset	170 meth = octave::fftw_planner::ESTIMATE;
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23024 diff changeset	171 methf = octave::float_fftw_planner::ESTIMATE;
20579 10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	172 }
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	173 else if (arg1 == "measure")
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	174 {
23058 5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23024 diff changeset	175 meth = octave::fftw_planner::MEASURE;
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23024 diff changeset	176 methf = octave::float_fftw_planner::MEASURE;
20579 10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	177 }
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	178 else if (arg1 == "patient")
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	179 {
23058 5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23024 diff changeset	180 meth = octave::fftw_planner::PATIENT;
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23024 diff changeset	181 methf = octave::float_fftw_planner::PATIENT;
20579 10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	182 }
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	183 else if (arg1 == "exhaustive")
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	184 {
23058 5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23024 diff changeset	185 meth = octave::fftw_planner::EXHAUSTIVE;
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23024 diff changeset	186 methf = octave::float_fftw_planner::EXHAUSTIVE;
20579 10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	187 }
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	188 else if (arg1 == "hybrid")
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	189 {
23058 5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23024 diff changeset	190 meth = octave::fftw_planner::HYBRID;
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23024 diff changeset	191 methf = octave::float_fftw_planner::HYBRID;
20579 10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	192 }
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	193 else
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	194 error ("fftw: unrecognized planner METHOD");
20555 f90c8372b7ba eliminate many more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20163 diff changeset	195
23058 5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23024 diff changeset	196 meth = octave::fftw_planner::method (meth);
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23024 diff changeset	197 octave::float_fftw_planner::method (methf);
20579 10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	198
23058 5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23024 diff changeset	199 if (meth == octave::fftw_planner::MEASURE)
20579 10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	200 retval = octave_value ("measure");
23058 5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23024 diff changeset	201 else if (meth == octave::fftw_planner::PATIENT)
20579 10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	202 retval = octave_value ("patient");
23058 5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23024 diff changeset	203 else if (meth == octave::fftw_planner::EXHAUSTIVE)
20579 10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	204 retval = octave_value ("exhaustive");
23058 5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23024 diff changeset	205 else if (meth == octave::fftw_planner::HYBRID)
20579 10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	206 retval = octave_value ("hybrid");
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	207 else
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	208 retval = octave_value ("estimate");
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	209 }
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	210 else //planner getter
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	211 {
27277 db687716fed6 style fixes: generally aim to break long lines before operators, not after John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	212 octave::fftw_planner::FftwMethod meth
db687716fed6 style fixes: generally aim to break long lines before operators, not after John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	213 = octave::fftw_planner::method ();
19743 67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	214
23058 5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23024 diff changeset	215 if (meth == octave::fftw_planner::MEASURE)
20579 10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	216 retval = octave_value ("measure");
23058 5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23024 diff changeset	217 else if (meth == octave::fftw_planner::PATIENT)
20579 10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	218 retval = octave_value ("patient");
23058 5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23024 diff changeset	219 else if (meth == octave::fftw_planner::EXHAUSTIVE)
20579 10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	220 retval = octave_value ("exhaustive");
23058 5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23024 diff changeset	221 else if (meth == octave::fftw_planner::HYBRID)
20579 10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	222 retval = octave_value ("hybrid");
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	223 else
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	224 retval = octave_value ("estimate");
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	225 }
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	226 }
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	227 else if (arg0 == "dwisdom")
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	228 {
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	229 if (nargin == 2) //dwisdom setter
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	230 {
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	231 // Use STL function to convert to lower case
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	232 std::transform (arg0.begin (), arg0.end (), arg0.begin (),
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	233 tolower);
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	234
20700 68e3a747ca02 rename octave_value value extractors that accept error message args John W. Eaton <jwe@octave.org> parents: 20579 diff changeset	235 std::string arg1 = args(1).xstring_value ("fftw: WISDOM must be a string");
20579 10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	236
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	237 char *str = fftw_export_wisdom_to_string ();
24661 02989d7d68dc fftw: report error if FFTW library fails to return wisdom (bug #52244) Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	238 if (! str)
02989d7d68dc fftw: report error if FFTW library fails to return wisdom (bug #52244) Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	239 error ("fftw: could not get current FFTW wisdom");
02989d7d68dc fftw: report error if FFTW library fails to return wisdom (bug #52244) Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	240
21447 ac1e50cfc9ed avoid possible memory leak with fftw wisdom (bug #47372) John W. Eaton <jwe@octave.org> parents: 21301 diff changeset	241 std::string wisdom_str (str);
ac1e50cfc9ed avoid possible memory leak with fftw wisdom (bug #47372) John W. Eaton <jwe@octave.org> parents: 21301 diff changeset	242 free (str);
20579 10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	243
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	244 if (arg1.length () < 1)
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	245 fftw_forget_wisdom ();
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	246 else if (! fftw_import_wisdom_from_string (arg1.c_str ()))
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	247 error ("fftw: could not import supplied WISDOM");
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	248
21447 ac1e50cfc9ed avoid possible memory leak with fftw wisdom (bug #47372) John W. Eaton <jwe@octave.org> parents: 21301 diff changeset	249 retval = octave_value (wisdom_str);
20579 10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	250 }
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	251 else //dwisdom getter
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	252 {
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	253 char *str = fftw_export_wisdom_to_string ();
24661 02989d7d68dc fftw: report error if FFTW library fails to return wisdom (bug #52244) Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	254 if (! str)
02989d7d68dc fftw: report error if FFTW library fails to return wisdom (bug #52244) Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	255 error ("fftw: could not get current FFTW wisdom");
02989d7d68dc fftw: report error if FFTW library fails to return wisdom (bug #52244) Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	256
21447 ac1e50cfc9ed avoid possible memory leak with fftw wisdom (bug #47372) John W. Eaton <jwe@octave.org> parents: 21301 diff changeset	257 std::string wisdom_str (str);
20579 10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	258 free (str);
21447 ac1e50cfc9ed avoid possible memory leak with fftw wisdom (bug #47372) John W. Eaton <jwe@octave.org> parents: 21301 diff changeset	259 retval = octave_value (wisdom_str);
20579 10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	260 }
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	261 }
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	262 else if (arg0 == "swisdom")
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	263 {
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	264 //swisdom uses fftwf_ functions (float), dwisdom fftw_ (real)
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	265 if (nargin == 2) //swisdom setter
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	266 {
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	267 // Use STL function to convert to lower case
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	268 std::transform (arg0.begin (), arg0.end (), arg0.begin (),
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	269 tolower);
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	270
20700 68e3a747ca02 rename octave_value value extractors that accept error message args John W. Eaton <jwe@octave.org> parents: 20579 diff changeset	271 std::string arg1 = args(1).xstring_value ("fftw: WISDOM must be a string");
20579 10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	272
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	273 char *str = fftwf_export_wisdom_to_string ();
24661 02989d7d68dc fftw: report error if FFTW library fails to return wisdom (bug #52244) Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	274 if (! str)
02989d7d68dc fftw: report error if FFTW library fails to return wisdom (bug #52244) Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	275 error ("fftw: could not get current FFTW wisdom");
02989d7d68dc fftw: report error if FFTW library fails to return wisdom (bug #52244) Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	276
21447 ac1e50cfc9ed avoid possible memory leak with fftw wisdom (bug #47372) John W. Eaton <jwe@octave.org> parents: 21301 diff changeset	277 std::string wisdom_str (str);
ac1e50cfc9ed avoid possible memory leak with fftw wisdom (bug #47372) John W. Eaton <jwe@octave.org> parents: 21301 diff changeset	278 free (str);
20579 10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	279
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	280 if (arg1.length () < 1)
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	281 fftwf_forget_wisdom ();
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	282 else if (! fftwf_import_wisdom_from_string (arg1.c_str ()))
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	283 error ("fftw: could not import supplied WISDOM");
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	284
21447 ac1e50cfc9ed avoid possible memory leak with fftw wisdom (bug #47372) John W. Eaton <jwe@octave.org> parents: 21301 diff changeset	285 retval = octave_value (wisdom_str);
20579 10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	286 }
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	287 else //swisdom getter
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	288 {
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	289 char *str = fftwf_export_wisdom_to_string ();
24661 02989d7d68dc fftw: report error if FFTW library fails to return wisdom (bug #52244) Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	290 if (! str)
02989d7d68dc fftw: report error if FFTW library fails to return wisdom (bug #52244) Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	291 error ("fftw: could not get current FFTW wisdom");
02989d7d68dc fftw: report error if FFTW library fails to return wisdom (bug #52244) Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	292
21447 ac1e50cfc9ed avoid possible memory leak with fftw wisdom (bug #47372) John W. Eaton <jwe@octave.org> parents: 21301 diff changeset	293 std::string wisdom_str (str);
20579 10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	294 free (str);
21447 ac1e50cfc9ed avoid possible memory leak with fftw wisdom (bug #47372) John W. Eaton <jwe@octave.org> parents: 21301 diff changeset	295 retval = octave_value (wisdom_str);
20579 10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	296 }
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	297 }
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	298 else if (arg0 == "threads")
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	299 {
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	300 if (nargin == 2) //threads setter
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	301 {
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	302 if (! args(1).is_real_scalar ())
b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	303 error ("fftw: setting threads needs one integer argument");
b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	304
b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	305 int nthreads = args(1).int_value();
b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	306 if (nthreads < 1)
b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	307 error ("fftw: number of threads must be >=1");
b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	308
20579 10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	309 #if defined (HAVE_FFTW3_THREADS)
23058 5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23024 diff changeset	310 octave::fftw_planner::threads (nthreads);
20579 10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	311 #else
21100 e39e05d90788 Switch gripe_XXX to either err_XXX or warn_XXX naming scheme. Rik <rik@octave.org> parents: 20939 diff changeset	312 err_disabled_feature ("fftw", "multithreaded FFTW");
20579 10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	313 #endif
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	314 #if defined (HAVE_FFTW3F_THREADS)
23058 5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23024 diff changeset	315 octave::float_fftw_planner::threads (nthreads);
20579 10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	316 #else
21100 e39e05d90788 Switch gripe_XXX to either err_XXX or warn_XXX naming scheme. Rik <rik@octave.org> parents: 20939 diff changeset	317 err_disabled_feature ("fftw", "multithreaded FFTW");
20579 10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	318 #endif
19743 67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	319 }
20579 10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	320 else //threads getter
15960 bde7731b2b83 added FFTW multithreaded library support Andreas Weber <andy.weber.aw@gmail.com> parents: 15818 diff changeset	321 #if defined (HAVE_FFTW3_THREADS)
23058 5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23024 diff changeset	322 retval = octave_value (octave::fftw_planner::threads());
15960 bde7731b2b83 added FFTW multithreaded library support Andreas Weber <andy.weber.aw@gmail.com> parents: 15818 diff changeset	323 #else
22407 34ce5be04942 maint: Style check C++ code in libinterp/. Rik <rik@octave.org> parents: 22323 diff changeset	324 retval = 1;
15960 bde7731b2b83 added FFTW multithreaded library support Andreas Weber <andy.weber.aw@gmail.com> parents: 15818 diff changeset	325 #endif
6228 aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	326 }
15960 bde7731b2b83 added FFTW multithreaded library support Andreas Weber <andy.weber.aw@gmail.com> parents: 15818 diff changeset	327 else
19221 f5ad7470d957 fftw: Reword error messages to be consistent with other functions Mike Miller <mtmiller@ieee.org> parents: 19130 diff changeset	328 error ("fftw: unrecognized argument");
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	329
b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	330 return retval;
b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	331
6228 aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	332 #else
21691 263d18409fdf Eliminate unused variable warnings for conditionally compiled code. John W. Eaton <jwe@octave.org> parents: 21581 diff changeset	333
263d18409fdf Eliminate unused variable warnings for conditionally compiled code. John W. Eaton <jwe@octave.org> parents: 21581 diff changeset	334 octave_unused_parameter (args);
263d18409fdf Eliminate unused variable warnings for conditionally compiled code. John W. Eaton <jwe@octave.org> parents: 21581 diff changeset	335
21100 e39e05d90788 Switch gripe_XXX to either err_XXX or warn_XXX naming scheme. Rik <rik@octave.org> parents: 20939 diff changeset	336 err_disabled_feature ("fftw", "the FFTW3 planner");
21691 263d18409fdf Eliminate unused variable warnings for conditionally compiled code. John W. Eaton <jwe@octave.org> parents: 21581 diff changeset	337
6228 aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	338 #endif
aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	339 }
15741 f63a4f23bfe7 Fix infinite loop when setting fftw planner method (bug #37873) Mike Miller <mtmiller@ieee.org> parents: 14138 diff changeset	340
f63a4f23bfe7 Fix infinite loop when setting fftw planner method (bug #37873) Mike Miller <mtmiller@ieee.org> parents: 14138 diff changeset	341 /*
f63a4f23bfe7 Fix infinite loop when setting fftw planner method (bug #37873) Mike Miller <mtmiller@ieee.org> parents: 14138 diff changeset	342 %!testif HAVE_FFTW
f63a4f23bfe7 Fix infinite loop when setting fftw planner method (bug #37873) Mike Miller <mtmiller@ieee.org> parents: 14138 diff changeset	343 %! def_method = fftw ("planner");
f63a4f23bfe7 Fix infinite loop when setting fftw planner method (bug #37873) Mike Miller <mtmiller@ieee.org> parents: 14138 diff changeset	344 %! unwind_protect
f63a4f23bfe7 Fix infinite loop when setting fftw planner method (bug #37873) Mike Miller <mtmiller@ieee.org> parents: 14138 diff changeset	345 %! method = "estimate";
f63a4f23bfe7 Fix infinite loop when setting fftw planner method (bug #37873) Mike Miller <mtmiller@ieee.org> parents: 14138 diff changeset	346 %! fftw ("planner", method);
f63a4f23bfe7 Fix infinite loop when setting fftw planner method (bug #37873) Mike Miller <mtmiller@ieee.org> parents: 14138 diff changeset	347 %! assert (fftw ("planner"), method);
f63a4f23bfe7 Fix infinite loop when setting fftw planner method (bug #37873) Mike Miller <mtmiller@ieee.org> parents: 14138 diff changeset	348 %! method = "measure";
f63a4f23bfe7 Fix infinite loop when setting fftw planner method (bug #37873) Mike Miller <mtmiller@ieee.org> parents: 14138 diff changeset	349 %! fftw ("planner", method);
f63a4f23bfe7 Fix infinite loop when setting fftw planner method (bug #37873) Mike Miller <mtmiller@ieee.org> parents: 14138 diff changeset	350 %! assert (fftw ("planner"), method);
f63a4f23bfe7 Fix infinite loop when setting fftw planner method (bug #37873) Mike Miller <mtmiller@ieee.org> parents: 14138 diff changeset	351 %! method = "patient";
f63a4f23bfe7 Fix infinite loop when setting fftw planner method (bug #37873) Mike Miller <mtmiller@ieee.org> parents: 14138 diff changeset	352 %! fftw ("planner", method);
f63a4f23bfe7 Fix infinite loop when setting fftw planner method (bug #37873) Mike Miller <mtmiller@ieee.org> parents: 14138 diff changeset	353 %! assert (fftw ("planner"), method);
f63a4f23bfe7 Fix infinite loop when setting fftw planner method (bug #37873) Mike Miller <mtmiller@ieee.org> parents: 14138 diff changeset	354 %! method = "exhaustive";
f63a4f23bfe7 Fix infinite loop when setting fftw planner method (bug #37873) Mike Miller <mtmiller@ieee.org> parents: 14138 diff changeset	355 %! fftw ("planner", method);
f63a4f23bfe7 Fix infinite loop when setting fftw planner method (bug #37873) Mike Miller <mtmiller@ieee.org> parents: 14138 diff changeset	356 %! assert (fftw ("planner"), method);
f63a4f23bfe7 Fix infinite loop when setting fftw planner method (bug #37873) Mike Miller <mtmiller@ieee.org> parents: 14138 diff changeset	357 %! method = "hybrid";
f63a4f23bfe7 Fix infinite loop when setting fftw planner method (bug #37873) Mike Miller <mtmiller@ieee.org> parents: 14138 diff changeset	358 %! fftw ("planner", method);
f63a4f23bfe7 Fix infinite loop when setting fftw planner method (bug #37873) Mike Miller <mtmiller@ieee.org> parents: 14138 diff changeset	359 %! assert (fftw ("planner"), method);
f63a4f23bfe7 Fix infinite loop when setting fftw planner method (bug #37873) Mike Miller <mtmiller@ieee.org> parents: 14138 diff changeset	360 %! unwind_protect_cleanup
f63a4f23bfe7 Fix infinite loop when setting fftw planner method (bug #37873) Mike Miller <mtmiller@ieee.org> parents: 14138 diff changeset	361 %! fftw ("planner", def_method);
f63a4f23bfe7 Fix infinite loop when setting fftw planner method (bug #37873) Mike Miller <mtmiller@ieee.org> parents: 14138 diff changeset	362 %! end_unwind_protect
f63a4f23bfe7 Fix infinite loop when setting fftw planner method (bug #37873) Mike Miller <mtmiller@ieee.org> parents: 14138 diff changeset	363
19130 90421e725f1d codesprint: Tests for fftw Mike Miller <mtmiller@ieee.org> parents: 18678 diff changeset	364 %!testif HAVE_FFTW
90421e725f1d codesprint: Tests for fftw Mike Miller <mtmiller@ieee.org> parents: 18678 diff changeset	365 %! def_dwisdom = fftw ("dwisdom");
90421e725f1d codesprint: Tests for fftw Mike Miller <mtmiller@ieee.org> parents: 18678 diff changeset	366 %! def_swisdom = fftw ("swisdom");
90421e725f1d codesprint: Tests for fftw Mike Miller <mtmiller@ieee.org> parents: 18678 diff changeset	367 %! unwind_protect
90421e725f1d codesprint: Tests for fftw Mike Miller <mtmiller@ieee.org> parents: 18678 diff changeset	368 %! wisdom = fftw ("dwisdom");
90421e725f1d codesprint: Tests for fftw Mike Miller <mtmiller@ieee.org> parents: 18678 diff changeset	369 %! assert (ischar (wisdom));
90421e725f1d codesprint: Tests for fftw Mike Miller <mtmiller@ieee.org> parents: 18678 diff changeset	370 %! fftw ("dwisdom", wisdom);
90421e725f1d codesprint: Tests for fftw Mike Miller <mtmiller@ieee.org> parents: 18678 diff changeset	371 %! assert (fftw ("dwisdom"), wisdom);
90421e725f1d codesprint: Tests for fftw Mike Miller <mtmiller@ieee.org> parents: 18678 diff changeset	372 %! wisdom = fftw ("swisdom");
90421e725f1d codesprint: Tests for fftw Mike Miller <mtmiller@ieee.org> parents: 18678 diff changeset	373 %! assert (ischar (wisdom));
90421e725f1d codesprint: Tests for fftw Mike Miller <mtmiller@ieee.org> parents: 18678 diff changeset	374 %! fftw ("swisdom", wisdom);
90421e725f1d codesprint: Tests for fftw Mike Miller <mtmiller@ieee.org> parents: 18678 diff changeset	375 %! assert (fftw ("swisdom"), wisdom);
90421e725f1d codesprint: Tests for fftw Mike Miller <mtmiller@ieee.org> parents: 18678 diff changeset	376 %! unwind_protect_cleanup
90421e725f1d codesprint: Tests for fftw Mike Miller <mtmiller@ieee.org> parents: 18678 diff changeset	377 %! fftw ("dwisdom", def_dwisdom);
90421e725f1d codesprint: Tests for fftw Mike Miller <mtmiller@ieee.org> parents: 18678 diff changeset	378 %! fftw ("swisdom", def_swisdom);
90421e725f1d codesprint: Tests for fftw Mike Miller <mtmiller@ieee.org> parents: 18678 diff changeset	379 %! end_unwind_protect
15741 f63a4f23bfe7 Fix infinite loop when setting fftw planner method (bug #37873) Mike Miller <mtmiller@ieee.org> parents: 14138 diff changeset	380
15960 bde7731b2b83 added FFTW multithreaded library support Andreas Weber <andy.weber.aw@gmail.com> parents: 15818 diff changeset	381 %!testif HAVE_FFTW3_THREADS
bde7731b2b83 added FFTW multithreaded library support Andreas Weber <andy.weber.aw@gmail.com> parents: 15818 diff changeset	382 %! n = fftw ("threads");
bde7731b2b83 added FFTW multithreaded library support Andreas Weber <andy.weber.aw@gmail.com> parents: 15818 diff changeset	383 %! unwind_protect
bde7731b2b83 added FFTW multithreaded library support Andreas Weber <andy.weber.aw@gmail.com> parents: 15818 diff changeset	384 %! fftw ("threads", 3);
bde7731b2b83 added FFTW multithreaded library support Andreas Weber <andy.weber.aw@gmail.com> parents: 15818 diff changeset	385 %! assert (fftw ("threads"), 3);
bde7731b2b83 added FFTW multithreaded library support Andreas Weber <andy.weber.aw@gmail.com> parents: 15818 diff changeset	386 %! unwind_protect_cleanup
bde7731b2b83 added FFTW multithreaded library support Andreas Weber <andy.weber.aw@gmail.com> parents: 15818 diff changeset	387 %! fftw ("threads", n);
bde7731b2b83 added FFTW multithreaded library support Andreas Weber <andy.weber.aw@gmail.com> parents: 15818 diff changeset	388 %! end_unwind_protect
19130 90421e725f1d codesprint: Tests for fftw Mike Miller <mtmiller@ieee.org> parents: 18678 diff changeset	389
22271 16efd0403698 Add %!error test pattern matches for disabled optional features Mike Miller <mtmiller@octave.org> parents: 21966 diff changeset	390 %!error <Invalid call to fftw\|was unavailable or disabled> fftw ()
16efd0403698 Add %!error test pattern matches for disabled optional features Mike Miller <mtmiller@octave.org> parents: 21966 diff changeset	391 %!error <Invalid call to fftw\|was unavailable or disabled> fftw ("planner", "estimate", "measure")
21581 6fab85c1538f maint: Follow Octave conventions for use of semicolon in BIST tests. Rik <rik@octave.org> parents: 21451 diff changeset	392 %!error fftw (3)
6fab85c1538f maint: Follow Octave conventions for use of semicolon in BIST tests. Rik <rik@octave.org> parents: 21451 diff changeset	393 %!error fftw ("invalid")
6fab85c1538f maint: Follow Octave conventions for use of semicolon in BIST tests. Rik <rik@octave.org> parents: 21451 diff changeset	394 %!error fftw ("planner", "invalid")
6fab85c1538f maint: Follow Octave conventions for use of semicolon in BIST tests. Rik <rik@octave.org> parents: 21451 diff changeset	395 %!error fftw ("planner", 2)
6fab85c1538f maint: Follow Octave conventions for use of semicolon in BIST tests. Rik <rik@octave.org> parents: 21451 diff changeset	396 %!error fftw ("dwisdom", "invalid")
6fab85c1538f maint: Follow Octave conventions for use of semicolon in BIST tests. Rik <rik@octave.org> parents: 21451 diff changeset	397 %!error fftw ("swisdom", "invalid")
6fab85c1538f maint: Follow Octave conventions for use of semicolon in BIST tests. Rik <rik@octave.org> parents: 21451 diff changeset	398 %!error fftw ("threads", "invalid")
6fab85c1538f maint: Follow Octave conventions for use of semicolon in BIST tests. Rik <rik@octave.org> parents: 21451 diff changeset	399 %!error fftw ("threads", -3)
15741 f63a4f23bfe7 Fix infinite loop when setting fftw planner method (bug #37873) Mike Miller <mtmiller@ieee.org> parents: 14138 diff changeset	400 */

Mercurial > octave

annotate libinterp/dldfcn/fftw.cc @ 27923:bd51beb6205e