Improve type annotations

.pre-commit-config.yaml

@@ -11,4 +11,5 @@ repos:
  rev: v0.4.7
  hooks:
  - id: ruff
+ args: [--fix, --exit-non-zero-on-fix]
  - id: ruff-format

README.md

@@ -33,7 +33,7 @@ The new ufuncs are written in pure Python and [just-in-time compiled](https://nu
 
 ## Features
 
-- Supports all [Galois fields](https://mhostetter.github.io/galois/latest/api/galois.GF/) $\mathrm{GF}(p^m)$, even arbitrarily-large fields!
+- Supports all [Galois fields](https://mhostetter.github.io/galois/latest/api/galois.GF/) $\mathrm{GF}(p^m)$, even arbitrarily large fields!
 - [**Faster**](https://mhostetter.github.io/galois/latest/performance/prime-fields/) than native NumPy! `GF(x) * GF(y)` is faster than `(x * y) % p` for $\mathrm{GF}(p)$.
 - Seamless integration with NumPy -- normal NumPy functions work on [`FieldArray`](https://mhostetter.github.io/galois/latest/api/galois.FieldArray/)s.
 - Linear algebra over finite fields using normal [`np.linalg`](https://mhostetter.github.io/galois/latest/basic-usage/array-arithmetic/#linear-algebra) functions.

docs/basic-usage/array-arithmetic.rst

@@ -292,7 +292,7 @@ Advanced arithmetic
  :collapsible:
 
  The Discrete Fourier Transform (DFT) of size $n$ over the finite field $\mathrm{GF}(p^m)$ exists when
- there exists a primitive $n$-th root of unity. This occurs when $n\ |\ p^m - 1$.
+ there exists a primitive $n$-th root of unity. This occurs when $n \mid p^m - 1$.
 
  .. ipython-with-reprs:: int,poly,power
 
@@ -310,7 +310,7 @@ Advanced arithmetic
  :collapsible:
 
  The inverse Discrete Fourier Transform (DFT) of size $n$ over the finite field $\mathrm{GF}(p^m)$
- exists when there exists a primitive $n$-th root of unity. This occurs when $n\ |\ p^m - 1$.
+ exists when there exists a primitive $n$-th root of unity. This occurs when $n \mid p^m - 1$.
 
  .. ipython-with-reprs:: int,poly,power
 

docs/index.rst

@@ -40,7 +40,7 @@ calculation (for memory savings).
 Features
 --------
 
-- Supports all Galois fields $\mathrm{GF}(p^m)$, even arbitrarily-large fields!
+- Supports all Galois fields $\mathrm{GF}(p^m)$, even arbitrarily large fields!
 - **Faster** than native NumPy! `GF(x) * GF(y)` is faster than `(x * y) % p` for $\mathrm{GF}(p)$.
 - Seamless integration with NumPy -- normal NumPy functions work on :obj:`~galois.FieldArray` instances.
 - Linear algebra over finite fields using normal :obj:`numpy.linalg` functions.

docs/release-notes/v0.0.md

@@ -307,7 +307,7 @@ Poly(1, GF(2))
 - Allow polynomial comparison with integers and field scalars. Now `galois.Poly([0]) == 0` and `galois.Poly([0]) == GF(0)` return `True` rather than raising `TypeError`.
 - Support testing 0-degree polynomials for irreducibility and primitivity.
 - Extend `crt()` to work over non co-prime moduli.
-- Extend `prev_prime()` and `next_prime()` to work over arbitrarily-large inputs.
+- Extend `prev_prime()` and `next_prime()` to work over arbitrarily large inputs.
 - Allow negative integer inputs to `primes()`, `is_prime()`, `is_composite()`, `is_prime_power()`, `is_perfect_power()`, `is_square_free()`, `is_smooth()`, and `is_powersmooth()`.
 - Fix various type hinting errors.
 - Various other bug fixes.
@@ -715,8 +715,8 @@ Poly(1, GF(2))
 - Moved `galois.square_free_factorization()` function into `Poly.square_free_factors()` method. ([#362](https://github.com/mhostetter/galois/pull/362))
 - Moved `galois.distinct_degree_factorization()` function into `Poly.distinct_degree_factors()` method. ([#362](https://github.com/mhostetter/galois/pull/362))
 - Moved `galois.equal_degree_factorization()` function into `Poly.equal_degree_factors()` method. ([#362](https://github.com/mhostetter/galois/pull/362))
-- Moved `galois.is_irreducible()` function into `Poly.is_irreducible()` method. This is a method, not property, to indicate it is a computationally-expensive operation. ([#362](https://github.com/mhostetter/galois/pull/362))
-- Moved `galois.is_primitive()` function into `Poly.is_primitive()` method. This is a method, not property, to indicate it is a computationally-expensive operation. ([#362](https://github.com/mhostetter/galois/pull/362))
+- Moved `galois.is_irreducible()` function into `Poly.is_irreducible()` method. This is a method, not property, to indicate it is a computationally expensive operation. ([#362](https://github.com/mhostetter/galois/pull/362))
+- Moved `galois.is_primitive()` function into `Poly.is_primitive()` method. This is a method, not property, to indicate it is a computationally expensive operation. ([#362](https://github.com/mhostetter/galois/pull/362))
 - Moved `galois.is_monic()` function into `Poly.is_monic` property. ([#362](https://github.com/mhostetter/galois/pull/362))
 
 ### Changes
@@ -742,7 +742,7 @@ Poly(1, GF(2))
 - Added `galois.get_printoptions()` function to return the current package-wide printing options. This is the equivalent of `np.get_printoptions()`. ([#363](https://github.com/mhostetter/galois/pull/363))
 - Added `galois.printoptions()` context manager to modify printing options inside of a `with` statement. This is the equivalent of `np.printoptions()`. ([#363](https://github.com/mhostetter/galois/pull/363))
 - Added a separate `Poly.factors()` method, in addition to the polymorphic `galois.factors()`. ([#362](https://github.com/mhostetter/galois/pull/362))
-- Added a separate `Poly.is_square_free()` method, in addition to the polymorphic `galois.is_square_free()`. This is a method, not property, to indicate it is a computationally-expensive operation. ([#362](https://github.com/mhostetter/galois/pull/362))
+- Added a separate `Poly.is_square_free()` method, in addition to the polymorphic `galois.is_square_free()`. This is a method, not property, to indicate it is a computationally expensive operation. ([#362](https://github.com/mhostetter/galois/pull/362))
 - Fixed a bug (believed to be introduced in v0.0.26) where `Poly.degree` occasionally returned `np.int64` instead of `int`. This could cause overflow in certain large integer operations (e.g., computing $q^m$ when determining if a degree-$m$ polynomial over $\mathrm{GF}(q)$ is irreducible). When the integer overflowed, this created erroneous results. ([#360](https://github.com/mhostetter/galois/issues/360), [#361](https://github.com/mhostetter/galois/pull/361))
 - Increased code coverage.
 
@@ -756,7 +756,7 @@ Poly(1, GF(2))
 
 ### Changes
 
-- Added support for NumPy 1.22 with Numba 0.55.2. This allows users to upgrade NumPy and avoid recently-discovered vulnerabilities [CVE-2021-34141](https://nvd.nist.gov/vuln/detail/CVE-2021-34141), [CVE-2021-41496](https://nvd.nist.gov/vuln/detail/CVE-2021-41496), and [CVE-2021-41495](https://nvd.nist.gov/vuln/detail/CVE-2021-41495). ([#366](https://github.com/mhostetter/galois/pull/366))
+- Added support for NumPy 1.22 with Numba 0.55.2. This allows users to upgrade NumPy and avoid recently discovered vulnerabilities [CVE-2021-34141](https://nvd.nist.gov/vuln/detail/CVE-2021-34141), [CVE-2021-41496](https://nvd.nist.gov/vuln/detail/CVE-2021-41496), and [CVE-2021-41495](https://nvd.nist.gov/vuln/detail/CVE-2021-41495). ([#366](https://github.com/mhostetter/galois/pull/366))
 - Made `FieldArray.repr_table()` more compact. ([#367](https://github.com/mhostetter/galois/pull/367))
  ```ipython
  In [2]: GF = galois.GF(3**3)

docs/release-notes/v0.3.md

@@ -173,7 +173,7 @@ tocdepth: 2
  Poly(x^9 + 3x^2 + 4, GF(7))
  ```
 - Added a database of binary irreducible polynomials with degrees less than 10,000. These polynomials are
- lexicographically-first and have the minimum number of non-zero terms. The database is accessed in
+ lexicographically first and have the minimum number of non-zero terms. The database is accessed in
  `irreducible_poly()` when `terms="min"` and `method="min"`. ([#462](https://github.com/mhostetter/galois/pull/462))
  ```ipython
  In [1]: import galois

pyproject.toml

@@ -118,6 +118,13 @@ ignore = [
 [tool.ruff.lint.per-file-ignores]
 "__init__.py" = ["F401", "F403"]
 
+[tool.mypy]
+plugins = "numpy.typing.mypy_plugin"
+
+[[tool.mypy.overrides]]
+module = ["numba.*"]
+ignore_missing_imports = true
+
 [tool.pytest.ini_options]
 minversion = "6.2"
 addopts = "-s --showlocals"