galois v0.0.31

Released July 24, 2022

Breaking changes

• Renamed FieldArray.Elements() classmethod to FieldArray.elements class property. This naming convention is more consistent with primitive_elements, units, quadratic_residues, and quadratic_non_residues. (#373)

  >>> GF = galois.GF(3**2, display="poly")
  >>> GF.elements
  GF([     0,      1,      2,      α,  α + 1,  α + 2,     2α, 2α + 1,
      2α + 2], order=3^2)

• Renamed BCH.systematic to BCH.is_systematic. (#376)
• Renamed ReedSolomon.systematic to ReedSolomon.is_systematic. (#376)

Changes

• Added support for polynomial composition in Poly.__call__(). (#377)

  >>> GF = galois.GF(3**5)
  >>> f = galois.Poly([37, 123, 0, 201], field=GF); f
  Poly(37x^3 + 123x^2 + 201, GF(3^5))
  >>> g = galois.Poly([55, 0, 1], field=GF); g
  Poly(55x^2 + 1, GF(3^5))
  >>> f(g)
  Poly(77x^6 + 5x^4 + 104x^2 + 1, GF(3^5))

• Added FieldArray.units class property. (#373)

  >>> GF = galois.GF(3**2, display="poly")
  >>> GF.units
  GF([     1,      2,      α,  α + 1,  α + 2,     2α, 2α + 1, 2α + 2],
     order=3^2)

Documentation

• Reworked API reference using Sphinx Immaterial's python-apigen. (#370)
• Shortened website URLs to use directories. https://galois.readthedocs.io/en/v0.0.30/getting-started.html is converted to https://galois.readthedocs.io/en/v0.0.31/getting-started/. (#370)

Contributors

• Matt Hostetter (@mhostetter)

Commits

d50f88b Version bump to 0.0.31
5a3b484 Add release notes for v0.0.31
4df5d7b Move primitive element functions into _fields/ folder
23337ad Clean up math equations
373a246 Remove math notation from individual numbers
4619383 Include rubrics in docstring in the local TOC
cb25b40 Update hyperlinks to use the new dirhtml style
e6acdfd Add polynomial composition unit test
30aa67e Add support for polynomial composition
0e63b7c Clarify type hint for primitive_element in GF()
5cf9161 Make poly evaluation at a matrix a private function
8d7a8b8 Make operand verification private functions
2f667d8 Make _convert_coeffs a private function
8613f22 Make _root_multiplicity a private function
371d7b1 Rename systematic property to is_systematic
e8f58ce Modify Sphinx Immaterial linkable parameter coloring
cae910d Indicate in docs that the dirhtml builder is used
2b2e5bf Fix search in dirhtml docs builds
eacf60f Add units and quadratic_residues to Array Creation page
9a4366c Remove OBE note on GF2 docstring
9a7ccb9 Add FieldArray.units class property
31ad02b Move FieldArray.Elements() to the FieldArray.elements property
1306f91 Make class property monkey patching for docs more algorithmic
f34038f Remove unnecessary autosummary templates
7a50cc1 Do not use "Tests" sections in classes
dd9476f Add note about polymorphic polynomial functions
9fc2b29 Clean up vector space method docstrings
d9f6fdb Remove unnecessary private methods from FieldArray
649bd10 Add basic docstrings to Array class properties
4635f81 Suppress private base classes from class documentation
ffee1bd Remove pandoc from CI docs build
ecefd5f Remove need for explicit forward references
4a5381c Use Sphinx Immaterial's conversion of type annotations
ce1bdde Use the Sphinx dirhtml builder for cleaner URLs
a0133d3 Use Sphinx Immaterial's python-apigen for API Reference