Skip to content

Commit

Permalink
Fix argument order in clebschgordan docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
Jutho committed Nov 10, 2017
1 parent dd75309 commit 9350aae
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Now that it is register, install via `Pkg.add("WignerSymbols")`.
While the following function signatures are probably self-explanatory, you can query help for them in the Julia REPL to get further details.
* `wigner3j(T::Type{<:AbstractFloat} = Float64, j₁, j₂, j₃, m₁, m₂, m₃ = -m₂-m₁) -> ::T`
* `wigner6j(T::Type{<:AbstractFloat} = Float64, j₁, j₂, j₃, j₄, j₅, j₆) -> ::T`
* `clebschgordan(T::Type{<:AbstractFloat} = Float64, j₁, j₂, j, m₁, m₂, m₃ = m₁+m₂) -> ::T`
* `clebschgordan(T::Type{<:AbstractFloat} = Float64, j₁, m₁, j, m₂, j₃, m₃ = m₁+m₂) -> ::T`
* `racahV(T::Type{<:AbstractFloat} = Float64, j₁, j₂, j₃, m₁, m₂, m₃ = -m₁-m₂) -> ::T`
* `racahW(T::Type{<:AbstractFloat} = Float64, j₁, j₂, J, j₃, J₁₂, J₂₃) -> ::T`
* `δ(j₁, j₂, j₃) -> ::Bool`
Expand Down
4 changes: 2 additions & 2 deletions src/WignerSymbols.jl
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ wigner3j(j₁, j₂, j₃, m₁, m₂, m₃ = -m₁-m₂) = wigner3j(Float64, j
function wigner3j(T::Type{<:AbstractFloat}, j₁, j₂, j₃, m₁, m₂, m₃ = -m₁-m₂)
# check angular momenta
for (jᵢ,mᵢ) in ((j₁, m₁), (j₂, m₂), (j₃, m₃))
ϵ(jᵢ, mᵢ) || throw(DomainError("invalid (jᵢ, mᵢ)", (jᵢ, mᵢ) ))
ϵ(jᵢ, mᵢ) || throw(DomainError((jᵢ, mᵢ), "invalid combination (jᵢ, mᵢ)"))
end
# check triangle condition and m₁+m₂+m₃ == 0
if !δ(j₁, j₂, j₃) || !iszero(m₁+m₂+m₃)
Expand Down Expand Up @@ -111,7 +111,7 @@ function wigner3j(T::Type{<:AbstractFloat}, j₁, j₂, j₃, m₁, m₂, m₃ =
end

"""
clebschgordan(T::Type{<:AbstractFloat} = Float64, j₁, j₂, j, m₁, m₂, m₃ = m₁+m₂) -> ::T
clebschgordan(T::Type{<:AbstractFloat} = Float64, j₁, m₁, j, m₂, j₃, m₃ = m₁+m₂) -> ::T
Compute the value of the Clebsch-Gordan coefficient <j₁, m₁; j₂, m₂ | j₃, m₃ >
as a type `T` floating point number. By default, `T = Float64` and `m₃ = m₁+m₂`.
Expand Down

0 comments on commit 9350aae

Please sign in to comment.