summaryrefslogtreecommitdiff
path: root/modules/polynomials/help/en_US/coeff.xml
blob: ec158dc23c314e250c4c5ad04514ecf659919967 (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
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
<?xml version="1.0" encoding="UTF-8"?>
<!--
 * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
 * Copyright (C) 2006-2008 - INRIA - Serge STEER
 *
 * 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="coeff">
    <refnamediv>
        <refname>coeff</refname>
        <refpurpose>coefficients of matrix polynomial</refpurpose>
    </refnamediv>
    <refsynopsisdiv>
        <title>Calling Sequence</title>
        <synopsis>[C]=coeff(Mp [,v])</synopsis>
    </refsynopsisdiv>
    <refsection>
        <title>Arguments</title>
        <variablelist>
            <varlistentry>
                <term>Mp</term>
                <listitem>
                    <para>polynomial matrix</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>v</term>
                <listitem>
                    <para>integer (row or column) vector of selected degrees</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>C</term>
                <listitem>
                    <para>big matrix of the coefficients</para>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsection>
    <refsection>
        <title>Description</title>
        <para>
            <literal>C=coeff(Mp)</literal>
            returns in a big matrix <literal>C</literal> the coefficients of the
            polynomial matrix <literal>Mp</literal> . <literal>C</literal> is partitioned
            as <literal>C=[C0,C1,...,Ck]</literal>
            where the <literal>Ci</literal> are arranged in increasing order
            <literal>k = max(degree(Mp))</literal>
        </para>
        <para>
            <literal>C=coeff(Mp,v)</literal> returns the matrix of coefficients with
            degree in <literal>v</literal> . (<literal>v</literal> is a row or column vector).
        </para>
    </refsection>
    <refsection>
        <title>Examples</title>
        <programlisting role="example"><![CDATA[
s=poly(0,'s');
w=s*rand(10,10);
determ(w)
coeff(w,1)

r = poly([0 -1+%i -1-%i],'s',"roots");
coeff(r)

r = poly([-1-%i -1+2*%i 0],'s',"roots");
coeff(r)

 ]]></programlisting>
    </refsection>
    <refsection role="see also">
        <title>See Also</title>
        <simplelist type="inline">
            <member>
                <link linkend="poly">poly</link>
            </member>
            <member>
                <link linkend="degree">degree</link>
            </member>
            <member>
                <link linkend="inv_coeff">inv_coeff</link>
            </member>
        </simplelist>
    </refsection>
</refentry>