~ubuntu-branches/ubuntu/trusty/khronos-opencl-man/trusty

« back to all changes in this revision

Viewing changes to cl_khr_int64_extended_atomics.xml

  • Committer: Package Import Robot
  • Author(s): Mathieu Malaterre
  • Date: 2013-05-21 18:06:15 UTC
  • Revision ID: package-import@ubuntu.com-20130521180615-6e0s2n3pai95ip2f
Tags: upstream-1.0~svn21772
ImportĀ upstreamĀ versionĀ 1.0~svn21772

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<?xml version="1.0" encoding="UTF-8"?>
 
2
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"
 
3
              "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">
 
4
 
 
5
<refentry>
 
6
    <refentryinfo>
 
7
        <keywordset>
 
8
            <keyword>cl_khr_int64_extended_atomics</keyword>
 
9
        </keywordset>
 
10
    </refentryinfo>
 
11
 
 
12
    <refmeta>
 
13
        <refentrytitle>cl_khr_int64_extended_atomics</refentrytitle>
 
14
 
 
15
        <refmiscinfo>
 
16
            <copyright>
 
17
                <year>2007-2011</year>
 
18
                <holder>The Khronos Group Inc.
 
19
 Permission is hereby granted, free of charge, to any person obtaining a
 
20
copy of this software and/or associated documentation files (the
 
21
"Materials"), to deal in the Materials without restriction, including
 
22
without limitation the rights to use, copy, modify, merge, publish,
 
23
distribute, sublicense, and/or sell copies of the Materials, and to
 
24
permit persons to whom the Materials are furnished to do so, subject to
 
25
the condition that this copyright notice and permission notice shall be included
 
26
in all copies or substantial portions of the Materials.</holder>
 
27
            </copyright>
 
28
        </refmiscinfo>
 
29
        <manvolnum>3</manvolnum>
 
30
    </refmeta>
 
31
 
 
32
<!-- ================================ SYNOPSIS -->
 
33
 
 
34
    <refnamediv id="cl_khr_int64_extended_atomics">
 
35
        <refname>cl_khr_int64_extended_atomics</refname>
 
36
 
 
37
        <refpurpose>
 
38
            Optional extensions that implement atomic operations on 64-bit signed and unsigned integers to locations in __global and __local memory.
 
39
        </refpurpose>
 
40
    </refnamediv>
 
41
 
 
42
    <!-- ALTERNATIVE SYNTAX SYNOPSIS (NON-FUNCTION) -->
 
43
 
 
44
    <refsect2 id="synopsis">
 
45
        <title>
 
46
        </title>
 
47
 
 
48
        <informaltable frame="none">
 
49
            <tgroup cols="1" align="left" colsep="0" rowsep="0">
 
50
                <colspec colname="col1" colnum="1" />
 
51
                <tbody>
 
52
                    <row>
 
53
                        <entry>
 
54
#pragma OPENCL EXTENSION cl_khr_int64_extended_atomics : enable
 
55
                        </entry>
 
56
                    </row>
 
57
                </tbody>
 
58
            </tgroup>
 
59
        </informaltable>
 
60
    </refsect2>
 
61
 
 
62
<!-- ================================ DESCRIPTION  -->
 
63
 
 
64
    <refsect1 id="description" xmlns:xlink="http://www.w3.org/1999/xlink"><title>Description</title>
 
65
        <para>
 
66
          An application that wants to use this extension will need to include the
 
67
          <function>#pragma OPENCL EXTENSION cl_khr_int64_extended_atomics : enable</function>
 
68
          directive in the OpenCL program source.
 
69
        </para>
 
70
 
 
71
        <para>
 
72
          The atomic functions supported by the <function>cl_khr_int64_extended_atomics</function>
 
73
          extension are described in the following table. All of the functions listed in the
 
74
          following table are performed in one atomic transaction.
 
75
        </para>
 
76
 
 
77
        <para>
 
78
          These transactions are atomic for the device executing these atomic functions. There
 
79
          is no guarantee of atomicity if the atomic operations to the same memory location
 
80
          are being performed by kernels executing on multiple devices.
 
81
        </para>
 
82
 
 
83
        <para>
 
84
          Atomic operations on 64-bit integers and 32-bit integers (and float) are also atomic
 
85
          w.r.t. each other.
 
86
        </para>
 
87
 
 
88
        <informaltable frame="all">
 
89
            <tgroup cols="2" align="left" colsep="1" rowsep="1">
 
90
                <colspec colname="col1" colnum="1" />
 
91
                <colspec colname="col2" colnum="2" />
 
92
                <thead>
 
93
                    <row>
 
94
                        <entry>Function</entry>
 
95
                        <entry>Description</entry>
 
96
                    </row>
 
97
                </thead>
 
98
 
 
99
                <tbody>
 
100
                    <row>
 
101
                        <entry><citerefentry><refentrytitle>atom_min</refentrytitle></citerefentry></entry>
 
102
                        <entry>Compute
 
103
                           <link xlink:href="commonMin.html">min</link>
 
104
                            (<varname>old</varname>, <varname>val</varname>)</entry>
 
105
                    </row>
 
106
 
 
107
                    <row>
 
108
                        <entry><citerefentry><refentrytitle>atom_max</refentrytitle></citerefentry></entry>
 
109
                        <entry>Compute
 
110
                            <link xlink:href="commonMin.html">max</link>
 
111
                            (<varname>old</varname>, <varname>val</varname>)></entry>
 
112
                    </row>
 
113
 
 
114
                    <row>
 
115
                        <entry><citerefentry><refentrytitle>atom_and</refentrytitle></citerefentry></entry>
 
116
                        <entry>Compute (<varname>old</varname> &amp; <varname>val</varname>)</entry>
 
117
                    </row>
 
118
 
 
119
                    <row>
 
120
                        <entry><citerefentry><refentrytitle>atom_or</refentrytitle></citerefentry></entry>
 
121
                        <entry>Compute (<varname>old</varname> | <varname>val</varname>)</entry>
 
122
                    </row>
 
123
 
 
124
                    <row>
 
125
                        <entry><citerefentry><refentrytitle>atom_xor</refentrytitle></citerefentry></entry>
 
126
                        <entry>Compute (<varname>old</varname> ^ <varname>val</varname>)</entry>
 
127
                    </row>
 
128
                </tbody>
 
129
            </tgroup>
 
130
        </informaltable>
 
131
    </refsect1>
 
132
 
 
133
<!-- ================================ NOTES  -->
 
134
 
 
135
    <!-- refsect1 id="notes"><title>Notes</title>
 
136
        <para>
 
137
 
 
138
        </para>
 
139
    </refsect1 -->
 
140
 
 
141
<!-- ================================ EXAMPLE  -->
 
142
<!-- DO NOT DELETE IN CASE AN EXAMPLE IS ADDED IN THE FUTURE -->
 
143
<!--
 
144
    <refsect2 id="example1">
 
145
        <title>
 
146
            Example
 
147
        </title>
 
148
 
 
149
        <informaltable frame="none">
 
150
            <tgroup cols="1" align="left" colsep="0" rowsep="0">
 
151
                <colspec colname="col1" colnum="1" />
 
152
                <tbody>
 
153
                    <row>
 
154
                        <entry>
 
155
                            Example goes here - it will be set in "code" type with white space preserved.
 
156
                        </entry>
 
157
                    </row>
 
158
                </tbody>
 
159
            </tgroup>
 
160
        </informaltable>
 
161
    </refsect2>
 
162
-->
 
163
 
 
164
<!-- ================================ SPECIFICATION  -->
 
165
<!-- Set the "uri" attribute in the <olink /> element to the "named destination" for the PDF page
 
166
-->
 
167
    <refsect1 id="specification"><title>Specification</title>
 
168
        <para>
 
169
            <imageobject>
 
170
                <imagedata fileref="pdficon_small1.gif" format="gif" />
 
171
            </imageobject>
 
172
 
 
173
            <olink uri="cl_khr_int64_extended_atomics">OpenCL Specification</olink>
 
174
        </para>
 
175
    </refsect1>
 
176
 
 
177
<!-- ================================ ALSO SEE  -->
 
178
 
 
179
    <refsect1 id="seealso"><title>Also see</title>
 
180
        <para>
 
181
            <citerefentry><refentrytitle>EXTENSION</refentrytitle></citerefentry>,
 
182
            <citerefentry><refentrytitle>cl_khr_int64_base_atomics</refentrytitle></citerefentry>,
 
183
            <citerefentry href="atomicFunctions"><refentrytitle>Atomic Functions</refentrytitle></citerefentry>
 
184
        </para>
 
185
    </refsect1>
 
186
 
 
187
<!-- ============================== COPYRIGHT -->
 
188
<!-- Content included from copyright.inc.xsl -->
 
189
 
 
190
    <refsect3 id="Copyright"><title></title>
 
191
        <imageobject>
 
192
                <imagedata fileref="KhronosLogo.jpg" format="jpg" />
 
193
        </imageobject>
 
194
        <para />
 
195
    </refsect3>
 
196
 
 
197
<!-- 18-Oct-2011 -->
 
198
</refentry>
 
199