summaryrefslogtreecommitdiff
path: root/modules/string/help/en_US/sci2exp.xml
blob: 125bd9dd8e0edf7224b64fa42da2fbaf400cff00 (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
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
<?xml version="1.0" encoding="UTF-8"?>
<!--
 * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
 * Copyright (C) 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" xml:lang="en" xml:id="sci2exp">
    <refnamediv>
        <refname>sci2exp</refname>
        <refpurpose> converts an expression to a string</refpurpose>
    </refnamediv>
    <refsynopsisdiv>
        <title>Calling Sequence</title>
        <synopsis>t = sci2exp(a [,nam] [,lmax])</synopsis>
    </refsynopsisdiv>
    <refsection>
        <title>Arguments</title>
        <variablelist>
            <varlistentry>
                <term>a</term>
                <listitem>
                    <para>a scilab expression, may be:</para>
                    <variablelist>
                        <varlistentry>
                            <term>-    </term>
                            <listitem>
                                <para>a constant;</para>
                            </listitem>
                        </varlistentry>
                        <varlistentry>
                            <term>-    </term>
                            <listitem>
                                <para>a polynomial;</para>
                            </listitem>
                        </varlistentry>
                        <varlistentry>
                            <term>-    </term>
                            <listitem>
                                <para>a string matrix;</para>
                            </listitem>
                        </varlistentry>
                        <varlistentry>
                            <term>-    </term>
                            <listitem>
                                <para>a list;</para>
                            </listitem>
                        </varlistentry>
                        <varlistentry>
                            <term>-    </term>
                            <listitem>
                                <para>a boolean matrix;</para>
                            </listitem>
                        </varlistentry>
                        <varlistentry>
                            <term>-    </term>
                            <listitem>
                                <para>a handle (only figure and uicontrol).</para>
                            </listitem>
                        </varlistentry>
                    </variablelist>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>nam</term>
                <listitem>
                    <para>a character string.</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>t</term>
                <listitem>
                    <para>
                        a vector of strings, contains the expression or the affectation instruction.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>lmax</term>
                <listitem>
                    <para>
                        an integer, contains the maximum line length. Default
                        value is <literal>0</literal>,
                        which indicates no line length
                        control; a single string is returned.
                    </para>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsection>
    <refsection>
        <title>Description</title>
        <para>
            <function>sci2exp</function> converts expression to an instruction string if <varname>nam</varname> is
            given or to an expression string.
        </para>
    </refsection>
    <refsection>
        <title>Remarks</title>
        <itemizedlist>
            <listitem>
                <para>
                    If <varname>a</varname> is a handle, <function>sci2exp</function> gives a result which has no hierarchical links,
                    that is, with empty fields for parent and children.
                </para>
            </listitem>
            <listitem>
                <para>
                    <varname>t</varname> can be impacted by <link linkend="format">format</link>. 
                </para>
            </listitem>
        </itemizedlist>
    </refsection>
    
    <refsection>
        <title>Examples</title>
        <programlisting role="example"><![CDATA[
a=[1 2;3 4]
sci2exp(a,'aa')
sci2exp(a,'aa',10)
sci2exp(ssrand(2,2,2))
sci2exp(poly([1 0 3 4],'s'),'fi')
sci2exp(figure("figure_name","figure1"))
b=0.123456789;
format(5);
c=sci2exp(b)
format(10);
d=sci2exp(b)
    ]]></programlisting>
    </refsection>
    <refsection role="see also">
        <title>See Also</title>
        <simplelist type="inline">
            <member>
                <link linkend="prettyprint">prettyprint</link>
            </member>
            <member>
                <link linkend="format">format</link>
            </member>
        </simplelist>
    </refsection>
</refentry>