← Back to branch summary

~ubuntu-branches/ubuntu/raring/scilab/raring-proposed

« back to all changes in this revision

Viewing changes to modules/signal_processing/help/en_US/dft.xml

  • Committer: Package Import Robot
  • Author(s): Sylvestre Ledru
  • Date: 2012-08-30 14:42:38 UTC
  • mfrom: (1.4.7)
  • Revision ID: package-import@ubuntu.com-20120830144238-c1y2og7dbm7m9nig
Tags: 5.4.0-beta-3-1~exp1
* New upstream release
* Update the scirenderer dep
* Get ride of libjhdf5-java dependency

Show diffs side-by-side

added added

removed removed

Lines of Context:
modules/signal_processing/help/en_US/dft.xml
1
 
<?xml version="1.0" encoding="UTF-8"?>
2
 
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" version="5.0-subset Scilab" xml:lang="en" xml:id="dft">
3
 
  <refnamediv>
4
 
    <refname>dft</refname>
5
 
    <refpurpose> discrete Fourier transform</refpurpose>
6
 
  </refnamediv>
7
 
  <refsynopsisdiv>
8
 
    <title>Calling Sequence</title>
9
 
    <synopsis>[xf]=dft(x,flag);</synopsis>
10
 
  </refsynopsisdiv>
11
 
  <refsection>
12
 
    <title>Arguments</title>
13
 
    <variablelist>
14
 
      <varlistentry>
15
 
        <term>x</term>
16
 
        <listitem>
17
 
          <para>input vector</para>
18
 
        </listitem>
19
 
      </varlistentry>
20
 
      <varlistentry>
21
 
        <term>flag</term>
22
 
        <listitem>
23
 
          <para>indicates dft (flag=-1)  or idft (flag=1)</para>
24
 
        </listitem>
25
 
      </varlistentry>
26
 
      <varlistentry>
27
 
        <term>xf</term>
28
 
        <listitem>
29
 
          <para>output vector</para>
30
 
        </listitem>
31
 
      </varlistentry>
32
 
    </variablelist>
33
 
  </refsection>
34
 
  <refsection>
35
 
    <title>Description</title>
36
 
    <para>
37
 
      Function which computes dft of vector <literal>x</literal>.
38
 
    </para>
39
 
  </refsection>
40
 
  <refsection>
41
 
    <title>Examples</title>
42
 
    <programlisting role="example"><![CDATA[ 
43
 
n=8;omega = exp(-2*%pi*%i/n);
44
 
j=0:n-1;F=omega.^(j'*j);  //Fourier matrix
45
 
x=1:8;x=x(:);
46
 
F*x
47
 
fft(x,-1)
48
 
dft(x,-1)
49
 
inv(F)*x
50
 
fft(x,1)
51
 
dft(x,1)
52
 
 ]]></programlisting>
53
 
  </refsection>
54
 
  <refsection role="see also">
55
 
    <title>See Also</title>
56
 
    <simplelist type="inline">
57
 
      <member>
58
 
        <link linkend="fft">fft</link>
59
 
      </member>
60
 
    </simplelist>
61
 
  </refsection>
62
 
</refentry>