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