man3/j0.3

   1 .\" Copyright 1993 David Metcalfe (david@prism.demon.co.uk)
   2 .\" and Copyright 2008, Linux Foundation, written by Michael Kerrisk
   3 .\"     <mtk.manpages@gmail.com>
   4 .\"
   5 .\" %%%LICENSE_START(VERBATIM)
   6 .\" Permission is granted to make and distribute verbatim copies of this
   7 .\" manual provided the copyright notice and this permission notice are
   8 .\" preserved on all copies.
   9 .\"
  10 .\" Permission is granted to copy and distribute modified versions of this
  11 .\" manual under the conditions for verbatim copying, provided that the
  12 .\" entire resulting derived work is distributed under the terms of a
  13 .\" permission notice identical to this one.
  14 .\"
  15 .\" Since the Linux kernel and libraries are constantly changing, this
  16 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  17 .\" responsibility for errors or omissions, or for damages resulting from
  18 .\" the use of the information contained herein.  The author(s) may not
  19 .\" have taken the same level of care in the production of this manual,
  20 .\" which is licensed free of charge, as they might when working
  21 .\" professionally.
  22 .\"
  23 .\" Formatted or processed versions of this manual, if unaccompanied by
  24 .\" the source, must acknowledge the copyright and authors of this work.
  25 .\" %%%LICENSE_END
  26 .\"
  27 .\" References consulted:
  28 .\"     Linux libc source code
  29 .\"     Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991)
  30 .\"     386BSD man pages
  31 .\" Modified Sat Jul 24 19:08:17 1993 by Rik Faith (faith@cs.unc.edu)
  32 .\" Modified 2002-08-25, aeb
  33 .\" Modified 2004-11-12 as per suggestion by Fabian Kreutz/AEB
  34 .\" 2008-07-24, mtk, moved yxx() material into separate y0.3 page
  35 .\"
  36 .TH J0 3  2021-03-22 "" "Linux Programmer's Manual"
  37 .SH NAME
  38 j0, j0f, j0l, j1, j1f, j1l, jn, jnf, jnl \-
  39 Bessel functions of the first kind
  40 .SH SYNOPSIS
  41 .nf
  42 .B #include <math.h>
  43 .PP
  44 .BI "double j0(double " x );
  45 .BI "double j1(double " x );
  46 .BI "double jn(int " n ", double " x );
  47 .PP
  48 .BI "float j0f(float " x );
  49 .BI "float j1f(float " x );
  50 .BI "float jnf(int " n ", float " x );
  51 .PP
  52 .BI "long double j0l(long double " x );
  53 .BI "long double j1l(long double " x );
  54 .BI "long double jnl(int " n ", long double " x );
  55 .fi
  56 .PP
  57 Link with \fI\-lm\fP.
  58 .PP
  59 .RS -4
  60 Feature Test Macro Requirements for glibc (see
  61 .BR feature_test_macros (7)):
  62 .RE
  63 .PP
  64 .BR j0 (),
  65 .BR j1 (),
  66 .BR jn ():
  67 .nf
  68     _XOPEN_SOURCE
  69         || /* Since glibc 2.19: */ _DEFAULT_SOURCE
  70         || /* Glibc <= 2.19: */ _SVID_SOURCE || _BSD_SOURCE
  71 .fi
  72 .PP
  73 .BR j0f (),
  74 .BR j0l (),
  75 .BR j1f (),
  76 .BR j1l (),
  77 .BR jnf (),
  78 .BR jnl ():
  79 .nf
  80     _XOPEN_SOURCE >= 600
  81         || (_ISOC99_SOURCE && _XOPEN_SOURCE)
  82         || /* Since glibc 2.19: */ _DEFAULT_SOURCE
  83         || /* Glibc <= 2.19: */ _SVID_SOURCE || _BSD_SOURCE
  84 .fi
  85 .SH DESCRIPTION
  86 The
  87 .BR j0 ()
  88 and
  89 .BR j1 ()
  90 functions return Bessel functions of
  91 .I x
  92 of the first kind of orders 0 and 1, respectively.
  93 The
  94 .BR jn ()
  95 function
  96 returns the Bessel function of
  97 .I x
  98 of the first kind of order
  99 .IR n .
 100 .PP
 101 The
 102 .BR j0f (),
 103 .BR j1f (),
 104 and
 105 .BR jnf (),
 106 functions are versions that take and return
 107 .I float
 108 values.
 109 The
 110 .BR j0l (),
 111 .BR j1l (),
 112 and
 113 .BR jnl ()
 114 functions are versions that take and return
 115 .I "long double"
 116 values.
 117 .SH RETURN VALUE
 118 On success, these functions return the appropriate
 119 Bessel value of the first kind for
 120 .IR x .
 121 .PP
 122 If
 123 .I x
 124 is a NaN, a NaN is returned.
 125 .PP
 126 If
 127 .I x
 128 is too large in magnitude,
 129 or the result underflows,
 130 a range error occurs,
 131 and the return value is 0.
 132 .SH ERRORS
 133 See
 134 .BR math_error (7)
 135 for information on how to determine whether an error has occurred
 136 when calling these functions.
 137 .PP
 138 The following errors can occur:
 139 .TP
 140 Range error: result underflow, or \fIx\fP is too large in magnitude
 141 .I errno
 142 is set to
 143 .BR ERANGE .
 144 .PP
 145 These functions do not raise exceptions for
 146 .BR fetestexcept (3).
 147 .\" e.g., j0(1.5e16)
 148 .\" This is intentional.
 149 .\" See http://sources.redhat.com/bugzilla/show_bug.cgi?id=6805
 150 .SH ATTRIBUTES
 151 For an explanation of the terms used in this section, see
 152 .BR attributes (7).
 153 .ad l
 154 .nh
 155 .TS
 156 allbox;
 157 lbx lb lb
 158 l l l.
 159 Interface       Attribute       Value
 160 T{
 161 .BR j0 (),
 162 .BR j0f (),
 163 .BR j0l ()
 164 T}      Thread safety   MT-Safe
 165 T{
 166 .BR j1 (),
 167 .BR j1f (),
 168 .BR j1l ()
 169 T}      Thread safety   MT-Safe
 170 T{
 171 .BR jn (),
 172 .BR jnf (),
 173 .BR jnl ()
 174 T}      Thread safety   MT-Safe
 175 .TE
 176 .hy
 177 .ad
 178 .sp 1
 179 .SH CONFORMING TO
 180 The functions returning
 181 .I double
 182 conform to SVr4, 4.3BSD,
 183 POSIX.1-2001, and POSIX.1-2008.
 184 The others are nonstandard functions that also exist on the BSDs.
 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)