← 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/plotprofile.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/plotprofile.xml
11
11
 *
12
12
 -->
13
13
<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" version="5.0-subset Scilab" xml:lang="en" xml:id="plotprofile">
14
 
  <refnamediv>
15
 
    <refname>plotprofile</refname>
16
 
    <refpurpose> extracts and displays execution profiles
17
 
      of a Scilab function
18
 
    </refpurpose>
19
 
  </refnamediv>
20
 
  <refsynopsisdiv>
21
 
    <title>Calling Sequence</title>
22
 
    <synopsis>plotprofile(fun)</synopsis>
23
 
  </refsynopsisdiv>
24
 
  <refsection>
25
 
    <title>Arguments</title>
26
 
    <variablelist>
27
 
      <varlistentry>
28
 
        <term>fun</term>
29
 
        <listitem>
30
 
          <para>a Scilab compiled function, or a function name (string), or an array of
31
 
            function names
32
 
          </para>
33
 
        </listitem>
34
 
      </varlistentry>
35
 
    </variablelist>
36
 
  </refsection>
37
 
  <refsection>
38
 
    <title>Description</title>
39
 
    <para>
40
 
      To use <literal>plotprofile</literal>, the Scilab function must have been prepared for
41
 
      profiling (see exec).
42
 
    </para>
43
 
    <para>
44
 
      When such a function is executed, the system
45
 
      counts how many times each line is executed and how much cpu time is
46
 
      spent executing each line. This data is stored within the
47
 
      function data structure. The function <literal>plotprofile</literal> in an interactive
48
 
      command which displays this results in a graphic window. When a line
49
 
      is clicked, the source of the function is displayed with the selected line
50
 
      highlighted.
51
 
    </para>
52
 
    <para>
53
 
      NOTE: you have to click on the "Exit" item in the graphics windows to
54
 
      exit from "plotprofile".
55
 
    </para>
56
 
    <para>
57
 
      The function code is regenerated with <literal>fun2string</literal> and dumped into
58
 
      a temporary file.
59
 
    </para>
60
 
  </refsection>
61
 
  <refsection>
62
 
    <title>Examples</title>
63
 
    <programlisting role="example"><![CDATA[ 
 
14
    <refnamediv>
 
15
        <refname>plotprofile</refname>
 
16
        <refpurpose> extracts and displays execution profiles
 
17
            of a Scilab function
 
18
        </refpurpose>
 
19
    </refnamediv>
 
20
    <refsynopsisdiv>
 
21
        <title>Calling Sequence</title>
 
22
        <synopsis>plotprofile(fun)</synopsis>
 
23
    </refsynopsisdiv>
 
24
    <refsection>
 
25
        <title>Arguments</title>
 
26
        <variablelist>
 
27
            <varlistentry>
 
28
                <term>fun</term>
 
29
                <listitem>
 
30
                    <para>a Scilab compiled function, or a function name (string), or an array of
 
31
                        function names
 
32
                    </para>
 
33
                </listitem>
 
34
            </varlistentry>
 
35
        </variablelist>
 
36
    </refsection>
 
37
    <refsection>
 
38
        <title>Description</title>
 
39
        <para>
 
40
            To use <literal>plotprofile</literal>, the Scilab function must have been prepared for
 
41
            profiling (see exec).
 
42
        </para>
 
43
        <para>
 
44
            When such a function is executed, the system
 
45
            counts how many times each line is executed and how much cpu time is
 
46
            spent executing each line. This data is stored within the
 
47
            function data structure. The function <literal>plotprofile</literal> in an interactive
 
48
            command which displays this results in a graphic window. When a line
 
49
            is clicked, the source of the function is displayed with the selected line
 
50
            highlighted.
 
51
        </para>
 
52
        <para>
 
53
            NOTE: you have to click on the "Exit" item in the graphics windows to
 
54
            exit from "plotprofile".
 
55
        </para>
 
56
        <para>
 
57
            The function code is regenerated with <literal>fun2string</literal> and dumped into
 
58
            a temporary file.
 
59
        </para>
 
60
    </refsection>
 
61
    <refsection>
 
62
        <title>Examples</title>
 
63
        <programlisting role="example"><![CDATA[ 
64
64
//define a function and prepare it for profiling
65
65
deff('x=foo(n)',['if n==0 then'
66
66
                 '  x=[]'
77
77
//get execution profiles
78
78
plotprofile(foo) // click on Exit to exit
79
79
  ]]></programlisting>
80
 
  </refsection>
81
 
  <refsection role="see also">
82
 
    <title>See Also</title>
83
 
    <simplelist type="inline">
84
 
      <member>
85
 
        <link linkend="profile">profile</link>
86
 
      </member>
87
 
      <member>
88
 
        <link linkend="showprofile">showprofile</link>
89
 
      </member>
90
 
      <member>
91
 
        <link linkend="fun2string">fun2string</link>
92
 
      </member>
93
 
    </simplelist>
94
 
  </refsection>
 
80
    </refsection>
 
81
    <refsection role="see also">
 
82
        <title>See Also</title>
 
83
        <simplelist type="inline">
 
84
            <member>
 
85
                <link linkend="profile">profile</link>
 
86
            </member>
 
87
            <member>
 
88
                <link linkend="showprofile">showprofile</link>
 
89
            </member>
 
90
            <member>
 
91
                <link linkend="fun2string">fun2string</link>
 
92
            </member>
 
93
        </simplelist>
 
94
    </refsection>
95
95
</refentry>