← Back to branch summary

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

« back to all changes in this revision

Viewing changes to atom_min.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:
atom_min.xml
 
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
<refentry>
 
5
    <refentryinfo>
 
6
        <keywordset>
 
7
            <keyword>atom_min</keyword>
 
8
        </keywordset>
 
9
    </refentryinfo>
 
10
 
 
11
    <refmeta>                                    
 
12
        <refentrytitle>atom_min</refentrytitle>
 
13
 
 
14
        <refmiscinfo>
 
15
            <copyright>
 
16
                <year>2007-2011</year>
 
17
                <holder>The Khronos Group Inc. 
 
18
 Permission is hereby granted, free of charge, to any person obtaining a
 
19
copy of this software and/or associated documentation files (the
 
20
"Materials"), to deal in the Materials without restriction, including
 
21
without limitation the rights to use, copy, modify, merge, publish,
 
22
distribute, sublicense, and/or sell copies of the Materials, and to
 
23
permit persons to whom the Materials are furnished to do so, subject to
 
24
the condition that this copyright notice and permission notice shall be included
 
25
in all copies or substantial portions of the Materials.</holder>
 
26
            </copyright>
 
27
        </refmiscinfo>
 
28
        <manvolnum>3</manvolnum>
 
29
    </refmeta>
 
30
 
 
31
<!-- ================================ SYNOPSIS -->
 
32
 
 
33
    <refnamediv id="atom_min">             
 
34
        <refname>atom_min</refname>
 
35
 
 
36
        <refpurpose>
 
37
            64-bit atom_min functions. 
 
38
        </refpurpose>
 
39
    </refnamediv>
 
40
 
 
41
    <refsynopsisdiv xmlns:xlink="http://www.w3.org/1999/xlink"><title></title>
 
42
        <funcsynopsis>
 
43
            <funcprototype>
 
44
                <funcdef>
 
45
                    <link xlink:href="scalarDataTypes.html">long</link>
 
46
                    <function>                   
 
47
                        atom_min
 
48
                    </function>
 
49
                </funcdef>
 
50
                <paramdef>
 
51
                    volatile <citerefentry href="global"><refentrytitle>__global</refentrytitle></citerefentry> 
 
52
                    <link xlink:href="scalarDataTypes.html">long</link><parameter>*p</parameter>
 
53
                </paramdef>    
 
54
                <paramdef><link xlink:href="scalarDataTypes.html">long</link><parameter>val</parameter></paramdef>   
 
55
            </funcprototype>
 
56
        </funcsynopsis>     
 
57
        
 
58
        <funcsynopsis>
 
59
            <funcprototype>
 
60
                <funcdef>
 
61
                    <link xlink:href="scalarDataTypes.html">long</link>
 
62
                    <function>                   
 
63
                        atom_min
 
64
                    </function>
 
65
                </funcdef>
 
66
                <paramdef>
 
67
                    volatile <citerefentry href="global"><refentrytitle>__local</refentrytitle></citerefentry> 
 
68
                    <link xlink:href="scalarDataTypes.html">long</link><parameter>*p</parameter>
 
69
                </paramdef>   
 
70
                <paramdef><link xlink:href="scalarDataTypes.html">long</link><parameter>val</parameter></paramdef>  
 
71
            </funcprototype>
 
72
        </funcsynopsis>     
 
73
 
 
74
        <funcsynopsis>
 
75
            <funcprototype>
 
76
                <funcdef>
 
77
                    <link xlink:href="scalarDataTypes.html">ulong</link>
 
78
                    <function>                   
 
79
                        atom_min
 
80
                    </function>
 
81
                </funcdef>
 
82
                <paramdef>
 
83
                    volatile <citerefentry href="local"><refentrytitle>__global</refentrytitle></citerefentry> 
 
84
                    <link xlink:href="scalarDataTypes.html">ulong</link><parameter>*p</parameter>
 
85
                </paramdef>  
 
86
                <paramdef><link xlink:href="scalarDataTypes.html">ulong</link><parameter>val</parameter></paramdef>   
 
87
            </funcprototype>
 
88
        </funcsynopsis>     
 
89
        
 
90
        <funcsynopsis>
 
91
            <funcprototype>
 
92
                <funcdef>
 
93
                    <link xlink:href="scalarDataTypes.html">ulong</link>
 
94
                    <function>                   
 
95
                        atom_min
 
96
                    </function>
 
97
                </funcdef>
 
98
                <paramdef>
 
99
                    volatile <citerefentry href="local"><refentrytitle>__local</refentrytitle></citerefentry>
 
100
                    <link xlink:href="scalarDataTypes.html">ulong</link><parameter>*p</parameter>
 
101
                </paramdef> 
 
102
                <paramdef><link xlink:href="scalarDataTypes.html">ulong</link><parameter>val</parameter></paramdef>  
 
103
            </funcprototype>
 
104
        </funcsynopsis>     
 
105
    </refsynopsisdiv>
 
106
 
 
107
<!-- ================================ DESCRIPTION  -->
 
108
 
 
109
    <refsect1 id="description"><title>Description</title>
 
110
        <para>
 
111
            Read the 64-bit value (referred to as <varname>old</varname>) stored at location pointed by 
 
112
            <varname>p</varname>. Compute <citerefentry href="commonMin"><refentrytitle>min</refentrytitle></citerefentry>
 
113
            (<varname>old</varname>, <varname>val</varname>) and store minimum value at location pointed by 
 
114
            <varname>p</varname>. The function returns <varname>old</varname>.
 
115
        </para>
 
116
 
 
117
        <para>
 
118
            An application that wants to use this extension will need to include the <code>#pragma 
 
119
            OPENCL EXTENSION cl_khr_int64_extended_atomics : enable</code> in the OpenCL program source.
 
120
        </para>
 
121
 
 
122
        <para>
 
123
            This function is performed in one atomic transaction. These transactions are atomic for the device 
 
124
            executing these atomic functions. There is no guarantee of atomicity if the atomic operations to 
 
125
            the same memory location are being performed by kernels executing on multiple devices.
 
126
        </para>
 
127
 
 
128
        <para>
 
129
            Atomic operations on 64-bit integers and 32-bit integers (and float) are also atomic with regard to each other.
 
130
        </para>
 
131
 
 
132
    </refsect1>
 
133
 
 
134
<!-- ================================ NOTES  
 
135
 
 
136
    <refsect1 id="notes"><title>Notes</title>
 
137
         
 
138
    </refsect1>-->
 
139
 
 
140
<!-- ================================ EXAMPLE  -->
 
141
<!-- DO NOT DELETE IN CASE AN EXAMPLE IS ADDED IN THE FUTURE -->
 
142
<!--
 
143
    <refsect2 id="example1">
 
144
        <title>
 
145
            Example
 
146
        </title>
 
147
 
 
148
        <informaltable frame="none">
 
149
            <tgroup cols="1" align="left" colsep="0" rowsep="0">
 
150
                <colspec colname="col1" colnum="1" />
 
151
                <tbody>
 
152
                    <row>
 
153
                        <entry>
 
154
                            Example goes here - it will be set in "code" type with white space preserved.
 
155
                        </entry>
 
156
                    </row>
 
157
                </tbody>
 
158
            </tgroup>
 
159
        </informaltable>
 
160
    </refsect2>
 
161
-->
 
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="atomicFunctions">OpenCL Specification</olink>
 
174
        </para>
 
175
    </refsect1>
 
176
 
 
177
 
 
178
<!-- ================================ ALSO SEE  -->
 
179
 
 
180
    <refsect1 id="seealso"><title>Also see</title>
 
181
        <para>
 
182
            <citerefentry href="atomicFunctions"><refentrytitle>Atomic Functions</refentrytitle></citerefentry>,
 
183
            <citerefentry><refentrytitle>atomic_min</refentrytitle></citerefentry>,
 
184
            <citerefentry><refentrytitle>cl_khr_int64_extended_atomics</refentrytitle></citerefentry>  
 
185
        </para>
 
186
    </refsect1>
 
187
 
 
188
 
 
189
 
 
190
<!-- ============================== COPYRIGHT -->
 
191
<!-- Content included from copyright.inc.xsl -->
 
192
 
 
193
    <refsect3 id="Copyright"><title></title>
 
194
        <imageobject>
 
195
                <imagedata fileref="KhronosLogo.jpg" format="jpg" />
 
196
        </imageobject>
 
197
        <para />
 
198
    </refsect3>
 
199
<!-- 11-Oct-11 -->
 
200
</refentry>
 
201