COPYSIGN(3clc)

💖 COPYSIGN — the OpenCL manual, but make it make sense 💖

okay bestie, pull up a chair, we're doing copysign from the OpenCL Manual (that's the 3clc section, iykyk). It's literally one of the math functions and it's so much simpler than it sounds, I promise. 🫶

---

✨ NAME ✨

copysign — take x, and swap its sign out for whatever sign y is rocking. That's it. That's the whole job. 💅

gentype copysign(gentype x, gentype y);

---

🌸 DESCRIPTION 🌸

You hand it x and you hand it y, and it gives you back x — same magnitude, same everything — except the sign now matches the sign of y. Sign transplant. Iconic behaviour, no notes. 🎀

---

🦋 NOTES 🦋

Okay this is the part where I need you to actually pay attention, because it's giving "small print but it matters", fr fr.

• The vector versions of the math functions operate component-wise. The description is per-component. So like, each lane minds its own business. 🧚
• The built-in math functions are not affected by the prevailing rounding mode in the calling environment, and they always return the same value as they would if called with the round to nearest even rounding mode. No cap — the environment does not get a vote here. 😤
• The built-in math functions take scalar or vector arguments. For any specific use of these functions, the actual type has to be the same for all arguments and the return type, unless otherwise specified. Don't mix and match, bestie, it will not slay. 💀
• The generic type name gentype is used to indicate that the function can take float, float2, float3, float4, float8, float16, double, double2, double3, double4, double8, or double16 as the type for the arguments. ✨
• If extended with cl_khr_fp16(3clc), the generic type name gentype may indicate half and half{2|3|4|8|16} as arguments and return values. 👑
• The generic type name gentypef is used to indicate that the function can take float, float2, float3, float4, float8, or float16 as the type for the arguments. 🌈
• The generic type name gentyped is used to indicate that the function can take double, double2, double3, double4, double8, or double16 as the type for the arguments. 💜

---

⭐ SPECIFICATION ⭐

OpenCL Specification[1]

---

🔥 SEE ALSO 🔥

mathFunctions(3clc) — go read the whole family, they're all cute. 🌸

---

🎀 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 244, section 6.12.2 - Math Functions

---

okay that's the whole page!! 💖 every flag, every type, every caveat, all of it — nothing skipped, bestie, we ate and left no crumbs. 🍓

The Khronos Group ✨ 01/14/2021 ✨ COPYSIGN(3clc) — mwah, go write some shaders, you've got this 💅🦋