Mercurial > octave-antonio

comparison libinterp/dldfcn/fftw.cc @ 20163:075a5e2e1ba5 stable

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: Update more docstrings to have one sentence summary as first line. Reviewed build-aux, libinterp/dldfcn, libinterp/octave-value, libinterp/parse-tree directories. * build-aux/mk-opts.pl, libinterp/dldfcn/__magick_read__.cc, libinterp/dldfcn/amd.cc, libinterp/dldfcn/audiodevinfo.cc, libinterp/dldfcn/audioread.cc, libinterp/dldfcn/ccolamd.cc, libinterp/dldfcn/chol.cc, libinterp/dldfcn/colamd.cc, libinterp/dldfcn/convhulln.cc, libinterp/dldfcn/dmperm.cc, libinterp/dldfcn/fftw.cc, libinterp/dldfcn/qr.cc, libinterp/dldfcn/symbfact.cc, libinterp/dldfcn/symrcm.cc, libinterp/octave-value/ov-base.cc, libinterp/octave-value/ov-bool-mat.cc, libinterp/octave-value/ov-cell.cc, libinterp/octave-value/ov-class.cc, libinterp/octave-value/ov-fcn-handle.cc, libinterp/octave-value/ov-fcn-inline.cc, libinterp/octave-value/ov-java.cc, libinterp/octave-value/ov-null-mat.cc, libinterp/octave-value/ov-oncleanup.cc, libinterp/octave-value/ov-range.cc, libinterp/octave-value/ov-struct.cc, libinterp/octave-value/ov-typeinfo.cc, libinterp/octave-value/ov-usr-fcn.cc, libinterp/octave-value/ov.cc, libinterp/parse-tree/lex.ll, libinterp/parse-tree/oct-parse.in.yy, libinterp/parse-tree/pt-binop.cc, libinterp/parse-tree/pt-eval.cc, libinterp/parse-tree/pt-mat.cc: doc: Update more docstrings to have one sentence summary as first line.
author Rik <rik@octave.org>
date Sun, 03 May 2015 21:52:42 -0700
parents 67f2c76f9f4d
children
comparison
equal deleted inserted replaced
20162:2645f9ef8c88 20163:075a5e2e1ba5
41 @deftypefnx {Loadable Function} {@var{wisdom} =} fftw (\"dwisdom\")\n\ 41 @deftypefnx {Loadable Function} {@var{wisdom} =} fftw (\"dwisdom\")\n\
42 @deftypefnx {Loadable Function} {} fftw (\"dwisdom\", @var{wisdom})\n\ 42 @deftypefnx {Loadable Function} {} fftw (\"dwisdom\", @var{wisdom})\n\
43 @deftypefnx {Loadable Function} {} fftw (\"threads\", @var{nthreads})\n\ 43 @deftypefnx {Loadable Function} {} fftw (\"threads\", @var{nthreads})\n\
44 @deftypefnx {Loadable Function} {@var{nthreads} =} fftw (\"threads\")\n\ 44 @deftypefnx {Loadable Function} {@var{nthreads} =} fftw (\"threads\")\n\
45 \n\ 45 \n\
46 Manage @sc{fftw} wisdom data. Wisdom data can be used to significantly\n\ 46 Manage @sc{fftw} wisdom data.\n\
47 accelerate the calculation of the FFTs, but implies an initial cost\n\ 47 \n\
48 in its calculation. When the @sc{fftw} libraries are initialized, they read\n\ 48 Wisdom data can be used to significantly accelerate the calculation of the\n\
49 a system wide wisdom file (typically in @file{/etc/fftw/wisdom}), allowing\n\ 49 FFTs, but implies an initial cost in its calculation. When the @sc{fftw}\n\
50 wisdom to be shared between applications other than Octave. Alternatively,\n\ 50 libraries are initialized, they read a system wide wisdom file (typically in\n\
51 the @code{fftw} function can be used to import wisdom. For example,\n\ 51 @file{/etc/fftw/wisdom}), allowing wisdom to be shared between applications\n\
52 other than Octave. Alternatively, the @code{fftw} function can be used to\n\
53 import wisdom. For example,\n\
52 \n\ 54 \n\
53 @example\n\ 55 @example\n\
54 @var{wisdom} = fftw (\"dwisdom\")\n\ 56 @var{wisdom} = fftw (\"dwisdom\")\n\
55 @end example\n\ 57 @end example\n\
56 \n\ 58 \n\