NEARBYINT(3P)

πŸ’– NEARBYINT(3P) β€” POSIX Programmer's Manual πŸ’–

okay bestie, welcome to the POSIX Programmer's Manual ✨ this page lives in the POSIX volume, so quick heads up before we dive in:

🚨 PROLOG 🚨

This manual page is part of the POSIX Programmer's Manual. The Linux implementation of this interface may differ (consult the corresponding Linux manual page for details of Linux behavior), or the interface may not be implemented on Linux.

fr fr, check your platform before you @ me πŸ’€

✨ NAME ✨

nearbyint, nearbyintf, nearbyintl β€” floating-point rounding functions πŸŽ€


🌸 SYNOPSIS 🌸

#include <math.h>

double nearbyint(double x);
float nearbyintf(float x);
long double nearbyintl(long double x);

πŸ’… DESCRIPTION πŸ’…

The functionality described on this reference page is aligned with the ISO C standard. Any conflict between the requirements described here and the ISO C standard is unintentional. This volume of POSIX.1‐2017 defers to the ISO C standard. no cap, ISO C is the main character here πŸ‘‘

These functions shall round their argument to an integer value in floating-point format, using the current rounding direction and without raising the inexact floating-point exception. so like, it rounds but it stays a float, it respects whatever rounding mode you've set, and it does NOT throw the inexact exception at you. iconic behavior honestly πŸ¦‹


🫢 RETURN VALUE 🫢

Upon successful completion, these functions shall return the rounded integer value. The result shall have the same sign as x. ✨

  • If x is NaN, a NaN shall be returned. 😭
  • If x is Β±0, Β±0 shall be returned. 🌸
  • If x is Β±Inf, x shall be returned. πŸ’€

πŸ™ˆ ERRORS πŸ™ˆ

No errors are defined. literally none, she's unproblematic πŸ’…

The following sections are informative. (iykyk, that means they're the vibe, not the rules ⭐)


πŸ“ EXAMPLES πŸ“

None. nothing to show, she just works πŸŽ€


🌈 APPLICATION USAGE 🌈

The integral value returned by these functions need not be expressible as an intmax_t. The return value should be tested before assigning it to an integer type to avoid the undefined results of an integer overflow.

bestie please, please, PLEASE check the value before you shove it into an integer type 😭 undefined results from integer overflow are not the vibe, that's giving chaos not cute πŸ’€

🧚 RATIONALE 🧚

None. πŸ’œ


πŸ‘‘ FUTURE DIRECTIONS πŸ‘‘

None. ⭐


πŸ’– SEE ALSO πŸ’–

  • feclearexcept()
  • fetestexcept()

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 β€” this one's brought to you by IEEE/The Open Group, 2017, filed under NEARBYINT(3P) πŸ’– go forth and round responsibly βœ¨πŸŽ€

πŸ“¦ where this page comes from