summaryrefslogtreecommitdiff
path: root/modules/functions/help/en_US/tree2code.xml
blob: 15f985eb48f7d9851f04e9785a09bec01515be48 (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
<?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" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="tree2code">
    <refnamediv>
        <refname>tree2code</refname>
        <refpurpose>generates ASCII definition of a Scilab function</refpurpose>
    </refnamediv>
    <refsynopsisdiv>
        <title>Calling Sequence</title>
        <synopsis>txt = tree2code(tree, prettyprint)</synopsis>
    </refsynopsisdiv>
    <refsection>
        <title>Arguments</title>
        <variablelist>
            <varlistentry>
                <term>tree</term>
                <listitem>
                    <para>
                        a macro tree (coming from <function>macr2tree</function>).
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>prettyprint</term>
                <listitem>
                    <para>an optional boolean value:</para>
                    <variablelist>
                        <varlistentry>
                            <term>%T</term>
                            <listitem>
                                <para>generated code is indented and beautified</para>
                            </listitem>
                        </varlistentry>
                        <varlistentry>
                            <term>%F</term>
                            <listitem>
                                <para>
                                    generated code is not beautified (default)
                                </para>
                            </listitem>
                        </varlistentry>
                    </variablelist>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>txt</term>
                <listitem>
                    <para>a column vector of strings, the text giving the Scilab instructions.</para>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsection>
    <refsection>
        <title>Description</title>
        <para>
            Given a loaded Scilab function "tree" (returned by <function>macr2tree</function>), <function>tree2code</function> allows to
            re-generate the code.
        </para>
    </refsection>
    <refsection>
        <title>Examples</title>
        <programlisting role="example"><![CDATA[
tree=macr2tree(cosh);
txt=tree2code(tree,%T);
write(%io(2),txt,'(a)');
 ]]></programlisting>
    </refsection>
    <refsection role="see also">
        <title>See Also</title>
        <simplelist type="inline">
            <member>
                <link linkend="macr2tree">macr2tree</link>
            </member>
        </simplelist>
    </refsection>
</refentry>