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