OSDN Git Service

2010-03-03 Benjamin Kosnik <bkoz@redhat.com>
[pf3gnuchains/gcc-fork.git] / libstdc++-v3 / doc / xml / manual / atomics.xml
1 <?xml version='1.0'?>
2 <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3  "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"
4 [ ]>
5
6 <chapter id="std.atomics" xreflabel="Atomics">
7 <?dbhtml filename="atomics.html"?>
8
9 <chapterinfo>
10   <keywordset>
11     <keyword>
12       ISO C++
13     </keyword>
14     <keyword>
15       library
16     </keyword>
17     <keyword>
18       atomic
19     </keyword>
20   </keywordset>
21 </chapterinfo>
22
23 <title>
24   Atomics
25   <indexterm><primary>Atomics</primary></indexterm>
26 </title>
27
28 <para>
29   Facilities for atomic operations.
30 </para>
31
32 <!-- Sect1 01 : API -->
33 <sect1 id="std.atomics.api">
34   <title>API Reference</title>
35
36   <para>
37     All items are declared in the standard header
38     file <filename>atomic</filename>.
39   </para>
40
41   <para>
42     Set of typedefs that map <type>int</type> to
43     <classname>atomic_int</classname>, and so on for all builtin
44     integral types. Global enumeration <type>memory_order</type> to
45     control memory ordering. Also includes
46     <classname>atomic</classname>, a class template with member
47     functions such as <function>load</function> and
48     <function>store</function> that is instantiable such that
49     <classname>atomic_int</classname> is the base class of
50     <classname>atomic&lt;int&gt;</classname>.
51   </para>
52
53   <para>
54     Full API details.
55   </para>
56
57   <!-- Doxygen XML: api/group__atomics.xml -->
58
59 </sect1>
60
61 </chapter>