-
-
Notifications
You must be signed in to change notification settings - Fork 5.5k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Unclear docstring for airyx #17032
Comments
cc @simonbyrne or @stevengj might be the most knowledgeable here |
Actually also the docstring of |
Yeah that looks right at first glance in the source code. Can we rename these horrible functions? It looks like the Fortran interface was copied a little too literally (or is it Matlab's fault?)—I'd rather just define eight functions in Julia (for Ai, Ai', Bi, Bi', and the scaled versions) rather than pass these obscure integer arguments. The scaling is defined by the |
These should be moved to a special functions package where they can be named more idiomatically. |
Actually I like about Julia that you don't have to install and load an external package in order to use common special functions. |
Sorry, that's going to change, there's zero technical reason for them to be here and tied to the development schedule of the base language. |
This rearranges the different airy functions, deprecating `airy`, `airyx` and `airyprime` in favour of the more specific variants (`airyai`, `airyaiprime`, etc.), and clarifies the docs of each remaining function. Fixes #17032.
This rearranges the different airy functions, deprecating `airy`, `airyx` and `airyprime` in favour of the more specific variants (`airyai`, `airyaiprime`, etc.), and clarifies the docs of each remaining function. Fixes #17032.
This rearranges the different airy functions, deprecating `airy`, `airyx` and `airyprime` in favour of the more specific variants (`airyai`, `airyaiprime`, etc.), and clarifies the docs of each remaining function. Fixes #17032.
This rearranges the different airy functions, deprecating `airy`, `airyx` and `airyprime` in favour of the more specific variants (`airyai`, `airyaiprime`, etc.), and clarifies the docs of each remaining function. Fixes #17032.
This rearranges the different airy functions, deprecating `airy`, `airyx` and `airyprime` in favour of the more specific variants (`airyai`, `airyaiprime`, etc.), and clarifies the docs of each remaining function. Fixes #17032.
The docstring of
airyx
function reads:This is at best unclear, if not misleading.
airyx(2, x)
isn't the scaled second derivative of Airy Ai function, but rather the scaled Airy Bi function, likeairyx(3, x)
isn't the scaled third derivative of Airy Ai.In addition, how is the scaling factor computed? For negative real values of
x
it should be complex according to the docstring (at least in the casek == 0 || k ==1
), butairyx(0, -1.23)
is real. GSL uses 1 as scaling factor for negative realx
, but this isn't the case for Julia'sairyx
, becauseairyx(0, -1.23) != airy(0, -1.23)
.The text was updated successfully, but these errors were encountered: