INTEGERFUNCTIONS(3clc)

💖 INTEGER BUILT-IN FU — OpenCL Manual, section 3clc 💖

okay bestie, come sit with me 🫶 this is the lil index page for every single built-in integer function in OpenCL. it's giving group chat, but for math. every entry has its own manpage, so just tap the name and go live your truth ✨

---

🎀 NAME 🎀

Integer_Built-In_Functions — click an item in the table below for details about that function.

bestie, the original was a whole table and tables are not the vibe here, so it's a list now. same rows, same facts, zero casualties. 💅

• abs(3clc) — the absolute value situation: |x|
• abs(3clc) — |x-y|, and no modulo overflow allowed 💀
• add_sat(3clc) — x+y and saturate result
• hadd(3clc) — (x+y) >> 1 without modulo overflow
• hadd(3clc) — (x+y+1) >> 1. The intermediate sum does not modulo overflow.
• clz(3clc) — Number of leading 0-bits in x
• integerClamp(3clc) — min(max( x, minval), maxval)
• mad_hi(3clc) — mul_hi(a,b)+c
• mad24(3clc) — (Fast integer function.) Multiply 24-bit integer then add the 32-bit result to 32-bit integer
• mad_sat(3clc) — a*b+c and saturate the result
• integerMax(3clc) — The greater of x or y
• integerMax(3clc) — The lessor of x or y
• mul_hi(3clc) — High half of the product of x and y
• mul24(3clc) — (Fast integer function.) Multiply 24-bit integer values a and b
• rotate(3clc) — result[indx]=v[indx]<<i[indx]
• sub_sat(3clc) — x - y and saturate the result
• upsample(3clc) — result[i] = ((gentype)hi[i] << 8|16|32) | lo[i]
• popcount(3clc) — Returns the number of non-zero bits in x.

---

🌸 DESCRIPTION 🌸

so here's the tea ☕ built-in integer functions take scalar or vector arguments. the vector versions of the integer functions operate component-wise, and the description is per component. yes bestie, per component. every time. 🦋

we use the generic type name gentype to indicate that the function can take char, char{2|3|4|8|16}, uchar, uchar{2|3|4|8|16}, short, short{2|3|4|8|16}, ushort, ushort{2|3|4|8|16}, int, int{2|3|4|8|16}, uint, uint{2|3|4|8|16}, long, long{2|3|4|8|16}, ulong, or ulong{2|3|4|8|16} as the type for the arguments. iconic list, no notes. 👑

we also use the generic type name ugentype to refer to the unsigned versions of gentype. for example, if gentype is char4, then ugentype is uchar4. slay. ✨

and we use the generic type name sgentype to indicate that the function can take a scalar data type, i.e. char, uchar, short, ushort, int, uint, long, or ulong as the type for the arguments. for built-in integer functions that take gentype and sgentype arguments, the gentype argument must be a vector or scalar version of the sgentype argument. for example, if sgentype is uchar, then gentype must be uchar or uchar{2|3|4|8|16}. for vector versions, sgentype is implicitly widened to gentype as described in section 6.3.a of the OpenCL specification. it's giving "they have to match, bestie" 🙈

one more thing, and it's important fr fr: 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. no mixing, no matching, periodt. 💅

---

⭐ SPECIFICATION ⭐

OpenCL Specification[1]

---

👑 AUTHORS 👑

The Khronos Group

---

📜 COPYRIGHT 📜

Copyright © 2007-2011 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 256, section 6.12.3 - Integer Functions

---

and that's the whole page, bestie, you ate it up 💖 this little legend comes to you from The Khronos Group, dated 01/14/2021, and it lives under the manual name INTEGER BUILT-IN FU(3clc). go forth and integer responsibly 🧚✨