ABS(3clc)

💅 ABS, ABS_DIFF — the OpenCL Manual's absolute value girlies 💅

okay bestie, welcome to ABS(3clc) and ABS_DIFF(3clc) — two functions from the OpenCL Manual that are literally just here to give you absolute values. no drama, no overflow, just vibes. ✨

---

🌸 NAME 🌸

abs, _abs_diff — absolute value functions. that's it, that's the whole name section. iconic.

---

🦋 SYNOPSIS 🦋

ugentype abs(gentype x);

ugentype abs_diff(gentype x, gentype y);

---

💖 DESCRIPTION 💖

• abs — hands you |x|. the absolute value. the "how far from zero are you, emotionally" of numbers. 🫶
• abs_diff — hands you |x-y|, and it does it without modulo overflow. no wrap-around chaos, no surprises, just the clean difference. slay. 🔥

---

✨ NOTES ✨

okay so here's the lore, and you're gonna wanna read this part because it's all about types:

built-in integer functions take scalar or vector arguments, bestie. the vector versions of the integer functions operate component-wise. the description is per component. so like, every lane does its own little thing. 💅

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. that's the whole menu. 🍓

we use the generic type name ugentype to refer to unsigned versions of gentype. for example, if gentype is char4, ugentype is uchar4. see how that works? glow-up energy. ⭐

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. no cap. 📖

and 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. consistency is the moment, okay? don't be mixing types out here. 😭

---

🎀 SPECIFICATION 🎀

OpenCL Specification[1]

---

🌈 SEE ALSO 🌈

integerFunctions(3clc)

like, go read that one too, it's the whole friend group. 👑

---

💜 AUTHORS 💜

The Khronos Group — the actual main characters behind all of this. 🫡

---

👑 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 (the footnote one, not the other one) 🙈

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

---

k bye bestie, go compute some absolute values, you're doing amazing sweetie 💖✨🌸🦋🎀💅

this lil lesson came to you from The Khronos Group, dated 01/14/2021, and yes the manual page is literally called ABS, ABS_DIFF(3clc). periodt. 💜