octave: libinterp/dldfcn/fftw.cc annotate

annotate libinterp/dldfcn/fftw.cc @ 21966:112b20240c87

move docstrings in C++ files out of C strings and into comments * __contourc__.cc, __dispatch__.cc, __dsearchn__.cc, __ichol__.cc, __ilu__.cc, __lin_interpn__.cc, __luinc__.cc, __magick_read__.cc, __pchip_deriv__.cc, __qp__.cc, balance.cc, besselj.cc, betainc.cc, bitfcns.cc, bsxfun.cc, cellfun.cc, colloc.cc, conv2.cc, daspk.cc, dasrt.cc, dassl.cc, data.cc, debug.cc, defaults.cc, det.cc, dirfns.cc, dlmread.cc, dot.cc, eig.cc, ellipj.cc, error.cc, fft.cc, fft2.cc, fftn.cc, file-io.cc, filter.cc, find.cc, gammainc.cc, gcd.cc, getgrent.cc, getpwent.cc, getrusage.cc, givens.cc, graphics.cc, hash.cc, help.cc, hess.cc, hex2num.cc, input.cc, inv.cc, kron.cc, load-path.cc, load-save.cc, lookup.cc, ls-oct-text.cc, lsode.cc, lu.cc, mappers.cc, matrix_type.cc, max.cc, mgorth.cc, nproc.cc, oct-hist.cc, octave-link.cc, ordschur.cc, pager.cc, pinv.cc, pr-output.cc, profiler.cc, psi.cc, pt-jit.cc, quad.cc, quadcc.cc, qz.cc, rand.cc, rcond.cc, regexp.cc, schur.cc, sighandlers.cc, sparse.cc, spparms.cc, sqrtm.cc, str2double.cc, strfind.cc, strfns.cc, sub2ind.cc, svd.cc, sylvester.cc, symtab.cc, syscalls.cc, sysdep.cc, time.cc, toplev.cc, tril.cc, tsearch.cc, typecast.cc, urlwrite.cc, utils.cc, variables.cc, __delaunayn__.cc, __eigs__.cc, __fltk_uigetfile__.cc, __glpk__.cc, __init_fltk__.cc, __init_gnuplot__.cc, __osmesa_print__.cc, __voronoi__.cc, amd.cc, audiodevinfo.cc, audioread.cc, ccolamd.cc, chol.cc, colamd.cc, convhulln.cc, dmperm.cc, fftw.cc, qr.cc, symbfact.cc, symrcm.cc, ov-base.cc, ov-bool-mat.cc, ov-cell.cc, ov-class.cc, ov-classdef.cc, ov-fcn-handle.cc, ov-fcn-inline.cc, ov-flt-re-mat.cc, ov-int16.cc, ov-int32.cc, ov-int64.cc, ov-int8.cc, ov-java.cc, ov-null-mat.cc, ov-oncleanup.cc, ov-range.cc, ov-re-mat.cc, ov-struct.cc, ov-typeinfo.cc, ov-uint16.cc, ov-uint32.cc, ov-uint64.cc, ov-uint8.cc, ov-usr-fcn.cc, ov.cc, octave.cc, pt-arg-list.cc, pt-binop.cc, pt-eval.cc, pt-mat.cc, lex.ll, oct-parse.in.yy: Docstrings are now comments instead of C strings. * build-aux/mk-opts.pl: Emit docstrings as comments instead of C strings. * DASPK-opts.in, LSODE-opts.in: Don't quote " in docstring fragments. * builtins.h: Include builtin-defun-decls.h unconditionally. * defun.h (DEFUN, DEFUNX, DEFCONSTFUN): Simply emit declaration. (DEFALIAS): Always expand to nothing. * defun-dld.h: No special macro expansions for MAKE_BUILTINS. (DEFUN_DLD): Use FORWARD_DECLARE_FUN. (DEFUNX_DLD): Use FORWARD_DECLARE_FUNX. * defun-int.h: No special macro expansions for MAKE_BUILTINS. (FORWARD_DECLARE_FUN, FORWARD_DECLARE_FUNX): New macros. (DEFINE_FUN_INSTALLER_FUN): If compiling an Octave source file, pass "external-doc" to DEFINE_FUNX_INSTALLER_FUN. (DEFUN_INTERNAL, DEFCONSTFUN_INTERNAL, DEFUNX_INTERNAL, DEFALIAS_INTERNAL): Delete. * common.mk (move_if_change_rule): New macro. (simple_move_if_change_rule): Define using move_if_change_rule. * find-defun-files.sh (DEFUN_PATTERN): Update. Don't transform file name extension to ".df". * libinterp/mk-pkg-add, gendoc.pl: Operate directly on source files. * mkbuiltins: New argument, SRCDIR. Operate directly on source files. * mkdefs: Delete. * libinterp/module.mk (BUILT_SOURCES): Update list to contain only files included in other source files. (GENERATED_MAKE_BUILTINS_INCS, DEF_FILES): Delete. (LIBINTERP_BUILT_DISTFILES): Include $(OPT_HANDLERS) here. (LIBINTERP_BUILT_NODISTFILES): Not here. Remove $(ALL_DEF_FILES from the list. (libinterp_EXTRA_DIST): Remove mkdefs from the list. (FOUND_DEFUN_FILES): Rename from SRC_DEF_FILES. (DLDFCN_DEFUN_FILES): Rename from DLDFCN_DEF_FILES. (SRC_DEFUN_FILES): Rename from SRC_DEF_FILES. (ALL_DEFUN_FILES): Rename from ALL_DEF_FILES. (%.df: %.cc): Delete pattern rule. (libinterp/build-env-features.cc, libinterp/builtins.cc, libinterp/dldfcn/PKG_ADD): Use mv instead of move-if-change. (libinterp/builtins.cc, libinterp/builtin-defun-decls.h): Update mkbuiltins command. ($(srcdir)/libinterp/DOCSTRINGS): Update gendoc.pl command. * liboctave/module.mk (BUILT_SOURCES): Don't include liboctave-build-info.cc in the list.

author	John W. Eaton <jwe@octave.org>
date	Tue, 21 Jun 2016 16:07:51 -0400
parents	aba2e6293dd8
children	16efd0403698

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
21724 aba2e6293dd8 use "#if ..." consistently instead of "#ifdef" and "#ifndef" John W. Eaton <jwe@octave.org> parents: 21691 diff changeset	23 #if defined (HAVE_CONFIG_H)
21301 40de9f8f23a6 Use '#include "config.h"' rather than <config.h>. Rik <rik@octave.org> parents: 21200 diff changeset	24 # include "config.h"
6228 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
21451 763e30285935 eliminate configuration macros from oct-fftw.h (bug #41027) John W. Eaton <jwe@octave.org> parents: 21447 diff changeset	29 #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	30 # include <fftw3.h>
763e30285935 eliminate configuration macros from oct-fftw.h (bug #41027) John W. Eaton <jwe@octave.org> parents: 21447 diff changeset	31 #endif
763e30285935 eliminate configuration macros from oct-fftw.h (bug #41027) John W. Eaton <jwe@octave.org> parents: 21447 diff changeset	32
9523 0ce82753dd72 more configure changes for libraries John W. Eaton <jwe@octave.org> parents: 9516 diff changeset	33 #include "oct-fftw.h"
0ce82753dd72 more configure changes for libraries John W. Eaton <jwe@octave.org> parents: 9516 diff changeset	34
6228 aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	35 #include "defun-dld.h"
aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	36 #include "error.h"
9523 0ce82753dd72 more configure changes for libraries John W. Eaton <jwe@octave.org> parents: 9516 diff changeset	37 #include "ov.h"
6228 aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	38
21100 e39e05d90788 Switch gripe_XXX to either err_XXX or warn_XXX naming scheme. Rik <rik@octave.org> parents: 20939 diff changeset	39 #include "errwarn.h"
19221 f5ad7470d957 fftw: Reword error messages to be consistent with other functions Mike Miller <mtmiller@ieee.org> parents: 19130 diff changeset	40
6228 aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	41 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	42 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	43 @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	44 @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	45 @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	46 @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	47 @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	48 @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	49
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	50 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	51
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	52 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	53 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	54 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	55 @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	56 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	57 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	58
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	59 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	60 @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	61 @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	62
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	63 @noindent
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	64 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	65 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	66 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	67 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	68
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	69 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	70 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	71 @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	72
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	73 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	74
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	75 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	76 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	77 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	78 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	79
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	80 @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	81 @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	82 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	83 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	84 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	85 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	86 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	87
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	88 @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	89 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	90 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	91
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	92 @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	93 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	94 considered.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	95
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	96 @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	97 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	98 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	99
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	100 @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	101 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	102 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	103 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	104 @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	105
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	106 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	107 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	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 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	110 @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	111 @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	112
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	113 @noindent
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	114 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	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 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	117 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	118 @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	119
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	120 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	121 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	122 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	123 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	124
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	125 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	126 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	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 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	129 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	130 @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	131
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	132 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	133 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	134 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	135
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	136 @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	137 @end deftypefn */)
6228 aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	138 {
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	139 #if defined (HAVE_FFTW)
6228 aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	140
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	141 int nargin = args.length ();
6228 aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	142
aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	143 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	144 print_usage ();
6228 aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	145
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	146 octave_value retval;
b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	147
20700 68e3a747ca02 rename octave_value value extractors that accept error message args John W. Eaton <jwe@octave.org> parents: 20579 diff changeset	148 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	149
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	150 if (arg0 == "planner")
6228 aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	151 {
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	152 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	153 {
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	154 // 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	155 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	156
20711 7b608fadc663 Make error messages more specific about the variable and problem encountered. Rik <rik@octave.org> parents: 20700 diff changeset	157 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	158
20711 7b608fadc663 Make error messages more specific about the variable and problem encountered. Rik <rik@octave.org> parents: 20700 diff changeset	159 std::transform (arg1.begin (), arg1.end (), arg1.begin (), tolower);
20579 10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	160 octave_fftw_planner::FftwMethod meth
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	161 = octave_fftw_planner::UNKNOWN;
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	162 octave_float_fftw_planner::FftwMethod methf
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	163 = octave_float_fftw_planner::UNKNOWN;
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	164
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	165 if (arg1 == "estimate")
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	166 {
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	167 meth = octave_fftw_planner::ESTIMATE;
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	168 methf = octave_float_fftw_planner::ESTIMATE;
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	169 }
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	170 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	171 {
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	172 meth = octave_fftw_planner::MEASURE;
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	173 methf = octave_float_fftw_planner::MEASURE;
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	174 }
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	175 else if (arg1 == "patient")
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9523 diff changeset	176 {
20579 10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	177 meth = octave_fftw_planner::PATIENT;
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	178 methf = octave_float_fftw_planner::PATIENT;
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	179 }
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	180 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	181 {
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	182 meth = octave_fftw_planner::EXHAUSTIVE;
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	183 methf = octave_float_fftw_planner::EXHAUSTIVE;
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	184 }
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	185 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	186 {
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	187 meth = octave_fftw_planner::HYBRID;
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	188 methf = octave_float_fftw_planner::HYBRID;
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	189 }
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	190 else
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	191 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	192
20579 10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	193 meth = octave_fftw_planner::method (meth);
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	194 octave_float_fftw_planner::method (methf);
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	195
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	196 if (meth == octave_fftw_planner::MEASURE)
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	197 retval = octave_value ("measure");
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	198 else if (meth == octave_fftw_planner::PATIENT)
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	199 retval = octave_value ("patient");
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	200 else if (meth == octave_fftw_planner::EXHAUSTIVE)
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	201 retval = octave_value ("exhaustive");
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	202 else if (meth == octave_fftw_planner::HYBRID)
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	203 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	204 else
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	205 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	206 }
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	207 else //planner getter
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	208 {
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	209 octave_fftw_planner::FftwMethod meth =
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	210 octave_fftw_planner::method ();
19743 67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	211
20579 10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	212 if (meth == octave_fftw_planner::MEASURE)
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	213 retval = octave_value ("measure");
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	214 else if (meth == octave_fftw_planner::PATIENT)
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	215 retval = octave_value ("patient");
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	216 else if (meth == octave_fftw_planner::EXHAUSTIVE)
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	217 retval = octave_value ("exhaustive");
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	218 else if (meth == octave_fftw_planner::HYBRID)
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	219 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	220 else
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	221 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	222 }
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	223 }
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	224 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	225 {
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	226 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	227 {
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	228 // 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	229 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	230 tolower);
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	231
20700 68e3a747ca02 rename octave_value value extractors that accept error message args John W. Eaton <jwe@octave.org> parents: 20579 diff changeset	232 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	233
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	234 char *str = fftw_export_wisdom_to_string ();
21447 ac1e50cfc9ed avoid possible memory leak with fftw wisdom (bug #47372) John W. Eaton <jwe@octave.org> parents: 21301 diff changeset	235 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	236 free (str);
20579 10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	237
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	238 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	239 fftw_forget_wisdom ();
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	240 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	241 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	242
21447 ac1e50cfc9ed avoid possible memory leak with fftw wisdom (bug #47372) John W. Eaton <jwe@octave.org> parents: 21301 diff changeset	243 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	244 }
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	245 else //dwisdom getter
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	246 {
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	247 char *str = fftw_export_wisdom_to_string ();
21447 ac1e50cfc9ed avoid possible memory leak with fftw wisdom (bug #47372) John W. Eaton <jwe@octave.org> parents: 21301 diff changeset	248 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	249 free (str);
21447 ac1e50cfc9ed avoid possible memory leak with fftw wisdom (bug #47372) John W. Eaton <jwe@octave.org> parents: 21301 diff changeset	250 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	251 }
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 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	254 {
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	255 //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	256 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	257 {
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	258 // 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	259 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	260 tolower);
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	261
20700 68e3a747ca02 rename octave_value value extractors that accept error message args John W. Eaton <jwe@octave.org> parents: 20579 diff changeset	262 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	263
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	264 char *str = fftwf_export_wisdom_to_string ();
21447 ac1e50cfc9ed avoid possible memory leak with fftw wisdom (bug #47372) John W. Eaton <jwe@octave.org> parents: 21301 diff changeset	265 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	266 free (str);
20579 10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	267
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	268 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	269 fftwf_forget_wisdom ();
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	270 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	271 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	272
21447 ac1e50cfc9ed avoid possible memory leak with fftw wisdom (bug #47372) John W. Eaton <jwe@octave.org> parents: 21301 diff changeset	273 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	274 }
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	275 else //swisdom getter
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	276 {
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	277 char *str = fftwf_export_wisdom_to_string ();
21447 ac1e50cfc9ed avoid possible memory leak with fftw wisdom (bug #47372) John W. Eaton <jwe@octave.org> parents: 21301 diff changeset	278 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	279 free (str);
21447 ac1e50cfc9ed avoid possible memory leak with fftw wisdom (bug #47372) John W. Eaton <jwe@octave.org> parents: 21301 diff changeset	280 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	281 }
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	282 }
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	283 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	284 {
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	285 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	286 {
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	287 if (! args(1).is_real_scalar ())
b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	288 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	289
b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	290 int nthreads = args(1).int_value();
b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	291 if (nthreads < 1)
b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	292 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	293
20579 10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	294 #if defined (HAVE_FFTW3_THREADS)
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	295 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	296 #else
21100 e39e05d90788 Switch gripe_XXX to either err_XXX or warn_XXX naming scheme. Rik <rik@octave.org> parents: 20939 diff changeset	297 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	298 #endif
10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	299 #if defined (HAVE_FFTW3F_THREADS)
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	300 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	301 #else
21100 e39e05d90788 Switch gripe_XXX to either err_XXX or warn_XXX naming scheme. Rik <rik@octave.org> parents: 20939 diff changeset	302 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	303 #endif
19743 67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	304 }
20579 10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	305 else //threads getter
15960 bde7731b2b83 added FFTW multithreaded library support Andreas Weber <andy.weber.aw@gmail.com> parents: 15818 diff changeset	306 #if defined (HAVE_FFTW3_THREADS)
20579 10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	307 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	308 #else
20579 10ec79b47808 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	309 retval = 1;
15960 bde7731b2b83 added FFTW multithreaded library support Andreas Weber <andy.weber.aw@gmail.com> parents: 15818 diff changeset	310 #endif
6228 aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	311 }
15960 bde7731b2b83 added FFTW multithreaded library support Andreas Weber <andy.weber.aw@gmail.com> parents: 15818 diff changeset	312 else
19221 f5ad7470d957 fftw: Reword error messages to be consistent with other functions Mike Miller <mtmiller@ieee.org> parents: 19130 diff changeset	313 error ("fftw: unrecognized argument");
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	314
b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	315 return retval;
b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	316
6228 aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	317 #else
21691 263d18409fdf Eliminate unused variable warnings for conditionally compiled code. John W. Eaton <jwe@octave.org> parents: 21581 diff changeset	318
263d18409fdf Eliminate unused variable warnings for conditionally compiled code. John W. Eaton <jwe@octave.org> parents: 21581 diff changeset	319 octave_unused_parameter (args);
263d18409fdf Eliminate unused variable warnings for conditionally compiled code. John W. Eaton <jwe@octave.org> parents: 21581 diff changeset	320
21100 e39e05d90788 Switch gripe_XXX to either err_XXX or warn_XXX naming scheme. Rik <rik@octave.org> parents: 20939 diff changeset	321 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	322
6228 aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	323 #endif
aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: diff changeset	324 }
15741 f63a4f23bfe7 Fix infinite loop when setting fftw planner method (bug #37873) Mike Miller <mtmiller@ieee.org> parents: 14138 diff changeset	325
f63a4f23bfe7 Fix infinite loop when setting fftw planner method (bug #37873) Mike Miller <mtmiller@ieee.org> parents: 14138 diff changeset	326 /*
f63a4f23bfe7 Fix infinite loop when setting fftw planner method (bug #37873) Mike Miller <mtmiller@ieee.org> parents: 14138 diff changeset	327 %!testif HAVE_FFTW
f63a4f23bfe7 Fix infinite loop when setting fftw planner method (bug #37873) Mike Miller <mtmiller@ieee.org> parents: 14138 diff changeset	328 %! def_method = fftw ("planner");
f63a4f23bfe7 Fix infinite loop when setting fftw planner method (bug #37873) Mike Miller <mtmiller@ieee.org> parents: 14138 diff changeset	329 %! unwind_protect
f63a4f23bfe7 Fix infinite loop when setting fftw planner method (bug #37873) Mike Miller <mtmiller@ieee.org> parents: 14138 diff changeset	330 %! method = "estimate";
f63a4f23bfe7 Fix infinite loop when setting fftw planner method (bug #37873) Mike Miller <mtmiller@ieee.org> parents: 14138 diff changeset	331 %! fftw ("planner", method);
f63a4f23bfe7 Fix infinite loop when setting fftw planner method (bug #37873) Mike Miller <mtmiller@ieee.org> parents: 14138 diff changeset	332 %! assert (fftw ("planner"), method);
f63a4f23bfe7 Fix infinite loop when setting fftw planner method (bug #37873) Mike Miller <mtmiller@ieee.org> parents: 14138 diff changeset	333 %! method = "measure";
f63a4f23bfe7 Fix infinite loop when setting fftw planner method (bug #37873) Mike Miller <mtmiller@ieee.org> parents: 14138 diff changeset	334 %! fftw ("planner", method);
f63a4f23bfe7 Fix infinite loop when setting fftw planner method (bug #37873) Mike Miller <mtmiller@ieee.org> parents: 14138 diff changeset	335 %! assert (fftw ("planner"), method);
f63a4f23bfe7 Fix infinite loop when setting fftw planner method (bug #37873) Mike Miller <mtmiller@ieee.org> parents: 14138 diff changeset	336 %! method = "patient";
f63a4f23bfe7 Fix infinite loop when setting fftw planner method (bug #37873) Mike Miller <mtmiller@ieee.org> parents: 14138 diff changeset	337 %! fftw ("planner", method);
f63a4f23bfe7 Fix infinite loop when setting fftw planner method (bug #37873) Mike Miller <mtmiller@ieee.org> parents: 14138 diff changeset	338 %! assert (fftw ("planner"), method);
f63a4f23bfe7 Fix infinite loop when setting fftw planner method (bug #37873) Mike Miller <mtmiller@ieee.org> parents: 14138 diff changeset	339 %! method = "exhaustive";
f63a4f23bfe7 Fix infinite loop when setting fftw planner method (bug #37873) Mike Miller <mtmiller@ieee.org> parents: 14138 diff changeset	340 %! fftw ("planner", method);
f63a4f23bfe7 Fix infinite loop when setting fftw planner method (bug #37873) Mike Miller <mtmiller@ieee.org> parents: 14138 diff changeset	341 %! assert (fftw ("planner"), method);
f63a4f23bfe7 Fix infinite loop when setting fftw planner method (bug #37873) Mike Miller <mtmiller@ieee.org> parents: 14138 diff changeset	342 %! method = "hybrid";
f63a4f23bfe7 Fix infinite loop when setting fftw planner method (bug #37873) Mike Miller <mtmiller@ieee.org> parents: 14138 diff changeset	343 %! fftw ("planner", method);
f63a4f23bfe7 Fix infinite loop when setting fftw planner method (bug #37873) Mike Miller <mtmiller@ieee.org> parents: 14138 diff changeset	344 %! assert (fftw ("planner"), method);
f63a4f23bfe7 Fix infinite loop when setting fftw planner method (bug #37873) Mike Miller <mtmiller@ieee.org> parents: 14138 diff changeset	345 %! unwind_protect_cleanup
f63a4f23bfe7 Fix infinite loop when setting fftw planner method (bug #37873) Mike Miller <mtmiller@ieee.org> parents: 14138 diff changeset	346 %! fftw ("planner", def_method);
f63a4f23bfe7 Fix infinite loop when setting fftw planner method (bug #37873) Mike Miller <mtmiller@ieee.org> parents: 14138 diff changeset	347 %! end_unwind_protect
f63a4f23bfe7 Fix infinite loop when setting fftw planner method (bug #37873) Mike Miller <mtmiller@ieee.org> parents: 14138 diff changeset	348
19130 90421e725f1d codesprint: Tests for fftw Mike Miller <mtmiller@ieee.org> parents: 18678 diff changeset	349 %!testif HAVE_FFTW
90421e725f1d codesprint: Tests for fftw Mike Miller <mtmiller@ieee.org> parents: 18678 diff changeset	350 %! def_dwisdom = fftw ("dwisdom");
90421e725f1d codesprint: Tests for fftw Mike Miller <mtmiller@ieee.org> parents: 18678 diff changeset	351 %! def_swisdom = fftw ("swisdom");
90421e725f1d codesprint: Tests for fftw Mike Miller <mtmiller@ieee.org> parents: 18678 diff changeset	352 %! unwind_protect
90421e725f1d codesprint: Tests for fftw Mike Miller <mtmiller@ieee.org> parents: 18678 diff changeset	353 %! wisdom = fftw ("dwisdom");
90421e725f1d codesprint: Tests for fftw Mike Miller <mtmiller@ieee.org> parents: 18678 diff changeset	354 %! assert (ischar (wisdom));
90421e725f1d codesprint: Tests for fftw Mike Miller <mtmiller@ieee.org> parents: 18678 diff changeset	355 %! fftw ("dwisdom", wisdom);
90421e725f1d codesprint: Tests for fftw Mike Miller <mtmiller@ieee.org> parents: 18678 diff changeset	356 %! assert (fftw ("dwisdom"), wisdom);
90421e725f1d codesprint: Tests for fftw Mike Miller <mtmiller@ieee.org> parents: 18678 diff changeset	357 %! wisdom = fftw ("swisdom");
90421e725f1d codesprint: Tests for fftw Mike Miller <mtmiller@ieee.org> parents: 18678 diff changeset	358 %! assert (ischar (wisdom));
90421e725f1d codesprint: Tests for fftw Mike Miller <mtmiller@ieee.org> parents: 18678 diff changeset	359 %! fftw ("swisdom", wisdom);
90421e725f1d codesprint: Tests for fftw Mike Miller <mtmiller@ieee.org> parents: 18678 diff changeset	360 %! assert (fftw ("swisdom"), wisdom);
90421e725f1d codesprint: Tests for fftw Mike Miller <mtmiller@ieee.org> parents: 18678 diff changeset	361 %! unwind_protect_cleanup
90421e725f1d codesprint: Tests for fftw Mike Miller <mtmiller@ieee.org> parents: 18678 diff changeset	362 %! fftw ("dwisdom", def_dwisdom);
90421e725f1d codesprint: Tests for fftw Mike Miller <mtmiller@ieee.org> parents: 18678 diff changeset	363 %! fftw ("swisdom", def_swisdom);
90421e725f1d codesprint: Tests for fftw Mike Miller <mtmiller@ieee.org> parents: 18678 diff changeset	364 %! end_unwind_protect
15741 f63a4f23bfe7 Fix infinite loop when setting fftw planner method (bug #37873) Mike Miller <mtmiller@ieee.org> parents: 14138 diff changeset	365
15960 bde7731b2b83 added FFTW multithreaded library support Andreas Weber <andy.weber.aw@gmail.com> parents: 15818 diff changeset	366 %!testif HAVE_FFTW3_THREADS
bde7731b2b83 added FFTW multithreaded library support Andreas Weber <andy.weber.aw@gmail.com> parents: 15818 diff changeset	367 %! n = fftw ("threads");
bde7731b2b83 added FFTW multithreaded library support Andreas Weber <andy.weber.aw@gmail.com> parents: 15818 diff changeset	368 %! unwind_protect
bde7731b2b83 added FFTW multithreaded library support Andreas Weber <andy.weber.aw@gmail.com> parents: 15818 diff changeset	369 %! fftw ("threads", 3);
bde7731b2b83 added FFTW multithreaded library support Andreas Weber <andy.weber.aw@gmail.com> parents: 15818 diff changeset	370 %! assert (fftw ("threads"), 3);
bde7731b2b83 added FFTW multithreaded library support Andreas Weber <andy.weber.aw@gmail.com> parents: 15818 diff changeset	371 %! unwind_protect_cleanup
bde7731b2b83 added FFTW multithreaded library support Andreas Weber <andy.weber.aw@gmail.com> parents: 15818 diff changeset	372 %! fftw ("threads", n);
bde7731b2b83 added FFTW multithreaded library support Andreas Weber <andy.weber.aw@gmail.com> parents: 15818 diff changeset	373 %! end_unwind_protect
19130 90421e725f1d codesprint: Tests for fftw Mike Miller <mtmiller@ieee.org> parents: 18678 diff changeset	374
21581 6fab85c1538f maint: Follow Octave conventions for use of semicolon in BIST tests. Rik <rik@octave.org> parents: 21451 diff changeset	375 %!error <Invalid call to fftw> fftw ()
6fab85c1538f maint: Follow Octave conventions for use of semicolon in BIST tests. Rik <rik@octave.org> parents: 21451 diff changeset	376 %!error <Invalid call to fftw> fftw ("planner", "estimate", "measure")
6fab85c1538f maint: Follow Octave conventions for use of semicolon in BIST tests. Rik <rik@octave.org> parents: 21451 diff changeset	377 %!error fftw (3)
6fab85c1538f maint: Follow Octave conventions for use of semicolon in BIST tests. Rik <rik@octave.org> parents: 21451 diff changeset	378 %!error fftw ("invalid")
6fab85c1538f maint: Follow Octave conventions for use of semicolon in BIST tests. Rik <rik@octave.org> parents: 21451 diff changeset	379 %!error fftw ("planner", "invalid")
6fab85c1538f maint: Follow Octave conventions for use of semicolon in BIST tests. Rik <rik@octave.org> parents: 21451 diff changeset	380 %!error fftw ("planner", 2)
6fab85c1538f maint: Follow Octave conventions for use of semicolon in BIST tests. Rik <rik@octave.org> parents: 21451 diff changeset	381 %!error fftw ("dwisdom", "invalid")
6fab85c1538f maint: Follow Octave conventions for use of semicolon in BIST tests. Rik <rik@octave.org> parents: 21451 diff changeset	382 %!error fftw ("swisdom", "invalid")
6fab85c1538f maint: Follow Octave conventions for use of semicolon in BIST tests. Rik <rik@octave.org> parents: 21451 diff changeset	383 %!error fftw ("threads", "invalid")
6fab85c1538f maint: Follow Octave conventions for use of semicolon in BIST tests. Rik <rik@octave.org> parents: 21451 diff changeset	384 %!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	385 */

Mercurial > octave

annotate libinterp/dldfcn/fftw.cc @ 21966:112b20240c87