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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
|
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"
"http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">
<refentry>
<refentryinfo>
<keywordset>
<keyword>Scalar Data Types</keyword>
</keywordset>
</refentryinfo>
<refmeta>
<refentrytitle>Scalar Data Types</refentrytitle>
<refmiscinfo>
<copyright>
<year>2007-2011</year>
<holder>The Khronos Group Inc.
Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and/or associated documentation files (the
"Materials"), to deal in the Materials without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Materials, and to
permit persons to whom the Materials are furnished to do so, subject to
the condition that this copyright notice and permission notice shall be included
in all copies or substantial portions of the Materials.</holder>
</copyright>
</refmiscinfo>
<manvolnum>3</manvolnum>
</refmeta>
<!-- ================================ SYNOPSIS -->
<refnamediv id="Built-inScalarDataTypes">
<refname>Scalar Data Types</refname>
<refpurpose>
Built-in scalar data types.
</refpurpose>
</refnamediv>
<!-- ================================ DESCRIPTION -->
<refsect1 id="description"><title>Description</title>
<para>
These are the data types available in the OpenCL C programming language used to create
kernels that are executed on OpenCL device(s). The OpenCL C programming language (also
referred to as OpenCL C) is based on the ISO/IEC 9899:1999 C language specification
(a.k.a. C99 specification) with specific extensions and restrictions. Please refer
to the ISO/IEC 9899:1999 specification for a detailed description of the language
grammar. This section describes modifications and restrictions to ISO/IEC 9899:1999
supported in OpenCL C.
</para>
<para>
Most built-in scalar data types are also declared as appropriate types in the OpenCL API
(and header files) that can be used by an application. The following table describes
the built-in scalar data type in the OpenCL C programming language and the corresponding
data type available to the application:
</para>
<informaltable frame="all">
<tgroup cols="3" align="left" colsep="1" rowsep="1">
<colspec colname="col1" colnum="1" />
<colspec colname="col2" colnum="2" />
<colspec colname="col3" colnum="3" />
<thead>
<row>
<entry>Type in OpenCL C Language</entry>
<entry>Description</entry>
<entry>API type for application</entry>
</row>
</thead>
<tbody>
<row>
<entry> <type>bool</type> </entry>
<entry>
A conditional data type which is either <varname>true</varname> or
<varname>false</varname>. The value <varname>true</varname> expands
to the integer constant 1 and the value <varname>false</varname>
expands to the integer constant 0. When any scalar value is converted
to bool, the result is 0 if the value compares equal to 0; otherwise,
the result is 1.
</entry>
<entry> n/a </entry>
</row>
<row>
<entry> <type>char</type> </entry>
<entry> A signed two's complement 8-bit integer. </entry>
<entry> <type>cl_char</type> </entry>
</row>
<row>
<entry>
<literallayout><type>unsigned char</type>,
<type>uchar</type></literallayout>
</entry>
<entry> An unsigned 8-bit integer. </entry>
<entry> <type>cl_uchar</type> </entry>
</row>
<row>
<entry> <type>short</type> </entry>
<entry> A signed two's complement 16-bit integer. </entry>
<entry> <type>cl_short</type> </entry>
</row>
<row>
<entry>
<literallayout><type>unsigned short</type>,
<type>ushort</type></literallayout>
</entry>
<entry> An unsigned 16-bit integer. </entry>
<entry> <type>cl_ushort</type> </entry>
</row>
<row>
<entry> <type>int</type> </entry>
<entry> A signed two's complement 32-bit integer. </entry>
<entry> <type>cl_int</type> </entry>
</row>
<row>
<entry>
<literallayout><type>unsigned int</type>,
<type>uint</type></literallayout>
</entry>
<entry> An unsigned 32-bit integer. </entry>
<entry> <type>cl_uint</type> </entry>
</row>
<row>
<entry> <type>long</type> </entry>
<entry> A signed two's complement 64-bit integer. </entry>
<entry> <type>cl_long</type> </entry>
</row>
<row>
<entry>
<literallayout><type>unsigned long</type>,
<type>ulong</type></literallayout>
</entry>
<entry> An unsigned 64-bit integer. </entry>
<entry> <type>cl_ulong</type> </entry>
</row>
<row>
<entry> <type>float</type> </entry>
<entry>
A 32-bit floating point. The float data type must conform to the
IEEE 754 single precision storage format.
</entry>
<entry> <type>cl_float</type> </entry>
</row>
<row>
<entry> <type>double</type> </entry>
<entry>
A 64-bit floating point. The <type>double</type> data type must conform to the
IEEE 754 double precision storage format. The <type>double</type> scalar
type is an optional type that is supported if <constant>CL_DEVICE_DOUBLE_FP_CONFIG</constant>
for a device is not zero. See the table for <varname>param_name</varname> for
<citerefentry><refentrytitle>clGetDeviceInfo</refentrytitle></citerefentry>
for details.
</entry>
<entry> <type>cl_double</type> </entry>
</row>
<row>
<entry> <type>half</type> </entry>
<entry>
A 16-bit float. The <type>half</type> data type must conform to the IEEE 754-2008
half precision storage format.
</entry>
<entry> <type>cl_half</type> </entry>
</row>
<row>
<entry> <type>size_t</type> </entry>
<entry>
The unsigned integer type of the result of the sizeof
operator. This is a 32-bit unsigned integer if <constant>CL_DEVICE_ADDRESS_BITS</constant>
defined in <citerefentry><refentrytitle>clGetDeviceInfo</refentrytitle></citerefentry>
is 32-bits and is a 64-bit unsigned integer if <constant>CL_DEVICE_ADDRESS_BITS</constant>
is 64-bits.
</entry>
<entry> n/a </entry>
</row>
<row>
<entry> <type>ptrdiff_t</type> </entry>
<entry>
A signed integer type that is the result of subtracting two pointers.
This is a 32-bit signed integer if <constant>CL_DEVICE_ADDRESS_BITS</constant> defined in
<citerefentry><refentrytitle>clGetDeviceInfo</refentrytitle></citerefentry>
is 32-bits and is a 64-bit signed integer if <constant>CL_DEVICE_ADDRESS_BITS</constant>
is 64-bits.
</entry>
<entry> n/a </entry>
</row>
<row>
<entry> <type>intptr_t</type> </entry>
<entry>
A signed integer type with the property that any valid pointer to
<type>void</type> can be converted to this type, then converted back
to pointer to <type>void</type>, and the result will compare equal
to the original pointer. This is a 32-bit signed integer if
<constant>CL_DEVICE_ADDRESS_BITS</constant> defined in table 4.3 is
32-bits and is a 64-bit signed integer if <constant>CL_DEVICE_ADDRESS_BITS</constant>
is 64-bits.
</entry>
<entry> n/a </entry>
</row>
<row>
<entry> <type>uintptr_t</type> </entry>
<entry>
An unsigned integer type with the property that any valid pointer to
<type>void</type> can be converted to this type, then converted back
to pointer to <type>void</type>, and the result will compare equal to
the original pointer. This is a 32-bit signed integer if
<constant>CL_DEVICE_ADDRESS_BITS</constant> defined in table 4.3 is
32-bits and is a 64-bit signed integer if <constant>CL_DEVICE_ADDRESS_BITS</constant>
is 64-bits.
</entry>
<entry> n/a </entry>
</row>
<row>
<entry> <type>void</type> </entry>
<entry>
The <type>void</type> type comprises an empty set of values; it is an
incomplete type that cannot be completed.
</entry>
<entry> <type>void</type> </entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<!-- OPTIONAL DOUBLE AND HALF DATA TYPES -->
<refsect1 id="optional"><title>Optional Half Floating Point</title>
<para>
The <type>half</type> floating-point is supported as an optional
extension. An application that wants to use <type>half</type>
and <type>half<replaceable>n</replaceable></type> will need to include the
<citerefentry href="cl_khr_fp16"><refentrytitle>#pragma OPENCL EXTENSION cl_khr_fp16
: enable</refentrytitle></citerefentry> directive. This will extended the list of
built-in vector and scalar data types to include the following:
</para>
<para>
<informaltable frame="all">
<tgroup cols="3" align="left" colsep="1" rowsep="1">
<colspec colname="col1" colnum="1" /> <colspec colname="col2" colnum="2" />
<colspec colname="col3" colnum="3" />
<thead>
<row>
<entry>Type in OpenCL Language</entry>
<entry>Description</entry>
<entry>API type for application</entry>
</row>
</thead>
<tbody>
<row>
<entry><type>half2</type></entry>
<entry>A 2-component half-precision floating-point vector.</entry>
<entry><type>cl_half2</type></entry>
</row>
<row>
<entry><type>half3</type></entry>
<entry>A 3-component half-precision floating-point vector.</entry>
<entry><type>cl_half3</type></entry>
</row>
<row>
<entry><type>half4</type></entry>
<entry>A 4-component half-precision floating-point vector.</entry>
<entry><type>cl_half4</type></entry>
</row>
<row>
<entry><type>half8</type></entry>
<entry>An 8-component half-precision floating-point vector.</entry>
<entry><type>cl_half8</type></entry>
</row>
<row>
<entry><type>half16</type></entry>
<entry>A 16-component half-precision floating-point vector.</entry>
<entry><type>cl_half16</type></entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
<para>
The relational, equality, logical and logical unary operators can be used with
<type>half</type> scalar and <type>half<replaceable>n</replaceable></type>
vector types and shall produce a scalar <type>int</type> and vector
<type>short<replaceable>n</replaceable></type> result respectively.
</para>
<para>
The OpenCL compiler accepts an h and H suffix on floating point literals, indicating
the literal is typed as a <type>half</type>.
</para>
</refsect1>
<!-- ================================ SPECIFICATION -->
<!-- Set the "uri" attribute in the <olink /> element to the "named destination" for the PDF page
-->
<refsect1 id="specification"><title>Specification</title>
<para>
<imageobject>
<imagedata fileref="pdficon_small1.gif" format="gif" />
</imageobject>
<olink uri="scalarDataTypes">OpenCL Specification</olink>
</para>
</refsect1>
<!-- ================================ ALSO SEE -->
<refsect1 id="seealso"><title>Also see</title>
<para>
<citerefentry href="macroLimits"><refentrytitle>Macros and Limits</refentrytitle></citerefentry>,
<citerefentry href="vectorDataTypes"><refentrytitle>Vector Data Types</refentrytitle></citerefentry>,
<citerefentry href="reservedDataTypes"><refentrytitle>Reserved Data Types</refentrytitle></citerefentry>,
<citerefentry href="otherDataTypes"><refentrytitle>Other Data Types</refentrytitle></citerefentry>,
<citerefentry href="abstractDataTypes"><refentrytitle>Abstract Data Types</refentrytitle></citerefentry>,
<citerefentry href="enums"><refentrytitle>Enumerated Data Types</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>cl_khr_fp16</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>cl_khr_fp64</refentrytitle></citerefentry>
</para>
</refsect1>
<!-- ============================== COPYRIGHT -->
<!-- Content included from copyright.inc.xsl -->
<refsect3 id="Copyright"><title></title>
<imageobject>
<imagedata fileref="KhronosLogo.jpg" format="jpg" />
</imageobject>
<para />
</refsect3>
<!-- 13-Oct-2011 -->
</refentry>
|
