Komm

Added

- Implemented [Shannon](https://komm.dev/ref/ShannonCode) and [Fano](https://komm.dev/ref/FanoCode) codes.
- Implemented method to compute the [Kraft parameter](https://komm.dev/ref/FixedToVariableCode#kraft_parameter) of a fixed-to-variable code.

Fixed

- Fixed `parse_prefix_free` when `allow_incomplete=True`.

Fixed

- Fixed Sardinas–Patterson algorithm.
- Encoding and decoding of [variable-to-fixed codes](https://komm.dev/ref/VariableToFixedCode) now require the code to be [fully covering](https://komm.dev/ref/VariableToFixedCode#is_fully_covering).

Breaking changes

- Removed `primitive_element` method from `FiniteField` class, since the implementation was incorrect. The method was assuming that the modulus was always primitive (which may not be true).

Added

- Added polynomial [irreducibility](https://komm.dev/ref/BinaryPolynomial#is_irreducible) and [primitivity](https://komm.dev/ref/BinaryPolynomial#is_primitive) tests for binary polynomials.

- Restored sequence support in block code and decoders methods.

- Block code methods `encode`, `inverse_encode`, `check`, and block decoders `__call__` now accept sequences spanning multiple blocks (as before v0.13.0) as well as multidimensional arrays.

- Added support for multidimensional input in modulation, demodulation, and channel methods.

Breaking changes

- Removed `BlockEncoder` and `BlockDecoder` classes in favor of direct methods and specialized decoder classes.

- Block code methods are now called directly: `code.encode(u)`, `code.inverse_encode(v)`, and `code.check(r)` (previously `enc_mapping`, `inv_enc_mapping`, and `chk_mapping`). These methods are now vetorized (i.e., support input arrays of any shape). For example, for a code with dimension $k = 2$, instead of `encoder = BlockEncoder(code); encoder([0, 1, 0, 1])`, use `code.encode([[0, 1], [0, 1]])`.
- Decoder methods are now individual classes: `BCJRDecoder`, `BerlekampDecoder`, `ExhaustiveSearchDecoder`, `ReedDecoder`, `SyndromeTableDecoder`, `ViterbiDecoder`, and `WagnerDecoder`. For example, instead of `decoder = komm.BlockDecoder(code, method="exhaustive-search-hard")`, use `decoder = komm.ExhaustiveSearchDecoder(code, input_type="hard")`. The decoder `__call__` are now vectorized (i.e., support input arrays of any shape). For example, for a code with length $n = 3$, instead of `decoder([0, 1, 0, 1, 1, 0])`, use `decoder([[0, 1, 0], [1, 1, 0]])`.
- The decoders `majority-logic-repetition-code` and `meggitt` were removed for now.

- Renamed `ConvolutionalStreamDecoder` to `ViterbiStreamDecoder`.

- Merged lossless source coding encoders/decoders into code classes.

- Removed `FixedToVariableEncoder`, `FixedToVariableDecoder`, `VariableToFixedEncoder`, `VariableToFixedDecoder`. For example, instead of `encoder = FixedToVariableEncoder(code); output = encoder(input)`, use `output = code.encode(input)`.

Added

- Implemented [Marcum Q-function](https://komm.dev/ref/marcum_q).

Breaking changes

- Renamed `int2binlist` to `int_to_bits`, `binlist2int` to `bits_to_int`, `qfunc` to `gaussian_q`, `qfuncinv` to `gaussian_q_inv`, `acorr` to `autocorrelation`, and `cyclic_acorr` to `cyclic_autocorrelation`, for consistency with other functions.
- Removed `pack` and `unpack` functions from `komm` module. Instead of `komm.pack(arr, width)`, use `komm.bits_to_int(arr.reshape(-1, width))`; and instead of `komm.unpack(arr, width)`, use `komm.int_to_bits(arr, width).ravel()`.