'\" t
.\"     Title: Integer Built-In Functions
.\"    Author: The Khronos Group
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
.\"      Date: 02/03/2019
.\"    Manual: OpenCL Manual
.\"    Source: The Khronos Group
.\"  Language: English
.\"
.TH "INTEGER BUILT\-IN FU" "3clc" "02/03/2019" "The Khronos Group" "OpenCL Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
Integer_Built-In_Functions \- Click an item in the table below for details about that function\&.
.SH ""
.TS
allbox tab(:);
l l
l l
l l
l l
l l
l l
l l
l l
l l
l l
l l
l l
l l
l l
l l
l l
l l
l l.
T{
\fBabs\fR(3clc)
T}:T{
|\fIx\fR|
T}
T{
\fBabs\fR(3clc)
T}:T{
|\fIx\fR\-\fIy\fR| without modulo overflow
T}
T{
\fBadd_sat\fR(3clc)
T}:T{
\fIx\fR+\fIy\fR and saturate result
T}
T{
\fBhadd\fR(3clc)
T}:T{
(\fIx\fR+\fIy\fR) >> 1 without modulo overflow
T}
T{
\fBhadd\fR(3clc)
T}:T{
(\fIx\fR+\fIy\fR+1) >> 1\&. The intermediate sum
does not modulo overflow\&.
T}
T{
\fBclz\fR(3clc)
T}:T{
Number of leading 0\-bits in \fIx\fR
T}
T{
\fBintegerClamp\fR(3clc)
T}:T{
\fBmin\fR(\fBmax\fR(
\fIx\fR, \fIminval\fR), \fImaxval\fR)
T}
T{
\fBmad_hi\fR(3clc)
T}:T{
\fBmul_hi\fR(\fIa\fR,\fIb\fR)+\fIc\fR
T}
T{
\fBmad24\fR(3clc)
T}:T{
(Fast integer function\&.) Multiply 24\-bit integer then add the 32\-bit result to 32\-bit integer
T}
T{
\fBmad_sat\fR(3clc)
T}:T{
\fIa\fR*\fIb\fR+\fIc\fR and saturate the result
T}
T{
\fBintegerMax\fR(3clc)
T}:T{
The greater of \fIx\fR or \fIy\fR
T}
T{
\fBintegerMax\fR(3clc)
T}:T{
The lessor of \fIx\fR or \fIy\fR
T}
T{
\fBmul_hi\fR(3clc)
T}:T{
High half of the product of \fIx\fR and \fIy\fR
T}
T{
\fBmul24\fR(3clc)
T}:T{
(Fast integer function\&.) Multiply 24\-bit integer values \fIa\fR and \fIb\fR
T}
T{
\fBrotate\fR(3clc)
T}:T{
result[\fIindx\fR]=\fIv\fR[\fIindx\fR]<<\fIi\fR[\fIindx\fR]
T}
T{
\fBsub_sat\fR(3clc)
T}:T{
\fIx\fR \- \fIy\fR and saturate the result
T}
T{
\fBupsample\fR(3clc)
T}:T{
\fIresult\fR[i] = ((gentype)\fIhi\fR[i] << 8|16|32) | \fIlo\fR[i]
T}
T{
\fBpopcount\fR(3clc)
T}:T{
Returns the number of non\-zero bits in \fIx\fR\&.
T}
.TE
.sp 1
.SH "DESCRIPTION"
.PP
Built\-in integer functions take scalar or vector arguments\&. The vector versions of the integer functions operate component\-wise\&. The description is per component\&.
.PP
We use the generic type name
\fBgentype\fR
to indicate that the function can take
\fBchar\fR,
\fBchar{2|3|4|8|16}\fR,
\fBuchar\fR,
\fBuchar{2|3|4|8|16}\fR,
\fBshort\fR,
\fBshort{2|3|4|8|16}\fR,
\fBushort\fR,
\fBushort{2|3|4|8|16}\fR,
\fBint\fR,
\fBint{2|3|4|8|16}\fR,
\fBuint\fR,
\fBuint{2|3|4|8|16}\fR,
\fBlong\fR,
\fBlong{2|3|4|8|16}\fR,
\fBulong\fR, or
\fBulong{2|3|4|8|16}\fR
as the type for the arguments\&. We use the generic type name
\fBugentype\fR
to refer to unsigned versions of
\fBgentype\fR\&. For example, if
\fBgentype\fR
is
\fBchar4\fR,
\fBugentype\fR
is
\fBuchar4\fR\&.
.PP
We also use the generic type name
\fBsgentype\fR
to indicate that the function can take a scalar data type i\&.e\&.
\fBchar\fR,
\fBuchar\fR,
\fBshort\fR,
\fBushort\fR,
\fBint\fR,
\fBuint\fR,
\fBlong\fR, or
\fBulong\fR
as the type for the arguments\&. For built\-in integer functions that take
\fBgentype\fR
and
\fBsgentype\fR
arguments, the
\fBgentype\fR
argument must be a vector or scalar version of the
\fBsgentype\fR
argument\&. For example, if
\fBsgentype\fR
is
\fBuchar\fR,
\fBgentype\fR
must be
\fBuchar\fR
or
\fBuchar{2|3|4|8|16}\fR\&. For vector versions,
\fBsgentype\fR
is implicitly widened to
\fBgentype\fR
as described in section 6\&.3\&.a of the OpenCL specification\&.
.PP
For any specific use of a function, the actual type has to be the same for all arguments and the return type unless otherwise specified\&.
.SH "SPECIFICATION"
.PP
\m[blue]\fBOpenCL Specification\fR\m[]\&\s-2\u[1]\d\s+2
.SH "AUTHORS"
.PP
\fBThe Khronos Group\fR
.SH "COPYRIGHT"
.br
Copyright \(co 2007-2011 The Khronos Group Inc.
.br
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.
.sp
.SH "NOTES"
.IP " 1." 4
OpenCL Specification
.RS 4
\%page 256, section 6.12.3 - Integer Functions
.RE