bb6515d95a0b1dca2acb7f102f947b302a315532
[scilab.git] / scilab / modules / functions / help / en_US / listfunctions.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <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="listfunctions">
3     <refnamediv>
4         <refname>listfunctions</refname>
5         <refpurpose>properties of all functions in 
6             the workspace
7         </refpurpose>
8     </refnamediv>
9     <refsynopsisdiv>
10         <title>Calling Sequence</title>
11         <synopsis>[flist,compiled,profilable,called] = listfunctions([scope])</synopsis>
12     </refsynopsisdiv>
13     <refsection>
14         <title>Arguments</title>
15         <variablelist>
16             <varlistentry>
17                 <term>scope</term>
18                 <listitem>
19                     <para>string, "local" (default) or "global"
20                     </para>
21                 </listitem>
22             </varlistentry>
23             <varlistentry>
24                 <term>flist</term>
25                 <listitem>
26                     <para>string array, names of all the function variables in the specified namespace
27                     </para>
28                 </listitem>
29             </varlistentry>
30             <varlistentry>
31                 <term>compiled</term>
32                 <listitem>
33                     <para>boolean array, true if the corresponding element of flist is of type=13
34                     </para>
35                 </listitem>
36             </varlistentry>
37             <varlistentry>
38                 <term>profilable</term>
39                 <listitem>
40                     <para>boolean array, true if the corresponding element of flist is of type=13, 
41                         and additionally profiling information is found in the pseudocode of
42                         the function
43                     </para>
44                 </listitem>
45             </varlistentry>
46             <varlistentry>
47                 <term>called</term>
48                 <listitem>
49                     <para>uint32 array, number of times the corresponding element of flist has been
50                         already called (nonzero only for profilable functions)
51                     </para>
52                 </listitem>
53             </varlistentry>
54         </variablelist>
55     </refsection>
56     <refsection>
57         <title>Description</title>
58         <itemizedlist>
59             <listitem>
60                 <para>
61                     This function checks all the variables in the workspace (given by 
62                     <link linkend="who">who</link>) and collects those of type 11 or 13; for the latter,
63                     lst=<link linkend="macr2lst">macr2lst</link>(fun) is called, in order to check for the magic
64                     profiling entry at the end of the first codeline, i.e. lst(5)(1)=="25".
65                 </para>
66             </listitem>
67         </itemizedlist>
68     </refsection>
69     <refsection>
70         <title>Examples</title>
71         <programlisting role="example"><![CDATA[ 
72 recompilefunction("asinh","p")
73 [flist,compiled,profilable,called] = listfunctions();
74 flist(profilable)
75  ]]></programlisting>
76     </refsection>
77     <refsection role="see also">
78         <title>See Also</title>
79         <simplelist type="inline">
80             <member>
81                 <link linkend="function">function</link>
82             </member>
83             <member>
84                 <link linkend="exec">exec</link>
85             </member>
86             <member>
87                 <link linkend="deff">deff</link>
88             </member>
89             <member>
90                 <link linkend="comp">comp</link>
91             </member>
92             <member>
93                 <link linkend="fun2string">fun2string</link>
94             </member>
95             <member>
96                 <link linkend="profile">profile</link>
97             </member>
98             <member>
99                 <link linkend="recompilefunction">recompilefunction</link>
100             </member>
101         </simplelist>
102     </refsection>
103     <refsection>
104         <title>Bibliography</title>
105         <para>
106             <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>
107         </para>
108     </refsection>
109 </refentry>