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

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
line wrap: on
line diff
--- a/src/DLD-FUNCTIONS/fftw.cc	Mon Mar 30 19:48:56 2009 -0400
+++ b/src/DLD-FUNCTIONS/fftw.cc	Sat Mar 28 13:57:22 2009 -0700
@@ -40,12 +40,12 @@
 @deftypefnx {Loadable Function} {@var{wisdom} =} fftw ('dwisdom')\n\
 @deftypefnx {Loadable Function} {@var{wisdom} =} fftw ('dwisdom', @var{wisdom})\n\
 \n\
-Manage FFTW wisdom data. Wisdom data can be used to significantly\n\
+Manage FFTW wisdom data.  Wisdom data can be used to significantly\n\
 accelerate the calculation of the FFTs but implies an initial cost\n\
-in its calculation. When the FFTW libraries are initialized, they read\n\
+in its calculation.  When the FFTW libraries are initialized, they read\n\
 a system wide wisdom file (typically in @file{/etc/fftw/wisdom}), allowing wisdom\n\
-to be shared between applications other than Octave. Alternatively, the\n\
-@code{fftw} function can be used to import wisdom. For example\n\
+to be shared between applications other than Octave.  Alternatively, the\n\
+@code{fftw} function can be used to import wisdom.  For example\n\
 \n\
 @example\n\
 @var{wisdom} = fftw ('dwisdom')\n\
@@ -53,7 +53,7 @@
 \n\
 will save the existing wisdom used by Octave to the string @var{wisdom}.\n\
 This string can then be saved to a file and restored using the @code{save}\n\
-and @code{load} commands respectively. This existing wisdom can be reimported\n\
+and @code{load} commands respectively.  This existing wisdom can be reimported\n\
 as follows\n\
 \n\
 @example\n\
@@ -64,14 +64,14 @@
 \n\
 During the calculation of fourier transforms further wisdom is generated.\n\
 The fashion in which this wisdom is generated is equally controlled by\n\
-the @code{fftw} function. There are five different manners in which the\n\
+the @code{fftw} function.  There are five different manners in which the\n\
 wisdom can be treated, these being\n\
 \n\
 @table @asis\n\
 @item 'estimate'\n\
 This specifies that no run-time measurement of the optimal means of\n\
 calculating a particular is performed, and a simple heuristic is used\n\
-to pick a (probably sub-optimal) plan. The advantage of this method is\n\
+to pick a (probably sub-optimal) plan.  The advantage of this method is\n\
 that there is little or no overhead in the generation of the plan, which\n\
 is appropriate for a fourier transform that will be calculated once.\n\
 \n\
@@ -105,9 +105,9 @@
 fftw ('planner', @var{method})\n\
 @end example\n\
 \n\
-Note that calculated wisdom will be lost when restarting Octave. However,\n\
+Note that calculated wisdom will be lost when restarting Octave.  However,\n\
 the wisdom data can be reloaded if it is saved to a file as described\n\
-above. Saved wisdom files should not be used on different platforms since\n\
+above.  Saved wisdom files should not be used on different platforms since\n\
 they will not be efficient and the point of calculating the wisdom is lost.\n\
 @seealso{fft, ifft, fft2, ifft2, fftn, ifftn}\n\
 @end deftypefn")