New interface for belief propagation decoder

[krishna-praneet]

• Added Structs for BPSetup, BPDecoder, BPDecoderSparse
• Added Methods for decode! and batchdecode!
• Added Tests for above methods
• Updated README.md, gitignore, project.toml

If you want to submit an unfinished piece of work in order to get comments and discuss, please mark the pull request as a draft and ping the repository maintainer

Before considering your pull request ready for review and merging make sure that all of the below are completed:

• The code is properly formatted and commented.
• Substantial new functionality is documented within the docs.
• All new functionality is tested.
• All changes and new functionality are marked in the CHANGELOG file.

[Krastanov]

Thanks for taking care of this! It is a great start!

[krishna-praneet]

Thank you Stefan! I will ping you after the doing the updates.

[krishna-praneet]

@Krastanov I have pushed the suggested changes

[Krastanov]

Could you also add a doctest runner? Here is an example:

https://github.com/QuantumSavory/BPGates.jl/blob/main/test/test_doctests.jl

[Krastanov]

And could you click "resolve" on comments of mine above that you have already dealt with. It helps me when I get back to this PR after looking at something else.

[codecov]

Welcome to Codecov 🎉

Once you merge this PR into your default branch, you're all set! Codecov will compare coverage reports and display results in all future pull requests.

Thanks for integrating Codecov - We've got you covered ☂️

[Krastanov]

Check out the last commit I added here. It brings over a bunch more CI tooling. I added the static analysis tools JET.jl and Aqua.jl

Could you look into the spelling CI and the jet=true CI ?

In particular, JET is reporting the following:

┌ row_echelon(matrix::Any) @ LDPCDecoders /home/runner/work/LDPCDecoders.jl/LDPCDecoders.jl/src/util.jl:10
│┌ row_echelon(matrix::Any, full::Bool) @ LDPCDecoders /home/runner/work/LDPCDecoders.jl/LDPCDecoders.jl/src/util.jl:22
││ `LDPCDecoders.transform_matrix` is not defined: LDPCDecoders.transform_matrix
│└────────────────────
│┌ row_echelon(matrix::Any, full::Bool) @ LDPCDecoders /home/runner/work/LDPCDecoders.jl/LDPCDecoders.jl/src/util.jl:28
││ `LDPCDecoders.not` is not defined: goto %115 if not LDPCDecoders.not
│└────────────────────
│┌ row_echelon(matrix::Any, full::Bool) @ LDPCDecoders /home/runner/work/LDPCDecoders.jl/LDPCDecoders.jl/src/util.jl:55
││ `LDPCDecoders.transform_matrix` is not defined: Base.vect(row_esch_matrix, matrix_rank, LDPCDecoders.transform_matrix, LDPCDecoders.pivot_cols)
│└────────────────────