Skip to content

Commit 43b195a

Browse files
committed
update readme and news
1 parent ee9feb4 commit 43b195a

File tree

2 files changed

+7
-5
lines changed

2 files changed

+7
-5
lines changed

NEWS.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ For bug fixes, performance enhancements, or fixes to unexported functions we wil
1414
- add an unexport method (`Bessels.besseljy(nu, x)`) for faster computation of `besselj` and `bessely` (#33)
1515
- add exported methods for Hankel functions `besselh(nu, k, x)`, `hankelh1(nu, x)`, `hankelh2(nu, x)` (#33)
1616
- add exported methods for spherical bessel function `sphericalbesselj(nu, x)`, `sphericalbesselj(nu, x)`, (#38)
17+
- add exported methods for airy functions `airyai(x)`, `airyaiprime(x)`, `airybi(x)`, `airybiprime(x)`, (#39)
1718

1819
### Fixed
1920
- fix cutoff in `bessely` to not return error for integer orders and small arguments (#33)

README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22
[![Build Status](https://github.com/heltonmc/Bessels.jl/actions/workflows/CI.yml/badge.svg?branch=master)](https://github.com/heltonmc/Bessels.jl/actions/workflows/CI.yml?query=branch%3Amaster)
33
[![Coverage](https://codecov.io/gh/heltonmc/Bessels.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/heltonmc/Bessels.jl)
44

5-
Numerical routines for computing Bessel and Hankel functions for real arguments. These routines are written in the Julia programming language and are self contained without any external dependencies.
5+
Numerical routines for computing Bessel, Airy, and Hankel functions for real arguments. These routines are written in the Julia programming language and are self contained without any external dependencies.
66

77
The goal of the library is to provide high quality numerical implementations of Bessel functions with high accuracy without comprimising on computational time. In general, we try to match (and often exceed) the accuracy of other open source routines such as those provided by [SpecialFunctions.jl](https://github.com/JuliaMath/SpecialFunctions.jl). There are instances where we don't quite match that desired accuracy (within a digit or two) but in general will provide implementations that are 5-10x faster (see [benchmarks](https://github.com/heltonmc/Bessels.jl/edit/update_readme/README.md#benchmarks)).
88

9-
The library currently supports Bessel functions, modified Bessel functions, Hankel functions and spherical Bessel functions of the first and second kind for positive real arguments and integer and noninteger orders. Negative arguments are also supported only if the return value is real. We plan to support complex arguments in the future. An unexported gamma function is also provided.
9+
The library currently supports Bessel functions, modified Bessel functions, Hankel functions, spherical Bessel functions, and Airy functions of the first and second kind for positive real arguments and integer and noninteger orders. Negative arguments are also supported only if the return value is real. We plan to support complex arguments in the future. An unexported gamma function is also provided.
1010

1111
# Quick start
1212

@@ -170,7 +170,6 @@ We report the relative errors (`abs(1 - Bessels.f(x)/ArbNumerics.f(ArbFloat(x)))
170170
| besseli(92.12, x) | 9e-15 | 7e-14 |
171171
| Bessels.gamma(x) | 1.3e-16 | 5e-16
172172

173-
174173
In general the largest relative errors are observed near the zeros of Bessel functions for `besselj` and `bessely`. Accuracy might also be slightly worse for very large arguments when using `Float64` precision.
175174

176175
# Benchmarks
@@ -189,7 +188,6 @@ We give brief performance comparisons to the implementations provided by [Specia
189188
| besselk(nu, x) | 4x |
190189
| Bessels.gamma(x) | 5x |
191190

192-
193191
Benchmarks were run using Julia Version 1.7.2 on an Apple M1 using Rosetta.
194192

195193
# API
@@ -211,13 +209,16 @@ Benchmarks were run using Julia Version 1.7.2 on an Apple M1 using Rosetta.
211209
- `hankelh2(nu, x)`
212210
- `sphericalbesselj(nu, x)`
213211
- `sphericalbessely(nu, x)`
212+
- `airyai(x)`
213+
- `airyaiprime(x)`
214+
- `airybi(x)`
215+
- `airybiprime(x)`
214216
- `Bessels.gamma(x)`
215217

216218
# Current Development Plans
217219

218220
- Support for higher precision `Double64`, `Float128`
219221
- Support for complex arguments (`x` and `nu`)
220-
- Airy functions
221222
- Support for derivatives with respect to argument and order
222223

223224
# Contributing

0 commit comments

Comments
 (0)