FMOD(3clc)

💖 FMOD — the OpenCL Manual's cutest little remainder machine 💖

okay bestie, gather round, because we're reading FMOD(3clc) from the OpenCL Manual and honestly? it's giving "math but make it modular." ✨

---

✨ NAME ✨

fmod — Modulus. Returns x - y * trunc (x/y).

gentype fmod(gentype x, gentype y);

like. that's the whole vibe. it's the modulo function, she's simple, she's iconic, she does exactly what she says on the tin. 💅

---

🦋 DESCRIPTION 🦋

Modulus, babes. It returns x - y * trunc(3clc) (x/y).

periodt. that's the formula. no notes. 🎀

---

🌸 NOTES 🌸

okay so here's the fine print, and it's lowkey important, so lock in 🔥

• The vector versions of the math functions operate component-wise. The description is per-component. meaning every lil lane of your vector does its own thing, independently, no cross-talk, no drama. 💅
• 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. so whatever chaos your environment is doing? she does not care. she is unbothered. she is consistent. 👑
• The built-in math functions take scalar or vector arguments. For any specific use of these function, the actual type has to be the same for all arguments and the return type unless otherwise specified. no mixing and matching bestie, everyone shows up in the same outfit or nobody goes. 🫶
• 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. that's a lot of options and honestly? we love a flexible queen. ✨
• If extended with cl_khr_fp16(3clc), generic type name gentype may indicate half and half{2|3|4|8|16} as arguments and return values. half-precision girlies rise up 🧚
• 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 f is for float, obviously, keep up 💖
• 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. the d is for double. double the precision, double the slay 💅

---

⭐ SPECIFICATION ⭐

OpenCL Specification[1]

iykyk. the receipts are in the footnote, scroll down bestie 🫶

---

🌈 SEE ALSO 🌈

• mathFunctions(3clc)

go read that one next, it's the whole friend group and fmod is just one member of the squad 💜

---

👑 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 following condition:

the above copyright notice and this permission notice shall be included in all copies or substantial portions of the Materials.

(the original says "the condition that this copyright notice and permission notice shall be included in all copies or substantial portions of the Materials" — so yeah, keep the notice, it's the rules, no cap 🫶)

---

📚 NOTES 📚

1. OpenCL Specification — page 244, section 6.12.2 - Math Functions

---

and that's the whole page bestie!! 💜 this was FMOD(3clc) from The Khronos Group, dated 01/14/2021, and honestly? she ate. 💅✨ no crumbs. go forth and take remainders responsibly, mwah 🎀🦋💖