man3/j0.3

   1 '\" t
   2 .\" Copyright 1993 David Metcalfe (david@prism.demon.co.uk)
   3 .\" and Copyright 2008, Linux Foundation, written by Michael Kerrisk
   4 .\"     <mtk.manpages@gmail.com>
   5 .\"
   6 .\" SPDX-License-Identifier: Linux-man-pages-copyleft
   7 .\"
   8 .\" References consulted:
   9 .\"     Linux libc source code
  10 .\"     Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991)
  11 .\"     386BSD man pages
  12 .\" Modified Sat Jul 24 19:08:17 1993 by Rik Faith (faith@cs.unc.edu)
  13 .\" Modified 2002-08-25, aeb
  14 .\" Modified 2004-11-12 as per suggestion by Fabian Kreutz/AEB
  15 .\" 2008-07-24, mtk, moved yxx() material into separate y0.3 page
  16 .\"
  17 .TH j0 3 (date) "Linux man-pages (unreleased)"
  18 .SH NAME
  19 j0, j0f, j0l, j1, j1f, j1l, jn, jnf, jnl \-
  20 Bessel functions of the first kind
  21 .SH LIBRARY
  22 Math library
  23 .RI ( libm ", " \-lm )
  24 .SH SYNOPSIS
  25 .nf
  26 .B #include <math.h>
  27 .P
  28 .BI "double j0(double " x );
  29 .BI "double j1(double " x );
  30 .BI "double jn(int " n ", double " x );
  31 .P
  32 .BI "float j0f(float " x );
  33 .BI "float j1f(float " x );
  34 .BI "float jnf(int " n ", float " x );
  35 .P
  36 .BI "long double j0l(long double " x );
  37 .BI "long double j1l(long double " x );
  38 .BI "long double jnl(int " n ", long double " x );
  39 .fi
  40 .P
  41 .RS -4
  42 Feature Test Macro Requirements for glibc (see
  43 .BR feature_test_macros (7)):
  44 .RE
  45 .P
  46 .BR j0 (),
  47 .BR j1 (),
  48 .BR jn ():
  49 .nf
  50     _XOPEN_SOURCE
  51         || /* Since glibc 2.19: */ _DEFAULT_SOURCE
  52         || /* glibc <= 2.19: */ _SVID_SOURCE || _BSD_SOURCE
  53 .fi
  54 .P
  55 .BR j0f (),
  56 .BR j0l (),
  57 .BR j1f (),
  58 .BR j1l (),
  59 .BR jnf (),
  60 .BR jnl ():
  61 .nf
  62     _XOPEN_SOURCE >= 600
  63         || (_ISOC99_SOURCE && _XOPEN_SOURCE)
  64         || /* Since glibc 2.19: */ _DEFAULT_SOURCE
  65         || /* glibc <= 2.19: */ _SVID_SOURCE || _BSD_SOURCE
  66 .fi
  67 .SH DESCRIPTION
  68 The
  69 .BR j0 ()
  70 and
  71 .BR j1 ()
  72 functions return Bessel functions of
  73 .I x
  74 of the first kind of orders 0 and 1, respectively.
  75 The
  76 .BR jn ()
  77 function
  78 returns the Bessel function of
  79 .I x
  80 of the first kind of order
  81 .IR n .
  82 .P
  83 The
  84 .BR j0f (),
  85 .BR j1f (),
  86 and
  87 .BR jnf (),
  88 functions are versions that take and return
  89 .I float
  90 values.
  91 The
  92 .BR j0l (),
  93 .BR j1l (),
  94 and
  95 .BR jnl ()
  96 functions are versions that take and return
  97 .I "long double"
  98 values.
  99 .SH RETURN VALUE
 100 On success, these functions return the appropriate
 101 Bessel value of the first kind for
 102 .IR x .
 103 .P
 104 If
 105 .I x
 106 is a NaN, a NaN is returned.
 107 .P
 108 If
 109 .I x
 110 is too large in magnitude,
 111 or the result underflows,
 112 a range error occurs,
 113 and the return value is 0.
 114 .SH ERRORS
 115 See
 116 .BR math_error (7)
 117 for information on how to determine whether an error has occurred
 118 when calling these functions.
 119 .P
 120 The following errors can occur:
 121 .TP
 122 Range error: result underflow, or \fIx\fP is too large in magnitude
 123 .I errno
 124 is set to
 125 .BR ERANGE .
 126 .P
 127 These functions do not raise exceptions for
 128 .BR fetestexcept (3).
 129 .\" e.g., j0(1.5e16)
 130 .\" This is intentional.
 131 .\" See https://www.sourceware.org/bugzilla/show_bug.cgi?id=6805
 132 .SH ATTRIBUTES
 133 For an explanation of the terms used in this section, see
 134 .BR attributes (7).
 135 .TS
 136 allbox;
 137 lbx lb lb
 138 l l l.
 139 Interface       Attribute       Value
 140 T{
 141 .na
 142 .nh
 143 .BR j0 (),
 144 .BR j0f (),
 145 .BR j0l ()
 146 T}      Thread safety   MT-Safe
 147 T{
 148 .na
 149 .nh
 150 .BR j1 (),
 151 .BR j1f (),
 152 .BR j1l ()
 153 T}      Thread safety   MT-Safe
 154 T{
 155 .na
 156 .nh
 157 .BR jn (),
 158 .BR jnf (),
 159 .BR jnl ()
 160 T}      Thread safety   MT-Safe
 161 .TE
 162 .SH STANDARDS
 163 .TP
 164 .BR j0 ()
 165 .TQ
 166 .BR j1 ()
 167 .TQ
 168 .BR jn ()
 169 POSIX.1-2008.
 170 .TP
 171 Others:
 172 BSD.
 173 .SH HISTORY
 174 .TP
 175 .BR j0 ()
 176 .TQ
 177 .BR j1 ()
 178 .TQ
 179 .BR jn ()
 180 SVr4, 4.3BSD,
 181 POSIX.1-2001, POSIX.1-2008.
 182 .TP
 183 Others:
 184 BSD.
 185 .SH BUGS
 186 There are errors of up to 2e\-16 in the values returned by
 187 .BR j0 (),
 188 .BR j1 (),
 189 and
 190 .BR jn ()
 191 for values of
 192 .I x
 193 between \-8 and 8.
 194 .SH SEE ALSO
 195 .BR y0 (3)