Blame man-pages-posix-2013-a/man3p/y0.3p

Packit 7cfc04
'\" et
Packit 7cfc04
.TH Y0 "3P" 2013 "IEEE/The Open Group" "POSIX Programmer's Manual"
Packit 7cfc04
.SH PROLOG
Packit 7cfc04
This manual page is part of the POSIX Programmer's Manual.
Packit 7cfc04
The Linux implementation of this interface may differ (consult
Packit 7cfc04
the corresponding Linux manual page for details of Linux behavior),
Packit 7cfc04
or the interface may not be implemented on Linux.
Packit 7cfc04
Packit 7cfc04
.SH NAME
Packit 7cfc04
y0,
Packit 7cfc04
y1,
Packit 7cfc04
yn
Packit 7cfc04
\(em Bessel functions of the second kind
Packit 7cfc04
.SH SYNOPSIS
Packit 7cfc04
.LP
Packit 7cfc04
.nf
Packit 7cfc04
#include <math.h>
Packit 7cfc04
.P
Packit 7cfc04
double y0(double \fIx\fP);
Packit 7cfc04
double y1(double \fIx\fP);
Packit 7cfc04
double yn(int \fIn\fP, double \fIx\fP);
Packit 7cfc04
.fi
Packit 7cfc04
.SH DESCRIPTION
Packit 7cfc04
The
Packit 7cfc04
\fIy0\fR(),
Packit 7cfc04
\fIy1\fR(),
Packit 7cfc04
and
Packit 7cfc04
\fIyn\fR()
Packit 7cfc04
functions shall compute Bessel functions of
Packit 7cfc04
.IR x
Packit 7cfc04
of the second kind of orders 0, 1, and
Packit 7cfc04
.IR n ,
Packit 7cfc04
respectively.
Packit 7cfc04
.P
Packit 7cfc04
An application wishing to check for error situations should set
Packit 7cfc04
.IR errno
Packit 7cfc04
to zero and call
Packit 7cfc04
.IR feclearexcept (FE_ALL_EXCEPT)
Packit 7cfc04
before calling these functions. On return, if
Packit 7cfc04
.IR errno
Packit 7cfc04
is non-zero or \fIfetestexcept\fR(FE_INVALID | FE_DIVBYZERO |
Packit 7cfc04
FE_OVERFLOW | FE_UNDERFLOW) is non-zero, an error has occurred.
Packit 7cfc04
.SH "RETURN VALUE"
Packit 7cfc04
Upon successful completion, these functions shall return the relevant
Packit 7cfc04
Bessel value of
Packit 7cfc04
.IR x
Packit 7cfc04
of the second kind.
Packit 7cfc04
.P
Packit 7cfc04
If
Packit 7cfc04
.IR x
Packit 7cfc04
is NaN, NaN shall be returned.
Packit 7cfc04
.P
Packit 7cfc04
If the
Packit 7cfc04
.IR x
Packit 7cfc04
argument to these functions is negative, \(miHUGE_VAL or NaN shall be
Packit 7cfc04
returned, and a domain error may occur.
Packit 7cfc04
.P
Packit 7cfc04
If
Packit 7cfc04
.IR x
Packit 7cfc04
is 0.0, \(miHUGE_VAL shall be returned and a pole error may occur.
Packit 7cfc04
.P
Packit 7cfc04
If the correct result would cause underflow, 0.0 shall be returned and
Packit 7cfc04
a range error may occur.
Packit 7cfc04
.P
Packit 7cfc04
If the correct result would cause overflow, \(miHUGE_VAL or 0.0 shall
Packit 7cfc04
be returned and a range error may occur.
Packit 7cfc04
.SH ERRORS
Packit 7cfc04
These functions may fail if:
Packit 7cfc04
.IP "Domain\ Error" 12
Packit 7cfc04
The value of
Packit 7cfc04
.IR x
Packit 7cfc04
is negative.
Packit 7cfc04
.RS 12 
Packit 7cfc04
.P
Packit 7cfc04
If the integer expression (\fImath_errhandling\fR & MATH_ERRNO) is
Packit 7cfc04
non-zero, then
Packit 7cfc04
.IR errno
Packit 7cfc04
shall be set to
Packit 7cfc04
.BR [EDOM] .
Packit 7cfc04
If the integer expression (\fImath_errhandling\fR & MATH_ERREXCEPT) is
Packit 7cfc04
non-zero, then the invalid floating-point exception shall be raised.
Packit 7cfc04
.RE
Packit 7cfc04
.IP "Pole\ Error" 12
Packit 7cfc04
The value of
Packit 7cfc04
.IR x
Packit 7cfc04
is zero.
Packit 7cfc04
.RS 12 
Packit 7cfc04
.P
Packit 7cfc04
If the integer expression (\fImath_errhandling\fR & MATH_ERRNO) is
Packit 7cfc04
non-zero, then
Packit 7cfc04
.IR errno
Packit 7cfc04
shall be set to
Packit 7cfc04
.BR [ERANGE] .
Packit 7cfc04
If the integer expression (\fImath_errhandling\fR & MATH_ERREXCEPT) is
Packit 7cfc04
non-zero, then the divide-by-zero floating-point exception shall be
Packit 7cfc04
raised.
Packit 7cfc04
.RE
Packit 7cfc04
.IP "Range\ Error" 12
Packit 7cfc04
The correct result would cause overflow.
Packit 7cfc04
.RS 12 
Packit 7cfc04
.P
Packit 7cfc04
If the integer expression (\fImath_errhandling\fR & MATH_ERRNO) is
Packit 7cfc04
non-zero, then
Packit 7cfc04
.IR errno
Packit 7cfc04
shall be set to
Packit 7cfc04
.BR [ERANGE] .
Packit 7cfc04
If the integer expression (\fImath_errhandling\fR & MATH_ERREXCEPT) is
Packit 7cfc04
non-zero, then the overflow floating-point exception shall be raised.
Packit 7cfc04
.RE
Packit 7cfc04
.IP "Range\ Error" 12
Packit 7cfc04
The value of
Packit 7cfc04
.IR x
Packit 7cfc04
is too large in magnitude, or the correct result would cause
Packit 7cfc04
underflow.
Packit 7cfc04
.RS 12 
Packit 7cfc04
.P
Packit 7cfc04
If the integer expression (\fImath_errhandling\fR & MATH_ERRNO) is
Packit 7cfc04
non-zero, then
Packit 7cfc04
.IR errno
Packit 7cfc04
shall be set to
Packit 7cfc04
.BR [ERANGE] .
Packit 7cfc04
If the integer expression (\fImath_errhandling\fR & MATH_ERREXCEPT) is
Packit 7cfc04
non-zero, then the underflow floating-point exception shall be raised.
Packit 7cfc04
.RE
Packit 7cfc04
.LP
Packit 7cfc04
.IR "The following sections are informative."
Packit 7cfc04
.SH EXAMPLES
Packit 7cfc04
None.
Packit 7cfc04
.SH "APPLICATION USAGE"
Packit 7cfc04
On error, the expressions (\fImath_errhandling\fR & MATH_ERRNO) and
Packit 7cfc04
(\fImath_errhandling\fR & MATH_ERREXCEPT) are independent of each
Packit 7cfc04
other, but at least one of them must be non-zero.
Packit 7cfc04
.SH RATIONALE
Packit 7cfc04
None.
Packit 7cfc04
.SH "FUTURE DIRECTIONS"
Packit 7cfc04
None.
Packit 7cfc04
.SH "SEE ALSO"
Packit 7cfc04
.IR "\fIfeclearexcept\fR\^(\|)",
Packit 7cfc04
.IR "\fIfetestexcept\fR\^(\|)",
Packit 7cfc04
.IR "\fIisnan\fR\^(\|)",
Packit 7cfc04
.IR "\fIj0\fR\^(\|)"
Packit 7cfc04
.P
Packit 7cfc04
The Base Definitions volume of POSIX.1\(hy2008,
Packit 7cfc04
.IR "Section 4.19" ", " "Treatment of Error Conditions for Mathematical Functions",
Packit 7cfc04
.IR "\fB<math.h>\fP"
Packit 7cfc04
.SH COPYRIGHT
Packit 7cfc04
Portions of this text are reprinted and reproduced in electronic form
Packit 7cfc04
from IEEE Std 1003.1, 2013 Edition, Standard for Information Technology
Packit 7cfc04
-- Portable Operating System Interface (POSIX), The Open Group Base
Packit 7cfc04
Specifications Issue 7, Copyright (C) 2013 by the Institute of
Packit 7cfc04
Electrical and Electronics Engineers, Inc and The Open Group.
Packit 7cfc04
(This is POSIX.1-2008 with the 2013 Technical Corrigendum 1 applied.) In the
Packit 7cfc04
event of any discrepancy between this version and the original IEEE and
Packit 7cfc04
The Open Group Standard, the original IEEE and The Open Group Standard
Packit 7cfc04
is the referee document. The original Standard can be obtained online at
Packit 7cfc04
http://www.unix.org/online.html .
Packit 7cfc04
Packit 7cfc04
Any typographical or formatting errors that appear
Packit 7cfc04
in this page are most likely
Packit 7cfc04
to have been introduced during the conversion of the source files to
Packit 7cfc04
man page format. To report such errors, see
Packit 7cfc04
https://www.kernel.org/doc/man-pages/reporting_bugs.html .