90245eecef91d8b3526f08c0f6e42b8d93b717ed
[scilab.git] / scilab / modules / polynomials / help / en_US / numer.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="numer">
17     <refnamediv>
18         <refname>numer</refname>
19         <refpurpose>numerator <emphasis role="bold">(obsolete)</emphasis></refpurpose>
20     </refnamediv>
21     <refsynopsisdiv>
22         <title>Syntax</title>
23         <synopsis>num=numer(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>num</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>.num</literal> rational attribute instead.
47         </warning>
48         <para>
49             Utility function. <literal>num=numer(R)</literal> returns the numerator <literal>num</literal> of a rational
50             function matrix <literal>R</literal> (<literal>R</literal> may be also a constant or polynomial matrix).
51             <literal>numer(R)</literal> is equivalent to <literal>R(2)</literal>, <literal>R('num')</literal> or <literal>R.num</literal>
52         </para>
53     </refsection>
54     <refsection>
55         <title>Examples</title>
56         <programlisting role="example"><![CDATA[
57 h=(1+2*%s)/poly(1:4,'s','c');
58 denom(h)
59 numer(h)
60
61 s=poly(0,"s");
62 p=1+s+2*s^2;
63 denom(p) // Should return 1
64 numer(p)
65  ]]></programlisting>
66     </refsection>
67     <refsection role="see also">
68         <title>See also</title>
69         <simplelist type="inline">
70             <member>
71                 <link linkend="denom">denom</link>
72             </member>
73         </simplelist>
74     </refsection>
75     <refsection role="history">
76         <title>History</title>
77         <revhistory>
78             <revision>
79                 <revnumber>6.0.1</revnumber>
80                 <revdescription>
81                     <literal>numer()</literal> is declared obsolete. The rational attribute
82                     <literal>.num</literal> must be used instead.
83                 </revdescription>
84             </revision>
85         </revhistory>
86     </refsection>
87 </refentry>