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
|
<?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>Vector Data Types</keyword>
</keywordset>
</refentryinfo>
<refmeta>
<refentrytitle>Vector Data Types</refentrytitle>
<refmiscinfo>
<copyright>
<year>2007-2020</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="VectorDataTypes">
<refname>Vector Data Types</refname>
<refpurpose>
Built-in vector data types.
</refpurpose>
</refnamediv>
<!-- ================================ DESCRIPTION -->
<refsect1 id="description"><title>Description</title>
<para>
The <type>char</type>, <type>unsigned char</type>, <type>short</type>, <type>unsigned
short</type>, <type>integer</type>, <type>unsigned integer</type>, <type>long</type>,
<type>unsigned long</type>, and <type>float</type> vector data types are supported. The
vector data type is defined with the type name i.e. <type>char</type>, <type>uchar</type>,
<type>short</type>, <type>ushort</type>, <type>int</type>, <type>uint</type>,
<type>float</type>, <type>long</type>, or <type>ulong</type> followed by a literal value
<emphasis>n</emphasis> that defines the number of elements in the vector. Supported
values of <emphasis>n</emphasis> are 2, 3, 4, 8, and 16 for all vector data types.
</para>
<para>
The built-in vector 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 vector 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 Language</entry>
<entry>Description</entry>
<entry>API type for application</entry>
</row>
</thead>
<tbody>
<row>
<entry><type>char<replaceable>n</replaceable></type></entry>
<entry>A vector of <replaceable>n</replaceable> 8-bit signed two's complement integer values.</entry>
<entry><type>cl_char<replaceable>n</replaceable></type></entry>
</row>
<row>
<entry><type>uchar<replaceable>n</replaceable></type></entry>
<entry>A vector of <replaceable>n</replaceable> 8-bit unsigned integer values.</entry>
<entry><type>cl_uchar<replaceable>n</replaceable></type></entry>
</row>
<row>
<entry><type>short<replaceable>n</replaceable></type></entry>
<entry>A vector of <replaceable>n</replaceable> 16-bit signed two's complement integer values.</entry>
<entry><type>cl_short<replaceable>n</replaceable></type></entry>
</row>
<row>
<entry><type>ushort<replaceable>n</replaceable></type></entry>
<entry>A vector of <replaceable>n</replaceable> 16-bit unsigned integer values.</entry>
<entry><type>cl_ushort<replaceable>n</replaceable></type></entry>
</row>
<row>
<entry><type>int<replaceable>n</replaceable></type></entry>
<entry>A vector of <replaceable>n</replaceable> 32-bit signed two's complement integer values.</entry>
<entry><type>cl_int<replaceable>n</replaceable></type></entry>
</row>
<row>
<entry><type>uint<replaceable>n</replaceable></type></entry>
<entry>A vector of <replaceable>n</replaceable> 32-bit unsigned integer values.</entry>
<entry><type>cl_uint<replaceable>n</replaceable></type></entry>
</row>
<row>
<entry><type>long<replaceable>n</replaceable></type></entry>
<entry>A vector of <replaceable>n</replaceable> 64-bit signed two's complement integer values.</entry>
<entry><type>cl_long<replaceable>n</replaceable></type></entry>
</row>
<row>
<entry><type>ulong<replaceable>n</replaceable></type></entry>
<entry>A vector of <replaceable>n</replaceable> 64-bit unsigned integer values.</entry>
<entry><type>cl_ulong<replaceable>n</replaceable></type></entry>
</row>
<row>
<entry><type>float<replaceable>n</replaceable></type></entry>
<entry>A vector of <replaceable>n</replaceable> 32-bit floating-point values.</entry>
<entry><type>cl_float<replaceable>n</replaceable></type></entry>
</row>
<row>
<entry><type>double<replaceable>n</replaceable></type></entry>
<entry>A vector of <replaceable>n</replaceable> 64-bit floating-point values.</entry>
<entry><type>cl_double<replaceable>n</replaceable></type></entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<!-- ================================ NOTES -->
<refsect1 id="notes"><title>Notes</title>
<para>
Built-in vector data types are supported by the OpenCL implementation even if the
underlying compute device does not support any or all of the vector data types. These
are to be converted by the device compiler to appropriate instructions that use
underlying built-in types supported natively by the compute device.
</para>
<para>
The <type>double</type> vector type is an optional type that is supported if
<constant>CL_DEVICE_DOUBLE_FP_CONFIG</constant> for a device is not zero. See
<citerefentry><refentrytitle>clGetDeviceInfo</refentrytitle></citerefentry>.
</para>
</refsect1>
<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="vectorDataTypes">OpenCL Specification</olink>
</para>
</refsect1>
<!-- ================================ ALSO SEE -->
<refsect1 id="seealso"><title>Also see</title>
<para>
<citerefentry href="scalarDataTypes"><refentrytitle>Scalar 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>
|
