search

jmert / AssociatedLegendrePolynomials.jl

A library for calculating the Associated Legendre polynomials
https://jmert.github.io/AssociatedLegendrePolynomials.jl/
MIT License
20 stars 2 forks source link

Make math documentation more clear #5

Closed jmert closed 4 years ago

jmert commented 4 years ago

...and update the code to match.

The changes primarily revolve around two changes in notation/convention:

  1. Write all functions in terms of their degree ℓ. Previously, the two 1-term recurrence relations were written in terms of the order m.
  2. Reindex the documentation so that the recurrence relations are defined in terms of degree ℓ instead of ℓ+1 on the left-hand side.

This is another breaking change since the implicit definition of the Plm_ν function changed so that values should be calculated based on ℓ instead of m.

codecov[bot] commented 4 years ago

Codecov Report

Merging #5 into master will not change coverage. The diff coverage is 100.00%.

Impacted file tree graph

@@           Coverage Diff           @@
##           master       #5   +/-   ##
=======================================
  Coverage   97.61%   97.61%           
=======================================
  Files           9        9           
  Lines         252      252           
=======================================
  Hits          246      246           
  Misses          6        6
Impacted Files Coverage Δ
src/interface.jl 66.66% <ø> (ø)
src/calculation.jl 97.58% <100.00%> (ø)
src/norm_sphere.jl 100.00% <100.00%> (ø)
src/norm_table.jl 94.28% <100.00%> (ø)
src/norm_unit.jl 100.00% <100.00%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 2412b61...1a9a943. Read the comment docs.