← Back to branch summary

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

« back to all changes in this revision

Viewing changes to atomic_max.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:
atomic_max.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>atomic_max</keyword>
 
8
        </keywordset>
 
9
    </refentryinfo>
 
10
 
 
11
    <refmeta>                                    
 
12
        <refentrytitle>atomic_max</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="atomic_max">             
 
34
        <refname>atomic_max</refname>
 
35
 
 
36
        <refpurpose>
 
37
            atomic_max 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">int</link>
 
46
                    <function>                   
 
47
                        atomic_max
 
48
                    </function>
 
49
                </funcdef>
 
50
                <paramdef>
 
51
                    volatile <citerefentry href="global"><refentrytitle>__global</refentrytitle></citerefentry> 
 
52
                    <link xlink:href="scalarDataTypes.html">int</link><parameter>*p</parameter>
 
53
                </paramdef>    
 
54
                <paramdef><link xlink:href="scalarDataTypes.html">int</link><parameter>val</parameter></paramdef>   
 
55
            </funcprototype>
 
56
        </funcsynopsis>     
 
57
        
 
58
        <funcsynopsis>
 
59
            <funcprototype>
 
60
                <funcdef>
 
61
                    <link xlink:href="scalarDataTypes.html">unsigned int</link>
 
62
                    <function>                   
 
63
                        atomic_max
 
64
                    </function>
 
65
                </funcdef>
 
66
                <paramdef>
 
67
                    volatile <citerefentry href="global"><refentrytitle>__global</refentrytitle></citerefentry> 
 
68
                    <link xlink:href="scalarDataTypes.html">unsigned int</link><parameter>*p</parameter>
 
69
                </paramdef>   
 
70
                <paramdef><link xlink:href="scalarDataTypes.html">unsigned int</link><parameter>val</parameter></paramdef>  
 
71
            </funcprototype>
 
72
        </funcsynopsis>     
 
73
 
 
74
        <funcsynopsis>
 
75
            <funcprototype>
 
76
                <funcdef>
 
77
                    <link xlink:href="scalarDataTypes.html">int</link>
 
78
                    <function>                   
 
79
                        atomic_max
 
80
                    </function>
 
81
                </funcdef>
 
82
                <paramdef>
 
83
                    volatile <citerefentry href="local"><refentrytitle>__local</refentrytitle></citerefentry> 
 
84
                    <link xlink:href="scalarDataTypes.html">int</link><parameter>*p</parameter>
 
85
                </paramdef>  
 
86
                <paramdef><link xlink:href="scalarDataTypes.html">int</link><parameter>val</parameter></paramdef>   
 
87
            </funcprototype>
 
88
        </funcsynopsis>     
 
89
        
 
90
        <funcsynopsis>
 
91
            <funcprototype>
 
92
                <funcdef>
 
93
                    <link xlink:href="scalarDataTypes.html">unsigned int</link>
 
94
                    <function>                   
 
95
                        atomic_max
 
96
                    </function>
 
97
                </funcdef>
 
98
                <paramdef>
 
99
                    volatile <citerefentry href="local"><refentrytitle>__local</refentrytitle></citerefentry>
 
100
                    <link xlink:href="scalarDataTypes.html">unsigned int</link><parameter>*p</parameter>
 
101
                </paramdef> 
 
102
                <paramdef><link xlink:href="scalarDataTypes.html">unsigned int</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 32-bit value (referred to as <varname>old</varname>) stored at location pointed by 
 
112
            <varname>p</varname>. Compute <citerefentry href="commonMax"><refentrytitle>max</refentrytitle></citerefentry>
 
113
            (<varname>old</varname>, <varname>val</varname>) and store result at location pointed by 
 
114
            <varname>p</varname>. The function returns <varname>old</varname>.
 
115
        </para>
 
116
 
 
117
        <para>
 
118
            A 64-bit version of this function, <citerefentry><refentrytitle>atom_max</refentrytitle></citerefentry>,
 
119
            is enabled by <citerefentry><refentrytitle>cl_khr_int64_extended_atomics</refentrytitle></citerefentry>.
 
120
        </para>
 
121
    </refsect1>
 
122
 
 
123
<!-- ================================ NOTES  
 
124
 
 
125
    <refsect1 id="notes"><title>Notes</title>
 
126
         
 
127
    </refsect1>-->
 
128
 
 
129
<!-- ================================ EXAMPLE  -->
 
130
<!-- DO NOT DELETE IN CASE AN EXAMPLE IS ADDED IN THE FUTURE -->
 
131
<!--
 
132
    <refsect2 id="example1">
 
133
        <title>
 
134
            Example
 
135
        </title>
 
136
 
 
137
        <informaltable frame="none">
 
138
            <tgroup cols="1" align="left" colsep="0" rowsep="0">
 
139
                <colspec colname="col1" colnum="1" />
 
140
                <tbody>
 
141
                    <row>
 
142
                        <entry>
 
143
                            Example goes here - it will be set in "code" type with white space preserved.
 
144
                        </entry>
 
145
                    </row>
 
146
                </tbody>
 
147
            </tgroup>
 
148
        </informaltable>
 
149
    </refsect2>
 
150
-->
 
151
 
 
152
 
 
153
<!-- ================================ SPECIFICATION  -->
 
154
<!-- Set the "uri" attribute in the <olink /> element to the "named destination" for the PDF page
 
155
-->
 
156
    <refsect1 id="specification"><title>Specification</title>
 
157
        <para>
 
158
            <imageobject>
 
159
                <imagedata fileref="pdficon_small1.gif" format="gif" />
 
160
            </imageobject>
 
161
                                                 
 
162
            <olink uri="atomicFunctions">OpenCL Specification</olink>
 
163
        </para>
 
164
    </refsect1>
 
165
 
 
166
 
 
167
<!-- ================================ ALSO SEE  -->
 
168
 
 
169
    <refsect1 id="seealso"><title>Also see</title>
 
170
        <para>
 
171
            <citerefentry href="atomicFunctions"><refentrytitle>Atomic Functions</refentrytitle></citerefentry>,
 
172
            <citerefentry><refentrytitle>atom_max</refentrytitle></citerefentry> 
 
173
        </para>
 
174
    </refsect1>
 
175
 
 
176
 
 
177
 
 
178
<!-- ============================== COPYRIGHT -->
 
179
<!-- Content included from copyright.inc.xsl -->
 
180
 
 
181
    <refsect3 id="Copyright"><title></title>
 
182
        <imageobject>
 
183
                <imagedata fileref="KhronosLogo.jpg" format="jpg" />
 
184
        </imageobject>
 
185
        <para />
 
186
    </refsect3>
 
187
<!-- 11-Oct-11 -->
 
188
</refentry>
 
189