Vector_Data_Types - Built-in vector data types.
Contents
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.
Description
The char, unsignedchar, short, unsignedshort, integer, unsignedinteger, long, unsignedlong, 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:
┌─────────────────────────┬──────────────────────────────┬──────────────────────────┐
│ TypeinOpenCLLanguage │ Description │ APItypeforapplication │
├─────────────────────────┼──────────────────────────────┼──────────────────────────┤
│ charn │ A vector of n 8-bit signed │ cl_charn │
│ │ two's complement integer │ │
│ │ values. │ │
├─────────────────────────┼──────────────────────────────┼──────────────────────────┤
│ ucharn │ A vector of n 8-bit unsigned │ cl_ucharn │
│ │ integer values. │ │
├─────────────────────────┼──────────────────────────────┼──────────────────────────┤
│ shortn │ A vector of n 16-bit signed │ cl_shortn │
│ │ two's complement integer │ │
│ │ values. │ │
├─────────────────────────┼──────────────────────────────┼──────────────────────────┤
│ ushortn │ A vector of n 16-bit │ cl_ushortn │
│ │ unsigned integer values. │ │
├─────────────────────────┼──────────────────────────────┼──────────────────────────┤
│ intn │ A vector of n 32-bit signed │ cl_intn │
│ │ two's complement integer │ │
│ │ values. │ │
├─────────────────────────┼──────────────────────────────┼──────────────────────────┤
│ uintn │ A vector of n 32-bit │ cl_uintn │
│ │ unsigned integer values. │ │
├─────────────────────────┼──────────────────────────────┼──────────────────────────┤
│ longn │ A vector of n 64-bit signed │ cl_longn │
│ │ 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. │ │
└─────────────────────────┴──────────────────────────────┴──────────────────────────┘
Name
Vector_Data_Types - Built-in vector data types.
Notes
1. OpenCL Specification
page 198, section 6.1.2 - Built-in Vector Data Types
The Khronos Group 11/18/2024 VECTORDATATYPES(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:
┌─────────────────────────┬──────────────────────────────┬──────────────────────────┐
│ TypeinOpenCLLanguage │ Description │ APItypeforapplication │
├─────────────────────────┼──────────────────────────────┼──────────────────────────┤
│ half2 │ A 2-component half-precision │ cl_half2 │
│ │ floating-point vector. │ │
├─────────────────────────┼──────────────────────────────┼──────────────────────────┤
│ half3 │ A 3-component half-precision │ cl_half3 │
│ │ floating-point vector. │ │
├─────────────────────────┼──────────────────────────────┼──────────────────────────┤
│ half4 │ A 4-component half-precision │ cl_half4 │
│ │ 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.
See Also
scalarDataTypes(3clc), reservedDataTypes(3clc), otherDataTypes(3clc), abstractDataTypes(3clc), enums(3clc), cl_khr_fp16(3clc), cl_khr_fp64(3clc)
Specification
OpenCLSpecification[1]
