← 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/findAC.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/findAC.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="findAC">
14
 
  <refnamediv>
15
 
    <refname>findAC</refname>
16
 
    <refpurpose> discrete-time system subspace identification</refpurpose>
17
 
  </refnamediv>
18
 
  <refsynopsisdiv>
19
 
    <title>Calling Sequence</title>
20
 
    <synopsis>[A,C] = findAC(S,N,L,R,METH,TOL,PRINTW)
21
 
      [A,C,RCND] = findAC(S,N,L,R,METH,TOL,PRINTW)
22
 
    </synopsis>
23
 
  </refsynopsisdiv>
24
 
  <refsection>
25
 
    <title>Arguments</title>
26
 
    <variablelist>
27
 
      <varlistentry>
28
 
        <term>S</term>
29
 
        <listitem>
30
 
          <para>integer, the number of block rows in the block-Hankel matrices</para>
31
 
        </listitem>
32
 
      </varlistentry>
33
 
      <varlistentry>
34
 
        <term>N</term>
35
 
        <listitem>
36
 
          <para>integer</para>
37
 
        </listitem>
38
 
      </varlistentry>
39
 
      <varlistentry>
40
 
        <term>L</term>
41
 
        <listitem>
42
 
          <para>integer</para>
43
 
        </listitem>
44
 
      </varlistentry>
45
 
      <varlistentry>
46
 
        <term>R</term>
47
 
        <listitem>
48
 
          <para>matrix, relevant part of the  R factor of the concatenated block-Hankel matrices computed by a call to findr.</para>
49
 
        </listitem>
50
 
      </varlistentry>
51
 
      <varlistentry>
52
 
        <term>METH</term>
53
 
        <listitem>
54
 
          <para>integer, an option for the method to use</para>
55
 
          <variablelist>
56
 
            <varlistentry>
57
 
              <term>= 1</term>
58
 
              <listitem>
59
 
                <para> MOESP method with past inputs and outputs;</para>
60
 
              </listitem>
61
 
            </varlistentry>
62
 
            <varlistentry>
63
 
              <term>= 2</term>
64
 
              <listitem>
65
 
                <para> N4SID method;</para>
66
 
              </listitem>
67
 
            </varlistentry>
68
 
          </variablelist>
69
 
          <para>
70
 
            Default:    METH = 3.
71
 
          </para>
72
 
        </listitem>
73
 
      </varlistentry>
74
 
      <varlistentry>
75
 
        <term>TOL</term>
76
 
        <listitem>
77
 
          <para>the tolerance used for estimating the rank of matrices.  If  TOL &gt; 0,  then the given value of  TOL  is used as a lower bound for the reciprocal condition number. Default: prod(size(matrix))*epsilon_machine where epsilon_machine is the relative machine precision.</para>
78
 
        </listitem>
79
 
      </varlistentry>
80
 
      <varlistentry>
81
 
        <term>PRINTW</term>
82
 
        <listitem>
83
 
          <para>integer, switch for printing the warning messages.</para>
84
 
          <variablelist>
85
 
            <varlistentry>
86
 
              <term>PRINTW</term>
87
 
              <listitem>
88
 
                <para>= 1: print warning messages;</para>
89
 
              </listitem>
90
 
            </varlistentry>
91
 
            <varlistentry>
92
 
              <term>= 0</term>
93
 
              <listitem>
94
 
                <para>do not print warning messages.</para>
95
 
              </listitem>
96
 
            </varlistentry>
97
 
          </variablelist>
98
 
          <para>
99
 
            Default:    PRINTW = 0.
100
 
          </para>
101
 
        </listitem>
102
 
      </varlistentry>
103
 
      <varlistentry>
104
 
        <term>A</term>
105
 
        <listitem>
106
 
          <para>matrix, state system matrix</para>
107
 
        </listitem>
108
 
      </varlistentry>
109
 
      <varlistentry>
110
 
        <term>C</term>
111
 
        <listitem>
112
 
          <para>matrix, output system matrix</para>
113
 
        </listitem>
114
 
      </varlistentry>
115
 
      <varlistentry>
116
 
        <term>RCND</term>
117
 
        <listitem>
118
 
          <para>vector of length 4,  condition numbers of the matrices involved in rank decision</para>
119
 
        </listitem>
120
 
      </varlistentry>
121
 
    </variablelist>
122
 
  </refsection>
123
 
  <refsection>
124
 
    <title>Description</title>
125
 
    <para>
126
 
      finds the system matrices A and C of a discrete-time system, given the
127
 
      system order and the relevant part of the R factor of the concatenated
128
 
      block-Hankel matrices, using subspace identification techniques (MOESP 
129
 
      or N4SID).
130
 
    </para>
131
 
    <itemizedlist>
132
 
      <listitem>
133
 
        <para>[A,C] = findAC(S,N,L,R,METH,TOL,PRINTW)  computes the system matrices A and C. The model structure is:       x(k+1) = Ax(k) + Bu(k) + Ke(k),   k &gt;= 1,      y(k)   = Cx(k) + Du(k) + e(k),  where x(k) and y(k) are vectors of length N and L, respectively.</para>
134
 
      </listitem>
135
 
      <listitem>
136
 
        <para>[A,C,RCND] = findAC(S,N,L,R,METH,TOL,PRINTW)  also returns the vector RCND of length 4 containing the condition numbers of the matrices involved in rank decisions.</para>
137
 
      </listitem>
138
 
    </itemizedlist>
139
 
    <para>
140
 
      Matrix R, computed by findR, should be determined with suitable arguments
141
 
      METH and JOBD.
142
 
    </para>
143
 
  </refsection>
144
 
  <refsection>
145
 
    <title>Examples</title>
146
 
    <programlisting role="example"><![CDATA[ 
 
14
    <refnamediv>
 
15
        <refname>findAC</refname>
 
16
        <refpurpose> discrete-time system subspace identification</refpurpose>
 
17
    </refnamediv>
 
18
    <refsynopsisdiv>
 
19
        <title>Calling Sequence</title>
 
20
        <synopsis>[A,C] = findAC(S,N,L,R,METH,TOL,PRINTW)
 
21
            [A,C,RCND] = findAC(S,N,L,R,METH,TOL,PRINTW)
 
22
        </synopsis>
 
23
    </refsynopsisdiv>
 
24
    <refsection>
 
25
        <title>Arguments</title>
 
26
        <variablelist>
 
27
            <varlistentry>
 
28
                <term>S</term>
 
29
                <listitem>
 
30
                    <para>integer, the number of block rows in the block-Hankel matrices</para>
 
31
                </listitem>
 
32
            </varlistentry>
 
33
            <varlistentry>
 
34
                <term>N</term>
 
35
                <listitem>
 
36
                    <para>integer</para>
 
37
                </listitem>
 
38
            </varlistentry>
 
39
            <varlistentry>
 
40
                <term>L</term>
 
41
                <listitem>
 
42
                    <para>integer</para>
 
43
                </listitem>
 
44
            </varlistentry>
 
45
            <varlistentry>
 
46
                <term>R</term>
 
47
                <listitem>
 
48
                    <para>matrix, relevant part of the  R factor of the concatenated block-Hankel matrices computed by a call to findr.</para>
 
49
                </listitem>
 
50
            </varlistentry>
 
51
            <varlistentry>
 
52
                <term>METH</term>
 
53
                <listitem>
 
54
                    <para>integer, an option for the method to use</para>
 
55
                    <variablelist>
 
56
                        <varlistentry>
 
57
                            <term>= 1</term>
 
58
                            <listitem>
 
59
                                <para> MOESP method with past inputs and outputs;</para>
 
60
                            </listitem>
 
61
                        </varlistentry>
 
62
                        <varlistentry>
 
63
                            <term>= 2</term>
 
64
                            <listitem>
 
65
                                <para> N4SID method;</para>
 
66
                            </listitem>
 
67
                        </varlistentry>
 
68
                    </variablelist>
 
69
                    <para>
 
70
                        Default:    METH = 3.
 
71
                    </para>
 
72
                </listitem>
 
73
            </varlistentry>
 
74
            <varlistentry>
 
75
                <term>TOL</term>
 
76
                <listitem>
 
77
                    <para>the tolerance used for estimating the rank of matrices.  If  TOL &gt; 0,  then the given value of  TOL  is used as a lower bound for the reciprocal condition number. Default: prod(size(matrix))*epsilon_machine where epsilon_machine is the relative machine precision.</para>
 
78
                </listitem>
 
79
            </varlistentry>
 
80
            <varlistentry>
 
81
                <term>PRINTW</term>
 
82
                <listitem>
 
83
                    <para>integer, switch for printing the warning messages.</para>
 
84
                    <variablelist>
 
85
                        <varlistentry>
 
86
                            <term>PRINTW</term>
 
87
                            <listitem>
 
88
                                <para>= 1: print warning messages;</para>
 
89
                            </listitem>
 
90
                        </varlistentry>
 
91
                        <varlistentry>
 
92
                            <term>= 0</term>
 
93
                            <listitem>
 
94
                                <para>do not print warning messages.</para>
 
95
                            </listitem>
 
96
                        </varlistentry>
 
97
                    </variablelist>
 
98
                    <para>
 
99
                        Default:    PRINTW = 0.
 
100
                    </para>
 
101
                </listitem>
 
102
            </varlistentry>
 
103
            <varlistentry>
 
104
                <term>A</term>
 
105
                <listitem>
 
106
                    <para>matrix, state system matrix</para>
 
107
                </listitem>
 
108
            </varlistentry>
 
109
            <varlistentry>
 
110
                <term>C</term>
 
111
                <listitem>
 
112
                    <para>matrix, output system matrix</para>
 
113
                </listitem>
 
114
            </varlistentry>
 
115
            <varlistentry>
 
116
                <term>RCND</term>
 
117
                <listitem>
 
118
                    <para>vector of length 4,  condition numbers of the matrices involved in rank decision</para>
 
119
                </listitem>
 
120
            </varlistentry>
 
121
        </variablelist>
 
122
    </refsection>
 
123
    <refsection>
 
124
        <title>Description</title>
 
125
        <para>
 
126
            finds the system matrices A and C of a discrete-time system, given the
 
127
            system order and the relevant part of the R factor of the concatenated
 
128
            block-Hankel matrices, using subspace identification techniques (MOESP 
 
129
            or N4SID).
 
130
        </para>
 
131
        <itemizedlist>
 
132
            <listitem>
 
133
                <para>[A,C] = findAC(S,N,L,R,METH,TOL,PRINTW)  computes the system matrices A and C. The model structure is:       x(k+1) = Ax(k) + Bu(k) + Ke(k),   k &gt;= 1,      y(k)   = Cx(k) + Du(k) + e(k),  where x(k) and y(k) are vectors of length N and L, respectively.</para>
 
134
            </listitem>
 
135
            <listitem>
 
136
                <para>[A,C,RCND] = findAC(S,N,L,R,METH,TOL,PRINTW)  also returns the vector RCND of length 4 containing the condition numbers of the matrices involved in rank decisions.</para>
 
137
            </listitem>
 
138
        </itemizedlist>
 
139
        <para>
 
140
            Matrix R, computed by findR, should be determined with suitable arguments
 
141
            METH and JOBD.
 
142
        </para>
 
143
    </refsection>
 
144
    <refsection>
 
145
        <title>Examples</title>
 
146
        <programlisting role="example"><![CDATA[ 
147
147
//generate data from a given linear system
148
148
A = [ 0.5, 0.1,-0.1, 0.2;
149
149
      0.1, 0,  -0.1,-0.1;      
164
164
METH=3;TOL=-1;
165
165
[A,C] = findAC(S,N,L,R,METH,TOL);
166
166
 ]]></programlisting>
167
 
  </refsection>
168
 
  <refsection role="see also">
169
 
    <title>See Also</title>
170
 
    <simplelist type="inline">
171
 
      <member>
172
 
        <link linkend="findABCD">findABCD</link>
173
 
      </member>
174
 
      <member>
175
 
        <link linkend="findBD">findBD</link>
176
 
      </member>
177
 
      <member>
178
 
        <link linkend="findBDK">findBDK</link>
179
 
      </member>
180
 
      <member>
181
 
        <link linkend="findR">findR</link>
182
 
      </member>
183
 
      <member>
184
 
        <link linkend="sorder">sorder</link>
185
 
      </member>
186
 
      <member>
187
 
        <link linkend="sident">sident</link>
188
 
      </member>
189
 
    </simplelist>
190
 
  </refsection>
 
167
    </refsection>
 
168
    <refsection role="see also">
 
169
        <title>See Also</title>
 
170
        <simplelist type="inline">
 
171
            <member>
 
172
                <link linkend="findABCD">findABCD</link>
 
173
            </member>
 
174
            <member>
 
175
                <link linkend="findBD">findBD</link>
 
176
            </member>
 
177
            <member>
 
178
                <link linkend="findBDK">findBDK</link>
 
179
            </member>
 
180
            <member>
 
181
                <link linkend="findR">findR</link>
 
182
            </member>
 
183
            <member>
 
184
                <link linkend="sorder">sorder</link>
 
185
            </member>
 
186
            <member>
 
187
                <link linkend="sident">sident</link>
 
188
            </member>
 
189
        </simplelist>
 
190
    </refsection>
191
191
</refentry>