galois v0.0.19

Breaking Changes

• Remove unnecessary is_field() function. Use isinstance(x, galois.FieldClass) or isinstance(x, galois.FieldArray) instead.
• Remove log_naive() function. Might be re-added later through np.log() on a multiplicative group array.
• Rename mode kwarg in galois.GF() to compile.
• Revert np.copy() override that always returns a subclass. Now, by default it does not return a sublcass. To return a Galois field array, use x.copy() or np.copy(x, subok=True) instead.

Changes

• Improve documentation.
• Improve unit test coverage.
• Add benchmarking tests.
• Add initial LFSR implementation.
• Add display kwarg to galois.GF() class factory to set the display mode at class-creation time.
• Add Poly.reverse() method.
• Allow polynomial strings as input to galois.GF(). For example, galois.GF(2**4, irreducible_poly="x^4 + x + 1").
• Enable np.divmod() and np.remainder() on Galois field arrays. The remainder is always zero, though.
• Fix bug in bch_valid_codes() where repetition codes weren't included.
• Various minor bug fixes.

Contributors

• Matt Hostetter (@mhostetter)

Commits

84806de Version bump to 0.0.19
bd4ab58 Add release notes for v0.0.19
def6a4d Increase LFSR code coverage
3f25531 Increase prime functions' code coverage
0e615d8 Rework unit testing of prime factorization
ec2b862 Reconfigure format of test vector LUTs
39c81e2 Rework unit testing of polynomial derivatives
5549e83 Rework unit testing of computing polynomial roots
cea9c68 Fix error in Poly docstring of optional field kwarg
6e556e9 Fix ipython syntax highlighting in sphinx .md files
e51d9e4 Remove is_field() function
ce3f36b Add BCH repetition codes in bch_valid_codes()
d764b4b Use latest docs badge in README
1c1be4c Add features section to docs
660f566 Add versioning section to docs
731e3a4 Add acknowledgements section to docs
960fb02 Add citation style
627b489 Add GitHub social media logo
62d687f Increase logo resolution
a19bde7 Remove nbsphinx docs dependency
489244a Make TOC in README have only one level
69a2b4d Update basic usage examples
882fc27 Allow polynomial strings as input to galois.GF()
ce17e4a Rework unit testing of FEC codes
f1a7c73 Fix literal file includes in docs
a9cd379 Add first version of project logo
24477b0 Disable code coverage on JIT-compiled functions
4c2ce95 Rework unit testing of Galois field class factory function
f1ba17d Use polynomial indeterminate "x" for repr_table()
772d95e Don't update ufunc mode of a Galois field class with defaults
bb1fdc6 Don't update display mode of a Galois field class with defaults
d9fc631 Rework unit testing of number theoretic functions
11532ad Rework unit testing of polynomial factorization
6237b19 Add downloads badge to README
bec80bc Rework unit testing of poly_pow()
a19dfb6 Rework unit testing of polynomial GCDs
3cb9d27 Rework testing primitive elements
b354f58 Rework testing minimal polynomials
1179dcd Update irreducible and primitive poly unit tests
b6d8927 Fix docstring formatting issues for the display() method
2f82555 Hide "Constructor" and "Special Methods" section if they are empty
275f208 Add docstrings to arithmetic dunder methods and include in API reference
b50e6ad Refer GF2 docs to FieldArray
78d08b4 Support np.divmod() and np.remainder() ufuncs for Galois field arrays
c995199 Remove log_naive() function
95445fb Change syntax highlighting style in docs
c65b971 Fix typos in tutorials
cc72ffa Re-order functions in API reference
e6db491 Clean-up docstrings across the library
cef5016 Do not allow non-iterable coeffs to Poly constructor
41b59e5 Ensure copies of LFSR states are returned, not a reference
96a6f74 Ensure single-step LFSR outputs are 0-D arrays
fd6b056 Add hyperlinks to API reference in features section of README
0c89fac Re-arrange API order
24b95cd Clean-up raised exceptions
29e1895 Clean-up docstrings for Galois field array classes
4af4c36 Add display kwarg to GF() class factory
e7a17ca Rename mode kwarg to compile
84b583a Optionally specify x and y values for arithmetic tables
36377e0 Add sorting of rows in repr_table()
798fa2d Add irreducible poly and primitve element to properties of prime fields
c3efa00 In properties string, represent the primitive element as a polynomial
7edc23b Use primes() instead of PRIMES throughout the library
aadbee1 Move developer installation notes to "Installation" page
7ad6c9c Cache output from primes() function
23e05d9 Cleanup polynomial class property references
b267a42 Add reverse() method to polynomials
9a3a88c Add more detail in the LFSR notes section
fb5f108 Add Galois LFSR unit tests
6a53d37 Add Berlekamp-Massey algorithm example in docstring
0d05605 Add Berlekamp-Massey algorithm unit tests
8254a2c Add initial LFSR implementation
1cc5c35 Add protected-access to pylint ignore
cc6fd29 Remove cryptographic ciphers from roadmap
d165351 Revert np.copy() view casting override
6de731d Fix hyperlinks in README
a7c87aa Fix basic usage not being included in generated docs
40cc8d1 Ensure polynomial coefficients can't be modified
4e8204b Make arithmetic_table() use the current display_mode
c32ba4a Add examples to Reed-Solomon properties
cdda540 Add examples to BCH properties
973b3f9 Fix ASCII table border characters
08cb5bb Hide source links in sphinx docs
8e836c4 Add benchmarking info to documentation
2fb7239 Add .benchmarks/ to gitignore
cd9617f Add FEC benchmarking
a1b962c Add Galois field array benchmark tests