summaryrefslogtreecommitdiff
path: root/modules/polynomials/help/en_US/denom.xml
blob: e90cee2f698139b06401cdc1e47b2454ed7764a4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
<?xml version="1.0" encoding="UTF-8"?>
<!--
 * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
 * Copyright (C) 2006-2008 - INRIA
 *
 * This file must be used under the terms of the CeCILL.
 * This source file is licensed as described in the file COPYING, which
 * you should have received as part of this distribution.  The terms
 * are also available at
 * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt
 *
 -->
<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">
    <refnamediv>
        <refname>denom</refname>
        <refpurpose>denominator</refpurpose>
    </refnamediv>
    <refsynopsisdiv>
        <title>Calling Sequence</title>
        <synopsis>den=denom(r)</synopsis>
    </refsynopsisdiv>
    <refsection>
        <title>Arguments</title>
        <variablelist>
            <varlistentry>
                <term>r</term>
                <listitem>
                    <para>rational or polynomial or constant matrix.</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>den</term>
                <listitem>
                    <para>polynomial matrix</para>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsection>
    <refsection>
        <title>Description</title>
        <para>
            <literal>den=denom(r)</literal> returns the denominator of a rational matrix.
        </para>
        <para>
            Since rationals are internally represented as
            <literal>r=list(['r','num','den','dt'],num,den,[])</literal>,
            <literal>denom(r</literal>) is the same as <literal>r(3)</literal>,
            <literal>r('den')</literal> or <literal>r.den</literal>
        </para>
    </refsection>
    <refsection>
        <title>Examples</title>
        <programlisting role="example"><![CDATA[
h=(1+2*%s)/poly(1:4,'s','c');
denom(h)
numer(h)

s=poly(0,"s");
p=1+s+2*s^2;
denom(p) // Should return 1
numer(p)
 ]]></programlisting>
    </refsection>
    
    <refsection role="see also">
        <title>See Also</title>
        <simplelist type="inline">
            <member>
                <link linkend="numer">numer</link>
            </member>
        </simplelist>
    </refsection>
</refentry>