summaryrefslogtreecommitdiff
path: root/modules/functions/help/en_US/recompilefunction.xml
blob: 16ccaa76f7d05b87ee6c9429598825cd00d6d161 (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
<?xml version="1.0" encoding="UTF-8"?>
<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="recompilefunction">
    <refnamediv>
        <refname>recompilefunction</refname>
        <refpurpose>recompiles a scilab function, 
            changing its type
        </refpurpose>
    </refnamediv>
    <refsynopsisdiv>
        <title>Calling Sequence</title>
        <synopsis>recompilefunction(funname [,kind [,force]])</synopsis>
    </refsynopsisdiv>
    <refsection>
        <title>Arguments</title>
        <variablelist>
            <varlistentry>
                <term>funname</term>
                <listitem>
                    <para>string, name of the function to recompile
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>kind</term>
                <listitem>
                    <para>
                        string: <emphasis role="bold">"n"</emphasis> (noncompiled, type 11), <emphasis role="bold">"c"</emphasis> 
                        (compiled, type 13) or <emphasis role="bold">"p"</emphasis> (compiled, type 13, with 
                        provision for profiling). Default "c".
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>force</term>
                <listitem>
                    <para>boolean. If false, the function is recomplied only if its kind changes;
                        if true, it is recompiled even if it keeps the same kind (notably useful
                        to recompile a "p" function, to reset the profiling statistics).
                    </para>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsection>
    <refsection>
        <title>Description</title>
        <itemizedlist>
            <listitem>
                <para>
                    This function reverse-compiles a function variable via <link linkend="fun2string">fun2string</link>,
                    and recompiles it to the desired kind with <link linkend="deff">deff</link>.
                </para>
            </listitem>
        </itemizedlist>
    </refsection>
    <refsection>
        <title>Examples</title>
        <programlisting role="example"><![CDATA[ 
recompilefunction("asinh","p")
for i=1:100; asinh(rand(100,100)); end
showprofile(asinh)   
 ]]></programlisting>
    </refsection>
    <refsection role="see also">
        <title>See Also</title>
        <simplelist type="inline">
            <member>
                <link linkend="function">function</link>
            </member>
            <member>
                <link linkend="deff">deff</link>
            </member>
            <member>
                <link linkend="comp">comp</link>
            </member>
            <member>
                <link linkend="fun2string">fun2string</link>
            </member>
            <member>
                <link linkend="profile">profile</link>
            </member>
        </simplelist>
    </refsection>
    <refsection>
        <title>Bibliography</title>
        <para>
            <ulink url="http://wiki.scilab.org/Scilab_function_variables%3A_representation%2C_manipulation">http://wiki.scilab.org/Scilab_function_variables%3A_representation%2C_manipulation</ulink>
        </para>
    </refsection>
</refentry>