Upgrade to Sphinx v7

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

docs/requirements.txt

@@ -1,10 +1,10 @@
-sphinx < 7.3
-sphinx-immaterial == 0.11.11
+sphinx == 7.3.7
+sphinx-immaterial == 0.11.14
 # For some reason, if the below versions aren't specified, the dependency resolution takes 18 minutes in CI.
-myst-parser == 0.18.1
-sphinx-design  == 0.5.0
-sphinx-last-updated-by-git == 0.3.6
+myst-parser == 3.0.1
+sphinx-design  == 0.6.0
+sphinx-last-updated-by-git == 0.3.7
 sphinx-math-dollar == 1.2.1
-ipykernel == 6.26.0
-myst-nb == 0.17.2
+ipykernel == 6.29.5
+myst-nb == 1.1.1
 pickleshare == 0.7.5  # Needed by ipykernel

src/galois/_codes/_linear.py

@@ -383,11 +383,11 @@ def generator_to_parity_check_matrix(G: FieldArray) -> FieldArray:
 
     Arguments:
         G: The $(k, n)$ generator matrix $\mathbf{G}$ in systematic form
-            $\mathbf{G} = [\mathbf{I}_{k,k}\ |\ \mathbf{P}_{k,n-k}]$.
+            $\mathbf{G} = [\mathbf{I}_{k,k} \mid \mathbf{P}_{k,n-k}]$.
 
     Returns:
         The $(n-k, n)$ parity-check matrix
-        $\mathbf{H} = [-\mathbf{P}_{k,n-k}^T\ |\ \mathbf{I}_{n-k,n-k}]$`.
+        $\mathbf{H} = [-\mathbf{P}_{k,n-k}^T \mid \mathbf{I}_{n-k,n-k}]$`.
 
     Examples:
         .. ipython:: python
@@ -423,10 +423,10 @@ def parity_check_to_generator_matrix(H: FieldArray) -> FieldArray:
 
     Arguments:
         H: The $(n-k, n)$ parity-check matrix $\mathbf{G}$ in systematic form
-            $\mathbf{H} = [-\mathbf{P}_{k,n-k}^T\ |\ \mathbf{I}_{n-k,n-k}]$`.
+            $\mathbf{H} = [-\mathbf{P}_{k,n-k}^T \mid \mathbf{I}_{n-k,n-k}]$`.
 
     Returns:
-        The $(k, n)$ generator matrix $\mathbf{G} = [\mathbf{I}_{k,k}\ |\ \mathbf{P}_{k,n-k}]$.
+        The $(k, n)$ generator matrix $\mathbf{G} = [\mathbf{I}_{k,k} \mid \mathbf{P}_{k,n-k}]$.
 
     Examples:
         .. ipython:: python

src/galois/_databases/_interface.py

@@ -7,30 +7,32 @@
 import sqlite3
 import sys
 from pathlib import Path
+from threading import Lock
 
 
 class DatabaseInterface:
     """
     An abstract class to interface with SQLite databases.
     """
 
-    singleton = None
+    _lock = Lock()
+    _singleton = None
     file: Path
 
     def __new__(cls):
-        if cls.singleton is None:
-            cls.singleton = super().__new__(cls)
-            cls.conn = sqlite3.connect(cls.file)
-            cls.cursor = cls.conn.cursor()
-        return cls.singleton
+        with cls._lock:
+            if cls._singleton is None:
+                cls._singleton = super().__new__(cls)
+                cls.conn = sqlite3.connect(cls.file, check_same_thread=False)
+                cls.cursor = cls.conn.cursor()
+        return cls._singleton
 
 
 class PrimeFactorsDatabase(DatabaseInterface):
     """
     A class to interface with the prime factors database.
     """
 
-    singleton = None
     file = Path(__file__).parent / "prime_factors.db"
 
     def fetch(self, n: int) -> tuple[list[int], list[int], int]:
@@ -51,15 +53,16 @@ def fetch(self, n: int) -> tuple[list[int], list[int], int]:
             n = str(n)
             sys.set_int_max_str_digits(default_limit)
 
-        self.cursor.execute(
-            """
-            SELECT factors, multiplicities, composite
-            FROM factorizations
-            WHERE value=?
-            """,
-            (str(n),),
-        )
-        result = self.cursor.fetchone()
+        with self._lock:
+            self.cursor.execute(
+                """
+                SELECT factors, multiplicities, composite
+                FROM factorizations
+                WHERE value=?
+                """,
+                (str(n),),
+            )
+            result = self.cursor.fetchone()
 
         if result is None:
             raise LookupError(f"The prime factors database does not contain an entry for {n}.")
@@ -76,7 +79,6 @@ class IrreduciblePolyDatabase(DatabaseInterface):
     A class to interface with the irreducible polynomials database.
     """
 
-    singleton = None
     file = Path(__file__).parent / "irreducible_polys.db"
 
     def fetch(self, characteristic: int, degree: int) -> tuple[list[int], list[int]]:
@@ -90,14 +92,15 @@ def fetch(self, characteristic: int, degree: int) -> tuple[list[int], list[int]]
         Returns:
             A tuple containing the non-zero degrees and coefficients of the irreducible polynomial.
         """
-        self.cursor.execute(
-            """
-            SELECT nonzero_degrees, nonzero_coeffs
-            FROM polys
-            WHERE characteristic=? AND degree=?""",
-            (characteristic, degree),
-        )
-        result = self.cursor.fetchone()
+        with self._lock:
+            self.cursor.execute(
+                """
+                SELECT nonzero_degrees, nonzero_coeffs
+                FROM polys
+                WHERE characteristic=? AND degree=?""",
+                (characteristic, degree),
+            )
+            result = self.cursor.fetchone()
 
         if result is None:
             raise LookupError(
@@ -116,7 +119,6 @@ class ConwayPolyDatabase(DatabaseInterface):
     A class to interface with the Conway polynomials database.
     """
 
-    singleton = None
     file = Path(__file__).parent / "conway_polys.db"
 
     def fetch(self, characteristic: int, degree: int) -> tuple[list[int], list[int]]:
@@ -130,15 +132,16 @@ def fetch(self, characteristic: int, degree: int) -> tuple[list[int], list[int]]
         Returns:
             A tuple containing the non-zero degrees and coefficients of the Conway polynomial.
         """
-        self.cursor.execute(
-            """
-            SELECT nonzero_degrees, nonzero_coeffs
-            FROM polys
-            WHERE characteristic=? AND degree=?
-            """,
-            (characteristic, degree),
-        )
-        result = self.cursor.fetchone()
+        with self._lock:
+            self.cursor.execute(
+                """
+                SELECT nonzero_degrees, nonzero_coeffs
+                FROM polys
+                WHERE characteristic=? AND degree=?
+                """,
+                (characteristic, degree),
+            )
+            result = self.cursor.fetchone()
 
         if result is None:
             raise LookupError(

src/galois/_fields/_array.py

@@ -128,7 +128,7 @@ def _verify_array_like_types_and_values(cls, x: ElementLike | ArrayLike) -> Elem
         if isinstance(x, (int, np.integer)):
             cls._verify_scalar_value(x)
         elif isinstance(x, cls):
-            # This was a previously-created and vetted array -- there's no need to re-verify
+            # This was a previously created and vetted array -- there's no need to re-verify
             if x.ndim == 0:
                 # Ensure that in "large" fields with dtype=object that FieldArray objects aren't assigned to the array.
                 # The arithmetic functions are designed to operate on Python ints.

src/galois/_fields/_factory.py

@@ -88,7 +88,7 @@ def GF(
             :func:`~galois.FieldArray.compile` method. See :doc:`/basic-usage/compilation-modes` for a further
             discussion.
 
-            - `None` (default): For a newly-created :obj:`~galois.FieldArray` subclass, `None` corresponds to
+            - `None` (default): For a newly created :obj:`~galois.FieldArray` subclass, `None` corresponds to
               `"auto"`. If the :obj:`~galois.FieldArray` subclass already exists, `None` does not modify its current
               compilation mode.
             - `"auto"`: Selects `"jit-lookup"` for fields with order less than $2^{20}$, `"jit-calculate"` for
@@ -109,7 +109,7 @@ def GF(
             :func:`~galois.FieldArray.repr` method. See :doc:`/basic-usage/element-representation` for a further
             discussion.
 
-            - `None` (default): For a newly-created :obj:`~galois.FieldArray` subclass, `None` corresponds to `"int"`.
+            - `None` (default): For a newly created :obj:`~galois.FieldArray` subclass, `None` corresponds to `"int"`.
               If the :obj:`~galois.FieldArray` subclass already exists, `None` does not modify its current element
               representation.
             - `"int"`: Sets the element representation to the :ref:`integer representation <int-repr>`.
@@ -191,7 +191,7 @@ def GF(
                     GF = galois.GF(3**5, irreducible_poly="x^5 + 2x + 2")
                     print(GF.properties)
 
-        Finite fields with arbitrarily-large orders are supported.
+        Finite fields with arbitrarily large orders are supported.
 
         .. md-tab-set::
 
@@ -246,7 +246,7 @@ def GF(
         verify_isinstance(order, int)
         p, e = factors(order)
         if not len(p) == len(e) == 1:
-            s = " + ".join([f"{pi}**{ei}" for pi, ei in zip(p, e)])
+            s = " * ".join([f"{pi}^{ei}" for pi, ei in zip(p, e)])
             raise ValueError(f"Argument 'order' must be a prime power, not {order} = {s}.")
         characteristic, degree = p[0], e[0]
     elif len(args) == 2:

src/galois/_modular.py

@@ -82,7 +82,7 @@ def euler_phi(n: int) -> int:
     Notes:
         This function implements the Euler totient function
 
-        $$\phi(n) = n \prod_{p\ |\ n} \bigg(1 - \frac{1}{p}\bigg) = \prod_{i=1}^{k} p_i^{e_i-1} \big(p_i - 1\big)$$
+        $$\phi(n) = n \prod_{p \mid n} \bigg(1 - \frac{1}{p}\bigg) = \prod_{i=1}^{k} p_i^{e_i-1} \big(p_i - 1\big)$$
 
         for prime $p$ and the prime factorization $n = p_1^{e_1} \dots p_k^{e_k}$.