d06696c814e85696691c192debb64225510d82e9
[scilab.git] / scilab / modules / cacsd / help / en_US / inistate.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!--
3  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
4  * Copyright (C) INRIA - 
5  * 
6  * This file must be used under the terms of the CeCILL.
7  * This source file is licensed as described in the file COPYING, which
8  * you should have received as part of this distribution.  The terms
9  * are also available at    
10  * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
11  *
12  -->
13 <refentry version="5.0-subset Scilab" xml:id="inistate" xml:lang="en"
14           xmlns="http://docbook.org/ns/docbook"
15           xmlns:xlink="http://www.w3.org/1999/xlink"
16           xmlns:svg="http://www.w3.org/2000/svg"
17           xmlns:ns4="http://www.w3.org/1999/xhtml"
18           xmlns:mml="http://www.w3.org/1998/Math/MathML"
19           xmlns:db="http://docbook.org/ns/docbook">
20   <info>
21     <pubdate>$LastChangedDate$</pubdate>
22   </info>
23
24   <refnamediv>
25     <refname>inistate</refname>
26
27     <refpurpose>Estimates the initial state of a discrete-time
28     system</refpurpose>
29   </refnamediv>
30
31   <refsynopsisdiv>
32     <title>Calling Sequence</title>
33
34     <synopsis>X0 = inistate(SYS,Y,U,TOL,PRINTW)
35 X0 = inistate(A,B,C,Y,U);
36 X0 = inistate(A,C,Y);
37
38 [x0,V,rcnd] = inistate(SYS,Y,U,TOL,PRINTW)</synopsis>
39   </refsynopsisdiv>
40
41   <refsection>
42     <title>Parameters</title>
43
44     <variablelist>
45       <varlistentry>
46         <term>SYS</term>
47
48         <listitem>
49           <para>given system, syslin(dt,A,B,C,D)</para>
50         </listitem>
51       </varlistentry>
52
53       <varlistentry>
54         <term>Y</term>
55
56         <listitem>
57           <para>the output of the system</para>
58         </listitem>
59       </varlistentry>
60
61       <varlistentry>
62         <term>U</term>
63
64         <listitem>
65           <para>the input of the system</para>
66         </listitem>
67       </varlistentry>
68
69       <varlistentry>
70         <term>TOL</term>
71
72         <listitem>
73           <para>TOL is the tolerance used for estimating the rank of matrices.
74           If TOL &gt; 0, then the given value of TOL is used as a lower bound
75           for the reciprocal condition number.</para>
76
77           <para>Default: prod(size(matrix))*epsilon_machine where
78           epsilon_machine is the relative machine precision.</para>
79         </listitem>
80       </varlistentry>
81
82       <varlistentry>
83         <term>PRINTW</term>
84
85         <listitem>
86           <para>PRINTW is a switch for printing the warning messages.</para>
87
88           <variablelist>
89             <varlistentry>
90               <term>=</term>
91
92               <listitem>
93                 <para>1: print warning messages;</para>
94               </listitem>
95             </varlistentry>
96
97             <varlistentry>
98               <term>=</term>
99
100               <listitem>
101                 <para>0: do not print warning messages.</para>
102               </listitem>
103             </varlistentry>
104           </variablelist>
105
106           <para>Default: PRINTW = 0.</para>
107         </listitem>
108       </varlistentry>
109
110       <varlistentry>
111         <term>X0</term>
112
113         <listitem>
114           <para>the estimated initial state vector</para>
115         </listitem>
116       </varlistentry>
117
118       <varlistentry>
119         <term>V</term>
120
121         <listitem>
122           <para>orthogonal matrix which reduces the system state matrix A to a
123           real Schur form</para>
124         </listitem>
125       </varlistentry>
126
127       <varlistentry>
128         <term>rcnd</term>
129
130         <listitem>
131           <para>estimate of the reciprocal condition number of the coefficient
132           matrix of the least squares problem solved.</para>
133         </listitem>
134       </varlistentry>
135     </variablelist>
136   </refsection>
137
138   <refsection>
139     <title>Description</title>
140
141     <para>inistate Estimates the initial state of a discrete-time system,
142     given the (estimated) system matrices, and a set of input/output
143     data.</para>
144
145     <para>X0 = inistate(SYS,Y,U,TOL,PRINTW) estimates the initial state X0 of
146     the discrete-time system SYS = (A,B,C,D), using the output data Y and the
147     input data U. The model structure is :</para>
148
149     <programlisting> 
150 x(k+1) = Ax(k) + Bu(k),   k &gt;= 1,
151 y(k)   = Cx(k) + Du(k),
152       </programlisting>
153
154     <para>The vectors y(k) and u(k) are transposes of the k-th rows of Y and
155     U, respectively.</para>
156
157     <para>Instead of the first input parameter SYS (an syslin object),
158     equivalent information may be specified using matrix parameters, for
159     instance, X0 = inistate(A,B,C,Y,U); or X0 = inistate(A,C,Y);</para>
160
161     <para>[x0,V,rcnd] = inistate(SYS,Y,U,TOL,PRINTW) returns, besides x0, the
162     orthogonal matrix V which reduces the system state matrix A to a real
163     Schur form, as well as an estimate of the reciprocal condition number of
164     the coefficient matrix of the least squares problem solved.</para>
165   </refsection>
166
167   <refsection>
168     <title>See Also</title>
169
170     <simplelist type="inline">
171       <member><link linkend="findBD">findBD</link></member>
172
173       <member><link linkend="findx0BD">findx0BD</link></member>
174     </simplelist>
175   </refsection>
176 </refentry>