FMAX(3clc)

💖 FMAX — the OpenCL Manual, bestie edition 💖

okay so we're in the OpenCL Manual and today's main character is fmax. she picks the bigger one. that's it. that's the whole vibe. 🫶

---

✨ NAME ✨

fmax — Returns the greater of either x or y.

like, literally just hands you whichever one is bigger. no drama. 👑

gentype fmax(gentype x, gentype y);

gentypef fmax(gentypef x, float y);

gentyped fmax(gentyped x, double y);

gentype fmax (gentype x, half y)
// if half extension enabled

---

🌸 DESCRIPTION 🌸

She returns y if x is less than y, otherwise she returns x. that's the whole thing, periodt. 💅

but wait, the NaN lore, because this is where it gets juicy:

• if one argument is a NaN, fmax() returns the other argument (she's loyal, she picks the real one 🙈)
• if both arguments are NaNs, fmax() returns a NaN. yeah. both NaNs in, NaN out. it's giving "we're all NaNs here" 😭

---

🎀 NOTES 🎀

okay bestie, sit down, this part is important.

fmin(3clc) and fmax behave as defined by C99 and may not match the IEEE 754-2008 definition for minNum and maxNum with regard to signaling NaNs. Specifically, signaling NaNs may behave as quiet NaNs. so like. don't come for her about the spec, she's following C99's rules and C99 said what it said. 💀

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

The built-in math functions are not affected by the prevailing rounding mode in the calling environment, and always return the same value as they would if called with the round to nearest even rounding mode. she does not care what your environment is going through. she rounds to nearest even and moves on. ✨

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. no mixing and matching, bestie, that's not the energy. 🚫

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), 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 (the footnote kind, not the lore kind) 🌈

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

---

okay that's the whole page bestie, mwah 💋 this little gem came from The Khronos Group, dated 01/14/2021, and yeah — it's FMAX(3clc), an OpenCL Manual situation. go forth and pick the bigger number. slay. 🔥🦋✨