Skip to content

Commit

Permalink
modified: docs/src/Distributions.md
Browse files Browse the repository at this point in the history
	modified:   docs/src/index.md
	modified:   src/continuous/Alpha.jl
	modified:   src/discrete/ZIB.jl
	modified:   src/discrete/ZINB.jl
	modified:   src/discrete/ZIP.jl
	modified:   src/discrete/Zeta.jl
	modified:   src/discrete/Zipf.jl
  • Loading branch information
Santymax98 committed Aug 4, 2024
1 parent 450c5b8 commit 24e0302
Show file tree
Hide file tree
Showing 8 changed files with 16 additions and 10 deletions.
8 changes: 4 additions & 4 deletions docs/src/Distributions.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,19 +58,19 @@ plotdensity((0.0, 1.0), Argus, (1, 1)) # hide
Benini
```
```@example plotdensity
plotdensity((0.0, 1.0), Benini, (1, 1, 1)) # hide
plotdensity((1.0, 2.0), Benini, (1, 1, 1)) # hide
```
```@docs
Benktander_Type1
```
```@example plotdensity
plotdensity((0.0, 1.0), Benktander_Type1, (1, 1)) # hide
plotdensity((1.0, 2.0), Benktander_Type1, (1, 1)) # hide
```
```@docs
Benktander_Type2
```
```@example plotdensity
plotdensity((0.0, 1.0), Benktander_Type2, (1, 1)) # hide
plotdensity((1.0, 2.0), Benktander_Type2, (1, 1)) # hide
```
```@docs
Bhattacharjee
Expand Down Expand Up @@ -130,7 +130,7 @@ plotdensity((0.0, 1.0), Maxwell, (1,)) # hide
Nakagami
```
```@example plotdensity
plotdensity((-1.0, 1.0), Nakagami, (0.5, 1.0)) # hide
plotdensity((0.0, 1.0), Nakagami, (0.5, 1.0)) # hide
```
```@docs
PERT
Expand Down
4 changes: 2 additions & 2 deletions docs/src/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Welcome to ExtraDist
# Welcome to ExtraDistributions.jl

The [*ExtraDistributions*](https://github.com/Santymax98/ExtraDistributions.jl) package is a comprehensive extension of [*Distributions.jl*](https://github.com/JuliaStats/Distributions.jl), designed to expand its functionality by incorporating both discrete and continuous probability distributions not available in the base package. *ExtraDist* aims to enhance the breadth of statistical tools available for data analysis, simulation, and probabilistic modeling.
The [*ExtraDistributions.jl*](https://github.com/Santymax98/ExtraDistributions.jl) package is a comprehensive extension of [*Distributions.jl*](https://github.com/JuliaStats/Distributions.jl), designed to expand its functionality by incorporating both discrete and continuous probability distributions not available in the base package. *ExtraDist* aims to enhance the breadth of statistical tools available for data analysis, simulation, and probabilistic modeling.

With *ExtraDistributions*, you can:

Expand Down
6 changes: 3 additions & 3 deletions src/continuous/Alpha.jl
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ f(x; \\alpha, \\beta) = \\frac{\\beta}{\\sqrt{2\\pi} \\Phi(\\alpha) x^2} \\exp\\
```
where:
- \\alpha is a location parameter
- \\beta is a scale parameter
- \\Phi is the cumulative distribution function (CDF) of the standard normal distribution.
- ``\\alpha`` is a location parameter
- ``\\beta`` is a scale parameter
- ``\\Phi`` is the cumulative distribution function (CDF) of the standard normal distribution.
```julia
Alpha() # equivalent to Alpha(1, 1)
Expand Down
2 changes: 2 additions & 0 deletions src/discrete/ZIB.jl
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ ZIB(n) # equivalent to ZIB(n, 0.5, 0.5)
ZIB(n, θ) # equivalent to ZIB(n, θ, 0.5)
params(d) # Get the parameters, i.e. (n, θ, p)
```
"""
struct ZIB{T<:Real} <: Distributions.DiscreteUnivariateDistribution
n::Int
Expand Down
2 changes: 2 additions & 0 deletions src/discrete/ZINB.jl
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ ZINB(r) # equivalent to ZINB(r, 0.5, 0.5)
ZINB(r, θ) # equivalent to ZINB(r, θ, 0.5)
params(d) # Get the parameters, i.e. (r, θ, p)
```
"""
struct ZINB{T<:Real} <: Distributions.DiscreteUnivariateDistribution
r::Int
Expand Down
1 change: 1 addition & 0 deletions src/discrete/ZIP.jl
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ ZIP() # equivalent to ZIP(1, 0.5)
ZIP(λ) # equivalent to ZIP(λ, 0.5)
params(d) # Get the parameters, i.e. (λ, p)
```
External link:
Expand Down
2 changes: 1 addition & 1 deletion src/discrete/Zeta.jl
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Where ``\\zeta`` is a Riemann Function
Zeta() # equivalent to Zeta(1)
params(d) # Get the parameters, i.e. s
```
External link:
*[Zeta Distribution on Wikipedia](https://en.wikipedia.org/wiki/Zeta_distribution)
Expand Down
1 change: 1 addition & 0 deletions src/discrete/Zipf.jl
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ Zipf() # equivalent to BetaNegBinomial(1, 1)
Zipf(N) # equivalent to BetaNegBinomial(N, 1)
params(d) # Get the parameters, i.e. (N, s)
```
External link:
Expand Down

0 comments on commit 24e0302

Please sign in to comment.