summaryrefslogtreecommitdiff
path: root/modules/polynomials/help/en_US/pol2str.xml
blob: 79878bfbeacb90592be85fc0ab3864a952dee6a0 (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
<?xml version="1.0" encoding="UTF-8"?>
<!--
 * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
 * Copyright (C) 2006-2008 - INRIA
 * Copyright (C) 2013 - Samuel GOUGEON : upgrade for 5.5.0
 *
 * 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="pol2str">
    <refnamediv>
        <refname>pol2str</refname>
        <refpurpose>polynomial to string conversion</refpurpose>
    </refnamediv>
    <refsynopsisdiv>
        <title>Calling Sequence</title>
        <synopsis>strs = pol2str(p)</synopsis>
    </refsynopsisdiv>
    <refsection>
        <title>Arguments</title>
        <variablelist>
            <varlistentry>
                <term>p</term>
                <listitem>
                    <para>matrix or hypermatrix of polynomials with real or complex coefficients</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>strs</term>
                <listitem>
                    <para>matrix or hypermatrix of strings</para>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsection>
    <refsection>
        <title>Description</title>
        <para>
            converts polynomial to character string (utility function).
        </para>
        <para>
            <note>
                The output format of coefficients is set through  <link linkend="format">format(..)</link>.
            </note>
        </para>
    </refsection>
    
    <refsection>
        <title>Examples</title>
        <programlisting role="example"><![CDATA[
pol2str(%z)

p = poly ([1, 2, 3], "x","coeff");
pol2str(p)

p = (1+%i+%z)^(1:4)
pol2str(p)
 ]]></programlisting>
    </refsection>
    
    <refsection role="see also">
        <title>See Also</title>
        <simplelist type="inline">
            <member>
                <link linkend="string">string</link>
            </member>
            <member>
                <link linkend="prettyprint">prettyprint</link>
            </member>
            <member>
                <link linkend="sci2exp">sci2exp</link>
            </member>
        </simplelist>
    </refsection>
    <refsection role="history tag">
        <title>History</title>
        <revhistory>
            <revision>
                <revnumber>5.5.0</revnumber>
                <revdescription>pol2str() extended to polynomials with complex coefficients and to hypermatrix. Array processing vectorized.</revdescription>
            </revision>
        </revhistory>
    </refsection>
</refentry>