Revision of help page for listfunctions function
[scilab.git] / scilab / modules / functions / help / pt_BR / listfunctions.xml
1 <?xml version="1.0" encoding="ISO-8859-1"?>
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:ns4="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="listfunctions" xml:lang="pt">
3     <refnamediv>
4         <refname>listfunctions</refname>
5         <refpurpose>propriedades de todas as funções no espaço de
6             trabalho
7         </refpurpose>
8     </refnamediv>
9     <refsynopsisdiv>
10         <title>Seqüência de Chamamento</title>
11         <synopsis>[flist,compiled,profilable,called] = listfunctions([scope])</synopsis>
12     </refsynopsisdiv>
13     <refsection>
14         <title>Parâmetros</title>
15         <variablelist>
16             <varlistentry>
17                 <term>scope</term>
18                 <listitem>
19                     <para>
20                         string, <literal>"local"</literal> (padrão) ou <literal>"global"</literal>
21                     </para>
22                 </listitem>
23             </varlistentry>
24             <varlistentry>
25                 <term>flist</term>
26                 <listitem>
27                     <para>array de strings, names nomes de todas as variáveis funções
28                         especificadas no espaço de trabalho
29                     </para>
30                 </listitem>
31             </varlistentry>
32             <varlistentry>
33                 <term>compiled</term>
34                 <listitem>
35                     <para>array de booleanos, verdadeiro se o elemento correspondente de
36                         <varname>flist</varname> for do tipo 13
37                     </para>
38                 </listitem>
39             </varlistentry>
40             <varlistentry>
41                 <term>profilable</term>
42                 <listitem>
43                     <para>array de booleanos, verdadeiro se o elemento correspondente de
44                         <varname>flist</varname> for do tipo 13, e adicionalmente informações sobre profiling
45                         forem encontradas no pseudo-código da função.
46                     </para>
47                 </listitem>
48             </varlistentry>
49             <varlistentry>
50                 <term>called</term>
51                 <listitem>
52                     <para>array uint32, número de vezes que o elemento correspondente de
53                         <varname>flist</varname> foi chamado (não-zero apenas se a função possuir
54                         profiling)
55                     </para>
56                 </listitem>
57             </varlistentry>
58         </variablelist>
59     </refsection>
60     <refsection>
61         <title>Descrição</title>
62         <itemizedlist>
63             <listitem>
64                 <para>Esta função verifica todas as variáveis do espaço de trabalho
65                     (dadas por <link linkend="who">who</link>) e coleta aquelas de tipo 11
66                     ou 13; para as últimas, <code>lst = macr2lst(fun)</code> é chamada, de modo a verificar
67                     a entrada para magic profiling ao fim da primeira linha de código,
68                     i.e. <code>lst(5)(1)=="25"</code>.
69                 </para>
70             </listitem>
71         </itemizedlist>
72     </refsection>
73     <refsection>
74         <title>Exemplos</title>
75         <programlisting role="example"><![CDATA[
76 recompilefunction("asinh","p")
77 [flist,compiled,profilable,called] = listfunctions();
78 flist(profilable)
79  ]]></programlisting>
80     </refsection>
81     <refsection role="see also">
82         <title>Ver Também</title>
83         <simplelist type="inline">
84             <member>
85                 <link linkend="function">function</link>
86             </member>
87             <member>
88                 <link linkend="exec">exec</link>
89             </member>
90             <member>
91                 <link linkend="deff">deff</link>
92             </member>
93             <member>
94                 <link linkend="comp">comp</link>
95             </member>
96             <member>
97                 <link linkend="fun2string">fun2string</link>
98             </member>
99             <member>
100                 <link linkend="macr2lst">macr2lst</link>
101             </member>
102             <member>
103                 <link linkend="profile">profile</link>
104             </member>
105             <member>
106                 <link linkend="recompilefunction">recompilefunction</link>
107             </member>
108             <member>
109                 <link linkend="who">who</link>
110             </member>
111         </simplelist>
112     </refsection>
113     <refsection>
114         <title>Bibliografia</title>
115         <para>
116             <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>
117         </para>
118     </refsection>
119 </refentry>