MODF(3clc)

💖 MODF 💖

okay bestie, we're cracking open the OpenCL Manual page for modf(3clc) and honestly? it's giving "quietly does the most important thing in the room" energy. let's get into it 🫶

---

✨ NAME ✨

modf — decompose a floating-point number 🍓

gentype modf(gentype x, __global gentype *iptr);

gentype modf(gentype x, __local gentype *iptr);

gentype modf(gentype x, __private gentype *iptr);

---

🌸 DESCRIPTION 🌸

so modf decomposes a floating-point number. the way it works is it breaks the argument x into an integral part and a fractional part — and here's the cute part — each of them has the same sign as the argument. it stores the integral part in the object pointed to by iptr. slay. ✨

---

🦋 NOTES 🦋

modf behaves as though it were implemented like this:

gentype modf ( gentype value, gentype *iptr )
{
*iptr = trunc(3clc)( value );
return copysign(3clc)( isinf(3clc)( value ) ? 0.0 : value -  *iptr, value );
}

not me showing you the whole implementation, iykyk 💅

the vector versions of the math functions operate component-wise. the description is per-component, bestie.

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 like, don't stress about your environment's rounding drama, she does not care. 🙈

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.

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 the whole roster, no cap. 👑

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. ✨

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)

---

🎀 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, you ate that fr fr 🫶 this was brought to you by The Khronos Group, dated 01/14/2021, filed under MODF(3clc) — periodt 💅✨