bug_11077 fixed.
[scilab.git] / scilab / modules / data_structures / help / en_US / rlist.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) 2006-2008 - 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="rlist">
17     <refnamediv>
18         <refname>rlist</refname>
19         <refpurpose>Scilab rational fraction function definition</refpurpose>
20     </refnamediv>
21     <refsynopsisdiv>
22         <title>Syntax</title>
23         <synopsis>
24             [r] = rlist(N, D [,dom])
25         </synopsis>
26     </refsynopsisdiv>
27     <refsection>
28         <title>Arguments</title>
29         <variablelist>
30             <varlistentry>
31                 <term>N,D</term>
32                 <listitem>
33                     <para>polynomial martices.</para>
34                 </listitem>
35             </varlistentry>
36             <varlistentry>
37                 <term>dom</term>
38                 <listitem>
39                     <para>
40                         character string, or <literal>[]</literal> or a scalar.
41                     </para>
42                 </listitem>
43             </varlistentry>
44             <varlistentry>
45                 <term>r</term>
46                 <listitem>
47                     <para>
48                         tlist ("r" list) representing the rational fraction.
49                     </para>
50                 </listitem>
51             </varlistentry>
52         </variablelist>
53     </refsection>
54     <refsection>
55         <title>Description</title>
56         <para>
57             <literal>rlist(N, D, dom)</literal> is a shortcut  to
58             <literal>tlist(['r','num','den','dt'], N, D, dom)</literal>.
59         </para>
60         <para>
61             To correspond to the domain time of a linear system, <varname>dom</varname>
62             must be equal to <literal>'c'</literal>,<literal>'d'</literal>, <literal>[]</literal> or a scalar.
63             One the one hand, to be similar to functions as <link linkend="syslin">syslin</link>,
64             and on the other, to use some functions as <link linkend="tf2ss">tf2ss</link>, it
65             is necessary that <varname>dom</varname> is equal to these values.
66         </para>
67     </refsection>
68     <refsection>
69         <title>Examples</title>
70         <programlisting role="example"><![CDATA[
71 s=poly(0,'s');
72 W=[1/s,1/(s+1)]
73 W'*W
74 Num=[s,s+2;1,s];
75 Den=[s*s,s;s,s*s];
76 rlist(Num,Den,[])
77
78 H1=(1+2*s)/s^2;
79 S1bis=syslin('c',H1)
80 r=rlist(H1.num, H1.den, 'c')
81 r == S1bis
82  ]]></programlisting>
83     </refsection>
84     <refsection role="see also">
85         <title>See also</title>
86         <simplelist type="inline">
87             <member>
88                 <link linkend="tlist">tlist</link>
89             </member>
90             <member>
91                 <link linkend="syslin">syslin</link>
92             </member>
93             <member>
94                 <link linkend="rational">rational</link>
95             </member>
96             <member>
97                 <link linkend="tf2ss">tf2ss</link>
98             </member>
99         </simplelist>
100     </refsection>
101     <refsection>
102             <title>History</title>
103             <revhistory>
104                 <revision>
105                     <revnumber>6.1</revnumber>
106                     <revremark>rlist() removed.</revremark>
107                 </revision>
108             </revhistory>
109     </refsection>
110 </refentry>