Skip to content

Commit 20fdc11

Browse files
committed
add NEWS file
1 parent 1f48ef0 commit 20fdc11

File tree

2 files changed

+31
-4
lines changed

2 files changed

+31
-4
lines changed

NEWS.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Changelog
2+
All notable changes to this project will be documented in this file.
3+
4+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
5+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
6+
7+
For pre-1.0.0 releases we will increment the minor version when we export any new functions or alter exported API.
8+
For bug fixes, performance enhancements, or fixes to unexported functions we will increment the patch version.
9+
**Note**: The exported API can be considered very stable and likely will not change without serious consideration.
10+
11+
# Unreleased
12+
13+
### Added
14+
- add an unexport method (`Bessels.besseljy(nu, x)`) for faster computation of `besselj` and `bessely` (#33)
15+
- add exported methods for Hankel functions `besselh(nu, k, x)`, `hankelh1(nu, x)`, `hankelh2(nu, x)` (#33)
16+
17+
### Fixed
18+
- fix cutoff in `bessely` to not return error for integer orders and small arguments (#33)
19+
20+
# Version 0.1.0
21+
22+
Initial release of Bessels.jl
23+
24+
### Added
25+
26+
- support bessel functions (`besselj`, `bessely`, `besseli`, `besselk`) for real arguments
27+
- provide a gamma function (`Bessels.gamma`) for real arguments

src/hankel.jl

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,10 @@
55
#
66
# A numerical routine to compute both Bessel functions of the first J_{ν}(x) and second kind Y_{ν}(x)
77
# for real orders and arguments of positive or negative value. Please see notes in src/besselj.jl and src/bessely.jl
8-
# for notes on implementation details as most of the routine is similar. A key difference is when the methods to compute bessely
9-
# don't also give besselj, we rely on a continued fraction approach to compute J_{ν}(x)/J_{ν-1}(x) to get J_{ν}(x) [1].
10-
# The continued fraction approach is in general quickly converging when nu and x are small in magnitude.
11-
# When x and nu are large and nu > x we fall back to computing J_{ν}(x) and Y_{ν}(x) separately as this was found to be more efficient.
8+
# for details on implementation as most of the routine is similar. A key difference is when the methods to compute bessely
9+
# don't also give besselj. We then rely on a continued fraction approach to compute J_{ν}(x)/J_{ν-1}(x) to get J_{ν}(x)
10+
# from Y_{ν}(x) and Y_{ν-1}(x)[1]. The continued fraction approach is more quickly converging when nu and x are small in magnitude.
11+
# When x and nu are large and nu = x + ϵ, we fall back to computing J_{ν}(x) and Y_{ν}(x) separately as this was found to be more efficient.
1212
#
1313
# [1] Ratis, Yu L., and P. Fernández de Córdoba. "A code to calculate (high order) Bessel functions based on the continued fractions method."
1414
# Computer physics communications 76.3 (1993): 381-388.

0 commit comments

Comments
 (0)