logo

oasis-root

Compiled tree of Oasis Linux based on own branch at <https://hacktivis.me/git/oasis/> git clone https://anongit.hacktivis.me/git/oasis-root.git

sinh.3p (4174B)

    

  1. '\" et
  2. .TH SINH "3P" 2017 "IEEE/The Open Group" "POSIX Programmer's Manual"
  3. .\"
  4. .SH PROLOG
  5. This manual page is part of the POSIX Programmer's Manual.
  6. The Linux implementation of this interface may differ (consult
  7. the corresponding Linux manual page for details of Linux behavior),
  8. or the interface may not be implemented on Linux.
  9. .\"
  10. .SH NAME
  11. sinh,
  12. sinhf,
  13. sinhl
  14. \(em hyperbolic sine functions
  15. .SH SYNOPSIS
  16. .LP
  17. .nf
  18. #include <math.h>
  19. .P
  20. double sinh(double \fIx\fP);
  21. float sinhf(float \fIx\fP);
  22. long double sinhl(long double \fIx\fP);
  23. .fi
  24. .SH DESCRIPTION
  25. The functionality described on this reference page is aligned with the
  26. ISO\ C standard. Any conflict between the requirements described here and the
  27. ISO\ C standard is unintentional. This volume of POSIX.1\(hy2017 defers to the ISO\ C standard.
  28. .P
  29. These functions shall compute the hyperbolic sine of their argument
  30. .IR x .
  31. .P
  32. An application wishing to check for error situations should set
  33. .IR errno
  34. to zero and call
  35. .IR feclearexcept (FE_ALL_EXCEPT)
  36. before calling these functions. On return, if
  37. .IR errno
  38. is non-zero or \fIfetestexcept\fR(FE_INVALID | FE_DIVBYZERO |
  39. FE_OVERFLOW | FE_UNDERFLOW) is non-zero, an error has occurred.
  40. .SH "RETURN VALUE"
  41. Upon successful completion, these functions shall return the hyperbolic
  42. sine of
  43. .IR x .
  44. .P
  45. If the result would cause an overflow, a range error shall occur and
  46. \(+-HUGE_VAL, \(+-HUGE_VALF, and \(+-HUGE_VALL (with the same sign as
  47. .IR x )
  48. shall be returned as appropriate for the type of the function.
  49. .P
  50. If
  51. .IR x
  52. is NaN, a NaN shall be returned.
  53. .P
  54. If
  55. .IR x
  56. is \(+-0 or \(+-Inf,
  57. .IR x
  58. shall be returned.
  59. .P
  60. If
  61. .IR x
  62. is subnormal, a range error may occur
  63. .br
  64. and
  65. .IR x
  66. should be returned.
  67. .P
  68. If
  69. .IR x
  70. is not returned,
  71. \fIsinh\fR(),
  72. \fIsinhf\fR(),
  73. and
  74. \fIsinhl\fR()
  75. shall return an implementation-defined value no greater in magnitude
  76. than DBL_MIN, FLT_MIN, and LDBL_MIN, respectively.
  77. .SH ERRORS
  78. These functions shall fail if:
  79. .IP "Range\ Error" 12
  80. The result would cause an overflow.
  81. .RS 12 
  82. .P
  83. If the integer expression (\fImath_errhandling\fR & MATH_ERRNO) is
  84. non-zero, then
  85. .IR errno
  86. shall be set to
  87. .BR [ERANGE] .
  88. If the integer expression (\fImath_errhandling\fR & MATH_ERREXCEPT) is
  89. non-zero, then the overflow floating-point exception shall be raised.
  90. .RE
  91. .P
  92. These functions may fail if:
  93. .IP "Range\ Error" 12
  94. The value
  95. .IR x
  96. is subnormal.
  97. .RS 12 
  98. .P
  99. If the integer expression (\fImath_errhandling\fR & MATH_ERRNO) is
  100. non-zero, then
  101. .IR errno
  102. shall be set to
  103. .BR [ERANGE] .
  104. If the integer expression (\fImath_errhandling\fR & MATH_ERREXCEPT) is
  105. non-zero, then the underflow floating-point exception shall be raised.
  106. .RE
  107. .LP
  108. .IR "The following sections are informative."
  109. .SH EXAMPLES
  110. None.
  111. .SH "APPLICATION USAGE"
  112. On error, the expressions (\fImath_errhandling\fR & MATH_ERRNO) and
  113. (\fImath_errhandling\fR & MATH_ERREXCEPT) are independent of each
  114. other, but at least one of them must be non-zero.
  115. .SH RATIONALE
  116. None.
  117. .SH "FUTURE DIRECTIONS"
  118. None.
  119. .SH "SEE ALSO"
  120. .IR "\fIasinh\fR\^(\|)",
  121. .IR "\fIcosh\fR\^(\|)",
  122. .IR "\fIfeclearexcept\fR\^(\|)",
  123. .IR "\fIfetestexcept\fR\^(\|)",
  124. .IR "\fIisnan\fR\^(\|)",
  125. .IR "\fItanh\fR\^(\|)"
  126. .P
  127. The Base Definitions volume of POSIX.1\(hy2017,
  128. .IR "Section 4.20" ", " "Treatment of Error Conditions for Mathematical Functions",
  129. .IR "\fB<math.h>\fP"
  130. .\"
  131. .SH COPYRIGHT
  132. Portions of this text are reprinted and reproduced in electronic form
  133. from IEEE Std 1003.1-2017, Standard for Information Technology
  134. -- Portable Operating System Interface (POSIX), The Open Group Base
  135. Specifications Issue 7, 2018 Edition,
  136. Copyright (C) 2018 by the Institute of
  137. Electrical and Electronics Engineers, Inc and The Open Group.
  138. In the event of any discrepancy between this version and the original IEEE and
  139. The Open Group Standard, the original IEEE and The Open Group Standard
  140. is the referee document. The original Standard can be obtained online at
  141. http://www.opengroup.org/unix/online.html .
  142. .PP
  143. Any typographical or formatting errors that appear
  144. in this page are most likely
  145. to have been introduced during the conversion of the source files to
  146. man page format. To report such errors, see
  147. https://www.kernel.org/doc/man-pages/reporting_bugs.html .