Skip to content

Commit

Permalink
start upgrading docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
michael-petersen committed Jan 17, 2025
1 parent a802d8c commit 4c36461
Showing 1 changed file with 18 additions and 4 deletions.
22 changes: 18 additions & 4 deletions src/CB73.jl
Original file line number Diff line number Diff line change
Expand Up @@ -161,11 +161,25 @@ function _rhoCB73(x::Float64)
return (x^(2) - 1.0)/(x^(2) + 1.0) # Value of rho
end

"""
_ClnCB73(alpha, n, rho)
Definition of the Gegenbauer polynomials.
This function computes the Gegenbauer polynomial coefficients using an upward recurrence method.
## Arguments
- `alpha::Float64`: The alpha parameter of the Gegenbauer polynomial.
- `n::Int64`: The order of the Gegenbauer polynomial.
- `rho::Float64`: The value at which to evaluate the Gegenbauer polynomial.
## Returns
- `v::Float64`: The value of the Gegenbauer polynomial at `rho` and order `n`.
## Notes
- The coefficients are computed through an upward recurrence.
- The initial values for `n=0` and `n=1` are pre-defined.
- The recurrence relation is applied iteratively until the desired order `n` is reached.
"""_ClnCB73(alpha,n,rho)
Definition of the Gegenbauer polynomials
These coefficients are computed through an upward recurrence
@IMPROVE compute all the basis elements (n)_{1<=n<=nradial} at once
"""
function _ClnCB73(alpha::Float64,n::Int64,rho::Float64)

Expand Down

0 comments on commit 4c36461

Please sign in to comment.