changeset 8426:7523742aa026

Add explanation on what wisdom is.
author Francesco Potortì <pot@gnu.org>
date Fri, 26 Dec 2008 20:33:52 +0100
parents 2e777f5135a3
children 26b899d309f6
files doc/ChangeLog doc/interpreter/signal.txi
diffstat 2 files changed, 17 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/doc/ChangeLog	Thu Dec 25 12:31:07 2008 +0100
+++ b/doc/ChangeLog	Fri Dec 26 20:33:52 2008 +0100
@@ -1,3 +1,8 @@
+2008-12-26  Francesco Potortì  <pot@gnu.org>
+
+       * interpreter/signal.txi (Signal Processing): Add explanation of
+       what wisdom is.
+
 2008-12-23  David Bateman  <dbateman@free.fr>
 
 	* interpreter/sparse.txi: Document the eigs and svds functions.
--- a/doc/interpreter/signal.txi	Thu Dec 25 12:31:07 2008 +0100
+++ b/doc/interpreter/signal.txi	Fri Dec 26 20:33:52 2008 +0100
@@ -23,6 +23,18 @@
 
 @DOCSTRING(fft)
 
+Octave uses the FFTW libraries to perform FFT computations. When Octave
+starts up and initializes the FFTW libraries, they read a system wide
+file (on a Unix system, it is typically @file{/etc/fftw/wisdom}) that
+contains information useful to speed up FFT computations.  This
+information is called the @emph{wisdom}.  The system-wide file allows
+wisdom to be shared between all applications using the FFTW libraries.
+
+Use the @code{fftw} function to generate and save wisdom.  Using the
+utilities provided together with the FFTW libraries
+(@command{fftw-wisdom} on Unix systems), you can even add wisdom
+generated by Octave to the system-wide wisdom file.
+
 @DOCSTRING(fftw)
 
 @DOCSTRING(ifft)