87fe78e90d2dd5576e613aa3cc4e368f8365e223
[scilab.git] / scilab / modules / cacsd / help / en_US / inistate.xml
1 <?xml version="1.0" encoding="ISO-8859-1"?>
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 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="inistate"><info><pubdate>$LastChangedDate$</pubdate></info><refnamediv><refname>inistate</refname><refpurpose> Estimates the initial state of a discrete-time system</refpurpose></refnamediv>
14   
15   
16   
17   
18   
19   <refsynopsisdiv><title>Calling Sequence</title><synopsis>X0 = inistate(SYS,Y,U,TOL,PRINTW)
20 X0 = inistate(A,B,C,Y,U);
21 X0 = inistate(A,C,Y);
22
23 [x0,V,rcnd] = inistate(SYS,Y,U,TOL,PRINTW)</synopsis></refsynopsisdiv>
24   <refsection><title>Parameters</title>
25     <variablelist>
26       <varlistentry>
27         <term>SYS</term>
28         <listitem>
29           <para>given system, syslin(dt,A,B,C,D)</para>
30         </listitem>
31       </varlistentry>
32       <varlistentry>
33         <term>Y</term>
34         <listitem>
35           <para>the output of the system</para>
36         </listitem>
37       </varlistentry>
38       <varlistentry>
39         <term>U</term>
40         <listitem>
41           <para>the input of the system</para>
42         </listitem>
43       </varlistentry>
44       <varlistentry>
45         <term>TOL</term>
46         <listitem>
47           <para>TOL is 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.</para>
48           <para>
49     Default:    prod(size(matrix))*epsilon_machine where epsilon_machine is the relative machine precision. 
50   </para>
51         </listitem>
52       </varlistentry>
53       <varlistentry>
54         <term>PRINTW</term>
55         <listitem>
56           <para>PRINTW is a switch for printing the warning messages.</para>
57           <variablelist>
58             <varlistentry>
59               <term>=  </term>
60               <listitem>
61                 <para>1: print warning messages;</para>
62               </listitem>
63             </varlistentry>
64             <varlistentry>
65               <term>=  </term>
66               <listitem>
67                 <para>0: do not print warning messages.</para>
68               </listitem>
69             </varlistentry>
70           </variablelist>
71           <para>
72     Default:    PRINTW = 0.
73   </para>
74         </listitem>
75       </varlistentry>
76       <varlistentry>
77         <term>X0</term>
78         <listitem>
79           <para>the estimated initial state vector</para>
80         </listitem>
81       </varlistentry>
82       <varlistentry>
83         <term>V</term>
84         <listitem>
85           <para>orthogonal matrix which reduces the system state matrix A to  a real Schur form</para>
86         </listitem>
87       </varlistentry>
88       <varlistentry>
89         <term>rcnd</term>
90         <listitem>
91           <para>estimate of the reciprocal condition number of the coefficient matrix of the least squares problem solved.</para>
92         </listitem>
93       </varlistentry>
94     </variablelist>
95   </refsection>
96   <refsection><title>Description</title>
97     <para>
98     inistate  Estimates the initial state of a discrete-time system, given the 
99     (estimated) system matrices, and a set of input/output data.</para>
100     <para>
101     X0 = inistate(SYS,Y,U,TOL,PRINTW)  estimates the initial state X0 of 
102     the discrete-time system SYS = (A,B,C,D), using the output data Y
103     and the input data U. The model structure is :</para>
104     <programlisting><![CDATA[
105
106      x(k+1) = Ax(k) + Bu(k),   k >= 1,
107      y(k)   = Cx(k) + Du(k),
108    
109     ]]></programlisting>
110     <para>
111     The vectors y(k) and u(k) are transposes of the k-th rows of Y and U,
112     respectively.</para>
113     <para>
114     Instead of the first input parameter SYS (an syslin object), equivalent
115     information may be specified using matrix parameters, for instance,
116     X0 = inistate(A,B,C,Y,U);   or   X0 = inistate(A,C,Y);</para>
117     <para>
118     [x0,V,rcnd] = inistate(SYS,Y,U,TOL,PRINTW) returns, besides x0, 
119     the orthogonal matrix V which reduces the system state matrix A to 
120     a real Schur form, as well as an estimate of the reciprocal condition
121     number of the coefficient matrix of the least squares problem solved.</para>
122   </refsection>
123   <refsection><title>See Also</title><simplelist type="inline">
124     <member>
125       <link linkend="findBD">findBD</link>
126     </member>
127     <member>
128       <link linkend="findx0BD">findx0BD</link>
129     </member>
130   </simplelist></refsection>
131 </refentry>