summaryrefslogtreecommitdiff
path: root/modules/string/help/en_US/evstr.xml
blob: c79b9b890c31f84438b031eb64bb7ba723a7cd60 (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
<?xml version="1.0" encoding="UTF-8"?>
<!--
 * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
 *
 * 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:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="evstr" xml:lang="en">
    <refnamediv>
        <refname>evstr</refname>
        <refpurpose>evaluation of expressions</refpurpose>
    </refnamediv>
    <refsynopsisdiv>
        <title>Calling Sequence</title>
        <synopsis>
            H = evstr(Z)
            [H, ierr] = evstr(Z)
        </synopsis>
    </refsynopsisdiv>
    <refsection>
        <title>Arguments</title>
        <variablelist>
            <varlistentry>
                <term>Z</term>
                <listitem>
                    <para>
                        a matrix of character strings <varname>M</varname> or
                        <code>list(M,Subexp)</code>
                    </para>
                    <variablelist>
                        <varlistentry>
                            <term>M</term>
                            <listitem>
                                <para>a matrix of character strings.</para>
                            </listitem>
                        </varlistentry>
                        <varlistentry>
                            <term>Subexp</term>
                            <listitem>
                                <para>a vector of character strings.</para>
                            </listitem>
                        </varlistentry>
                    </variablelist>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>H</term>
                <listitem>
                    <para>a matrix.</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>ierr</term>
                <listitem>
                    <para>an integer, error indicator.</para>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsection>
    <refsection>
        <title>Description</title>
        <para>
            Returns the result of the evaluation of the matrix of character
            strings <varname>M</varname>. Each element of the matrix must define a
            valid Scilab expression.
        </para>
        <para>
            If the evaluation of <varname>M</varname> expression leads to an
            error, the single return value version, <code>H = evstr(M)</code>,
            raises the error as usual. The two return values version,
            <code>[H,ierr] = evstr(M)</code>, on the other hand, produces no
            error, but returns the error number in <varname>ierr</varname>.
        </para>
        <para>
            If <varname>Z</varname> is a list, <varname>Subexp</varname> is a
            vector of character strings, that defines subexpressions which are
            evaluated before evaluating <varname>M</varname>. These subexpressions
            must be referred to as <literal>%(k)</literal> in <varname>M</varname>,
            where <literal>k</literal> is the subexpression's index in
            <varname>Subexp</varname>.
        </para>
        <para>
            <code>evstr('a = 1')</code> is not valid (use <function>execstr</function>
            instead).
        </para>
        <para>
            <literal>Nan</literal>, <literal>NaN</literal> will be interpreted as <constant>%nan</constant>.
        </para>
        <para>
            <literal>Inf</literal> will be interpreted as <constant>%inf</constant>.
        </para>
        <note>
            Note that <varname>Z</varname> should not be composed of continuation marks (..).
        </note>
    </refsection>
    <refsection>
        <title>Examples</title>
        <programlisting role="example">
            a = 1; b = 2;
            Z = ['a', 'b'] ;
            evstr(Z)
            
            Z = list(['%(1)','%(1)-%(2)'],['a+1','b+1']);
            evstr(Z)
            
            evstr('NaN'), evstr('Inf')
            
            //The two return values version
            [H, ierr] = evstr(Z) // no error
            Z = ['a', 'b', 'c'] ;// the variable c is undefined
            [H, ierr] = evstr(Z) // error 4: Undefined variable: c
        </programlisting>
    </refsection>
    <refsection role="see also">
        <title>See Also</title>
        <simplelist type="inline">
            <member>
                <link linkend="execstr">execstr</link>
            </member>
        </simplelist>
    </refsection>
</refentry>