scilab/modules/cacsd/help/en_US/inistate.xml

   1 <?xml version="1.0" encoding="ISO-8859-1" standalone="no"?>
   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
  14 <!DOCTYPE MAN SYSTEM "../../../../modules/helptools/help.dtd">
  15 <MAN>
  16   <LANGUAGE>eng</LANGUAGE>
  17   <TITLE>inistate</TITLE>
  18   <TYPE>Scilab Function</TYPE>
  19   <DATE>$LastChangedDate$</DATE>
  20   <SHORT_DESCRIPTION name="inistate"> Estimates the initial state of a discrete-time system</SHORT_DESCRIPTION>
  21   <CALLING_SEQUENCE>
  22     <CALLING_SEQUENCE_ITEM>X0 = inistate(SYS,Y,U,TOL,PRINTW)   </CALLING_SEQUENCE_ITEM>
  23     <CALLING_SEQUENCE_ITEM>X0 = inistate(A,B,C,Y,U);  </CALLING_SEQUENCE_ITEM>
  24     <CALLING_SEQUENCE_ITEM>X0 = inistate(A,C,Y);  </CALLING_SEQUENCE_ITEM>
  25     <CALLING_SEQUENCE_ITEM>  </CALLING_SEQUENCE_ITEM>
  26     <CALLING_SEQUENCE_ITEM>[x0,V,rcnd] = inistate(SYS,Y,U,TOL,PRINTW)  </CALLING_SEQUENCE_ITEM>
  27   </CALLING_SEQUENCE>
  28   <PARAM>
  29     <PARAM_INDENT>
  30       <PARAM_ITEM>
  31         <PARAM_NAME>SYS</PARAM_NAME>
  32         <PARAM_DESCRIPTION>
  33           <SP>: given system, syslin(dt,A,B,C,D)</SP>
  34         </PARAM_DESCRIPTION>
  35       </PARAM_ITEM>
  36       <PARAM_ITEM>
  37         <PARAM_NAME>Y</PARAM_NAME>
  38         <PARAM_DESCRIPTION>
  39           <SP>: the output of the system</SP>
  40         </PARAM_DESCRIPTION>
  41       </PARAM_ITEM>
  42       <PARAM_ITEM>
  43         <PARAM_NAME>U</PARAM_NAME>
  44         <PARAM_DESCRIPTION>
  45           <SP>: the input of the system</SP>
  46         </PARAM_DESCRIPTION>
  47       </PARAM_ITEM>
  48       <PARAM_ITEM>
  49         <PARAM_NAME>TOL</PARAM_NAME>
  50         <PARAM_DESCRIPTION>
  51           <SP>: 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.</SP>
  52           <P>
  53     Default:    prod(size(matrix))*epsilon_machine where epsilon_machine is the relative machine precision.
  54   </P>
  55         </PARAM_DESCRIPTION>
  56       </PARAM_ITEM>
  57       <PARAM_ITEM>
  58         <PARAM_NAME>PRINTW</PARAM_NAME>
  59         <PARAM_DESCRIPTION>
  60           <SP>: PRINTW is a switch for printing the warning messages.</SP>
  61           <PARAM_INDENT>
  62             <PARAM_ITEM>
  63               <PARAM_NAME>=  </PARAM_NAME>
  64               <PARAM_DESCRIPTION>
  65                 <SP>1: print warning messages;</SP>
  66               </PARAM_DESCRIPTION>
  67             </PARAM_ITEM>
  68             <PARAM_ITEM>
  69               <PARAM_NAME>=  </PARAM_NAME>
  70               <PARAM_DESCRIPTION>
  71                 <SP>0: do not print warning messages.</SP>
  72               </PARAM_DESCRIPTION>
  73             </PARAM_ITEM>
  74           </PARAM_INDENT>
  75           <P>
  76     Default:    PRINTW = 0.
  77   </P>
  78         </PARAM_DESCRIPTION>
  79       </PARAM_ITEM>
  80       <PARAM_ITEM>
  81         <PARAM_NAME>X0</PARAM_NAME>
  82         <PARAM_DESCRIPTION>
  83           <SP>: the estimated initial state vector</SP>
  84         </PARAM_DESCRIPTION>
  85       </PARAM_ITEM>
  86       <PARAM_ITEM>
  87         <PARAM_NAME>V</PARAM_NAME>
  88         <PARAM_DESCRIPTION>
  89           <SP>: orthogonal matrix which reduces the system state matrix A to  a real Schur form</SP>
  90         </PARAM_DESCRIPTION>
  91       </PARAM_ITEM>
  92       <PARAM_ITEM>
  93         <PARAM_NAME>rcnd</PARAM_NAME>
  94         <PARAM_DESCRIPTION>
  95           <SP>: estimate of the reciprocal condition number of the coefficient matrix of the least squares problem solved.</SP>
  96         </PARAM_DESCRIPTION>
  97       </PARAM_ITEM>
  98     </PARAM_INDENT>
  99   </PARAM>
 100   <DESCRIPTION>
 101     <P>
 102     inistate  Estimates the initial state of a discrete-time system, given the
 103     (estimated) system matrices, and a set of input/output data.</P>
 104     <P>
 105     X0 = inistate(SYS,Y,U,TOL,PRINTW)  estimates the initial state X0 of
 106     the discrete-time system SYS = (A,B,C,D), using the output data Y
 107     and the input data U. The model structure is :</P>
 108     <VERBATIM>
 109 <![CDATA[
 110      x(k+1) = Ax(k) + Bu(k),   k >= 1,
 111      y(k)   = Cx(k) + Du(k),
 112    ]]>
 113     </VERBATIM>
 114     <P>
 115     The vectors y(k) and u(k) are transposes of the k-th rows of Y and U,
 116     respectively.</P>
 117     <P>
 118     Instead of the first input parameter SYS (an syslin object), equivalent
 119     information may be specified using matrix parameters, for instance,
 120     X0 = inistate(A,B,C,Y,U);   or   X0 = inistate(A,C,Y);</P>
 121     <P>
 122     [x0,V,rcnd] = inistate(SYS,Y,U,TOL,PRINTW) returns, besides x0,
 123     the orthogonal matrix V which reduces the system state matrix A to
 124     a real Schur form, as well as an estimate of the reciprocal condition
 125     number of the coefficient matrix of the least squares problem solved.</P>
 126   </DESCRIPTION>
 127   <SEE_ALSO>
 128     <SEE_ALSO_ITEM>
 129       <LINK>findBD</LINK>
 130     </SEE_ALSO_ITEM>
 131     <SEE_ALSO_ITEM>
 132       <LINK>findx0BD</LINK>
 133     </SEE_ALSO_ITEM>
 134   </SEE_ALSO>
 135 </MAN>