octave-antonio: libinterp/dldfcn/fftw.cc annotate

annotate libinterp/dldfcn/fftw.cc @ 20163:075a5e2e1ba5 stable

doc: Update more docstrings to have one sentence summary as first line. Reviewed build-aux, libinterp/dldfcn, libinterp/octave-value, libinterp/parse-tree directories. * build-aux/mk-opts.pl, libinterp/dldfcn/__magick_read__.cc, libinterp/dldfcn/amd.cc, libinterp/dldfcn/audiodevinfo.cc, libinterp/dldfcn/audioread.cc, libinterp/dldfcn/ccolamd.cc, libinterp/dldfcn/chol.cc, libinterp/dldfcn/colamd.cc, libinterp/dldfcn/convhulln.cc, libinterp/dldfcn/dmperm.cc, libinterp/dldfcn/fftw.cc, libinterp/dldfcn/qr.cc, libinterp/dldfcn/symbfact.cc, libinterp/dldfcn/symrcm.cc, libinterp/octave-value/ov-base.cc, libinterp/octave-value/ov-bool-mat.cc, libinterp/octave-value/ov-cell.cc, libinterp/octave-value/ov-class.cc, libinterp/octave-value/ov-fcn-handle.cc, libinterp/octave-value/ov-fcn-inline.cc, libinterp/octave-value/ov-java.cc, libinterp/octave-value/ov-null-mat.cc, libinterp/octave-value/ov-oncleanup.cc, libinterp/octave-value/ov-range.cc, libinterp/octave-value/ov-struct.cc, libinterp/octave-value/ov-typeinfo.cc, libinterp/octave-value/ov-usr-fcn.cc, libinterp/octave-value/ov.cc, libinterp/parse-tree/lex.ll, libinterp/parse-tree/oct-parse.in.yy, libinterp/parse-tree/pt-binop.cc, libinterp/parse-tree/pt-eval.cc, libinterp/parse-tree/pt-mat.cc: doc: Update more docstrings to have one sentence summary as first line.

author	Rik <rik@octave.org>
date	Sun, 03 May 2015 21:52:42 -0700
parents	67f2c76f9f4d
children

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
19697 4197fc428c7d maint: Update copyright notices for 2015. John W. Eaton <jwe@octave.org> parents: 19221 diff changeset	3 Copyright (C) 2006-2015 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
19221 f5ad7470d957 fftw: Reword error messages to be consistent with other functions Mike Miller <mtmiller@ieee.org> parents: 19130 diff changeset	35 #include "gripes.h"
f5ad7470d957 fftw: Reword error messages to be consistent with other functions Mike Miller <mtmiller@ieee.org> parents: 19130 diff changeset	36
6228 aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	37 DEFUN_DLD (fftw, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	38 "-- texinfo --\n\
14361 8de863b7126b doc: Use Octave preference for double quote in docstrings in all .cc files Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	39 @deftypefn {Loadable Function} {@var{method} =} fftw (\"planner\")\n\
8de863b7126b doc: Use Octave preference for double quote in docstrings in all .cc files Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	40 @deftypefnx {Loadable Function} {} fftw (\"planner\", @var{method})\n\
8de863b7126b doc: Use Octave preference for double quote in docstrings in all .cc files Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	41 @deftypefnx {Loadable Function} {@var{wisdom} =} fftw (\"dwisdom\")\n\
8de863b7126b doc: Use Octave preference for double quote in docstrings in all .cc files Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	42 @deftypefnx {Loadable Function} {} fftw (\"dwisdom\", @var{wisdom})\n\
15960 bde7731b2b83 added FFTW multithreaded library support Andreas Weber <andy.weber.aw@gmail.com> parents: 15818 diff changeset	43 @deftypefnx {Loadable Function} {} fftw (\"threads\", @var{nthreads})\n\
bde7731b2b83 added FFTW multithreaded library support Andreas Weber <andy.weber.aw@gmail.com> parents: 15818 diff changeset	44 @deftypefnx {Loadable Function} {@var{nthreads} =} fftw (\"threads\")\n\
6228 aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	45 \n\
20163 075a5e2e1ba5 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19743 diff changeset	46 Manage @sc{fftw} wisdom data.\n\
075a5e2e1ba5 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19743 diff changeset	47 \n\
075a5e2e1ba5 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19743 diff changeset	48 Wisdom data can be used to significantly accelerate the calculation of the\n\
075a5e2e1ba5 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19743 diff changeset	49 FFTs, but implies an initial cost in its calculation. When the @sc{fftw}\n\
075a5e2e1ba5 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19743 diff changeset	50 libraries are initialized, they read a system wide wisdom file (typically in\n\
075a5e2e1ba5 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19743 diff changeset	51 @file{/etc/fftw/wisdom}), allowing wisdom to be shared between applications\n\
075a5e2e1ba5 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19743 diff changeset	52 other than Octave. Alternatively, the @code{fftw} function can be used to\n\
075a5e2e1ba5 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19743 diff changeset	53 import wisdom. For example,\n\
6228 aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	54 \n\
aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	55 @example\n\
14360 97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	56 @var{wisdom} = fftw (\"dwisdom\")\n\
6228 aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	57 @end example\n\
aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	58 \n\
10846 a4f482e66b65 Grammarcheck more of the documentation. Rik <octave@nomad.inbox5.com> parents: 10840 diff changeset	59 @noindent\n\
6228 aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	60 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	61 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	62 and @code{load} commands respectively. This existing wisdom can be\n\
16826 a4969508008e doc: Periodic spellcheck of the documentation. Rik <rik@octave.org> parents: 16816 diff changeset	63 re-imported as follows\n\
6228 aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	64 \n\
aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	65 @example\n\
14360 97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	66 fftw (\"dwisdom\", @var{wisdom})\n\
12642 f96b9b9f141b doc: Periodic grammarcheck and spellcheck of documentation. Rik <octave@nomad.inbox5.com> parents: 11586 diff changeset	67 @end example\n\
6228 aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	68 \n\
15960 bde7731b2b83 added FFTW multithreaded library support Andreas Weber <andy.weber.aw@gmail.com> parents: 15818 diff changeset	69 If @var{wisdom} is an empty string, then the wisdom used is cleared.\n\
6228 aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	70 \n\
9072 bd8e388043c4 Cleanup documentation for signal.texi, image.texi, audio.texi Rik <rdrider0-list@yahoo.com> parents: 9064 diff changeset	71 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	72 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	73 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	74 wisdom can be treated:\n\
6228 aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	75 \n\
aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	76 @table @asis\n\
17281 bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 16826 diff changeset	77 @item @qcode{\"estimate\"}\n\
11553 01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	78 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	79 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	80 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	81 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	82 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	83 \n\
17281 bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 16826 diff changeset	84 @item @qcode{\"measure\"}\n\
6228 aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	85 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	86 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	87 \n\
17281 bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 16826 diff changeset	88 @item @qcode{\"patient\"}\n\
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 16826 diff changeset	89 Similar to @qcode{\"measure\"}, but a wider range of algorithms is\n\
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 16826 diff changeset	90 considered.\n\
6228 aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	91 \n\
17281 bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 16826 diff changeset	92 @item @qcode{\"exhaustive\"}\n\
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 16826 diff changeset	93 Like @qcode{\"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	94 treat the transform are considered.\n\
aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	95 \n\
17281 bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 16826 diff changeset	96 @item @qcode{\"hybrid\"}\n\
6228 aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	97 As run-time measurement of the algorithm can be expensive, this is a\n\
17281 bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 16826 diff changeset	98 compromise where @qcode{\"measure\"} is used for transforms up to the size\n\
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 16826 diff changeset	99 of 8192 and beyond that the @qcode{\"estimate\"} method is used.\n\
6228 aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	100 @end table\n\
aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	101 \n\
17281 bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 16826 diff changeset	102 The default method is @qcode{\"estimate\"}. The current method can\n\
11553 01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	103 be queried with\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\
14360 97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	106 @var{method} = fftw (\"planner\")\n\
6228 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\
10846 a4f482e66b65 Grammarcheck more of the documentation. Rik <octave@nomad.inbox5.com> parents: 10840 diff changeset	109 @noindent\n\
11553 01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	110 or set by using\n\
6228 aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	111 \n\
aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	112 @example\n\
14360 97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	113 fftw (\"planner\", @var{method})\n\
6228 aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	114 @end example\n\
aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	115 \n\
9064 7c02ec148a3c Check grammar on all .cc files Rik <rdrider0-list@yahoo.com> parents: 8920 diff changeset	116 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	117 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	118 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	119 they will not be efficient and the point of calculating the wisdom is lost.\n\
15960 bde7731b2b83 added FFTW multithreaded library support Andreas Weber <andy.weber.aw@gmail.com> parents: 15818 diff changeset	120 \n\
bde7731b2b83 added FFTW multithreaded library support Andreas Weber <andy.weber.aw@gmail.com> parents: 15818 diff changeset	121 The number of threads used for computing the plans and executing the\n\
bde7731b2b83 added FFTW multithreaded library support Andreas Weber <andy.weber.aw@gmail.com> parents: 15818 diff changeset	122 transforms can be set with\n\
bde7731b2b83 added FFTW multithreaded library support Andreas Weber <andy.weber.aw@gmail.com> parents: 15818 diff changeset	123 \n\
bde7731b2b83 added FFTW multithreaded library support Andreas Weber <andy.weber.aw@gmail.com> parents: 15818 diff changeset	124 @example\n\
bde7731b2b83 added FFTW multithreaded library support Andreas Weber <andy.weber.aw@gmail.com> parents: 15818 diff changeset	125 fftw (\"threads\", @var{NTHREADS})\n\
bde7731b2b83 added FFTW multithreaded library support Andreas Weber <andy.weber.aw@gmail.com> parents: 15818 diff changeset	126 @end example\n\
bde7731b2b83 added FFTW multithreaded library support Andreas Weber <andy.weber.aw@gmail.com> parents: 15818 diff changeset	127 \n\
16816 12005245b645 doc: Periodic grammarcheck of documentation. Rik <rik@octave.org> parents: 15960 diff changeset	128 Note that octave must be compiled with multi-threaded @sc{fftw} support for\n\
12005245b645 doc: Periodic grammarcheck of documentation. Rik <rik@octave.org> parents: 15960 diff changeset	129 this feature. The number of processors available to the current process is\n\
12005245b645 doc: Periodic grammarcheck of documentation. Rik <rik@octave.org> parents: 15960 diff changeset	130 used per default.\n\
15960 bde7731b2b83 added FFTW multithreaded library support Andreas Weber <andy.weber.aw@gmail.com> parents: 15818 diff changeset	131 \n\
6228 aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	132 @seealso{fft, ifft, fft2, ifft2, fftn, ifftn}\n\
aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	133 @end deftypefn")
aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	134 {
aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	135 octave_value retval;
aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	136
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	137 int nargin = args.length ();
6228 aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	138
aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	139 if (nargin < 1 \|\| nargin > 2)
aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	140 {
aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	141 print_usage ();
aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	142 return retval;
aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	143 }
aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	144
9523 0ce82753dd72 more configure changes for libraries John W. Eaton <jwe@octave.org> parents: 9516 diff changeset	145 #if defined (HAVE_FFTW)
6228 aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	146 if (args(0).is_string ())
aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	147 {
aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	148 std::string arg0 = args(0).string_value ();
19743 67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	149
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	150 if (arg0 == "planner")
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	151 {
19743 67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	152 if (nargin == 2) //planner setter
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	153 {
19743 67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	154 if (args(1).is_string ())
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	155 {
19743 67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	156 // Use STL function to convert to lower case
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	157 std::transform (arg0.begin (), arg0.end (), arg0.begin (),
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	158 tolower);
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	159 std::string arg1 = args(1).string_value ();
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	160 if (!error_state)
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	161 {
19743 67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	162 std::transform (arg1.begin (), arg1.end (),
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	163 arg1.begin (), tolower);
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	164 octave_fftw_planner::FftwMethod meth
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	165 = octave_fftw_planner::UNKNOWN;
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	166 octave_float_fftw_planner::FftwMethod methf
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	167 = octave_float_fftw_planner::UNKNOWN;
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	168
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	169 if (arg1 == "estimate")
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	170 {
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	171 meth = octave_fftw_planner::ESTIMATE;
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	172 methf = octave_float_fftw_planner::ESTIMATE;
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	173 }
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	174 else if (arg1 == "measure")
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	175 {
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	176 meth = octave_fftw_planner::MEASURE;
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	177 methf = octave_float_fftw_planner::MEASURE;
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	178 }
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	179 else if (arg1 == "patient")
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	180 {
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	181 meth = octave_fftw_planner::PATIENT;
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	182 methf = octave_float_fftw_planner::PATIENT;
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	183 }
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	184 else if (arg1 == "exhaustive")
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	185 {
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	186 meth = octave_fftw_planner::EXHAUSTIVE;
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	187 methf = octave_float_fftw_planner::EXHAUSTIVE;
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	188 }
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	189 else if (arg1 == "hybrid")
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	190 {
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	191 meth = octave_fftw_planner::HYBRID;
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	192 methf = octave_float_fftw_planner::HYBRID;
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	193 }
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	194 else
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	195 error ("fftw: unrecognized planner METHOD");
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	196
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	197 if (!error_state)
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	198 {
19743 67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	199 meth = octave_fftw_planner::method (meth);
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	200 octave_float_fftw_planner::method (methf);
15960 bde7731b2b83 added FFTW multithreaded library support Andreas Weber <andy.weber.aw@gmail.com> parents: 15818 diff changeset	201
19743 67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	202 if (meth == octave_fftw_planner::MEASURE)
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	203 retval = octave_value ("measure");
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	204 else if (meth == octave_fftw_planner::PATIENT)
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	205 retval = octave_value ("patient");
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	206 else if (meth == octave_fftw_planner::EXHAUSTIVE)
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	207 retval = octave_value ("exhaustive");
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	208 else if (meth == octave_fftw_planner::HYBRID)
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	209 retval = octave_value ("hybrid");
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	210 else
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	211 retval = octave_value ("estimate");
15960 bde7731b2b83 added FFTW multithreaded library support Andreas Weber <andy.weber.aw@gmail.com> parents: 15818 diff changeset	212 }
bde7731b2b83 added FFTW multithreaded library support Andreas Weber <andy.weber.aw@gmail.com> parents: 15818 diff changeset	213 }
bde7731b2b83 added FFTW multithreaded library support Andreas Weber <andy.weber.aw@gmail.com> parents: 15818 diff changeset	214 }
19743 67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	215 else
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	216 error ("fftw: planner expects a string value as METHOD");
15960 bde7731b2b83 added FFTW multithreaded library support Andreas Weber <andy.weber.aw@gmail.com> parents: 15818 diff changeset	217 }
19743 67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	218 else //planner getter
15960 bde7731b2b83 added FFTW multithreaded library support Andreas Weber <andy.weber.aw@gmail.com> parents: 15818 diff changeset	219 {
19743 67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	220 octave_fftw_planner::FftwMethod meth =
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	221 octave_fftw_planner::method ();
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	222
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	223 if (meth == octave_fftw_planner::MEASURE)
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	224 retval = octave_value ("measure");
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	225 else if (meth == octave_fftw_planner::PATIENT)
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	226 retval = octave_value ("patient");
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	227 else if (meth == octave_fftw_planner::EXHAUSTIVE)
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	228 retval = octave_value ("exhaustive");
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	229 else if (meth == octave_fftw_planner::HYBRID)
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	230 retval = octave_value ("hybrid");
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	231 else
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	232 retval = octave_value ("estimate");
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	233 }
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	234 }
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	235 else if (arg0 == "dwisdom")
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	236 {
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	237 if (nargin == 2) //dwisdom setter
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	238 {
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	239 if (args(1).is_string ())
15960 bde7731b2b83 added FFTW multithreaded library support Andreas Weber <andy.weber.aw@gmail.com> parents: 15818 diff changeset	240 {
19743 67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	241 // Use STL function to convert to lower case
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	242 std::transform (arg0.begin (), arg0.end (), arg0.begin (),
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	243 tolower);
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	244 std::string arg1 = args(1).string_value ();
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	245 if (!error_state)
15960 bde7731b2b83 added FFTW multithreaded library support Andreas Weber <andy.weber.aw@gmail.com> parents: 15818 diff changeset	246 {
19743 67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	247 char *str = fftw_export_wisdom_to_string ();
15960 bde7731b2b83 added FFTW multithreaded library support Andreas Weber <andy.weber.aw@gmail.com> parents: 15818 diff changeset	248
19743 67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	249 if (arg1.length () < 1)
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	250 fftw_forget_wisdom ();
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	251 else if (! fftw_import_wisdom_from_string (arg1.c_str ()))
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	252 error ("fftw: could not import supplied WISDOM");
15960 bde7731b2b83 added FFTW multithreaded library support Andreas Weber <andy.weber.aw@gmail.com> parents: 15818 diff changeset	253
19743 67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	254 if (!error_state)
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	255 retval = octave_value (std::string (str));
15960 bde7731b2b83 added FFTW multithreaded library support Andreas Weber <andy.weber.aw@gmail.com> parents: 15818 diff changeset	256
19743 67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	257 free (str);
15960 bde7731b2b83 added FFTW multithreaded library support Andreas Weber <andy.weber.aw@gmail.com> parents: 15818 diff changeset	258 }
bde7731b2b83 added FFTW multithreaded library support Andreas Weber <andy.weber.aw@gmail.com> parents: 15818 diff changeset	259 }
19743 67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	260 }
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	261 else //dwisdom getter
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	262 {
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	263 char *str = fftw_export_wisdom_to_string ();
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	264 retval = octave_value (std::string (str));
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	265 free (str);
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	266 }
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	267 }
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	268 else if (arg0 == "swisdom")
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	269 {
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	270 //swisdom uses fftwf_ functions (float), dwisdom fftw_ (real)
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	271 if (nargin == 2) //swisdom setter
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	272 {
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	273 if (args(1).is_string ())
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	274 {
19743 67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	275 // Use STL function to convert to lower case
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	276 std::transform (arg0.begin (), arg0.end (), arg0.begin (),
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	277 tolower);
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	278 std::string arg1 = args(1).string_value ();
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	279 if (!error_state)
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	280 {
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	281 char *str = fftwf_export_wisdom_to_string ();
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	282
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	283 if (arg1.length () < 1)
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	284 fftwf_forget_wisdom ();
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	285 else if (! fftwf_import_wisdom_from_string (arg1.c_str ()))
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	286 error ("fftw: could not import supplied WISDOM");
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	287
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	288 if (!error_state)
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	289 retval = octave_value (std::string (str));
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	290
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	291 free (str);
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	292 }
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	293 }
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	294 }
19743 67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	295 else //swisdom getter
15960 bde7731b2b83 added FFTW multithreaded library support Andreas Weber <andy.weber.aw@gmail.com> parents: 15818 diff changeset	296 {
19743 67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	297 char *str = fftwf_export_wisdom_to_string ();
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	298 retval = octave_value (std::string (str));
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	299 free (str);
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	300 }
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	301 }
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	302 else if (arg0 == "threads")
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	303 {
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	304 if (nargin == 2) //threads setter
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	305 {
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	306 if (args(1).is_real_scalar ())
15960 bde7731b2b83 added FFTW multithreaded library support Andreas Weber <andy.weber.aw@gmail.com> parents: 15818 diff changeset	307 {
19743 67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	308 int nthreads = args(1).int_value();
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	309 if (nthreads >= 1)
15960 bde7731b2b83 added FFTW multithreaded library support Andreas Weber <andy.weber.aw@gmail.com> parents: 15818 diff changeset	310 {
bde7731b2b83 added FFTW multithreaded library support Andreas Weber <andy.weber.aw@gmail.com> parents: 15818 diff changeset	311 #if defined (HAVE_FFTW3_THREADS)
19743 67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	312 octave_fftw_planner::threads (nthreads);
15960 bde7731b2b83 added FFTW multithreaded library support Andreas Weber <andy.weber.aw@gmail.com> parents: 15818 diff changeset	313 #else
19743 67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	314 gripe_disabled_feature ("fftw", "multithreaded FFTW");
15960 bde7731b2b83 added FFTW multithreaded library support Andreas Weber <andy.weber.aw@gmail.com> parents: 15818 diff changeset	315 #endif
bde7731b2b83 added FFTW multithreaded library support Andreas Weber <andy.weber.aw@gmail.com> parents: 15818 diff changeset	316 #if defined (HAVE_FFTW3F_THREADS)
19743 67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	317 octave_float_fftw_planner::threads (nthreads);
15960 bde7731b2b83 added FFTW multithreaded library support Andreas Weber <andy.weber.aw@gmail.com> parents: 15818 diff changeset	318 #else
19743 67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	319 gripe_disabled_feature ("fftw", "multithreaded FFTW");
15960 bde7731b2b83 added FFTW multithreaded library support Andreas Weber <andy.weber.aw@gmail.com> parents: 15818 diff changeset	320 #endif
bde7731b2b83 added FFTW multithreaded library support Andreas Weber <andy.weber.aw@gmail.com> parents: 15818 diff changeset	321 }
bde7731b2b83 added FFTW multithreaded library support Andreas Weber <andy.weber.aw@gmail.com> parents: 15818 diff changeset	322 else
19743 67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	323 error ("fftw: number of threads must be >=1");
15960 bde7731b2b83 added FFTW multithreaded library support Andreas Weber <andy.weber.aw@gmail.com> parents: 15818 diff changeset	324 }
19743 67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	325 else
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	326 error ("fftw: setting threads needs one integer argument");
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	327 }
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	328 else //threads getter
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	329 #if defined (HAVE_FFTW3_THREADS)
19743 67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	330 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	331 #else
19743 67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	332 retval = 1;
15960 bde7731b2b83 added FFTW multithreaded library support Andreas Weber <andy.weber.aw@gmail.com> parents: 15818 diff changeset	333 #endif
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	334 }
19743 67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	335 else
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	336 error ("fftw: unrecognized argument");
6228 aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	337 }
15960 bde7731b2b83 added FFTW multithreaded library support Andreas Weber <andy.weber.aw@gmail.com> parents: 15818 diff changeset	338 else
19221 f5ad7470d957 fftw: Reword error messages to be consistent with other functions Mike Miller <mtmiller@ieee.org> parents: 19130 diff changeset	339 error ("fftw: unrecognized argument");
6228 aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	340 #else
aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	341
19221 f5ad7470d957 fftw: Reword error messages to be consistent with other functions Mike Miller <mtmiller@ieee.org> parents: 19130 diff changeset	342 gripe_disabled_feature ("fftw", "the FFTW3 planner");
6228 aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	343
aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	344 #endif
aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	345
aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	346 return retval;
aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	347 }
15741 f63a4f23bfe7 Fix infinite loop when setting fftw planner method (bug #37873) Mike Miller <mtmiller@ieee.org> parents: 14138 diff changeset	348
f63a4f23bfe7 Fix infinite loop when setting fftw planner method (bug #37873) Mike Miller <mtmiller@ieee.org> parents: 14138 diff changeset	349 /*
f63a4f23bfe7 Fix infinite loop when setting fftw planner method (bug #37873) Mike Miller <mtmiller@ieee.org> parents: 14138 diff changeset	350 %!testif HAVE_FFTW
f63a4f23bfe7 Fix infinite loop when setting fftw planner method (bug #37873) Mike Miller <mtmiller@ieee.org> parents: 14138 diff changeset	351 %! def_method = fftw ("planner");
f63a4f23bfe7 Fix infinite loop when setting fftw planner method (bug #37873) Mike Miller <mtmiller@ieee.org> parents: 14138 diff changeset	352 %! unwind_protect
f63a4f23bfe7 Fix infinite loop when setting fftw planner method (bug #37873) Mike Miller <mtmiller@ieee.org> parents: 14138 diff changeset	353 %! method = "estimate";
f63a4f23bfe7 Fix infinite loop when setting fftw planner method (bug #37873) Mike Miller <mtmiller@ieee.org> parents: 14138 diff changeset	354 %! fftw ("planner", method);
f63a4f23bfe7 Fix infinite loop when setting fftw planner method (bug #37873) Mike Miller <mtmiller@ieee.org> parents: 14138 diff changeset	355 %! assert (fftw ("planner"), method);
f63a4f23bfe7 Fix infinite loop when setting fftw planner method (bug #37873) Mike Miller <mtmiller@ieee.org> parents: 14138 diff changeset	356 %! method = "measure";
f63a4f23bfe7 Fix infinite loop when setting fftw planner method (bug #37873) Mike Miller <mtmiller@ieee.org> parents: 14138 diff changeset	357 %! fftw ("planner", method);
f63a4f23bfe7 Fix infinite loop when setting fftw planner method (bug #37873) Mike Miller <mtmiller@ieee.org> parents: 14138 diff changeset	358 %! assert (fftw ("planner"), method);
f63a4f23bfe7 Fix infinite loop when setting fftw planner method (bug #37873) Mike Miller <mtmiller@ieee.org> parents: 14138 diff changeset	359 %! method = "patient";
f63a4f23bfe7 Fix infinite loop when setting fftw planner method (bug #37873) Mike Miller <mtmiller@ieee.org> parents: 14138 diff changeset	360 %! fftw ("planner", method);
f63a4f23bfe7 Fix infinite loop when setting fftw planner method (bug #37873) Mike Miller <mtmiller@ieee.org> parents: 14138 diff changeset	361 %! assert (fftw ("planner"), method);
f63a4f23bfe7 Fix infinite loop when setting fftw planner method (bug #37873) Mike Miller <mtmiller@ieee.org> parents: 14138 diff changeset	362 %! method = "exhaustive";
f63a4f23bfe7 Fix infinite loop when setting fftw planner method (bug #37873) Mike Miller <mtmiller@ieee.org> parents: 14138 diff changeset	363 %! fftw ("planner", method);
f63a4f23bfe7 Fix infinite loop when setting fftw planner method (bug #37873) Mike Miller <mtmiller@ieee.org> parents: 14138 diff changeset	364 %! assert (fftw ("planner"), method);
f63a4f23bfe7 Fix infinite loop when setting fftw planner method (bug #37873) Mike Miller <mtmiller@ieee.org> parents: 14138 diff changeset	365 %! method = "hybrid";
f63a4f23bfe7 Fix infinite loop when setting fftw planner method (bug #37873) Mike Miller <mtmiller@ieee.org> parents: 14138 diff changeset	366 %! fftw ("planner", method);
f63a4f23bfe7 Fix infinite loop when setting fftw planner method (bug #37873) Mike Miller <mtmiller@ieee.org> parents: 14138 diff changeset	367 %! assert (fftw ("planner"), method);
f63a4f23bfe7 Fix infinite loop when setting fftw planner method (bug #37873) Mike Miller <mtmiller@ieee.org> parents: 14138 diff changeset	368 %! unwind_protect_cleanup
f63a4f23bfe7 Fix infinite loop when setting fftw planner method (bug #37873) Mike Miller <mtmiller@ieee.org> parents: 14138 diff changeset	369 %! fftw ("planner", def_method);
f63a4f23bfe7 Fix infinite loop when setting fftw planner method (bug #37873) Mike Miller <mtmiller@ieee.org> parents: 14138 diff changeset	370 %! end_unwind_protect
f63a4f23bfe7 Fix infinite loop when setting fftw planner method (bug #37873) Mike Miller <mtmiller@ieee.org> parents: 14138 diff changeset	371
19130 90421e725f1d codesprint: Tests for fftw Mike Miller <mtmiller@ieee.org> parents: 18678 diff changeset	372 %!testif HAVE_FFTW
90421e725f1d codesprint: Tests for fftw Mike Miller <mtmiller@ieee.org> parents: 18678 diff changeset	373 %! def_dwisdom = fftw ("dwisdom");
90421e725f1d codesprint: Tests for fftw Mike Miller <mtmiller@ieee.org> parents: 18678 diff changeset	374 %! def_swisdom = fftw ("swisdom");
90421e725f1d codesprint: Tests for fftw Mike Miller <mtmiller@ieee.org> parents: 18678 diff changeset	375 %! unwind_protect
90421e725f1d codesprint: Tests for fftw Mike Miller <mtmiller@ieee.org> parents: 18678 diff changeset	376 %! wisdom = fftw ("dwisdom");
90421e725f1d codesprint: Tests for fftw Mike Miller <mtmiller@ieee.org> parents: 18678 diff changeset	377 %! assert (ischar (wisdom));
90421e725f1d codesprint: Tests for fftw Mike Miller <mtmiller@ieee.org> parents: 18678 diff changeset	378 %! fftw ("dwisdom", wisdom);
90421e725f1d codesprint: Tests for fftw Mike Miller <mtmiller@ieee.org> parents: 18678 diff changeset	379 %! assert (fftw ("dwisdom"), wisdom);
90421e725f1d codesprint: Tests for fftw Mike Miller <mtmiller@ieee.org> parents: 18678 diff changeset	380 %! wisdom = fftw ("swisdom");
90421e725f1d codesprint: Tests for fftw Mike Miller <mtmiller@ieee.org> parents: 18678 diff changeset	381 %! assert (ischar (wisdom));
90421e725f1d codesprint: Tests for fftw Mike Miller <mtmiller@ieee.org> parents: 18678 diff changeset	382 %! fftw ("swisdom", wisdom);
90421e725f1d codesprint: Tests for fftw Mike Miller <mtmiller@ieee.org> parents: 18678 diff changeset	383 %! assert (fftw ("swisdom"), wisdom);
90421e725f1d codesprint: Tests for fftw Mike Miller <mtmiller@ieee.org> parents: 18678 diff changeset	384 %! unwind_protect_cleanup
90421e725f1d codesprint: Tests for fftw Mike Miller <mtmiller@ieee.org> parents: 18678 diff changeset	385 %! fftw ("dwisdom", def_dwisdom);
90421e725f1d codesprint: Tests for fftw Mike Miller <mtmiller@ieee.org> parents: 18678 diff changeset	386 %! fftw ("swisdom", def_swisdom);
90421e725f1d codesprint: Tests for fftw Mike Miller <mtmiller@ieee.org> parents: 18678 diff changeset	387 %! end_unwind_protect
15741 f63a4f23bfe7 Fix infinite loop when setting fftw planner method (bug #37873) Mike Miller <mtmiller@ieee.org> parents: 14138 diff changeset	388
15960 bde7731b2b83 added FFTW multithreaded library support Andreas Weber <andy.weber.aw@gmail.com> parents: 15818 diff changeset	389 %!testif HAVE_FFTW3_THREADS
bde7731b2b83 added FFTW multithreaded library support Andreas Weber <andy.weber.aw@gmail.com> parents: 15818 diff changeset	390 %! n = fftw ("threads");
bde7731b2b83 added FFTW multithreaded library support Andreas Weber <andy.weber.aw@gmail.com> parents: 15818 diff changeset	391 %! unwind_protect
bde7731b2b83 added FFTW multithreaded library support Andreas Weber <andy.weber.aw@gmail.com> parents: 15818 diff changeset	392 %! fftw ("threads", 3);
bde7731b2b83 added FFTW multithreaded library support Andreas Weber <andy.weber.aw@gmail.com> parents: 15818 diff changeset	393 %! assert (fftw ("threads"), 3);
bde7731b2b83 added FFTW multithreaded library support Andreas Weber <andy.weber.aw@gmail.com> parents: 15818 diff changeset	394 %! unwind_protect_cleanup
bde7731b2b83 added FFTW multithreaded library support Andreas Weber <andy.weber.aw@gmail.com> parents: 15818 diff changeset	395 %! fftw ("threads", n);
bde7731b2b83 added FFTW multithreaded library support Andreas Weber <andy.weber.aw@gmail.com> parents: 15818 diff changeset	396 %! end_unwind_protect
19130 90421e725f1d codesprint: Tests for fftw Mike Miller <mtmiller@ieee.org> parents: 18678 diff changeset	397
90421e725f1d codesprint: Tests for fftw Mike Miller <mtmiller@ieee.org> parents: 18678 diff changeset	398 %!error <Invalid call to fftw> fftw ();
90421e725f1d codesprint: Tests for fftw Mike Miller <mtmiller@ieee.org> parents: 18678 diff changeset	399 %!error <Invalid call to fftw> fftw ("planner", "estimate", "measure");
90421e725f1d codesprint: Tests for fftw Mike Miller <mtmiller@ieee.org> parents: 18678 diff changeset	400 %!error fftw (3);
90421e725f1d codesprint: Tests for fftw Mike Miller <mtmiller@ieee.org> parents: 18678 diff changeset	401 %!error fftw ("invalid");
90421e725f1d codesprint: Tests for fftw Mike Miller <mtmiller@ieee.org> parents: 18678 diff changeset	402 %!error fftw ("planner", "invalid");
90421e725f1d codesprint: Tests for fftw Mike Miller <mtmiller@ieee.org> parents: 18678 diff changeset	403 %!error fftw ("planner", 2);
90421e725f1d codesprint: Tests for fftw Mike Miller <mtmiller@ieee.org> parents: 18678 diff changeset	404 %!error fftw ("dwisdom", "invalid");
90421e725f1d codesprint: Tests for fftw Mike Miller <mtmiller@ieee.org> parents: 18678 diff changeset	405 %!error fftw ("swisdom", "invalid");
90421e725f1d codesprint: Tests for fftw Mike Miller <mtmiller@ieee.org> parents: 18678 diff changeset	406 %!error fftw ("threads", "invalid");
90421e725f1d codesprint: Tests for fftw Mike Miller <mtmiller@ieee.org> parents: 18678 diff changeset	407 %!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	408 */

Mercurial > octave-antonio

annotate libinterp/dldfcn/fftw.cc @ 20163:075a5e2e1ba5 stable