Comments (8)
Yes, that is much more descriptive, thank you.
from reedsolomon.
Thank you for your suggestion. The C module is entirely optional and will always be, and on top it's transpiled from a statically typed python like *.pyx module, hence the description. The pure python version will remain the gold standard, the C implementation is only a bonus for those who want to get some more speed. The documentation already quite clearly specify the existence of the C module, and the fact it is complimentary.
from reedsolomon.
Also for context, all other "Python Reed-Solomon codecs" are actually just wrappers around non-python implementations, so that you can't just edit the Python code, and the Python code is not sufficient (and in fact not doing much of the maths).
Hence, to formalize my thought process, I consider as "Pure-Python" any Python package that does not require external non-Python tools to function. With this definition, which I believe is widely agreed on by other old time pythonistas, the outputs of a Python package do not matter. For example, I don't think anyone regard a Python package that generates DLLs or binaries, such as scripts entry points, as "non pure python". I think this is similar to a transpiled Cythonized extension.
And this definition is not an adhoc post rationalization, I use it for every other Python package I have published so far.
from reedsolomon.
I'm afraid I have to disagree about the common use of "pure Python". At least what I've been taught is that "pure Python" means "no C code involved, so it won't segfault on me" (without getting into the details on how this is actually wrong ;-)).
from reedsolomon.
A word of context to my use of the term: Linux distributions often treat Python packages that don't include any non-Python code as "noarch", i.e. roughly equivalent to "purelib" wheels. On the other hand, packages that do install C extensions need to be built and tested on every architecture separately (i.e. "platlib"). Having "pure Python" in the description here has led me to initially wrongly believe this is the package of the former category.
from reedsolomon.
Thank you for your explanation.
Would the following rewriting of the description be OK?
A pythonic universal errors-and-erasures Reed-Solomon Codec to protect your data from errors and bitrot. It includes a pure python implementation and an optional speed-optimized Cython/C extension.
This is a burst-type implementation, so that it supports any Galois field higher than 2^3, but not binary streams. Burst errors are non-random errors that more often happen on data storage mediums such as hard drives, hence this library is better suited for data storage protection, and less for streams noise correction, although it also works for this purpose but with a bit of overhead (since it works with bytes only, instead of bits).
Based on the wonderful tutorial at Wikiversity, written by "Bobmath" and "LRQ3000". If you are just starting with Reed-Solomon error correction codes, the Wikiversity article is a good beginner's introduction.
from reedsolomon.
Please read the issue on GitHub, I have edited the description I have previously suggested.
from reedsolomon.
Thank you for your feedback and your patience. It's now updated :-) I won't push to PyPi since no code has changed, but it will be pushed with the next bugfix! Have a great day and Merry Christmas!
from reedsolomon.
Related Issues (20)
- The current state of this module HOT 1
- Decoding a message composed of 4-bit words in GF(16) HOT 1
- Missing tag for 1.7.0 HOT 2
- Questions about two different results with the same coding target. HOT 1
- 1.7.0: pep517 is not building DSO `creedsolo` module HOT 10
- Question Possible Systematic Generator Matrix from field generator polynomial? HOT 1
- creedsolo.pyx fails to cythonize on 2.0.5 HOT 30
- 2.0.5: pep517 based build fails HOT 5
- docs: Cython version can not be installed HOT 5
- Encode parity shards HOT 2
- Generated correction symbols do not match those ones of MATLAB HOT 5
- rs_calc_syndromes could not find injected error HOT 1
- build: add automatic unit testing in ci-build github workflow for MicroPython
- How to correct errors with `creedsolo` (`2.1.2b1`)? HOT 3
- Using multiple instances of RSCodec fails
- Cython install/build fails
- Length of (message + ecc) be 255 vs 256? HOT 1
- Predicting RS encoded bytes size HOT 3
- Encoding/Decoding CCSDS (255,223) messages with reedsolomon HOT 10
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from reedsolomon.