fb541939a93b612ae1b814cb690b9a95b4574db6
[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>rlist()
21             rlist(a1 ,..., an)
22         </synopsis>
23     </refsynopsisdiv>
24     <refsection>
25         <title>Description</title>
26         <para>
27             <literal>rlist(a1, ..., an)</literal> is a shortcut  to
28             <literal>tlist(['r','num';'den','dt'], a1, ..., an)</literal>.
29         </para>
30         <para>
31             <literal>rlist(a1, ..., an)</literal> creates a <literal>tlist</literal> with  <literal>['r','num';'den','dt']</literal> as
32             first entry and  <literal>ai</literal>'s as next entries if any. No type nor size
33             checking is done on <literal>ai</literal>'s.
34         </para>
35     </refsection>
36     <refsection>
37         <title>Examples</title>
38         <programlisting role="example"><![CDATA[
39 s=poly(0,'s');
40 W=[1/s,1/(s+1)]
41 W'*W
42 Num=[s,s+2;1,s];
43 Den=[s*s,s;s,s*s];
44 rlist(Num,Den,[])
45  ]]></programlisting>
46     </refsection>
47     <refsection role="see also">
48         <title>See Also</title>
49         <simplelist type="inline">
50             <member>
51                 <link linkend="tlist">tlist</link>
52             </member>
53             <member>
54                 <link linkend="syslin">syslin</link>
55             </member>
56             <member>
57                 <link linkend="rational">rational</link>
58             </member>
59         </simplelist>
60     </refsection>
61 </refentry>