sinh - Man Page

hyperbolic sine functions

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.

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.

These functions shall compute the hyperbolic sine of their argument x.

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.

Return Value

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

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.

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.

The following sections are informative.

Examples

None.

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

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>

Referenced By

asinh(3p), cosh(3p), math.h(0p).

2017 IEEE/The Open Group POSIX Programmer's Manual