← Back to branch summary

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

« back to all changes in this revision

Viewing changes to modules/time/help/en_US/timer.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/time/help/en_US/timer.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:ns5="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="timer" xml:lang="en">
14
 
  <refnamediv>
15
 
    <refname>timer</refname>
16
 
    <refpurpose>cpu time</refpurpose>
17
 
  </refnamediv>
18
 
  <refsynopsisdiv>
19
 
    <title>Calling Sequence</title>
20
 
    <synopsis>timer()</synopsis>
21
 
  </refsynopsisdiv>
22
 
  <refsection>
23
 
    <title>Description</title>
24
 
    <para>Returns the CPU time since the preceding call to
25
 
      <literal>timer()</literal>.
26
 
    </para>
27
 
    <para>timer has a time precision of 100 nanoseconds.</para>
28
 
    <para>NOTE: CPU time is the number of processor cycles used for a
29
 
      computation. This is not at all equivalent to real-world time.
30
 
    </para>
31
 
    <para>CPU time can be used to compare CPU usage between different programs
32
 
      or functions , irrespective of background processes that might slow down
33
 
      the computer.
34
 
    </para>
35
 
  </refsection>
36
 
  <refsection>
37
 
    <title>Examples</title>
38
 
    <programlisting role="example"><![CDATA[ 
 
14
    <refnamediv>
 
15
        <refname>timer</refname>
 
16
        <refpurpose>cpu time</refpurpose>
 
17
    </refnamediv>
 
18
    <refsynopsisdiv>
 
19
        <title>Calling Sequence</title>
 
20
        <synopsis>timer()</synopsis>
 
21
    </refsynopsisdiv>
 
22
    <refsection>
 
23
        <title>Description</title>
 
24
        <para>Returns the CPU time since the preceding call to
 
25
            <literal>timer()</literal>.
 
26
        </para>
 
27
        <para>timer has a time precision of 100 nanoseconds.</para>
 
28
        <para>NOTE: CPU time is the number of processor cycles used for a
 
29
            computation. This is not at all equivalent to real-world time.
 
30
        </para>
 
31
        <para>CPU time can be used to compare CPU usage between different programs
 
32
            or functions , irrespective of background processes that might slow down
 
33
            the computer.
 
34
        </para>
 
35
    </refsection>
 
36
    <refsection>
 
37
        <title>Examples</title>
 
38
        <programlisting role="example"><![CDATA[ 
39
39
timer();A=rand(100,100);timer()
40
40
 ]]></programlisting>
41
 
  </refsection>
42
 
  <refsection role="see also">
43
 
    <title>See Also</title>
44
 
    <simplelist type="inline">
45
 
      <member>
46
 
        <link linkend="getdate">getdate</link>
47
 
      </member>
48
 
      <member>
49
 
        <link linkend="toc">toc</link>
50
 
      </member>
51
 
      <member>
52
 
        <link linkend="tic">tic</link>
53
 
      </member>
54
 
      <member>
55
 
        <link linkend="etime">etime</link>
56
 
      </member>
57
 
    </simplelist>
58
 
  </refsection>
 
41
    </refsection>
 
42
    <refsection role="see also">
 
43
        <title>See Also</title>
 
44
        <simplelist type="inline">
 
45
            <member>
 
46
                <link linkend="getdate">getdate</link>
 
47
            </member>
 
48
            <member>
 
49
                <link linkend="toc">toc</link>
 
50
            </member>
 
51
            <member>
 
52
                <link linkend="tic">tic</link>
 
53
            </member>
 
54
            <member>
 
55
                <link linkend="etime">etime</link>
 
56
            </member>
 
57
        </simplelist>
 
58
    </refsection>
59
59
</refentry>