License Header change: Removed the LICENSE_END before beta
[scilab.git] / scilab / modules / cacsd / help / en_US / formal_representation / tf2des.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  * Copyright (C) 2012 - 2016 - Scilab Enterprises
7  *
8  * This file is hereby licensed under the terms of the GNU GPL v2.0,
9  * pursuant to article 5.3.4 of the CeCILL v.2.1.
10  * This file was originally licensed under the terms of the CeCILL v2.1,
11  * and continues to be available under such terms.
12  * For more information, see the COPYING file which you should have received
13  * along with this program.
14  *
15  -->
16 <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" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="tf2des">
17     <refnamediv>
18         <refname>tf2des</refname>
19         <refpurpose>transfer function to descriptor</refpurpose>
20     </refnamediv>
21     <refsynopsisdiv>
22         <title>Calling Sequence</title>
23         <synopsis>S=tf2des(G)
24             S=tf2des(G,flag)
25         </synopsis>
26     </refsynopsisdiv>
27     <refsection>
28         <title>Arguments</title>
29         <variablelist>
30             <varlistentry>
31                 <term>G</term>
32                 <listitem>
33                     <para>
34                         linear system (<literal>syslin</literal> list) with possibly polynomial <literal>D</literal> matrix
35                     </para>
36                 </listitem>
37             </varlistentry>
38             <varlistentry>
39                 <term>flag</term>
40                 <listitem>
41                     <para>
42                         character string <literal>"withD"</literal>
43                     </para>
44                 </listitem>
45             </varlistentry>
46             <varlistentry>
47                 <term>S</term>
48                 <listitem>
49                     <para>list</para>
50                 </listitem>
51             </varlistentry>
52         </variablelist>
53     </refsection>
54     <refsection>
55         <title>Description</title>
56         <para>
57             Transfer function to descriptor form: <literal>S=list('d',A,B,C,D,E)</literal>
58         </para>
59         <programlisting role=""><![CDATA[ 
60 E*xdot = A*x+B*u
61 y = C*x + D*u
62  ]]></programlisting>
63         <para>
64             <note>
65                 Note that <literal>D=0</literal> if the optional parameter flag=<literal>"withD"</literal> is not
66                 given. Otherwise a maximal rank <literal>D</literal> matrix is returned in the fifth
67                 entry of the list <literal>S</literal>.
68             </note>
69         </para>
70     </refsection>
71     <refsection>
72         <title>Examples</title>
73         <programlisting role="example"><![CDATA[ 
74 s=poly(0,'s');
75 G=[1/(s-1),s;1,2/s^3];
76 S1=tf2des(G);des2tf(S1)
77 S2=tf2des(G,"withD");des2tf(S2)
78  ]]></programlisting>
79     </refsection>
80     <refsection role="see also">
81         <title>See Also</title>
82         <simplelist type="inline">
83             <member>
84                 <link linkend="pol2des">pol2des</link>
85             </member>
86             <member>
87                 <link linkend="tf2ss">tf2ss</link>
88             </member>
89             <member>
90                 <link linkend="ss2des">ss2des</link>
91             </member>
92             <member>
93                 <link linkend="des2tf">des2tf</link>
94             </member>
95         </simplelist>
96     </refsection>
97 </refentry>