std::isgreaterequal(3)

🎀 std::isgreaterequal(3) 🎀

okay so bestie, this is the C++ Standard Library page for std::isgreaterequal — the original header spells the manual name C++ Standard Libary, which is a little typo moment, but the math is still mathing. 💅

---

🌸 NAME 🌸

std::isgreaterequal — std::isgreaterequal

That's literally the whole NAME line. Self-titled main character energy. The function, the icon, the repeated name. 🫶

✨ Synopsis ✨

Defined in header <cmath>:

bool isgreaterequal( float x, float y );
bool isgreaterequal( double x, double y );
bool isgreaterequal( long double x, long double y );
constexpr bool isgreaterequal( /* floating-point-type */ x,
                               /* floating-point-type */ y );

Annotation tea ☕: the float overload is (since C++11); the double overload is (until C++23); the constexpr one is overload (1) and is (since C++23). Slay.

➕ Additional overloads ➕

Defined in header <cmath>:

template< class Arithmetic1, class Arithmetic2 >
bool isgreaterequal( Arithmetic1 x, Arithmetic2 y );

That one is overload (A), (since C++11), and (constexpr since C++23). Periodt.

1) Determines if the floating point number x is greater than or equal to the floating-point number y, without setting floating-point exceptions. The library provides overloads for all cv-unqualified floating-point types as the type of the parameters x and y. (since C++23)

A) Additional overloads are provided for all other combinations of arithmetic types.

💖 Parameters 💖

• x, y — floating-point or integer values.

🦋 Return value 🦋

• true if x >= y, false otherwise.

⭐ Notes ⭐

Okay so the built-in operator>= for floating-point numbers may raise FE_INVALID if one or both of the arguments is NaN. This function is a "quiet" version of operator>=. So she's not out here throwing floating-point exceptions at your face. 🙈

The additional overloads are not required to be provided exactly as (A). They only need to be sufficient to ensure that for their first argument num1 and second argument num2:

• If num1 or num2 has type long double, then std::isgreaterequal(num1, num2) has the same effect as std::isgreaterequal(static_cast<long double>(num1), static_cast<long double>(num2)).
• Otherwise, if num1 and/or num2 has type double or an integer type, then std::isgreaterequal(num1, num2) has the same effect as std::isgreaterequal(static_cast<double>(num1), static_cast<double>(num2)). This bullet is (until C++23).
• Otherwise, if num1 or num2 has type float, then std::isgreaterequal(num1, num2) has the same effect as std::isgreaterequal(static_cast<float>(num1), static_cast<float>(num2)).

If num1 and num2 have arithmetic types, then std::isgreaterequal(num1, num2) has the same effect as std::isgreaterequal(static_cast</* common-floating-point-type */>(num1), static_cast</* common-floating-point-type */>(num2)), where /* common-floating-point-type */ is the floating-point type with the greatest floating-point conversion rank and greatest floating-point conversion subrank between the types of num1 and num2; arguments of integer type are considered to have the same floating-point conversion rank as double. (since C++23)

If no such floating-point type with the greatest rank and subrank exists, then overload resolution does not result in a usable candidate from the overloads provided.

🌈 See also 🌈

• greater_equal — function object implementing x >= y (class template)
• islessequal — checks if the first floating-point argument is less or equal than the second (function) (C++11)
• C documentation for isgreaterequal

---

bestie, that's the whole page 💜. Source/version and date for this little manual-page moment: cppreference.com, 2024.06.10, and the page is std::isgreaterequal(3). Go compare responsibly, and remember: quiet version means no FE_INVALID drama. 🎀✨