LRINT(3P)

✨ LRINT(3P) ✨

okay bestie, so this one is lrint, lrintf, lrintl β€” and it's from the POSIX Programmer's Manual (the 3P vibe, iykyk πŸ’…). It's a math function page, it's lowkey iconic, and we're gonna get through it together. 🫢


🌸 PROLOG 🌸

okay so first things first, bestie: this manual page is part of the POSIX Programmer's Manual. That's important because the Linux implementation of this interface may differ β€” so if you're on Linux, go consult the corresponding Linux manual page for details on Linux behavior. OR, plot twist, the interface might not even be implemented on Linux at all. πŸ™ˆ


πŸ’– NAME πŸ’–

lrint, lrintf, lrintl β€” round to nearest integer value using the current rounding direction. ✨


πŸŽ€ SYNOPSIS πŸŽ€

#include <math.h>

long lrint(double x);
long lrintf(float x);
long lrintl(long double x);

three little icons, one big job. 🌈


πŸ¦‹ DESCRIPTION πŸ¦‹

okay so, the functionality described on this reference page is aligned with the ISO C standard. And like, if there's any conflict between the requirements described here and the ISO C standard? That was not intentional, fr fr. This volume of POSIX.1‐2017 defers to the ISO C standard. periodt.

These functions shall round their argument to the nearest integer value, rounding according to the current rounding direction. 🎯

And here's the tea for checking errors: an application wishing to check for error situations should set errno to zero and call feclearexcept(FE_ALL_EXCEPT) before calling these functions. Then on return β€” if errno is non-zero, OR if fetestexcept(FE_INVALID | FE_DIVBYZERO | FE_OVERFLOW | FE_UNDERFLOW) is non-zero, an error has occurred. πŸ’€


πŸ‘‘ RETURN VALUE πŸ‘‘

Upon successful completion, these functions shall return the rounded integer value. slay. ✨

  • If x is NaN, a domain error shall occur and an unspecified value is returned.
  • If x is +Inf, a domain error shall occur and an unspecified value is returned.
  • If x is -Inf, a domain error shall occur and an unspecified value is returned.
  • If the correct value is positive and too large to represent as a long, an unspecified value shall be returned. On systems that support the IEC 60559 Floating-Point option, a domain error shall occur; otherwise, a domain error may occur.
  • If the correct value is negative and too large to represent as a long, an unspecified value shall be returned. On systems that support the IEC 60559 Floating-Point option, a domain error shall occur; otherwise, a domain error may occur.

πŸ’œ ERRORS πŸ’œ

These functions shall fail if:

  • Domain Error β€” The x argument is NaN or Β±Inf, or the correct value is not representable as an integer.
    • If the integer expression (math_errhandling & MATH_ERRNO) is non-zero, then errno shall be set to [EDOM].
    • If the integer expression (math_errhandling & MATH_ERREXCEPT) is non-zero, then the invalid floating-point exception shall be raised.

These functions may fail if:

  • Domain Error β€” The correct value is not representable as an integer.
    • If the integer expression (math_errhandling & MATH_ERRNO) is non-zero, then errno shall be set to [EDOM].
    • If the integer expression (math_errhandling & MATH_ERREXCEPT) is non-zero, then the invalid floating-point exception shall be raised.
heads up bestie: the following sections are informative. 🫢

πŸ“ EXAMPLES πŸ“

None.

(it's giving minimal, and honestly? respect. πŸ’…)


🌈 APPLICATION USAGE 🌈

On error, the expressions (math_errhandling & MATH_ERRNO) and (math_errhandling & MATH_ERREXCEPT) are independent of each other, but at least one of them must be non-zero. ✨


🧚 RATIONALE 🧚

These functions provide floating-to-integer conversions. They round according to the current rounding direction. If the rounded value is outside the range of the return type, the numeric result is unspecified and the invalid floating-point exception is raised. When they raise no other floating-point exception and the result differs from the argument, they raise the inexact floating-point exception. 🎯


⭐ FUTURE DIRECTIONS ⭐

None.


πŸ’€ SEE ALSO πŸ’€

  • feclearexcept()
  • fetestexcept()
  • llrint()

The Base Definitions volume of POSIX.1‐2017, Section 4.20, Treatment of Error Conditions for Mathematical Functions, <math.h>


Portions of this text are reprinted and reproduced in electronic form from IEEE Std 1003.1-2017, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 7, 2018 Edition, Copyright (C) 2018 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between this version and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html .

Any typographical or formatting errors that appear in this page are most likely to have been introduced during the conversion of the source files to man page format. To report such errors, see https://www.kernel.org/doc/man-pages/reporting_bugs.html .


and that's the whole page, bestie πŸ’…βœ¨ β€” brought to you by IEEE/The Open Group, 2017, LRINT(3P). mwah. πŸ«ΆπŸŽ€

πŸ“¦ where this page comes from