Mercurial > octave-nkf
diff scripts/signal/fftconv.m @ 11085:2beacd515e09
Update docstrings for convolution family of functions (conv, conv2, fftconv)
author | Rik <octave@nomad.inbox5.com> |
---|---|
date | Thu, 07 Oct 2010 11:27:03 -0700 |
parents | a1dbe9d80eee |
children | e79f59d31a74 |
line wrap: on
line diff
--- a/scripts/signal/fftconv.m Thu Oct 07 03:18:44 2010 -0400 +++ b/scripts/signal/fftconv.m Thu Oct 07 11:27:03 2010 -0700 @@ -18,14 +18,18 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} fftconv (@var{a}, @var{b}, @var{n}) -## Return the convolution of the vectors @var{a} and @var{b}, as a vector -## with length equal to the @code{length (a) + length (b) - 1}. If @var{a} -## and @var{b} are the coefficient vectors of two polynomials, the returned -## value is the coefficient vector of the product polynomial. +## @deftypefn {Function File} {} fftconv (@var{a}, @var{b}) +## @deftypefnx {Function File} {} fftconv (@var{a}, @var{b}, @var{n}) +## Convolve two vectors using the FFT for computation. +## +## @code{c = fftconv (@var{a}, @var{b})} returns a vector of length equal to +## @code{length (@var{a}) + length (@var{b}) - 1}. +## If @var{a} and @var{b} are the coefficient vectors of two polynomials, the +## returned value is the coefficient vector of the product polynomial. ## ## The computation uses the FFT by calling the function @code{fftfilt}. If ## the optional argument @var{n} is specified, an N-point FFT is used. +## @seealso{deconv, conv, conv2} ## @end deftypefn ## Author: KH <Kurt.Hornik@wu-wien.ac.at> @@ -39,7 +43,7 @@ endif if (! (isvector (a) && isvector (b))) - error ("fftconv: both a and b should be vectors"); + error ("fftconv: both A and B must be vectors"); endif la = length (a); lb = length (b); @@ -53,10 +57,12 @@ c = fftfilt (a, b); else if (! (isscalar (N))) - error ("fftconv: N has to be a scalar"); + error ("fftconv: N must be a scalar"); endif c = fftfilt (a, b, N); endif endif endfunction + +%% FIXME: Borrow tests from conv.m. May need a tolerance on the assert comparison