← Back to branch summary

~ubuntu-branches/ubuntu/raring/scilab/raring-proposed

« back to all changes in this revision

Viewing changes to modules/functions/help/en_US/profiling/add_profiling.xml

  • Committer: Package Import Robot
  • Author(s): Sylvestre Ledru
  • Date: 2012-08-30 14:42:38 UTC
  • mfrom: (1.4.7)
  • Revision ID: package-import@ubuntu.com-20120830144238-c1y2og7dbm7m9nig
Tags: 5.4.0-beta-3-1~exp1
* New upstream release
* Update the scirenderer dep
* Get ride of libjhdf5-java dependency

Show diffs side-by-side

added added

removed removed

Lines of Context:
modules/functions/help/en_US/profiling/add_profiling.xml
10
10
 * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
11
11
-->
12
12
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns3="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" version="5.0-subset Scilab" xml:id="add_profiling" xml:lang="fr">
13
 
  <refnamediv>
14
 
    <refname>add_profiling</refname>
15
 
    <refpurpose>Adds profiling instructions to a function.</refpurpose>
16
 
  </refnamediv>
17
 
  <refsynopsisdiv>
18
 
    <title>Calling Sequence</title>
19
 
    <synopsis>add_profiling(funname)</synopsis>
20
 
  </refsynopsisdiv>
21
 
  <refsection>
22
 
    <title>Arguments</title>
23
 
    <variablelist>
24
 
      <varlistentry>
25
 
        <term>funname</term>
26
 
        <listitem>
27
 
          <para>A character string, the name of the function</para>
28
 
        </listitem>
29
 
      </varlistentry>
30
 
    </variablelist>
31
 
  </refsection>
32
 
  <refsection>
33
 
    <title>Description</title>
34
 
    <para>
35
 
      <literal>add_profiling(funname)</literal> Adds profiling instructions to the function
36
 
      named <literal>funname</literal>. Then when this function is run the number of calls, the
37
 
      time spent is stored for each function line.
38
 
    </para>
39
 
  </refsection>
40
 
  <refsection>
41
 
    <title>Examples</title>
42
 
    <programlisting role="example"><![CDATA[ 
 
13
    <refnamediv>
 
14
        <refname>add_profiling</refname>
 
15
        <refpurpose>Adds profiling instructions to a function.</refpurpose>
 
16
    </refnamediv>
 
17
    <refsynopsisdiv>
 
18
        <title>Calling Sequence</title>
 
19
        <synopsis>add_profiling(funname)</synopsis>
 
20
    </refsynopsisdiv>
 
21
    <refsection>
 
22
        <title>Arguments</title>
 
23
        <variablelist>
 
24
            <varlistentry>
 
25
                <term>funname</term>
 
26
                <listitem>
 
27
                    <para>A character string, the name of the function</para>
 
28
                </listitem>
 
29
            </varlistentry>
 
30
        </variablelist>
 
31
    </refsection>
 
32
    <refsection>
 
33
        <title>Description</title>
 
34
        <para>
 
35
            <literal>add_profiling(funname)</literal> Adds profiling instructions to the function
 
36
            named <literal>funname</literal>. Then when this function is run the number of calls, the
 
37
            time spent is stored for each function line.
 
38
        </para>
 
39
    </refsection>
 
40
    <refsection>
 
41
        <title>Examples</title>
 
42
        <programlisting role="example"><![CDATA[ 
43
43
function x=foo(a,n)
44
44
 x=0;
45
45
 for i=1:n
56
56
foo(0.1,100) //run the function
57
57
profile(foo) //extract profile information
58
58
 ]]></programlisting>
59
 
  </refsection>
60
 
  <refsection role="see also">
61
 
    <title>See Also</title>
62
 
    <simplelist type="inline">
63
 
      <member>
64
 
        <link linkend="profile">profile</link>
65
 
      </member>
66
 
      <member>
67
 
        <link linkend="plotprofile">plotprofile</link>
68
 
      </member>
69
 
      <member>
70
 
        <link linkend="remove_profiling">remove_profiling</link>
71
 
      </member>
72
 
      <member>
73
 
        <link linkend="reset_profiling">reset_profiling</link>
74
 
      </member>
75
 
    </simplelist>
76
 
  </refsection>
77
 
  <refsection>
78
 
    <title>Used Functions</title>
79
 
    <para>
80
 
      This function uses the Scilab functions <literal>bytecode</literal>  and
81
 
      <literal>walkbytecode</literal> 
82
 
    </para>
83
 
  </refsection>
 
59
    </refsection>
 
60
    <refsection role="see also">
 
61
        <title>See Also</title>
 
62
        <simplelist type="inline">
 
63
            <member>
 
64
                <link linkend="profile">profile</link>
 
65
            </member>
 
66
            <member>
 
67
                <link linkend="plotprofile">plotprofile</link>
 
68
            </member>
 
69
            <member>
 
70
                <link linkend="remove_profiling">remove_profiling</link>
 
71
            </member>
 
72
            <member>
 
73
                <link linkend="reset_profiling">reset_profiling</link>
 
74
            </member>
 
75
        </simplelist>
 
76
    </refsection>
 
77
    <refsection>
 
78
        <title>Used Functions</title>
 
79
        <para>
 
80
            This function uses the Scilab functions <literal>bytecode</literal>  and
 
81
            <literal>walkbytecode</literal> 
 
82
        </para>
 
83
    </refsection>
84
84
</refentry>