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

y0.3p (4530B)

    

  1. '\" et
  2. .TH Y0 "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. y0,
  12. y1,
  13. yn
  14. \(em Bessel functions of the second kind
  15. .SH SYNOPSIS
  16. .LP
  17. .nf
  18. #include <math.h>
  19. .P
  20. double y0(double \fIx\fP);
  21. double y1(double \fIx\fP);
  22. double yn(int \fIn\fP, double \fIx\fP);
  23. .fi
  24. .SH DESCRIPTION
  25. The
  26. \fIy0\fR(),
  27. \fIy1\fR(),
  28. and
  29. \fIyn\fR()
  30. functions shall compute Bessel functions of
  31. .IR x
  32. of the second kind of orders 0, 1, and
  33. .IR n ,
  34. respectively.
  35. .P
  36. An application wishing to check for error situations should set
  37. .IR errno
  38. to zero and call
  39. .IR feclearexcept (FE_ALL_EXCEPT)
  40. before calling these functions. On return, if
  41. .IR errno
  42. is non-zero or \fIfetestexcept\fR(FE_INVALID | FE_DIVBYZERO |
  43. FE_OVERFLOW | FE_UNDERFLOW) is non-zero, an error has occurred.
  44. .SH "RETURN VALUE"
  45. Upon successful completion, these functions shall return the relevant
  46. Bessel value of
  47. .IR x
  48. of the second kind.
  49. .P
  50. If
  51. .IR x
  52. is NaN, NaN shall be returned.
  53. .P
  54. If the
  55. .IR x
  56. argument to these functions is negative, \-HUGE_VAL or NaN shall be
  57. returned, and a domain error may occur.
  58. .P
  59. If
  60. .IR x
  61. is 0.0, \-HUGE_VAL shall be returned and a pole error may occur.
  62. .P
  63. If the correct result would cause underflow, 0.0 shall be returned and
  64. a range error may occur.
  65. .P
  66. If the correct result would cause overflow, \-HUGE_VAL or 0.0 shall
  67. be returned and a range error may occur.
  68. .SH ERRORS
  69. These functions may fail if:
  70. .IP "Domain\ Error" 12
  71. The value of
  72. .IR x
  73. is negative.
  74. .RS 12 
  75. .P
  76. If the integer expression (\fImath_errhandling\fR & MATH_ERRNO) is
  77. non-zero, then
  78. .IR errno
  79. shall be set to
  80. .BR [EDOM] .
  81. If the integer expression (\fImath_errhandling\fR & MATH_ERREXCEPT) is
  82. non-zero, then the invalid floating-point exception shall be raised.
  83. .RE
  84. .IP "Pole\ Error" 12
  85. The value of
  86. .IR x
  87. is zero.
  88. .RS 12 
  89. .P
  90. If the integer expression (\fImath_errhandling\fR & MATH_ERRNO) is
  91. non-zero, then
  92. .IR errno
  93. shall be set to
  94. .BR [ERANGE] .
  95. If the integer expression (\fImath_errhandling\fR & MATH_ERREXCEPT) is
  96. non-zero, then the divide-by-zero floating-point exception shall be
  97. raised.
  98. .RE
  99. .IP "Range\ Error" 12
  100. The correct result would cause overflow.
  101. .RS 12 
  102. .P
  103. If the integer expression (\fImath_errhandling\fR & MATH_ERRNO) is
  104. non-zero, then
  105. .IR errno
  106. shall be set to
  107. .BR [ERANGE] .
  108. If the integer expression (\fImath_errhandling\fR & MATH_ERREXCEPT) is
  109. non-zero, then the overflow floating-point exception shall be raised.
  110. .RE
  111. .IP "Range\ Error" 12
  112. The value of
  113. .IR x
  114. is too large in magnitude, or the correct result would cause
  115. underflow.
  116. .RS 12 
  117. .P
  118. If the integer expression (\fImath_errhandling\fR & MATH_ERRNO) is
  119. non-zero, then
  120. .IR errno
  121. shall be set to
  122. .BR [ERANGE] .
  123. If the integer expression (\fImath_errhandling\fR & MATH_ERREXCEPT) is
  124. non-zero, then the underflow floating-point exception shall be raised.
  125. .RE
  126. .LP
  127. .IR "The following sections are informative."
  128. .SH EXAMPLES
  129. None.
  130. .SH "APPLICATION USAGE"
  131. On error, the expressions (\fImath_errhandling\fR & MATH_ERRNO) and
  132. (\fImath_errhandling\fR & MATH_ERREXCEPT) are independent of each
  133. other, but at least one of them must be non-zero.
  134. .SH RATIONALE
  135. None.
  136. .SH "FUTURE DIRECTIONS"
  137. None.
  138. .SH "SEE ALSO"
  139. .IR "\fIfeclearexcept\fR\^(\|)",
  140. .IR "\fIfetestexcept\fR\^(\|)",
  141. .IR "\fIisnan\fR\^(\|)",
  142. .IR "\fIj0\fR\^(\|)"
  143. .P
  144. The Base Definitions volume of POSIX.1\(hy2017,
  145. .IR "Section 4.20" ", " "Treatment of Error Conditions for Mathematical Functions",
  146. .IR "\fB<math.h>\fP"
  147. .\"
  148. .SH COPYRIGHT
  149. Portions of this text are reprinted and reproduced in electronic form
  150. from IEEE Std 1003.1-2017, Standard for Information Technology
  151. -- Portable Operating System Interface (POSIX), The Open Group Base
  152. Specifications Issue 7, 2018 Edition,
  153. Copyright (C) 2018 by the Institute of
  154. Electrical and Electronics Engineers, Inc and The Open Group.
  155. In the event of any discrepancy between this version and the original IEEE and
  156. The Open Group Standard, the original IEEE and The Open Group Standard
  157. is the referee document. The original Standard can be obtained online at
  158. http://www.opengroup.org/unix/online.html .
  159. .PP
  160. Any typographical or formatting errors that appear
  161. in this page are most likely
  162. to have been introduced during the conversion of the source files to
  163. man page format. To report such errors, see
  164. https://www.kernel.org/doc/man-pages/reporting_bugs.html .