hichamjanati / pyldpc

Creation of LDPC codes & simulation of coding and decoding binary data. Applications to sound and image files.
BSD 3-Clause "New" or "Revised" License
121 stars 34 forks source link

Clean up old docstrings + 10x faster decoding with numba #6

Closed hichamjanati closed 4 years ago

hichamjanati commented 4 years ago

This PR cleans up some old docstrings and implements the BP algorithm in numba for a major 10x speed gain.

codecov[bot] commented 4 years ago

Codecov Report

Merging #6 into master will increase coverage by 1.23%. The diff coverage is 91.89%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master       #6      +/-   ##
==========================================
+ Coverage   87.41%   88.65%   +1.23%     
==========================================
  Files          14       14              
  Lines         763      670      -93     
  Branches      136      119      -17     
==========================================
- Hits          667      594      -73     
+ Misses         45       43       -2     
+ Partials       51       33      -18
Impacted Files Coverage Δ
pyldpc/utils_audio.py 89.47% <ø> (ø) :arrow_up:
pyldpc/utils.py 82.17% <100%> (-3.69%) :arrow_down:
pyldpc/utils_img.py 90% <100%> (-1.84%) :arrow_down:
pyldpc/tests/test_image.py 100% <100%> (ø) :arrow_up:
pyldpc/tests/test_decoding.py 100% <100%> (ø) :arrow_up:
pyldpc/tests/test_code.py 100% <100%> (ø) :arrow_up:
pyldpc/encoder.py 100% <100%> (ø) :arrow_up:
pyldpc/tests/test_audio.py 100% <100%> (ø) :arrow_up:
pyldpc/ldpc_audio.py 87.5% <100%> (-0.5%) :arrow_down:
pyldpc/decoder.py 88.23% <85.39%> (+6.25%) :arrow_up:
... and 3 more

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 10c68d2...8e27fe8. Read the comment docs.