SINH(3POSIX)

πŸ’– SINH(3POSIX) β€” the POSIX Programmer's Manual πŸ’–

okay bestie, welcome to the sinh page, part of the POSIX Programmer's Manual. quick heads up before we dive in: this page is part of that manual, and the Linux implementation of this interface may differ (so go peek at the matching Linux manual page for the tea on Linux behaviour), or honestly the interface might not even be implemented on Linux. πŸ™ˆ


✨ PROLOG ✨

okay so, same warning as above, but it's its own section so it gets its own moment:

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.


🌸 NAME 🌸

sinh, sinhf, sinhl β€” hyperbolic sine functions πŸ’«


πŸŽ€ SYNOPSIS πŸŽ€

#include <math.h>

double sinh(double x);
float sinhf(float x);
long double sinhl(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. (yes, the standard is the referee here, we just live in its house 🏠)

These functions shall compute the hyperbolic sine of their argument x. that's it, that's the whole job, and they ate πŸ’…

An application wishing to check for error situations should set errno to zero and call feclearexcept(FE_ALL_EXCEPT) before calling these functions. On return, if errno is non-zero or fetestexcept(FE_INVALID | FE_DIVBYZERO | FE_OVERFLOW | FE_UNDERFLOW) is non-zero, an error has occurred. it's giving "vibe check your error state before and after", no cap ✨


πŸ’œ RETURN VALUE πŸ’œ

Upon successful completion, these functions shall return the hyperbolic sine of x. slay.

If the result would cause an overflow, a range error shall occur and ±HUGE_VAL, ±HUGE_VALF, and ±HUGE_VALL (with the same sign as x) shall be returned as appropriate for the type of the function. like, it maxes out and tells you it maxed out, dramatic but fair 😭

If x is NaN, a NaN shall be returned.

If x is Β±0 or Β±Inf, x shall be returned.

If x is subnormal, a range error may occur and x should be returned.

If x is not returned, sinh(), sinhf(), and sinhl() shall return an implementation-defined value no greater in magnitude than DBL_MIN, FLT_MIN, and LDBL_MIN, respectively.


πŸ’… ERRORS πŸ’…

These functions shall fail if:

  • Range Error β€” The result would cause an overflow.
    • If the integer expression (math_errhandling & MATH_ERRNO) is non-zero, then errno shall be set to [ERANGE]. If the integer expression (math_errhandling & MATH_ERREXCEPT) is non-zero, then the overflow floating-point exception shall be raised.

These functions may fail if:

  • Range Error β€” The value x is subnormal.
    • If the integer expression (math_errhandling & MATH_ERRNO) is non-zero, then errno shall be set to [ERANGE]. If the integer expression (math_errhandling & MATH_ERREXCEPT) is non-zero, then the underflow floating-point exception shall be raised.
ngl the following sections are informative, so they're the chill bonus content, not the rules πŸ“

🌈 EXAMPLES 🌈

None. (not me getting zero examples πŸ’€ the standard said "figure it out bestie")


🫢 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. they don't text each other but they're both required to show up to the function πŸ’–


⭐ RATIONALE ⭐

None.


🧚 FUTURE DIRECTIONS 🧚

None.


πŸ‘‘ SEE ALSO πŸ‘‘

  • asinh()
  • cosh()
  • feclearexcept()
  • fetestexcept()
  • isnan()
  • tanh()

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 .


okay that's the whole page bestie, you're officially a hyperbolic sine scholar πŸŽ“βœ¨ IEEE/The Open Group, 2017, SINH(3POSIX) β€” mwah, go compute something iconic πŸ’‹