Mercurial > octave-antonio

comparison src/DLD-FUNCTIONS/fftw.cc @ 9072:bd8e388043c4

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Cleanup documentation for signal.texi, image.texi, audio.texi
author Rik <rdrider0-list@yahoo.com>
date Wed, 01 Apr 2009 17:06:45 -0700
parents 7c02ec148a3c
children fb933db0c517
comparison
equal deleted inserted replaced
9071:034800482c79 9072:bd8e388043c4
38 @deftypefn {Loadable Function} {@var{method} =} fftw ('planner')\n\ 38 @deftypefn {Loadable Function} {@var{method} =} fftw ('planner')\n\
39 @deftypefnx {Loadable Function} {} fftw ('planner', @var{method})\n\ 39 @deftypefnx {Loadable Function} {} fftw ('planner', @var{method})\n\
40 @deftypefnx {Loadable Function} {@var{wisdom} =} fftw ('dwisdom')\n\ 40 @deftypefnx {Loadable Function} {@var{wisdom} =} fftw ('dwisdom')\n\
41 @deftypefnx {Loadable Function} {@var{wisdom} =} fftw ('dwisdom', @var{wisdom})\n\ 41 @deftypefnx {Loadable Function} {@var{wisdom} =} fftw ('dwisdom', @var{wisdom})\n\
42 \n\ 42 \n\
43 Manage FFTW wisdom data. Wisdom data can be used to significantly\n\ 43 Manage @sc{fftw} wisdom data. Wisdom data can be used to significantly\n\
44 accelerate the calculation of the FFTs but implies an initial cost\n\ 44 accelerate the calculation of the FFTs but implies an initial cost\n\
45 in its calculation. When the FFTW libraries are initialized, they read\n\ 45 in its calculation. When the @sc{fftw} libraries are initialized, they read\n\
46 a system wide wisdom file (typically in @file{/etc/fftw/wisdom}), allowing wisdom\n\ 46 a system wide wisdom file (typically in @file{/etc/fftw/wisdom}), allowing wisdom\n\
47 to be shared between applications other than Octave. Alternatively, the\n\ 47 to be shared between applications other than Octave. Alternatively, the\n\
48 @code{fftw} function can be used to import wisdom. For example\n\ 48 @code{fftw} function can be used to import wisdom. For example\n\
49 \n\ 49 \n\
50 @example\n\ 50 @example\n\
60 fftw ('dwisdom', @var{wisdom})\n\ 60 fftw ('dwisdom', @var{wisdom})\n\
61 @end example \n\ 61 @end example \n\
62 \n\ 62 \n\
63 If @var{wisdom} is an empty matrix, then the wisdom used is cleared.\n\ 63 If @var{wisdom} is an empty matrix, then the wisdom used is cleared.\n\
64 \n\ 64 \n\
65 During the calculation of fourier transforms further wisdom is generated.\n\ 65 During the calculation of Fourier transforms further wisdom is generated.\n\
66 The fashion in which this wisdom is generated is equally controlled by\n\ 66 The fashion in which this wisdom is generated is equally controlled by\n\
67 the @code{fftw} function. There are five different manners in which the\n\ 67 the @code{fftw} function. There are five different manners in which the\n\
68 wisdom can be treated, these being\n\ 68 wisdom can be treated, these being\n\
69 \n\ 69 \n\
70 @table @asis\n\ 70 @table @asis\n\
71 @item 'estimate'\n\ 71 @item 'estimate'\n\
72 This specifies that no run-time measurement of the optimal means of\n\ 72 This specifies that no run-time measurement of the optimal means of\n\
73 calculating a particular is performed, and a simple heuristic is used\n\ 73 calculating a particular is performed, and a simple heuristic is used\n\
74 to pick a (probably sub-optimal) plan. The advantage of this method is\n\ 74 to pick a (probably sub-optimal) plan. The advantage of this method is\n\
75 that there is little or no overhead in the generation of the plan, which\n\ 75 that there is little or no overhead in the generation of the plan, which\n\
76 is appropriate for a fourier transform that will be calculated once.\n\ 76 is appropriate for a Fourier transform that will be calculated once.\n\
77 \n\ 77 \n\
78 @item 'measure'\n\ 78 @item 'measure'\n\
79 In this case a range of algorithms to perform the transform is considered\n\ 79 In this case a range of algorithms to perform the transform is considered\n\
80 and the best is selected based on their execution time.\n\ 80 and the best is selected based on their execution time.\n\
81 \n\ 81 \n\