diff options
Diffstat (limited to 'help/en_US/fftconv.xml')
-rw-r--r-- | help/en_US/fftconv.xml | 55 |
1 files changed, 55 insertions, 0 deletions
diff --git a/help/en_US/fftconv.xml b/help/en_US/fftconv.xml new file mode 100644 index 0000000..8748aec --- /dev/null +++ b/help/en_US/fftconv.xml @@ -0,0 +1,55 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * + * This help file was generated from fftconv.sci using help_from_sci(). + * + --> + +<refentry version="5.0-subset Scilab" xml:id="fftconv" xml:lang="en" + xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:svg="http://www.w3.org/2000/svg" + xmlns:ns3="http://www.w3.org/1999/xhtml" + xmlns:mml="http://www.w3.org/1998/Math/MathML" + xmlns:scilab="http://www.scilab.org" + xmlns:db="http://docbook.org/ns/docbook"> + + <refnamediv> + <refname>fftconv</refname> + <refpurpose>Convolve two vectors using the FFT for computation.</refpurpose> + </refnamediv> + + +<refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis> + Y = fftconv(X, Y) + Y = fftconv(X, Y, N) + </synopsis> +</refsynopsisdiv> + +<refsection> + <title>Parameters</title> + <variablelist> + <varlistentry><term>X, Y:</term> + <listitem><para> Vectors</para></listitem></varlistentry> + </variablelist> +</refsection> + +<refsection> + <title>Description</title> + <para> +Convolve two vectors using the FFT for computation. 'c' = fftconv (X, Y)' returns a vector of length equal to 'length(X) + length (Y) - 1'. If X and Y are the coefficient vectors of two polynomials, the returned value is the coefficient vector of the product polynomial. +</para> +</refsection> + +<refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +fftconv([1,2,3], [3,4,5]) +ans = +3. 10. 22. 22. 15. + ]]></programlisting> +</refsection> +</refentry> |