Mercurial > octave-nkf

comparison src/DLD-FUNCTIONS/fftw.cc @ 9064:7c02ec148a3c

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Check grammar on all .cc files Same check as previously done on .m files Attempt to enforce some conformity in documentation text for rules such as two spaces after a period, commas around latin abbreviations, etc.
author Rik <rdrider0-list@yahoo.com>
date Sat, 28 Mar 2009 13:57:22 -0700
parents eb63fbe60fab
children bd8e388043c4
comparison
equal deleted inserted replaced
9063:a6cf0ad87eee 9064:7c02ec148a3c
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 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 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\
51 @var{wisdom} = fftw ('dwisdom')\n\ 51 @var{wisdom} = fftw ('dwisdom')\n\
52 @end example\n\ 52 @end example\n\
53 \n\ 53 \n\
54 will save the existing wisdom used by Octave to the string @var{wisdom}.\n\ 54 will save the existing wisdom used by Octave to the string @var{wisdom}.\n\
55 This string can then be saved to a file and restored using the @code{save}\n\ 55 This string can then be saved to a file and restored using the @code{save}\n\
56 and @code{load} commands respectively. This existing wisdom can be reimported\n\ 56 and @code{load} commands respectively. This existing wisdom can be reimported\n\
57 as follows\n\ 57 as follows\n\
58 \n\ 58 \n\
59 @example\n\ 59 @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\
103 \n\ 103 \n\
104 @example\n\ 104 @example\n\
105 fftw ('planner', @var{method})\n\ 105 fftw ('planner', @var{method})\n\
106 @end example\n\ 106 @end example\n\
107 \n\ 107 \n\
108 Note that calculated wisdom will be lost when restarting Octave. However,\n\ 108 Note that calculated wisdom will be lost when restarting Octave. However,\n\
109 the wisdom data can be reloaded if it is saved to a file as described\n\ 109 the wisdom data can be reloaded if it is saved to a file as described\n\
110 above. Saved wisdom files should not be used on different platforms since\n\ 110 above. Saved wisdom files should not be used on different platforms since\n\
111 they will not be efficient and the point of calculating the wisdom is lost.\n\ 111 they will not be efficient and the point of calculating the wisdom is lost.\n\
112 @seealso{fft, ifft, fft2, ifft2, fftn, ifftn}\n\ 112 @seealso{fft, ifft, fft2, ifft2, fftn, ifftn}\n\
113 @end deftypefn") 113 @end deftypefn")
114 { 114 {
115 octave_value retval; 115 octave_value retval;