CLZ(3clc)

✨ CLZ — the clz page from the OpenCL Manual ✨

okay bestie, welcome to CLZ(3clc), straight out of the OpenCL manual 💖 this one's short and sweet, we're literally just counting zeroes. no cap.

---

🌸 NAME 🌸

clz — returns the number of leading 0-bits in x.

gentype clz(gentype x);

---

💅 DESCRIPTION 💅

clz returns the number of leading 0-bits in x, starting at the most significant bit position.

that's it. that's the whole function. she's simple, she's iconic, she counts the zeros hanging out at the front of your number 👑

---

🫶 NOTES 🫶

Built-in integer functions take scalar or vector arguments. The vector versions of the integer functions operate component-wise. The description is per component. so like, each lane does its own lil thing, no cross-talk 💫

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. We use the generic type name ugentype to refer to unsigned versions of gentype. For example, if gentype is char4, ugentype is uchar4.

We also 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, 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.

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. like, no mixing, bestie, we're matching here 🎀

---

🌈 SPECIFICATION 🌈

OpenCL Specification[1]

---

👀 SEE ALSO 👀

integerFunctions(3clc)

---

👑 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 📎 (yes, again — these are the footnotes, stay with me)

1. OpenCL Specification page 256, section 6.12.3 - Integer Functions

---

and that's the whole vibe check, bestie 🦋 this page was brought to you by The Khronos Group, dated 01/14/2021 — go count some leading zeros, you're gonna slay 💅✨