pfss help page fixed (incorrect formatting) 99/4499/4
Serge Steer [Mon, 18 Jul 2011 12:51:01 +0000 (14:51 +0200)]
Change-Id: If9b32f86d904ce41d8165aea14deeefece9992ab

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

index 891a69f..2427bc5 100644 (file)
@@ -2,7 +2,7 @@
 <!--
  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
  * Copyright (C) INRIA - F.D
- * 
+ * Revised July 2011, S. Steer, INRIA
  * This file must be used under the terms of the CeCILL.
  * This source file is licensed as described in the file COPYING, which
  * you should have received as part of this distribution.  The terms
@@ -22,8 +22,8 @@
     <title>Calling Sequence</title>
     <synopsis>elts=pfss(Sl)
 elts=pfss(Sl,rmax)
-elts=pfss(Sl,'cord')
-elts=pfss(Sl,rmax,'cord')</synopsis>
+elts=pfss(Sl,cord)
+elts=pfss(Sl,rmax,cord)</synopsis>
   </refsynopsisdiv>
   <refsection>
     <title>Arguments</title>
@@ -31,10 +31,29 @@ elts=pfss(Sl,rmax,'cord')</synopsis>
       <varlistentry>
         <term>Sl</term>
         <listitem>
-          <para><literal>syslin</literal> list (state-space or transfer linear system)
-  rmax : real number controlling the conditioning of block
-  diagoanalization cord : character string <literal>'c'</literal>
-  or <literal>'d'</literal>.</para>
+          <para>
+            A linear dynamical system in state-space or transfer
+            function representation (see <link
+            linkend="syslin">syslin</link>).
+          </para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term>rmax</term>
+        <listitem>
+          <para>
+            A real number controlling the conditioning of block
+            diagonalization (see  <link linkend="bdiag">bdiag</link>).
+          </para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term>cord</term>
+        <listitem>
+          <para>
+            A character string with possible values <literal>'c'</literal>
+            or <literal>'d'</literal>.
+          </para>
         </listitem>
       </varlistentry>
     </variablelist>
@@ -42,42 +61,60 @@ elts=pfss(Sl,rmax,'cord')</synopsis>
   <refsection>
     <title>Description</title>
     <para>
-    Partial fraction decomposition of the linear system <literal>Sl</literal> (in state-space 
-    form, transfer matrices are automatically converted to state-space form
-    by <literal>tf2ss</literal>):</para>
-    <para><literal>elts</literal> is the list of linear systems which add up to <literal>Sl</literal>
-    i.e. <literal>elts=list(S1,S2,S3,...,Sn)</literal> with:</para>
-    <para><literal>Sl = S1 + S2 +... +Sn</literal>.</para>
+    Partial fraction decomposition of the linear system <literal>Sl</literal>.
+    </para>
+    <para>
+      <literal>elts</literal> is the list of linear systems which add up to <literal>Sl</literal>
+      i.e. <literal>elts=list(S1,S2,S3,...,Sn)</literal> with:
+    </para>
     <para>
-    Each <literal>Si</literal> contains some poles of <literal/>S according to the 
-    block-diagonalization of the <literal>A</literal> matrix of <literal>S</literal>.</para>
+      <literal>Sl = S1 + S2 +... +Sn</literal>.
+    </para>
     <para>
-    For non proper systems the polynomial part of <literal>Sl</literal> is put
-    in the last entry of <literal>elts</literal>.</para>
+      Each <literal>Si</literal> contains some poles of <literal/>S according to the 
+      block-diagonalization of the <literal>A</literal> matrix of <literal>S</literal>.
+    </para>
     <para>
-    If <literal>Sl</literal> is given in transfer form, it is first converted into state-space
-    and each subsystem <literal>Si</literal> is then converted in transfer form.</para>
+      For non proper systems the polynomial part of <literal>Sl</literal> is put
+      in the last entry of <literal>elts</literal>.
+    </para>
     <para>
-    The A matrix is of the state-space is put into block diagonal form
-    by function <literal>bdiag</literal>. The optional parameter <literal>rmax</literal> is sent to
-    <literal>bdiag</literal>. If <literal>rmax</literal> should be set to a large number to enforce
-    block-diagonalization.</para>
+      If <literal>Sl</literal> is given in transfer form, it is first
+      converted into state-space by <link linkend="tf2ss">tf2ss</link>
+      and each subsystem <literal>Si</literal> is then converted in
+      transfer form by <link linkend="ss2tf">ss2tf</link>.
+    </para>
     <para>
-    If the optional flag <literal>cord='c'</literal> is given the elements in <literal>elts</literal>
-    are sorted according to the real part (resp. magnitude if <literal>cord='d'</literal>)
-    of the eigenvalues of A matrices.</para>
+      The A matrix is of the state-space is put into block diagonal form
+      by function <link linkend="bdiag">bdiag</link>. The optional parameter
+      <literal>rmax</literal> is sent to <literal>bdiag</literal>, 
+      <literal>rmax</literal> should be set to a large number to enforce
+      block-diagonalization.
+    </para>
+    <para>
+      If the optional flag <literal>cord='c'</literal> is given the elements in <literal>elts</literal>
+      are sorted according to the real part (resp. magnitude if <literal>cord='d'</literal>)
+      of the eigenvalues of A matrices.
+    </para>
   </refsection>
   <refsection>
     <title>Examples</title>
     <programlisting role="example"><![CDATA[ 
-W=ssrand(1,1,6);
-elts=pfss(W); 
-W1=0;for k=1:size(elts), W1=W1+ss2tf(elts(k));end
-clean(ss2tf(W)-W1)
- ]]></programlisting>
+    W=ssrand(1,1,6);
+    elts=pfss(W); 
+    W1=0;for k=1:size(elts), W1=W1+ss2tf(elts(k));end
+    clean(ss2tf(W)-W1)
+    ]]></programlisting>
+
+    <programlisting role="example"><![CDATA[ 
+    num=22801+4406.18*s+382.37*s^2+21.02*s^3+s^4;
+    den=22952.25+4117.77*s+490.63*s^2+33.06*s^3+s^4
+    h2=syslin('c',num/den);
+    ]]></programlisting>
+
   </refsection>
   <refsection role="see also">
-<title>See Also</title>
+    <title>See Also</title>
     <simplelist type="inline">
       <member>
         <link linkend="pbig">pbig</link>
@@ -95,6 +132,6 @@ clean(ss2tf(W)-W1)
   </refsection>
   <refsection>
     <title>Authors</title>
-    <para>F.D.;   </para>
+    <para>F.D., INRIA   </para>
   </refsection>
 </refentry>