FLOOR(3P)

πŸ’– FLOOR(3P) β€” bestie edition πŸ’–

okay so this is a page from the POSIX Programmer's Manual, and it's literally about floor, floorf and floorl. iykyk. 🫢


🌸 PROLOG 🌸

This manual page is part of the POSIX Programmer's Manual. Heads up bestie: the Linux implementation of this interface may differ (so go check the corresponding Linux manual page for the deets on Linux behavior), or the interface may not be implemented on Linux at all. πŸ’€ so like, vibe check first.


✨ NAME ✨

floor, floorf, floorl β€” the floor function. that's it. that's the name. iconic.


πŸŽ€ SYNOPSIS πŸŽ€

#include <math.h>

double floor(double x);
float floorf(float x);
long double floorl(long double x);

three of them. same energy, different types. slay. πŸ’…


πŸ¦‹ DESCRIPTION πŸ¦‹

The functionality described on this reference page is aligned with the ISO C standard. And listen β€” any conflict between the requirements described here and the ISO C standard is unintentional, no cap. This volume of POSIX.1‐2017 defers to the ISO C standard. periodt.

So what do these functions actually do? They shall compute the largest integral value not greater than x. that's the whole job. they take your number and snap it down to the biggest whole number that isn't bigger than it. no drama. πŸ’–


πŸ‘‘ RETURN VALUE πŸ‘‘

The result shall have the same sign as x. fr fr, sign stays.

Upon successful completion, these functions shall return the largest integral value not greater than x, expressed as a double, float, or long double, as appropriate for the return type of the function. match the return type to the function, obviously. πŸ’…

  • If x is NaN, a NaN shall be returned. 🫠
  • If x is Β±0 or Β±Inf, x shall be returned. so those just come right back at you, unchanged, like a text you sent to the wrong chat.

🌈 ERRORS 🌈

No errors are defined. nothing. zero. not one. ✨

The following sections are informative. (so like, the fun bonus content sections, not the strict rules. πŸŽ€)


πŸ“ EXAMPLES πŸ“

None. yeah. none. they really said "figure it out bestie". 😭


πŸ’œ APPLICATION USAGE πŸ’œ

okay this part is actually important, pay attention:

The integral value returned by these functions might not be expressible as an intmax_t. 🚨 so the return value should be tested before assigning it to an integer type to avoid the undefined results of an integer overflow. like, please test it first. do not just yeet it into an integer. undefined behavior is not the vibe. πŸ’€

Also: These functions may raise the inexact floating-point exception if the result differs in value from the argument. noted. 🫢


🧚 RATIONALE 🧚

None. (they had nothing to justify. understandable. the function justifies itself. main character energy. πŸ‘‘)


⭐ FUTURE DIRECTIONS ⭐

None. the future is bright and unchanging, bestie. ✨


🌸 SEE ALSO 🌸

  • ceil()
  • feclearexcept()
  • fetestexcept()
  • isnan()
  • Section 4.20, Treatment of Error Conditions for Mathematical Functions, <math.h>

go read those too, they're all in the same friend group. 🫢


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 came from IEEE/The Open Group, dated 2017, and the page is literally called FLOOR(3P). you ate that. bye πŸ’–βœ¨πŸ¦‹

πŸ“¦ where this page comes from