Skip to content

Commit ff76c3a

Browse files
authored
doc: add missing doc for beta_inc_inv (#467)
* Export function only in SpecialFunctions.jl * doc: add missing doc for `beta_inc_inv` * doc: remove link in title * Update docs/src/functions_overview.md
1 parent dc9ba56 commit ff76c3a

File tree

3 files changed

+20
-6
lines changed

3 files changed

+20
-6
lines changed

docs/src/functions_overview.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,10 @@
22
Here the *Special Functions* are listed according to the structure of [NIST Digital Library of Mathematical Functions](https://dlmf.nist.gov/).
33

44

5-
## [Gamma Function](https://dlmf.nist.gov/5)
5+
## Gamma Function
6+
7+
- [Gamma Function - DLMF](https://dlmf.nist.gov/5)
8+
69
| Function | Description |
710
|:-------- |:----------- |
811
| [`gamma(z)`](@ref SpecialFunctions.gamma(::Number)) | [gamma function](https://en.wikipedia.org/wiki/Gamma_function) ``\Gamma(z)`` |
@@ -16,12 +19,13 @@ Here the *Special Functions* are listed according to the structure of [NIST Digi
1619
| [`gamma(a,z)`](@ref SpecialFunctions.gamma(::Number,::Number)) | [upper incomplete gamma function ``\Gamma(a,z)``](https://en.wikipedia.org/wiki/Incomplete_gamma_function) |
1720
| [`loggamma(a,z)`](@ref SpecialFunctions.loggamma(::Number,::Number)) | accurate `log(gamma(a,x))` for large arguments |
1821
| [`gamma_inc(a,x,IND)`](@ref SpecialFunctions.gamma_inc) | [incomplete gamma function ratio P(a,x) and Q(a,x)](https://en.wikipedia.org/wiki/Incomplete_gamma_function) (i.e evaluates P(a,x) and Q(a,x)for accuracy specified by IND and returns tuple (p,q)) |
19-
| [`beta_inc(a,b,x,y)`](@ref SpecialFunctions.beta_inc) | [incomplete beta function ratio Ix(a,b) and Iy(a,b)](https://en.wikipedia.org/wiki/Beta_function#Incomplete_beta_function) (i.e evaluates Ix(a,b) and Iy(a,b) and returns tuple (p,q)) |
2022
| [`gamma_inc_inv(a,p,q)`](@ref SpecialFunctions.gamma_inc_inv) | [inverse of incomplete gamma function ratio P(a,x) and Q(a,x)](https://en.wikipedia.org/wiki/Incomplete_gamma_function) (i.e evaluates x given P(a,x)=p and Q(a,x)=q |
2123
| [`beta(x,y)`](@ref SpecialFunctions.beta) | [beta function](https://en.wikipedia.org/wiki/Beta_function) at `x,y` |
2224
| [`logbeta(x,y)`](@ref SpecialFunctions.logbeta) | accurate `log(beta(x,y))` for large `x` or `y` |
2325
| [`logabsbeta(x,y)`](@ref SpecialFunctions.logabsbeta) | accurate `log(abs(beta(x,y)))` for large `x` or `y` |
2426
| [`logabsbinomial(x,y)`](@ref SpecialFunctions.logabsbinomial) | accurate `log(abs(binomial(n,k)))` for large `n` and `k` near `n/2` |
27+
| [`beta_inc(a,b,x,y)`](@ref SpecialFunctions.beta_inc) | [incomplete beta function ratio Ix(a,b) and Iy(a,b)](https://en.wikipedia.org/wiki/Beta_function#Incomplete_beta_function) (i.e evaluates Ix(a,b) and Iy(a,b) and returns tuple (p,q)) |
28+
| [`beta_inc_inv(a,b,p,q)`](@ref SpecialFunctions.beta_inc_inv) | Inverse of the incomplete beta function (i.e evaluates x given ``I_{x}(a, b) = p``) |
2529

2630

2731
## [Exponential and Trigonometric Integrals](https://dlmf.nist.gov/6)

src/SpecialFunctions.jl

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -58,14 +58,26 @@ export
5858
logerfcx,
5959
faddeeva,
6060
eta,
61+
62+
# Gamma functions
63+
gamma,
64+
loggamma,
65+
logabsgamma,
66+
logfactorial,
6167
digamma,
6268
invdigamma,
63-
polygamma,
6469
trigamma,
70+
polygamma,
6571
gamma_inc,
72+
gamma_inc_inv,
73+
# beta functions
74+
beta,
75+
logbeta,
76+
logabsbeta,
77+
logabsbinomial,
6678
beta_inc,
6779
beta_inc_inv,
68-
gamma_inc_inv,
80+
6981
ncbeta,
7082
ncF,
7183
hankelh1,

src/gamma.jl

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@
22

33
using Base.MPFR: MPFRRoundingMode, ROUNDING_MODE
44

5-
export gamma, loggamma, logabsgamma, beta, logbeta, logabsbeta, logfactorial, logabsbinomial
6-
75
const ComplexOrReal{T} = Union{T,Complex{T}}
86

97
# Bernoulli numbers B_{2k}, using tabulated numerators and denominators from

0 commit comments

Comments
 (0)