← 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/sensi.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/sensi.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="sensi">
14
 
  <refnamediv>
15
 
    <refname>sensi</refname>
16
 
    <refpurpose> sensitivity functions</refpurpose>
17
 
  </refnamediv>
18
 
  <refsynopsisdiv>
19
 
    <title>Calling Sequence</title>
20
 
    <synopsis>[Se,Re,Te]=sensi(G,K)
21
 
      [Si,Ri,Ti]=sensi(G,K,flag)
22
 
    </synopsis>
23
 
  </refsynopsisdiv>
24
 
  <refsection>
25
 
    <title>Arguments</title>
26
 
    <variablelist>
27
 
      <varlistentry>
28
 
        <term>G</term>
29
 
        <listitem>
30
 
          <para>
31
 
            standard plant (<literal>syslin</literal> list)
32
 
          </para>
33
 
        </listitem>
34
 
      </varlistentry>
35
 
      <varlistentry>
36
 
        <term>K</term>
37
 
        <listitem>
38
 
          <para>
39
 
            compensator (<literal>syslin</literal> list)
40
 
          </para>
41
 
        </listitem>
42
 
      </varlistentry>
43
 
      <varlistentry>
44
 
        <term>flag</term>
45
 
        <listitem>
46
 
          <para>
47
 
            character string <literal>'o'</literal> (default value) or <literal>'i'</literal>
48
 
          </para>
49
 
        </listitem>
50
 
      </varlistentry>
51
 
      <varlistentry>
52
 
        <term>Se</term>
53
 
        <listitem>
54
 
          <para>
55
 
            output sensitivity function <literal>(I+G*K)^-1</literal>
56
 
          </para>
57
 
        </listitem>
58
 
      </varlistentry>
59
 
      <varlistentry>
60
 
        <term>Re</term>
61
 
        <listitem>
62
 
          <para>
63
 
            <literal>K*Se</literal>
64
 
          </para>
65
 
        </listitem>
66
 
      </varlistentry>
67
 
      <varlistentry>
68
 
        <term>Te</term>
69
 
        <listitem>
70
 
          <para>
71
 
            <literal>G*K*Se</literal> (output complementary sensitivity function)
72
 
          </para>
73
 
        </listitem>
74
 
      </varlistentry>
75
 
    </variablelist>
76
 
  </refsection>
77
 
  <refsection>
78
 
    <title>Description</title>
79
 
    <para>
80
 
      <literal>sensi</literal> computes sensitivity functions. If <literal>G</literal> and <literal>K</literal> are
81
 
      given in state-space form, the systems returned are generically minimal. 
82
 
      Calculation is made by <literal>lft</literal>, e.g., 
83
 
      <literal>Se</literal> can be given by the commands 
84
 
      <literal> P = augment(G,'S')</literal>, <literal>Se=lft(P,K)</literal>.
85
 
      If <literal>flag</literal> = <literal>'i'</literal>, <literal>[Si,Ri,Ti]=sensi(G,K,'i')</literal>
86
 
      returns the input sensitivity functions.
87
 
    </para>
88
 
    <programlisting role=""><![CDATA[ 
 
14
    <refnamediv>
 
15
        <refname>sensi</refname>
 
16
        <refpurpose> sensitivity functions</refpurpose>
 
17
    </refnamediv>
 
18
    <refsynopsisdiv>
 
19
        <title>Calling Sequence</title>
 
20
        <synopsis>[Se,Re,Te]=sensi(G,K)
 
21
            [Si,Ri,Ti]=sensi(G,K,flag)
 
22
        </synopsis>
 
23
    </refsynopsisdiv>
 
24
    <refsection>
 
25
        <title>Arguments</title>
 
26
        <variablelist>
 
27
            <varlistentry>
 
28
                <term>G</term>
 
29
                <listitem>
 
30
                    <para>
 
31
                        standard plant (<literal>syslin</literal> list)
 
32
                    </para>
 
33
                </listitem>
 
34
            </varlistentry>
 
35
            <varlistentry>
 
36
                <term>K</term>
 
37
                <listitem>
 
38
                    <para>
 
39
                        compensator (<literal>syslin</literal> list)
 
40
                    </para>
 
41
                </listitem>
 
42
            </varlistentry>
 
43
            <varlistentry>
 
44
                <term>flag</term>
 
45
                <listitem>
 
46
                    <para>
 
47
                        character string <literal>'o'</literal> (default value) or <literal>'i'</literal>
 
48
                    </para>
 
49
                </listitem>
 
50
            </varlistentry>
 
51
            <varlistentry>
 
52
                <term>Se</term>
 
53
                <listitem>
 
54
                    <para>
 
55
                        output sensitivity function <literal>(I+G*K)^-1</literal>
 
56
                    </para>
 
57
                </listitem>
 
58
            </varlistentry>
 
59
            <varlistentry>
 
60
                <term>Re</term>
 
61
                <listitem>
 
62
                    <para>
 
63
                        <literal>K*Se</literal>
 
64
                    </para>
 
65
                </listitem>
 
66
            </varlistentry>
 
67
            <varlistentry>
 
68
                <term>Te</term>
 
69
                <listitem>
 
70
                    <para>
 
71
                        <literal>G*K*Se</literal> (output complementary sensitivity function)
 
72
                    </para>
 
73
                </listitem>
 
74
            </varlistentry>
 
75
        </variablelist>
 
76
    </refsection>
 
77
    <refsection>
 
78
        <title>Description</title>
 
79
        <para>
 
80
            <literal>sensi</literal> computes sensitivity functions. If <literal>G</literal> and <literal>K</literal> are
 
81
            given in state-space form, the systems returned are generically minimal. 
 
82
            Calculation is made by <literal>lft</literal>, e.g., 
 
83
            <literal>Se</literal> can be given by the commands 
 
84
            <literal> P = augment(G,'S')</literal>, <literal>Se=lft(P,K)</literal>.
 
85
            If <literal>flag</literal> = <literal>'i'</literal>, <literal>[Si,Ri,Ti]=sensi(G,K,'i')</literal>
 
86
            returns the input sensitivity functions.
 
87
        </para>
 
88
        <programlisting role=""><![CDATA[ 
89
89
[Se;Re;Te]= [inv(eye()+G*K);K*inv(eye()+G*K);G*K*inv(eye()+G*K)];
90
90
[Si;Ri;Ti]= [inv(eye()+K*G);G*inv(eye()+K*G);K*G*inv(eye()+K*G)];
91
91
 ]]></programlisting>
92
 
  </refsection>
93
 
  <refsection>
94
 
    <title>Examples</title>
95
 
    <programlisting role="example"><![CDATA[ 
 
92
    </refsection>
 
93
    <refsection>
 
94
        <title>Examples</title>
 
95
        <programlisting role="example"><![CDATA[ 
96
96
G=ssrand(1,1,3);K=ssrand(1,1,3);
97
97
[Se,Re,Te]=sensi(G,K);
98
98
Se1=inv(eye()+G*K);  //Other way to compute
105
105
w2=[ss2tf(inv(eye()+K*G));ss2tf(G*inv(eye()+K*G));ss2tf(K*G*inv(eye()+K*G))];
106
106
clean(w1-w2)
107
107
 ]]></programlisting>
108
 
  </refsection>
109
 
  <refsection role="see also">
110
 
    <title>See Also</title>
111
 
    <simplelist type="inline">
112
 
      <member>
113
 
        <link linkend="augment">augment</link>
114
 
      </member>
115
 
      <member>
116
 
        <link linkend="lft">lft</link>
117
 
      </member>
118
 
      <member>
119
 
        <link linkend="h_cl">h_cl</link>
120
 
      </member>
121
 
    </simplelist>
122
 
  </refsection>
 
108
    </refsection>
 
109
    <refsection role="see also">
 
110
        <title>See Also</title>
 
111
        <simplelist type="inline">
 
112
            <member>
 
113
                <link linkend="augment">augment</link>
 
114
            </member>
 
115
            <member>
 
116
                <link linkend="lft">lft</link>
 
117
            </member>
 
118
            <member>
 
119
                <link linkend="h_cl">h_cl</link>
 
120
            </member>
 
121
        </simplelist>
 
122
    </refsection>
123
123
</refentry>