File: liboilcpu.xml

package info (click to toggle)
liboil 0.3.15-1
  • links: PTS
  • area: main
  • in suites: lenny
  • size: 7,032 kB
  • ctags: 5,929
  • sloc: ansic: 47,058; xml: 12,229; sh: 8,957; perl: 1,095; asm: 1,072; makefile: 748
file content (83 lines) | stat: -rw-r--r-- 2,868 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"
>
<refentry id="liboil-liboilcpu">
<refmeta>
<refentrytitle role="top_of_page" id="liboil-liboilcpu.top_of_page">CPU</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBOIL Library</refmiscinfo>
</refmeta>

<refnamediv>
<refname>CPU</refname>
<refpurpose>Check the capabilities of the current CPU</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>

<refsynopsisdiv id="liboil-liboilcpu.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>

<synopsis>
unsigned <link linkend="int">int</link>        <link linkend="oil-cpu-get-flags">oil_cpu_get_flags</link>                   (void);
<link linkend="double">double</link>              <link linkend="oil-cpu-get-ticks-per-second">oil_cpu_get_ticks_per_second</link>        (void);
</synopsis>
</refsynopsisdiv>









<refsect1 id="liboil-liboilcpu.description" role="desc">
<title role="desc.title">Description</title>
<para>
</para>
<para>

</para>
</refsect1>

<refsect1 id="liboil-liboilcpu.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="oil-cpu-get-flags" role="function">
<title>oil_cpu_get_flags ()</title>
<indexterm zone="oil-cpu-get-flags"><primary>oil_cpu_get_flags</primary></indexterm><programlisting>unsigned <link linkend="int">int</link>        oil_cpu_get_flags                   (void);</programlisting>
<para>
Returns a bitmask containing the available CPU features.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the CPU features.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="oil-cpu-get-ticks-per-second" role="function">
<title>oil_cpu_get_ticks_per_second ()</title>
<indexterm zone="oil-cpu-get-ticks-per-second"><primary>oil_cpu_get_ticks_per_second</primary></indexterm><programlisting><link linkend="double">double</link>              oil_cpu_get_ticks_per_second        (void);</programlisting>
<para>
Returns the estimated number of ticks per second.  This feature
is currently unimplemented.
</para>
<para>
This function may take several milliseconds or more to execute
in order to calculate a good estimate of the number of ticks (as
measured by the profiling functions) per second.  Note that the
number of ticks per second is often dependent on the CPU frequency,
which can change dynamically.  Thus the value returned by this
function may be incorrect as soon as it is returned.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a double
</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>




</refentry>