summaryrefslogtreecommitdiff
path: root/modules/functions/help/en_US/bytecode.xml
blob: 23f1412de276855393ba603a3e68f76cb326471e (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
<?xml version="1.0" encoding="UTF-8"?>
<!--
 * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
 * Copyright (C) ????-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="bytecode">
    <refnamediv>
        <refname>bytecode</refname>
        <refpurpose>given a function returns the "bytecode" of a function in a Scilab array and conversely. </refpurpose>
    </refnamediv>
    <refsynopsisdiv>
        <title>Calling Sequence</title>
        <synopsis>
            x = bytecode(f)
            f = bytecode(x)
        </synopsis>
    </refsynopsisdiv>
    <refsection>
        <title>Arguments</title>
        <variablelist>
            <varlistentry>
                <term>f</term>
                <listitem>
                    <para>
                        A Scilab function.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>x</term>
                <listitem>
                    <para>
                        an int32 row vector
                    </para>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsection>
    <refsection>
        <title>Description</title>
        <para>
            <code>x = bytecode(f)</code> returns the "bytecode" of
            the function <varname>f</varname> in the Scilab integer array
            <varname>x</varname>.
        </para>
        <para>
            <code>f= bytecode(x)</code> returns in
            <varname>f</varname> the function associated with the
            "bytecode" given in the Scilab integer array
            <varname>x</varname>.
            <warning>
                Warning: the validity of <varname>x</varname> is not checked.
            </warning>
        </para>
    </refsection>
    <refsection>
        <title>Remark</title>
        <para>
            The bytecode of Scilab function will evolve drastically in the
            future, so the use of this function should be restricted to the
            profiling instruction handling.
        </para>
    </refsection>
    <refsection>
        <title>Examples</title>
        <programlisting role="example"><![CDATA[
function a=foo(),a=sin(3),endfunction
bytecode(foo)
 ]]></programlisting>
    </refsection>
    <refsection role="see also">
        <title>See Also</title>
        <simplelist type="inline">
            <member>
                <link linkend="add_profiling">add_profiling</link>
            </member>
            <member>
                <link linkend="bytecodewalk">bytecodewalk</link>
            </member>
            <member>
                <link linkend="macr2lst">macr2lst</link>
            </member>
            <member>
                <link linkend="macr2tree">macr2tree</link>
            </member>
        </simplelist>
    </refsection>
</refentry>