summaryrefslogtreecommitdiff
path: root/modules/polynomials/help/en_US/detr.xml
blob: 2d34f2f9dbf44a35f75aa02a8ed93cd61021d91c (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
74
<?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="detr">
    <refnamediv>
        <refname>detr</refname>
        <refpurpose>polynomial determinant</refpurpose>
    </refnamediv>
    <refsynopsisdiv>
        <title>Calling Sequence</title>
        <synopsis>d=detr(h)</synopsis>
    </refsynopsisdiv>
    <refsection>
        <title>Arguments</title>
        <variablelist>
            <varlistentry>
                <term>h</term>
                <listitem>
                    <para>double or polynomial or rational square matrix</para>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsection>
    <refsection>
        <title>Description</title>
        <para>
            <literal>d=detr(h)</literal> returns the determinant <literal>d</literal> of the double
            or polynomial or rational function matrix <literal>h</literal>.
            Based on Leverrier's algorithm.
        </para>
    </refsection>
    <refsection>
        <title>Examples</title>
        <programlisting role="example">
            <![CDATA[
// Matrix of doubles
A = rand(5,5);
detr(A)

A = A+%i;
detr(A)

// Matrix of polynomials
x = poly(0, 'x')
A = [1+x 2 5; 3 4-x 3+x; x^2 1 x];
detr(A)

// Matrix of rationals
A = [1/x 2 3; 3 4/x 3/x; 1/x^2 1 1/x];
detr(A)
 ]]>
        </programlisting>
    </refsection>
    <refsection role="see also">
        <title>See Also</title>
        <simplelist type="inline">
            <member>
                <link linkend="det">det</link>
            </member>
            <member>
                <link linkend="determ">determ</link>
            </member>
        </simplelist>
    </refsection>
</refentry>