Skip to content

Commit

Permalink
Add release notes for v0.0.19
Browse files Browse the repository at this point in the history
  • Loading branch information
mhostetter committed Aug 9, 2021
1 parent def6a4d commit bd4ab58
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions docs/release-notes.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,31 @@
# Release Notes

## 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)

## v0.0.18

### Breaking Changes

0 comments on commit bd4ab58

Please sign in to comment.