← Back to branch summary

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

« back to all changes in this revision

Viewing changes to modules/cacsd/help/en_US/freq.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/cacsd/help/en_US/freq.xml
11
11
 *
12
12
 -->
13
13
<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="freq">
14
 
  <refnamediv>
15
 
    <refname>freq</refname>
16
 
    <refpurpose> frequency response</refpurpose>
17
 
  </refnamediv>
18
 
  <refsynopsisdiv>
19
 
    <title>Calling Sequence</title>
20
 
    <synopsis>[x]=freq(A,B,C [,D],f)
21
 
      [x]=freq(NUM,DEN,f)
22
 
    </synopsis>
23
 
  </refsynopsisdiv>
24
 
  <refsection>
25
 
    <title>Arguments</title>
26
 
    <variablelist>
27
 
      <varlistentry>
28
 
        <term>A, B, C, D</term>
29
 
        <listitem>
30
 
          <para>
31
 
            real matrices of respective dimensions <literal>nxn, nxp, mxn, mxp</literal>.
32
 
          </para>
33
 
        </listitem>
34
 
      </varlistentry>
35
 
      <varlistentry>
36
 
        <term>NUM,DEN</term>
37
 
        <listitem>
38
 
          <para>
39
 
            polynomial matrices of dimension <literal>mxp</literal>
40
 
          </para>
41
 
        </listitem>
42
 
      </varlistentry>
43
 
      <varlistentry>
44
 
        <term>x</term>
45
 
        <listitem>
46
 
          <para>real or complex matrix</para>
47
 
        </listitem>
48
 
      </varlistentry>
49
 
    </variablelist>
50
 
  </refsection>
51
 
  <refsection>
52
 
    <title>Description</title>
53
 
    <para>
54
 
      <literal>x=freq(A,B,C [,D],f)</literal> returns a real or complex <literal>mxp*t</literal> matrix
55
 
      such that:
56
 
    </para>
57
 
    <para>
58
 
      <literal>x(:,k*p:(k+1)*p)= C*inv(f(k)*eye()-A)*B + D</literal>.
59
 
    </para>
60
 
    <para>
61
 
      Thus, for <literal>f</literal> taking values along the imaginary axis or
62
 
      on the unit circle <literal>x</literal> is the continuous or discrete time 
63
 
      frequency response of <literal>(A,B,C,D)</literal>.
64
 
    </para>
65
 
    <para>
66
 
      <literal>x=freq(NUM,DEN,f)</literal> returns a real or complex matrix <literal>x</literal> such
67
 
      that columns <literal>k*(p-1)+1</literal> to <literal>k*p</literal> of <literal>x</literal> contain the matrix  
68
 
      <literal>NUM(f(k))./DEN(f(k))</literal>
69
 
    </para>
70
 
  </refsection>
71
 
  <refsection>
72
 
    <title>Examples</title>
73
 
    <programlisting role="example"><![CDATA[ 
 
14
    <refnamediv>
 
15
        <refname>freq</refname>
 
16
        <refpurpose> frequency response</refpurpose>
 
17
    </refnamediv>
 
18
    <refsynopsisdiv>
 
19
        <title>Calling Sequence</title>
 
20
        <synopsis>[x]=freq(A,B,C [,D],f)
 
21
            [x]=freq(NUM,DEN,f)
 
22
        </synopsis>
 
23
    </refsynopsisdiv>
 
24
    <refsection>
 
25
        <title>Arguments</title>
 
26
        <variablelist>
 
27
            <varlistentry>
 
28
                <term>A, B, C, D</term>
 
29
                <listitem>
 
30
                    <para>
 
31
                        real matrices of respective dimensions <literal>nxn, nxp, mxn, mxp</literal>.
 
32
                    </para>
 
33
                </listitem>
 
34
            </varlistentry>
 
35
            <varlistentry>
 
36
                <term>NUM,DEN</term>
 
37
                <listitem>
 
38
                    <para>
 
39
                        polynomial matrices of dimension <literal>mxp</literal>
 
40
                    </para>
 
41
                </listitem>
 
42
            </varlistentry>
 
43
            <varlistentry>
 
44
                <term>x</term>
 
45
                <listitem>
 
46
                    <para>real or complex matrix</para>
 
47
                </listitem>
 
48
            </varlistentry>
 
49
        </variablelist>
 
50
    </refsection>
 
51
    <refsection>
 
52
        <title>Description</title>
 
53
        <para>
 
54
            <literal>x=freq(A,B,C [,D],f)</literal> returns a real or complex <literal>mxp*t</literal> matrix
 
55
            such that:
 
56
        </para>
 
57
        <para>
 
58
            <literal>x(:,k*p:(k+1)*p)= C*inv(f(k)*eye()-A)*B + D</literal>.
 
59
        </para>
 
60
        <para>
 
61
            Thus, for <literal>f</literal> taking values along the imaginary axis or
 
62
            on the unit circle <literal>x</literal> is the continuous or discrete time 
 
63
            frequency response of <literal>(A,B,C,D)</literal>.
 
64
        </para>
 
65
        <para>
 
66
            <literal>x=freq(NUM,DEN,f)</literal> returns a real or complex matrix <literal>x</literal> such
 
67
            that columns <literal>k*(p-1)+1</literal> to <literal>k*p</literal> of <literal>x</literal> contain the matrix  
 
68
            <literal>NUM(f(k))./DEN(f(k))</literal>
 
69
        </para>
 
70
    </refsection>
 
71
    <refsection>
 
72
        <title>Examples</title>
 
73
        <programlisting role="example"><![CDATA[ 
74
74
s=poly(0,'s');
75
75
sys=(s+1)/(s^3-5*s+4)
76
76
rep=freq(sys("num"),sys("den"),[0,0.9,1.1,2,3,10,20])
80
80
[A,B,C,D]=abcd(Sys);
81
81
freq(A,B,C,[0,0.9,1.1,2,3,10,20])
82
82
 ]]></programlisting>
83
 
  </refsection>
84
 
  <refsection role="see also">
85
 
    <title>See Also</title>
86
 
    <simplelist type="inline">
87
 
      <member>
88
 
        <link linkend="repfreq">repfreq</link>
89
 
      </member>
90
 
      <member>
91
 
        <link linkend="horner">horner</link>
92
 
      </member>
93
 
    </simplelist>
94
 
  </refsection>
 
83
    </refsection>
 
84
    <refsection role="see also">
 
85
        <title>See Also</title>
 
86
        <simplelist type="inline">
 
87
            <member>
 
88
                <link linkend="repfreq">repfreq</link>
 
89
            </member>
 
90
            <member>
 
91
                <link linkend="horner">horner</link>
 
92
            </member>
 
93
        </simplelist>
 
94
    </refsection>
95
95
</refentry>