ISORDERED(3clc)

💖 ISORDERED 💖

okay bestie, welcome to the OpenCL Manual, section 3clc — this is the isordered(3clc) page and it is, lowkey, exactly what it sounds like. it's giving "are these two things in order, or are we in NaN chaos?" ✨

---

🌸 NAME 🌸

isordered — bestie's lil vibe check for whether the arguments are ordered. 🦋

here's the whole squad of signatures, verbatim, no notes:

int isordered(float x, float y);

intn isordered(floatn x, floatn y);

int isordered(double x, double y);

longn isordered(doublen x, doublen y);

int isordered (half x, half y)   // if
half extension enabled
shortn isordered (halfn x, halfn y)
// if half extension enabled

---

✨ DESCRIPTION ✨

so the whole job is: test if the arguments are ordered. that's it. that's the girl. 💅

isordered() takes arguments x and y, and returns the result isequal(3clc)(x, x) && isequal(y, y).

basically: if either one of them is a NaN, isequal is gonna say no, and so isordered says no too. ordered = neither of them is NaN. periodt. 💀

---

🎀 NOTES 🎀

okay this part is important, no cap:

• If an implementation extends this specification to support IEEE-754 flags or exceptions, then all built-in relational functions shall proceed without raising the invalid floating-point exception when one or more of the operands are NaNs.
• The built-in relational functions are extended with cl_khr_fp16(3clc) to include appropriate versions of functions that take half, and half{2|3|4|8|16} as arguments and return values.
• The function returns a 0 if the specified relation is false and a 1 if the specified relation is true for scalar argument types. These functions shall return a 0 if the specified relation is false and a - 1 (i.e. all bits set) if the specified relation is true for vector argument types.

so yeah — scalars get you a cute lil 0 or 1, but vectors come back with 0 or -1, and -1 means all bits set. she's dramatic like that. 🫶

---

📜 SPECIFICATION 📜

OpenCL Specification[1] — yes bestie, there's a footnote, keep scrolling 💜

---

👀 SEE ALSO 👀

• relationalFunctions(3clc)

go read that one too, iykyk ✨

---

👑 AUTHORS 👑

The Khronos Group — the icons themselves 🌈

---

💖 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 section, yes there's another one) 🍓

1. OpenCL Specification — page 264, section 6.12.6 - Relational Functions

---

and that's the whole page bestie!! 🦋✨ this gorgeous lil doc was brought to you by The Khronos Group, dated 01/14/2021, filed under ISORDERED(3clc) in the OpenCL Manual. slay, mwah 💅💖🎀