Mercurial > octave-nkf
diff src/DLD-FUNCTIONS/fftw.cc @ 14361:8de863b7126b
doc: Use Octave preference for double quote in docstrings in all .cc files
* cellfun.cc, chol.cc, colamd.cc, dlmread.cc, eigs.cc, fftw.cc, lu.cc,
luinc.cc, matrix_type.cc, spparms.cc, symrcm.cc, data.cc, dirfns.cc, error.cc:
Use Octave preference for double quote in docstrings.
author | Rik <octave@nomad.inbox5.com> |
---|---|
date | Mon, 13 Feb 2012 07:45:41 -0800 |
parents | 97883071e8e4 |
children | 460a3c6d8bf1 |
line wrap: on
line diff
--- a/src/DLD-FUNCTIONS/fftw.cc Mon Feb 13 07:42:56 2012 -0800 +++ b/src/DLD-FUNCTIONS/fftw.cc Mon Feb 13 07:45:41 2012 -0800 @@ -34,10 +34,10 @@ DEFUN_DLD (fftw, args, , "-*- texinfo -*-\n\ -@deftypefn {Loadable Function} {@var{method} =} fftw ('planner')\n\ -@deftypefnx {Loadable Function} {} fftw ('planner', @var{method})\n\ -@deftypefnx {Loadable Function} {@var{wisdom} =} fftw ('dwisdom')\n\ -@deftypefnx {Loadable Function} {} fftw ('dwisdom', @var{wisdom})\n\ +@deftypefn {Loadable Function} {@var{method} =} fftw (\"planner\")\n\ +@deftypefnx {Loadable Function} {} fftw (\"planner\", @var{method})\n\ +@deftypefnx {Loadable Function} {@var{wisdom} =} fftw (\"dwisdom\")\n\ +@deftypefnx {Loadable Function} {} fftw (\"dwisdom\", @var{wisdom})\n\ \n\ Manage @sc{fftw} wisdom data. Wisdom data can be used to significantly\n\ accelerate the calculation of the FFTs, but implies an initial cost\n\ @@ -68,31 +68,31 @@ wisdom can be treated:\n\ \n\ @table @asis\n\ -@item 'estimate'\n\ +@item \"estimate\"\n\ 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\ 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\ -@item 'measure'\n\ +@item \"measure\"\n\ In this case a range of algorithms to perform the transform is considered\n\ and the best is selected based on their execution time.\n\ \n\ -@item 'patient'\n\ -Similar to 'measure', but a wider range of algorithms is considered.\n\ +@item \"patient\"\n\ +Similar to \"measure\", but a wider range of algorithms is considered.\n\ \n\ -@item 'exhaustive'\n\ -Like 'measure', but all possible algorithms that may be used to\n\ +@item \"exhaustive\"\n\ +Like \"measure\", but all possible algorithms that may be used to\n\ treat the transform are considered.\n\ \n\ -@item 'hybrid'\n\ +@item \"hybrid\"\n\ As run-time measurement of the algorithm can be expensive, this is a\n\ -compromise where 'measure' is used for transforms up to the size of 8192\n\ -and beyond that the 'estimate' method is used.\n\ +compromise where \"measure\" is used for transforms up to the size of 8192\n\ +and beyond that the \"estimate\" method is used.\n\ @end table\n\ \n\ -The default method is 'estimate'. The current method can\n\ +The default method is \"estimate\". The current method can\n\ be queried with\n\ \n\ @example\n\