* Bug 15821 fixed: fac3d() and fac3d1() actually removed
[scilab.git] / scilab / modules / polynomials / help / en_US / denom.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="denom">
17     <refnamediv>
18         <refname>denom</refname>
19         <refpurpose>denominator <emphasis role="bold">(obsolete)</emphasis></refpurpose>
20     </refnamediv>
21     <refsynopsisdiv>
22         <title>Syntax</title>
23         <synopsis>den=denom(r)</synopsis>
24     </refsynopsisdiv>
25     <refsection>
26         <title>Arguments</title>
27         <variablelist>
28             <varlistentry>
29                 <term>r</term>
30                 <listitem>
31                     <para>rational or polynomial or constant matrix.</para>
32                 </listitem>
33             </varlistentry>
34             <varlistentry>
35                 <term>den</term>
36                 <listitem>
37                     <para>polynomial matrix</para>
38                 </listitem>
39             </varlistentry>
40         </variablelist>
41     </refsection>
42     <refsection>
43         <title>Description</title>
44         <warning>
45             This function is obsolete and will be removed from Scilab 6.1.0. Please use the
46             <literal>.den</literal> rational attribute instead.
47         </warning>
48         <para>
49             <literal>den=denom(r)</literal> returns the denominator of a rational matrix.
50         </para>
51         <para>
52             Since rationals are internally represented as
53             <literal>r=list(['r','num','den','dt'],num,den,[])</literal>,
54             <literal>denom(r</literal>) is the same as <literal>r(3)</literal>,
55             <literal>r('den')</literal> or <literal>r.den</literal>
56         </para>
57     </refsection>
58     <refsection>
59         <title>Examples</title>
60         <programlisting role="example"><![CDATA[
61 h=(1+2*%s)/poly(1:4,'s','c');
62 denom(h)
63 numer(h)
64
65 s=poly(0,"s");
66 p=1+s+2*s^2;
67 denom(p) // Should return 1
68 numer(p)
69  ]]></programlisting>
70     </refsection>
71
72     <refsection role="see also">
73         <title>See also</title>
74         <simplelist type="inline">
75             <member>
76                 <link linkend="numer">numer</link>
77             </member>
78         </simplelist>
79     </refsection>
80     <refsection role="history">
81         <title>History</title>
82         <revhistory>
83             <revision>
84                 <revnumber>6.0.1</revnumber>
85                 <revdescription>
86                     <literal>denom()</literal> is declared obsolete. The rational attribute
87                     <literal>.den</literal> must be used instead.
88                 </revdescription>
89             </revision>
90         </revhistory>
91     </refsection>
92 </refentry>