Provided by: opencl-1.2-man-doc_1.0~svn22836-1.1_all 
NAME
Vector_Data_Types - Built-in vector data types.
DESCRIPTION
The char, unsigned char, short, unsigned short, integer, unsigned integer, long, unsigned
long, and float vector data types are supported. The vector data type is defined with the
type name i.e. char, uchar, short, ushort, int, uint, float, long, or ulong followed by a
literal value n that defines the number of elements in the vector. Supported values of n
are 2, 3, 4, 8, and 16 for all vector data types.
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:
┌────────────────────────┬──────────────────────────┬──────────────────────────┐
│Type in OpenCL Language │ Description │ API type for application │
├────────────────────────┼──────────────────────────┼──────────────────────────┤
│charn │ A vector of n 8-bit │ cl_charn │
│ │ signed two's complement │ │
│ │ integer values. │ │
├────────────────────────┼──────────────────────────┼──────────────────────────┤
│ucharn │ A vector of n 8-bit │ cl_ucharn │
│ │ unsigned integer values. │ │
├────────────────────────┼──────────────────────────┼──────────────────────────┤
│shortn │ A vector of n 16-bit │ cl_shortn │
│ │ signed two's complement │ │
│ │ integer values. │ │
├────────────────────────┼──────────────────────────┼──────────────────────────┤
│ushortn │ A vector of n 16-bit │ cl_ushortn │
│ │ unsigned integer values. │ │
├────────────────────────┼──────────────────────────┼──────────────────────────┤
│intn │ A vector of n 32-bit │ cl_intn │
│ │ signed two's complement │ │
│ │ integer values. │ │
├────────────────────────┼──────────────────────────┼──────────────────────────┤
│uintn │ A vector of n 32-bit │ cl_uintn │
│ │ unsigned integer values. │ │
├────────────────────────┼──────────────────────────┼──────────────────────────┤
│longn │ A vector of n 64-bit │ cl_longn │
│ │ signed two's complement │ │
│ │ integer values. │ │
├────────────────────────┼──────────────────────────┼──────────────────────────┤
│ulongn │ A vector of n 64-bit │ cl_ulongn │
│ │ unsigned integer values. │ │
├────────────────────────┼──────────────────────────┼──────────────────────────┤
│floatn │ A vector of n 32-bit │ cl_floatn │
│ │ floating-point values. │ │
├────────────────────────┼──────────────────────────┼──────────────────────────┤
│doublen │ A vector of n 64-bit │ cl_doublen │
│ │ floating-point values. │ │
└────────────────────────┴──────────────────────────┴──────────────────────────┘
NOTES
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.
The double vector type is an optional type that is supported if CL_DEVICE_DOUBLE_FP_CONFIG
for a device is not zero. See clGetDeviceInfo(3clc).
OPTIONAL HALF FLOATING POINT
The half floating-point is supported as an optional extension. An application that wants
to use half and halfn will need to include the cl_khr_fp16(3clc) directive. This will
extended the list of built-in vector and scalar data types to include the following:
┌────────────────────────┬────────────────────────┬──────────────────────────┐
│Type in OpenCL Language │ Description │ API type for application │
├────────────────────────┼────────────────────────┼──────────────────────────┤
│half2 │ A 2-component │ cl_half2 │
│ │ half-precision │ │
│ │ floating-point vector. │ │
├────────────────────────┼────────────────────────┼──────────────────────────┤
│half3 │ A 3-component │ cl_half3 │
│ │ half-precision │ │
│ │ floating-point vector. │ │
├────────────────────────┼────────────────────────┼──────────────────────────┤
│half4 │ A 4-component │ cl_half4 │
│ │ half-precision │ │
│ │ floating-point vector. │ │
├────────────────────────┼────────────────────────┼──────────────────────────┤
│half8 │ An 8-component │ cl_half8 │
│ │ half-precision │ │
│ │ floating-point vector. │ │
├────────────────────────┼────────────────────────┼──────────────────────────┤
│half16 │ A 16-component │ cl_half16 │
│ │ half-precision │ │
│ │ floating-point vector. │ │
└────────────────────────┴────────────────────────┴──────────────────────────┘
The relational, equality, logical and logical unary operators can be used with half scalar
and halfn vector types and shall produce a scalar int and vector shortn result
respectively.
The OpenCL compiler accepts an h and H suffix on floating point literals, indicating the
literal is typed as a half.
SPECIFICATION
OpenCL Specification[1]
SEE ALSO
scalarDataTypes(3clc), reservedDataTypes(3clc), otherDataTypes(3clc),
abstractDataTypes(3clc), enums(3clc), cl_khr_fp16(3clc), cl_khr_fp64(3clc)
AUTHORS
The Khronos Group
COPYRIGHT
Copyright © 2007-2020 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.
NOTES
1. OpenCL Specification
page 198, section 6.1.2 - Built-in Vector Data Types